include full error in json output

Author: ss2165

hugr-cli/src/describe.rs

@@ -85,6 +85,7 @@ impl DescribeArgs {
             self.module_args.filter_module(module);
         }
 
+        let res = res.map_err(anyhow::Error::from);
         if self.json {
             if !self.packaged_extensions {
                 desc.packaged_extensions.clear();
@@ -95,8 +96,7 @@ impl DescribeArgs {
         }
 
         // bubble up any errors
-        let _ = res?;
-        Ok(())
+        res.map(|_| ())
     }
 
     fn print_description(&mut self, desc: PackageDesc) -> Result<()> {
@@ -135,12 +135,8 @@ impl DescribeArgs {
         Ok(())
     }
 
-    fn output_json<E: std::error::Error>(
-        &mut self,
-        package_desc: PackageDesc,
-        res: &Result<Package, E>,
-    ) -> Result<()> {
-        let err_str = res.as_ref().err().map(|e| format!("{e}"));
+    fn output_json(&mut self, package_desc: PackageDesc, res: &Result<Package>) -> Result<()> {
+        let err_str = res.as_ref().err().map(|e| format!("{e:?}"));
         let json_desc = JsonDescription {
             package_desc,
             error: err_str,

hugr-cli/tests/describe.rs

@@ -4,8 +4,6 @@
 //! calling the CLI binary, which Miri doesn't support.
 #![cfg(all(test, not(miri)))]
 
-use std::sync::Arc;
-
 use assert_cmd::Command;
 use assert_fs::NamedTempFile;
 use assert_fs::assert::PathAssert;
@@ -14,7 +12,9 @@ use hugr::Extension;
 use hugr::builder::ModuleBuilder;
 use hugr::builder::{Dataflow, DataflowSubContainer, HugrBuilder};
 use hugr::core::Visibility;
-use hugr::envelope::{EnvelopeConfig, GENERATOR_KEY, USED_EXTENSIONS_KEY};
+use hugr::envelope::{
+    EnvelopeConfig, EnvelopeFormat, EnvelopeHeader, GENERATOR_KEY, USED_EXTENSIONS_KEY,
+};
 use hugr::extension::prelude::bool_t;
 use hugr::extension::{ExtensionId, ExtensionRegistry, Version};
 use hugr::hugr::HugrView;
@@ -26,6 +26,8 @@ use predicates::{prelude::*, str::contains};
 use rstest::{fixture, rstest};
 use serde_json::Value;
 use serde_json::json;
+use std::io::Write;
+use std::sync::Arc;
 #[fixture]
 fn cmd() -> Command {
     Command::cargo_bin("hugr").unwrap()
@@ -53,6 +55,20 @@ fn empty_package_file(empty_package: Package) -> NamedTempFile {
     file
 }
 
+#[fixture]
+fn invalid_package() -> Vec<u8> {
+    let header = EnvelopeHeader {
+        format: EnvelopeFormat::Model,
+        ..Default::default()
+    };
+    let mut buffer = Vec::new();
+    header.write(&mut buffer).unwrap();
+    buffer
+        .write_all(b"this is not valid hugr package data")
+        .unwrap();
+    buffer
+}
+
 #[fixture]
 fn package_with_exts() -> Vec<u8> {
     let test_ext = Extension::new_arc(
@@ -235,3 +251,26 @@ fn test_generator_claimed_extensions(package_with_exts: Vec<u8>, mut describe_cm
         .stdout(contains("Generator claimed extensions"))
         .stdout(contains("used_ext"));
 }
+
+#[rstest]
+fn test_describe_invalid_package(invalid_package: Vec<u8>, mut describe_cmd: Command) {
+    describe_cmd.write_stdin(invalid_package);
+    describe_cmd
+        .assert()
+        .failure()
+        .stdout(contains("Model"))
+        .stderr(contains("Error reading a HUGR model payload"));
+}
+
+#[rstest]
+fn test_describe_invalid_package_json(invalid_package: Vec<u8>, mut describe_cmd: Command) {
+    describe_cmd.write_stdin(invalid_package);
+
+    describe_cmd.arg("--json");
+    describe_cmd
+        .assert()
+        .failure()
+        .stdout(contains("Model"))
+        .stdout(contains("\"error\": \"Error reading a HUGR model payload")) // error included in JSON
+        .stderr(contains("Error reading a HUGR model payload"));
+}

hugr-core/src/envelope.rs

@@ -43,7 +43,7 @@ pub use reader::PayloadError;
 
 pub mod serde_with;
 
-pub use header::{EnvelopeConfig, EnvelopeFormat, MAGIC_NUMBERS, ZstdConfig};
+pub use header::{EnvelopeConfig, EnvelopeFormat, EnvelopeHeader, MAGIC_NUMBERS, ZstdConfig};
 pub use package_json::PackageEncodingError;
 
 use crate::envelope::description::PackageDesc;
@@ -54,7 +54,6 @@ use crate::{
     extension::{ExtensionRegistry, Version},
     package::Package,
 };
-use header::EnvelopeHeader;
 use std::io::BufRead;
 use std::io::Write;
 use thiserror::Error;