Merge pull request #529 from pact-foundation/html-verification-report

Feat: HTML verification report

Author: rholshausen

rust/Cargo.lock

@@ -25,15 +25,18 @@ junit = ["dep:junit-report", "dep:strip-ansi-escapes"] # support for Junit forma
 ansi_term = "0.12.1"
 anyhow = "1.0.98"
 clap = { version = "4.5.40", features = ["cargo", "env"] }
-env_logger = "0.11.8"
 junit-report = { version = "0.8.3", optional = true }
 lazy_static = "1.5.0"
 log = "0.4.27"
 maplit = "1.0.2"
+pact_matching = { version = "~2.0.4", path = "../pact_matching", default-features = false }
 pact_models = { version = "~1.3.10", default-features = false }
 pact_verifier = { version = "~1.3.5", path = "../pact_verifier", default-features = false }
+quick-xml = { version = "0.39.2", features = ["serde", "serialize"] }
+xrust = "2.0.3"
 regex = "1.11.1"
 reqwest = { version = "0.12.20", default-features = false, features = ["rustls-tls-native-roots", "blocking", "json"] }
+serde = "1.0.228"
 serde_json = "1.0.140"
 strip-ansi-escapes = { version = "0.2.1", optional = true }
 time = "0.3.47"
@@ -46,6 +49,7 @@ tempfile = "3.20.0"
 
 [dev-dependencies]
 expectest = "0.12.0"
+insta = "1.43.1"
 rstest = "0.24.0"
 tempfile = "3.20.0"
 trycmd = "0.15.9"

rust/pact_verifier_cli/Cargo.toml

@@ -1,3 +1,5 @@
+//! Command Line Arguments for the Verifier
+
 use clap::{Arg, ArgAction, ArgGroup, Command, command};
 use clap::builder::{FalseyValueParser, NonEmptyStringValueParser, PossibleValuesParser};
 use lazy_static::lazy_static;
@@ -99,6 +101,18 @@ pub fn setup_app() -> Command {
       .action(ArgAction::Set)
       .value_parser(NonEmptyStringValueParser::new())
       .help("Generate a JUnit XML report of the verification (requires the junit feature)"))
+    .arg(Arg::new("html-file")
+      .long("html")
+      .env("PACT_VERIFIER_HTML_REPORT")
+      .action(ArgAction::Set)
+      .value_parser(NonEmptyStringValueParser::new())
+      .help("Generate an HTML report of the verification"))
+    .arg(Arg::new("html-file-xslt")
+      .long("xslt")
+      .action(ArgAction::Set)
+      .value_parser(NonEmptyStringValueParser::new())
+      .help("XSLT to use when generating the HTML report of the verification")
+      .requires("html-file"))
     .arg(Arg::new("no-colour")
       .long("no-colour")
       .action(ArgAction::SetTrue)

rust/pact_verifier_cli/src/args.rs

@@ -462,6 +462,7 @@ pub async fn handle_cli() -> Result<(), i32> {
   }
 }
 
+/// Run the verifier parsed arguments with a new Tokio runtime
 pub fn process_verifier_command(args: &ArgMatches) -> Result<(), ExitCode>  {
     tokio::runtime::Runtime::new().unwrap().block_on(async {
         let res = handle_matches(args).await;
@@ -472,6 +473,7 @@ pub fn process_verifier_command(args: &ArgMatches) -> Result<(), ExitCode>  {
     })
 }
 
+/// Process the parsed arguments
 pub async fn handle_matches(matches: &ArgMatches) -> Result<(), i32> {
   let coloured_output = setup_output(matches);
 
@@ -562,6 +564,14 @@ pub async fn handle_matches(matches: &ArgMatches) -> Result<(), i32> {
         warn!("junit feature is not enabled, ignoring junit-file option");
       }
 
+      if let Some(html_file) = matches.get_one::<String>("html-file") {
+        if let Err(err) = reports::write_html_report(&result, html_file.as_str(),
+          &provider_name, matches.get_one::<String>("html-file-xslt")) {
+          error!("Failed to write HTML report to '{html_file}' - {err}");
+          return Err(2)
+        }
+      }
+
       if result.result { Ok(()) } else { Err(1) }
     })
 }
@@ -819,14 +829,15 @@ fn interaction_filter(matches: &ArgMatches) -> FilterInfo {
 }
 
 
