Implement outputting JUnit XML report (#147, #50)

- impl `writer::JUnit` behind `output-junit` Cargo feature
- make `writer::Basic` generic over `io::Write` implementor

Co-authored-by: Kai Ren <[email protected]>

Author: ilslv

.clippy.toml

@@ -2,9 +2,15 @@
 # See full lints list at:
 # https://rust-lang.github.io/rust-clippy/master/index.html
 
+doc-valid-idents = ["JUnit"]
+
 standard-macro-braces = [
+    { name = "assert", brace = "(" },
+    { name = "assert_eq", brace = "(" },
+    { name = "assert_ne", brace = "(" },
     { name = "format", brace = "(" },
     { name = "format_ident", brace = "(" },
+    { name = "panic", brace = "(" },
     { name = "quote", brace = "{" },
     { name = "vec", brace = "[" },
 ]

.github/workflows/ci.yml

@@ -61,7 +61,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        feature: ['<none>', 'macros', 'timestamps']
+        feature: ["<none>", "macros", "timestamps", "output-junit"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

CHANGELOG.md

@@ -14,8 +14,12 @@ All user visible changes to `cucumber` crate will be documented in this file. Th
 ### Added
 
 - Ability for step functions to return `Result`. ([#151])
+- Arbitrary output for `writer::Basic` ([#147])
+- `writer::JUnit` ([JUnit XML report][0110-1]) behind the `output-junit` feature flag ([#147])
 
+[#147]: /../../pull/147
 [#151]: /../../pull/151
+[0110-1]: https://llg.cubic.org/docs/junit
 
 
 

Cargo.toml

@@ -19,7 +19,7 @@ repository = "https://github.com/cucumber-rs/cucumber"
 readme = "README.md"
 categories = ["asynchronous", "development-tools::testing"]
 keywords = ["cucumber", "testing", "bdd", "atdd", "async"]
-include = ["/src/", "/tests/wait.rs", "/LICENSE-*", "/README.md", "/CHANGELOG.md"]
+include = ["/src/", "/tests/junit.rs", "/tests/wait.rs", "/LICENSE-*", "/README.md", "/CHANGELOG.md"]
 
 [package.metadata.docs.rs]
 all-features = true
@@ -29,14 +29,16 @@ rustdoc-args = ["--cfg", "docsrs"]
 default = ["macros"]
 # Enables step attributes and auto-wiring.
 macros = ["cucumber-codegen", "inventory"]
+# Enables support for outputting JUnit XML report.
+output-junit = ["junit-report", "timestamps"]
 # Enables timestamps collecting for all events.
 timestamps = []
 
 [dependencies]
 async-trait = "0.1.40"
 atty = "0.2.14"
 console = "0.15"
-derive_more = { version = "0.99.16", features = ["as_ref", "deref", "deref_mut", "display", "error", "from"], default_features = false }
+derive_more = { version = "0.99.16", features = ["as_ref", "deref", "deref_mut", "display", "error", "from", "into"], default_features = false }
 either = "1.6"
 futures = "0.3.17"
 gherkin = { package = "gherkin_rust", version = "0.10" }
@@ -52,10 +54,19 @@ structopt = "0.3.25"
 cucumber-codegen = { version = "0.11.0-dev", path = "./codegen", optional = true }
 inventory = { version = "0.1.10", optional = true }
 
+# "output-junit" feature dependencies
+junit-report = { version = "0.7", optional = true }
+
 [dev-dependencies]
 humantime = "2.1"
+tempfile = "3.2"
 tokio = { version = "1.12", features = ["macros", "rt-multi-thread", "time"] }
 
+[[test]]
+name = "junit"
+required-features = ["output-junit"]
+harness = false
+
 [[test]]
 name = "wait"
 harness = false

README.md

@@ -100,6 +100,7 @@ For more examples check out the Book ([current][1] | [edge][2]).
 
 - `macros` (default): Enables step attributes and auto-wiring.
 - `timestamps`: Enables timestamps collecting for all [Cucumber] events.
+- `output-junit` (implies `timestamps`): Enables support for outputting [JUnit XML report].
 
 
 
@@ -131,7 +132,8 @@ at your option.
 
 
 [Cucumber]: https://cucumber.io
-[Gherkin]: https://cucumber.io/docs/gherkin/reference 
+[Gherkin]: https://cucumber.io/docs/gherkin/reference
+[JUnit XML report]: https://llg.cubic.org/docs/junit
 
 [1]: https://cucumber-rs.github.io/cucumber/current
 [2]: https://cucumber-rs.github.io/cucumber/main

book/src/Features.md

@@ -431,5 +431,49 @@ You may also extend CLI options with custom ones, if you have such a need for ru
 
 
 
+## JUnit XML report
+
+Library provides an ability to output tests result in as [JUnit XML report].
+
+Just enable `output-junit` library feature in your `Cargo.toml`:
+```toml
+cucumber = { version = "0.11", features = ["output-junit"] }
+```
+
+And configure [Cucumber]'s output to `writer::JUnit`:
+```rust
+# use std::{convert::Infallible, fs, io};
+# 
+# use async_trait::async_trait;
+# use cucumber::WorldInit;
+use cucumber::writer;
+
+# #[derive(Debug, WorldInit)]
+# struct World;
+# 
+# #[async_trait(?Send)]
+# impl cucumber::World for World {
+#     type Error = Infallible;
+# 
+#     async fn new() -> Result<Self, Self::Error> {
+#         Ok(World)
+#     }
+# }
+#
+# #[tokio::main]
+# async fn main() -> io::Result<()> {
+let file = fs::File::create(dbg!(format!("{}/target/junit.xml", env!("CARGO_MANIFEST_DIR"))))?;
+World::cucumber()
+    .with_writer(writer::JUnit::new(file))
+    .run("tests/features/book")
+    .await;
+# Ok(())
+# }
+```
+
+
+
+
 [Cucumber]: https://cucumber.io
 [Gherkin]: https://cucumber.io/docs/gherkin
+[JUnit XML report]: https://llg.cubic.org/docs/junit

book/tests/Cargo.toml

@@ -11,7 +11,7 @@ publish = false
 
 [dependencies]
 async-trait = "0.1"
-cucumber = { version = "0.11.0-dev", path = "../.." }
+cucumber = { version = "0.11.0-dev", path = "../..", features = ["output-junit"] }
 futures = "0.3"
 skeptic = "0.13"
 tokio = { version = "1", features = ["macros", "rt-multi-thread", "time"] }

src/cucumber.rs

@@ -922,10 +922,10 @@ where
     I: AsRef<Path>,
 {
     fn default() -> Self {
-        Cucumber::custom(
+        Self::custom(
             parser::Basic::new(),
             runner::Basic::default(),
-            writer::Basic::new().normalized().summarized(),
+            writer::Basic::default().normalized().summarized(),
         )
     }
 }
@@ -957,7 +957,7 @@ where
     /// [tag]: https://cucumber.io/docs/cucumber/api/#tags
     #[must_use]
     pub fn new() -> Self {
-        Cucumber::default()
+        Self::default()
     }
 }
 

src/parser/basic.rs

@@ -22,6 +22,7 @@ use derive_more::{Display, Error};
 use futures::stream;
 use gherkin::GherkinEnv;
 use globwalk::{GlobWalker, GlobWalkerBuilder};
+use itertools::Itertools as _;
 use structopt::StructOpt;
 
 use crate::feature::Ext as _;
@@ -65,6 +66,7 @@ impl<I: AsRef<Path>> Parser<I> for Basic {
         let walk = |walker: GlobWalker| {
             walker
                 .filter_map(Result::ok)
+                .sorted_by(|l, r| Ord::cmp(l.path(), r.path()))
                 .filter(|file| {
                     file.path()
                         .extension()