-
+/// Initialise ANSI terminal support (Windows only)
 #[cfg(windows)]
 pub fn init_windows() {
   if let Err(err) = ansi_term::enable_ansi_support() {
     warn!("Could not enable ANSI console support - {err}");
   }
 }
 
+/// Initialise ANSI terminal support (Windows only)
 #[cfg(not(windows))]
 pub fn init_windows() { }
 

rust/pact_verifier_cli/src/lib.rs

@@ -1,14 +1,57 @@
+use std::fs;
 use std::fs::File;
-use std::io::Write;
+use std::io::{Read, Write};
+use std::path::PathBuf;
 
 #[cfg(feature = "junit")] use junit_report::{ReportBuilder, TestCaseBuilder, TestSuiteBuilder};
 #[cfg(feature = "junit")] use strip_ansi_escapes;
 use serde_json::Value;
 use tracing::debug;
+use xrust::{Error, ErrorKind, Item, Node, SequenceTrait};
+use xrust::parser::ParseError;
+use xrust::parser::xml::parse;
+use xrust::transform::context::StaticContextBuilder;
+use xrust::trees::smite::RNode;
+use xrust::xslt::from_document;
 
 #[cfg(feature = "junit")] use pact_verifier::{interaction_mismatch_output, MismatchResult};
 use pact_verifier::verification_result::VerificationExecutionResult;
 
+mod xml;
+
+const XSLT: &str = include_str!("verification-report.xsl");
+
+fn node_from_str(s: &str) -> Result<RNode, Error> {
+  parse(RNode::new_document(), s, Some(|_: &_| Err(ParseError::MissingNameSpace)))
+}
+
+fn apply_xslt(xml_str: &str, xslt: Option<&String>) -> anyhow::Result<String> {
+  let doc = parse(RNode::new_document(), xml_str, Some(|_: &_| Err(ParseError::MissingNameSpace)))?;
+
+  let mut s = String::new();
+  let xslt_doc = if let Some(xslt) = xslt {
+    let mut f = File::open(xslt)?;
+    f.read_to_string(&mut s)?;
+    s.as_str()
+  } else {
+    XSLT
+  };
+  let xslt_doc = parse(RNode::new_document(), xslt_doc, Some(|_: &_| Err(ParseError::MissingNameSpace)))?;
+
+  let mut static_context = StaticContextBuilder::new()
+    .message(|_| Ok(()))
+    .fetcher(|_| Err(Error::new(ErrorKind::NotImplemented, "not implemented")))
+    .parser(|_| Err::<RNode, Error>(Error::new(ErrorKind::NotImplemented, "not implemented")))
+    .build();
+
+  let mut ctxt = from_document(xslt_doc, None, node_from_str, |_| Ok(String::new()))?;
+  ctxt.context(vec![Item::Node(doc)], 0);
+  ctxt.result_document(RNode::new_document());
+  let seq = ctxt.evaluate(&mut static_context)?;
+
+  Ok(seq.to_xml())
+}
+
 pub(crate) fn write_json_report(result: &VerificationExecutionResult, file_name: &str) -> anyhow::Result<()> {
   debug!("Writing JSON result of the verification to '{file_name}'");
   let mut f = File::create(file_name)?;
@@ -67,3 +110,41 @@ pub(crate) fn write_junit_report(result: &VerificationExecutionResult, file_name
   report.write_xml(&mut f)?;
   Ok(())
 }
+
+pub(crate) fn write_html_report(
+  result: &VerificationExecutionResult,
+  file_name: &str,
+  provider: &str,
+  xslt: Option<&String>
+) -> anyhow::Result<()> {
+  let path = PathBuf::from(file_name);
+  let parent = if let Some(parent) = path.parent() {
+    parent
+  } else {
+    return Err(anyhow::anyhow!("No parent directory found for {}", file_name));
+  };
+  fs::create_dir_all(parent)?;
+
+  let filename = if let Some(filename) = path.file_name() {
+    filename
+  } else {
+    return Err(anyhow::anyhow!("Failed to get file name of '{}'", path.display()));
+  };
+
+  let xml_path = if let Some(_extension) = path.extension() {
+    path.with_extension("xml")
+  } else {
+    parent.join(filename).with_extension("xml")
+  };
+
+  let xml_str = xml::to_xml_string(result, provider)?;
+
+  debug!("Writing XML report of the verification to '{}'", xml_path.display());
+  File::create(&xml_path)?.write_all(xml_str.as_bytes())?;
+
+  debug!("Writing HTML report of the verification to '{file_name}'");
+  let html = apply_xslt(&xml_str, xslt)?;
+  File::create(file_name)?.write_all(html.as_bytes())?;
+
+  Ok(())
+}

rust/pact_verifier_cli/src/reports.rs rust/pact_verifier_cli/src/reports/mod.rsrust/pact_verifier_cli/src/reports.rs renamed to rust/pact_verifier_cli/src/reports/mod.rs

@@ -0,0 +1,5 @@
+---
+source: pact_verifier_cli/src/reports/xml.rs
+expression: "to_xml(&result, \"My Provider\")"
+---
+<report><provider>My Provider</provider><result>false</result><errors><error><interaction>Complex interaction</interaction><mismatch type="mismatches"><interaction_id>complex-123</interaction_id><mismatches><mismatch type="MethodMismatch"><description>Expected method GET but received POST</description><expected>GET</expected><actual>POST</actual></mismatch><mismatch type="PathMismatch"><description>Expected path /foo but received /bar</description><expected>/foo</expected><actual>/bar</actual></mismatch><mismatch type="HeaderMismatch"><description>Expected header Content-Type=application/json but received text/plain</description><expected>application/json</expected><actual>text/plain</actual><key>Content-Type</key></mismatch><mismatch type="QueryMismatch"><description>Expected query parameter page=1 but received page=2</description><expected>1</expected><actual>2</actual><parameter>page</parameter></mismatch><mismatch type="BodyTypeMismatch"><description>Expected body content type application/json but received text/plain</description><expected>application/json</expected><actual>text/plain</actual></mismatch><mismatch type="MetadataMismatch"><description>Expected metadata contentType=application/json but received text/xml</description><expected>application/json</expected><actual>text/xml</actual><key>contentType</key></mismatch></mismatches></mismatch></error></errors></report>

rust/pact_verifier_cli/src/reports/snapshots/pact_verifier_cli__reports__xml__tests__all_mismatch_types.snap

@@ -0,0 +1,5 @@
+---
+source: pact_verifier_cli/src/reports/xml.rs
+expression: "to_xml(&VerificationExecutionResult::new(), \"My Provider\")"
+---
+<report><provider>My Provider</provider><result>true</result></report>

rust/pact_verifier_cli/src/reports/snapshots/pact_verifier_cli__reports__xml__tests__empty_result.snap

@@ -0,0 +1,5 @@
+---
+source: pact_verifier_cli/src/reports/xml.rs
+expression: "to_xml(&result, \"My Provider\")"
+---
+<report><provider>My Provider</provider><result>false</result><errors><error><interaction>GET /foo returns 200</interaction><mismatch type="mismatches"><mismatches><mismatch type="StatusMismatch"><description>Expected status 200 but was 404</description><expected>200</expected><actual>404</actual></mismatch><mismatch type="BodyMismatch"><description>Expected 100 but got 200</description><expected>100</expected><actual>200</actual><path>$.price</path></mismatch></mismatches></mismatch></error></errors></report>

rust/pact_verifier_cli/src/reports/snapshots/pact_verifier_cli__reports__xml__tests__failing_with_body_mismatch.snap

@@ -0,0 +1,5 @@
+---
+source: pact_verifier_cli/src/reports/xml.rs
+expression: "to_xml(&result, \"My Provider\")"
+---
+<report><provider>My Provider</provider><result>false</result><errors><error><interaction>GET /foo returns 200</interaction><mismatch type="error"><error_message>Connection refused</error_message><interaction_id>abc123</interaction_id></mismatch></error></errors><interaction_results><interaction><description>GET /foo returns 200</description><result>Error</result><pending>false</pending><duration_ms>5</duration_ms></interaction></interaction_results></report>

rust/pact_verifier_cli/src/reports/snapshots/pact_verifier_cli__reports__xml__tests__failing_with_error_mismatch.snap

@@ -0,0 +1,5 @@
+---
+source: pact_verifier_cli/src/reports/xml.rs
+expression: "to_xml(&result, \"My Provider\")"
+---
+<report><provider>My Provider</provider><result>true</result><interaction_results><interaction><description>GET /foo returns 200</description><result>OK</result><pending>false</pending><duration_ms>42</duration_ms></interaction><interaction><description>POST /bar returns 201</description><result>OK</result><pending>false</pending><duration_ms>15</duration_ms></interaction></interaction_results></report>