1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
// Copyright (c) 2018-2022 Brendan Molloy <brendan@bbqsrc.net>,
// Ilya Solovyiov <ilya.solovyiov@gmail.com>,
// Kai Ren <tyranron@gmail.com>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! [`Writer`]-wrapper for collecting a summary of execution.
use std::{borrow::Cow, collections::HashMap, sync::Arc};
use async_trait::async_trait;
use derive_more::Deref;
use itertools::Itertools as _;
use crate::{
cli::Colored,
event,
event::Retries,
parser,
writer::{self, out::Styles},
Event, World, Writer,
};
/// Execution statistics.
///
/// [`Step`]: gherkin::Step
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Stats {
/// Number of passed [`Step`]s (or [`Scenario`]s).
///
/// [`Scenario`]: gherkin::Scenario
/// [`Step`]: gherkin::Step
pub passed: usize,
/// Number of skipped [`Step`]s (or [`Scenario`]s).
///
/// [`Scenario`]: gherkin::Scenario
/// [`Step`]: gherkin::Step
pub skipped: usize,
/// Number of failed [`Step`]s (or [`Scenario`]s).
///
/// [`Scenario`]: gherkin::Scenario
/// [`Step`]: gherkin::Step
pub failed: usize,
/// Number of retried [`Step`]s (or [`Scenario`]s).
///
/// [`Scenario`]: gherkin::Scenario
/// [`Step`]: gherkin::Step
pub retried: usize,
}
impl Stats {
/// Returns total number of [`Step`]s (or [`Scenario`]s), these [`Stats`]
/// have been collected for.
///
/// [`Scenario`]: gherkin::Scenario
/// [`Step`]: gherkin::Step
#[must_use]
pub const fn total(&self) -> usize {
// We intentionally don't include `self.retried` number here, as it's
// already counted either in `self.passed` or `self.failed`.
self.passed + self.skipped + self.failed
}
}
/// Alias for [`fn`] used to determine should [`Skipped`] test considered as
/// [`Failed`] or not.
///
/// [`Failed`]: event::Step::Failed
/// [`Skipped`]: event::Step::Skipped
pub type SkipFn =
fn(&gherkin::Feature, Option<&gherkin::Rule>, &gherkin::Scenario) -> bool;
/// Indicator of a [`Failed`], [`Skipped`] or retried [`Scenario`].
///
/// [`Failed`]: event::Step::Failed
/// [`Scenario`]: gherkin::Scenario
/// [`Skipped`]: event::Step::Skipped
#[derive(Clone, Copy, Debug)]
enum Indicator {
/// [`Failed`] [`Scenario`].
///
/// [`Failed`]: event::Step::Failed
/// [`Scenario`]: gherkin::Scenario
Failed,
/// [`Skipped`] [`Scenario`].
///
/// [`Scenario`]: gherkin::Scenario
/// [`Skipped`]: event::Step::Skipped
Skipped,
/// Retried [`Scenario`].
///
/// [`Scenario`]: gherkin::Scenario
/// [`Skipped`]: event::Step::Skipped
Retried,
}
/// Possible states of a [`Summarize`] [`Writer`].
#[derive(Clone, Copy, Debug)]
enum State {
/// [`Finished`] event hasn't been encountered yet.
///
/// [`Finished`]: event::Cucumber::Finished
InProgress,
/// [`Finished`] event was encountered, but summary hasn't been output yet.
///
/// [`Finished`]: event::Cucumber::Finished
FinishedButNotOutput,
/// [`Finished`] event was encountered and summary was output.
///
/// [`Finished`]: event::Cucumber::Finished
FinishedAndOutput,
}
/// Wrapper for a [`Writer`] for outputting an execution summary (number of
/// executed features, scenarios, steps and parsing errors).
///
/// Underlying [`Writer`] has to be [`Summarizable`] and [`ArbitraryWriter`]
/// with `Value` accepting [`String`]. If your underlying [`ArbitraryWriter`]
/// operates with something like JSON (or any other type), you should implement
/// a [`Writer`] on [`Summarize`] by yourself, to provide the required summary
/// format.
///
/// [`ArbitraryWriter`]: writer::Arbitrary
#[derive(Debug, Deref)]
pub struct Summarize<Writer> {
/// Original [`Writer`] to summarize output of.
#[deref]
pub writer: Writer,
/// Number of started [`Feature`]s.
///
/// [`Feature`]: gherkin::Feature
pub features: usize,
/// Number of started [`Rule`]s.
///
/// [`Rule`]: gherkin::Rule
pub rules: usize,
/// [`Scenario`]s [`Stats`].
///
/// [`Scenario`]: gherkin::Scenario
pub scenarios: Stats,
/// [`Step`]s [`Stats`].
///
/// [`Step`]: gherkin::Step
pub steps: Stats,
/// Number of [`Parser`] errors.
///
/// [`Parser`]: crate::Parser
pub parsing_errors: usize,
/// Number of failed [`Scenario`] hooks.
///
/// [`Scenario`]: gherkin::Scenario
pub failed_hooks: usize,
/// Current [`State`] of this [`Writer`].
state: State,
/// Handled [`Scenario`]s to collect [`Stats`].
///
/// [`Scenario`]: gherkin::Scenario
handled_scenarios: HandledScenarios,
}
/// [`HashMap`] for keeping track of handled [`Scenario`]s. Whole path with
/// [`Feature`] and [`Rule`] is used to avoid collisions in case [`Scenario`]s
/// themself look identical.
///
/// [`Feature`]: gherkin::Feature
/// [`Rule`]: gherkin::Rule
/// [`Scenario`]: gherkin::Scenario
type HandledScenarios = HashMap<
(
Arc<gherkin::Feature>,
Option<Arc<gherkin::Rule>>,
Arc<gherkin::Scenario>,
),
Indicator,
>;
#[async_trait(?Send)]
impl<W, Wr> Writer<W> for Summarize<Wr>
where
W: World,
Wr: for<'val> writer::Arbitrary<'val, W, String> + Summarizable,
Wr::Cli: Colored,
{
type Cli = Wr::Cli;
async fn handle_event(
&mut self,
ev: parser::Result<Event<event::Cucumber<W>>>,
cli: &Self::Cli,
) {
use event::{Cucumber, Feature, Rule};
// Once `Cucumber::Finished` is emitted, we just pass events through,
// without collecting `Stats`.
// This is done to avoid miscalculations if this `Writer` happens to be
// wrapped by a `writer::Repeat` or similar.
if let State::InProgress = self.state {
match ev.as_deref() {
Err(_) => self.parsing_errors += 1,
Ok(Cucumber::Feature(feat, ev)) => match ev {
Feature::Started => self.features += 1,
Feature::Rule(_, Rule::Started) => {
self.rules += 1;
}
Feature::Rule(rule, Rule::Scenario(sc, ev)) => {
self.handle_scenario(
Arc::clone(feat),
Some(Arc::clone(rule)),
Arc::clone(sc),
ev,
);
}
Feature::Scenario(sc, ev) => {
self.handle_scenario(
Arc::clone(feat),
None,
Arc::clone(sc),
ev,
);
}
Feature::Finished | Feature::Rule(..) => {}
},
Ok(Cucumber::Finished) => {
self.state = State::FinishedButNotOutput;
}
Ok(Cucumber::Started | Cucumber::ParsingFinished { .. }) => {}
};
}
self.writer.handle_event(ev, cli).await;
if let State::FinishedButNotOutput = self.state {
self.state = State::FinishedAndOutput;
let mut styles = Styles::new();
styles.apply_coloring(cli.coloring());
self.writer.write(styles.summary(self)).await;
}
}
}
#[async_trait(?Send)]
impl<'val, W, Wr, Val> writer::Arbitrary<'val, W, Val> for Summarize<Wr>
where
W: World,
Self: Writer<W>,
Wr: writer::Arbitrary<'val, W, Val>,
Val: 'val,
{
async fn write(&mut self, val: Val)
where
'val: 'async_trait,
{
self.writer.write(val).await;
}
}
impl<W, Wr> writer::Stats<W> for Summarize<Wr>
where
W: World,
Self: Writer<W>,
{
fn passed_steps(&self) -> usize {
self.steps.passed
}
fn skipped_steps(&self) -> usize {
self.steps.skipped
}
fn failed_steps(&self) -> usize {
self.steps.failed
}
fn retried_steps(&self) -> usize {
self.steps.retried
}
fn parsing_errors(&self) -> usize {
self.parsing_errors
}
fn hook_errors(&self) -> usize {
self.failed_hooks
}
}
impl<Wr: writer::Normalized> writer::Normalized for Summarize<Wr> {}
impl<Wr: writer::NonTransforming> writer::NonTransforming for Summarize<Wr> {}
impl<Writer> From<Writer> for Summarize<Writer> {
fn from(writer: Writer) -> Self {
Self {
writer,
features: 0,
rules: 0,
scenarios: Stats {
passed: 0,
skipped: 0,
failed: 0,
retried: 0,
},
steps: Stats {
passed: 0,
skipped: 0,
failed: 0,
retried: 0,
},
parsing_errors: 0,
failed_hooks: 0,
state: State::InProgress,
handled_scenarios: HashMap::new(),
}
}
}
impl<Writer> Summarize<Writer> {
/// Keeps track of [`Step`]'s [`Stats`].
///
/// [`Step`]: gherkin::Step
fn handle_step<W>(
&mut self,
feature: Arc<gherkin::Feature>,
rule: Option<Arc<gherkin::Rule>>,
scenario: Arc<gherkin::Scenario>,
step: &gherkin::Step,
ev: &event::Step<W>,
retries: Option<Retries>,
) {
use self::{
event::Step,
Indicator::{Failed, Retried, Skipped},
};
match ev {
Step::Started => {}
Step::Passed(..) => {
self.steps.passed += 1;
if scenario.steps.last().filter(|s| *s == step).is_some() {
let _ = self
.handled_scenarios
.remove(&(feature, rule, scenario));
}
}
Step::Skipped => {
self.steps.skipped += 1;
self.scenarios.skipped += 1;
let _ = self
.handled_scenarios
.insert((feature, rule, scenario), Skipped);
}
Step::Failed(..) => {
if retries.filter(|r| r.left > 0).is_some() {
self.steps.retried += 1;
let inserted_before = self
.handled_scenarios
.insert((feature, rule, scenario), Retried);
if inserted_before.is_none() {
self.scenarios.retried += 1;
}
} else {
self.steps.failed += 1;
self.scenarios.failed += 1;
let _ = self
.handled_scenarios
.insert((feature, rule, scenario), Failed);
}
}
}
}
/// Keeps track of [`Scenario`]'s [`Stats`].
///
/// [`Scenario`]: gherkin::Scenario
fn handle_scenario<W>(
&mut self,
feature: Arc<gherkin::Feature>,
rule: Option<Arc<gherkin::Rule>>,
scenario: Arc<gherkin::Scenario>,
ev: &event::RetryableScenario<W>,
) {
use event::{Hook, Scenario};
let path = (feature, rule, scenario);
let ret = ev.retries;
match &ev.event {
Scenario::Started
| Scenario::Hook(_, Hook::Passed | Hook::Started) => {}
Scenario::Hook(_, Hook::Failed(..)) => {
// - If Scenario's last Step failed and then After Hook failed
// too, we don't need to track second failure;
// - If Scenario's last Step was skipped and then After Hook
// failed, we need to override skipped Scenario with failed;
// - If Scenario executed no Steps and then Hook failed, we
// track Scenario as failed.
match self.handled_scenarios.get(&path) {
Some(Indicator::Failed | Indicator::Retried) => {}
Some(Indicator::Skipped) => {
self.scenarios.skipped -= 1;
self.scenarios.failed += 1;
}
None => {
self.scenarios.failed += 1;
let _ = self
.handled_scenarios
.insert(path, Indicator::Failed);
}
}
self.failed_hooks += 1;
}
Scenario::Background(st, ev) | Scenario::Step(st, ev) => {
self.handle_step(path.0, path.1, path.2, st.as_ref(), ev, ret);
}
Scenario::Finished => {
// We don't remove retried `Scenario`s immediately, because we
// want to deduplicate. For example if some `Scenario` is
// retried 3 times, we'll see in summary 1 retried `Scenario`
// and 3 retried `Step`s.
let is_retried = self
.handled_scenarios
.get(&path)
.map(|indicator| matches!(indicator, Indicator::Retried))
.unwrap_or_default();
if !is_retried && self.handled_scenarios.remove(&path).is_none()
{
self.scenarios.passed += 1;
}
}
}
}
}
impl<Writer> Summarize<Writer> {
/// Wraps the given [`Writer`] into a new [`Summarize`]d one.
#[must_use]
pub fn new(writer: Writer) -> Self {
Self::from(writer)
}
}
/// Marker indicating that a [`Writer`] can be wrapped into a [`Summarize`].
///
/// Not any [`Writer`] can be wrapped into a [`Summarize`], as it may transform
/// events inside and the summary won't reflect outputted events correctly.
///
/// So, this trait ensures that a wrong [`Writer`]s pipeline cannot be build.
///
/// # Example
///
/// ```rust,compile_fail
/// # use cucumber::{writer, World, WriterExt as _};
/// #
/// # #[derive(Debug, Default, World)]
/// # struct MyWorld;
/// #
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() {
/// MyWorld::cucumber()
/// .with_writer(
/// // `Writer`s pipeline is constructed in a reversed order.
/// writer::Basic::stdout()
/// .fail_on_skipped() // Fails as `Summarize` will count skipped
/// .summarized() // steps instead of failed.
/// )
/// .run_and_exit("tests/features/readme")
/// .await;
/// # }
/// ```
///
/// ```rust
/// # use std::panic::AssertUnwindSafe;
/// #
/// # use cucumber::{writer, World, WriterExt as _};
/// # use futures::FutureExt as _;
/// #
/// # #[derive(Debug, Default, World)]
/// # struct MyWorld;
/// #
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() {
/// # let fut = async {
/// MyWorld::cucumber()
/// .with_writer(
/// // `Writer`s pipeline is constructed in a reversed order.
/// writer::Basic::stdout() // And, finally, print them.
/// .summarized() // Only then, count summary for them.
/// .fail_on_skipped() // First, transform skipped steps to failed.
/// )
/// .run_and_exit("tests/features/readme")
/// .await;
/// # };
/// # let err = AssertUnwindSafe(fut)
/// # .catch_unwind()
/// # .await
/// # .expect_err("should err");
/// # let err = err.downcast_ref::<String>().unwrap();
/// # assert_eq!(err, "1 step failed");
/// # }
/// ```
pub trait Summarizable {}
impl<T: writer::NonTransforming> Summarizable for T {}
// We better keep this here, as it's related to summarization only.
#[allow(clippy::multiple_inherent_impl)]
impl Styles {
/// Generates a formatted summary [`String`].
#[must_use]
pub fn summary<W>(&self, summary: &Summarize<W>) -> String {
let features = self.maybe_plural("feature", summary.features);
let rules = (summary.rules > 0)
.then(|| format!("{}\n", self.maybe_plural("rule", summary.rules)))
.unwrap_or_default();
let scenarios =
self.maybe_plural("scenario", summary.scenarios.total());
let scenarios_stats = self.format_stats(summary.scenarios);
let steps = self.maybe_plural("step", summary.steps.total());
let steps_stats = self.format_stats(summary.steps);
let parsing_errors = (summary.parsing_errors > 0)
.then(|| {
self.err(
self.maybe_plural("parsing error", summary.parsing_errors),
)
})
.unwrap_or_default();
let hook_errors = (summary.failed_hooks > 0)
.then(|| {
self.err(self.maybe_plural("hook error", summary.failed_hooks))
})
.unwrap_or_default();
let comma = (!parsing_errors.is_empty() && !hook_errors.is_empty())
.then(|| self.err(", "))
.unwrap_or_default();
format!(
"{summary}\n{features}\n{rules}{scenarios}{scenarios_stats}\n\
{steps}{steps_stats}\n{parsing_errors}{comma}{hook_errors}",
summary = self.bold(self.header("[Summary]")),
)
.trim_end_matches('\n')
.to_owned()
}
/// Formats [`Stats`] for a terminal output.
#[must_use]
pub fn format_stats(&self, stats: Stats) -> Cow<'static, str> {
let mut formatted = [
(stats.passed > 0)
.then(|| self.bold(self.ok(format!("{} passed", stats.passed))))
.unwrap_or_default(),
(stats.skipped > 0)
.then(|| {
self.bold(
self.skipped(format!("{} skipped", stats.skipped)),
)
})
.unwrap_or_default(),
(stats.failed > 0)
.then(|| {
self.bold(self.err(format!("{} failed", stats.failed)))
})
.unwrap_or_default(),
]
.into_iter()
.filter(|s| !s.is_empty())
.join(&self.bold(", "));
if stats.retried > 0 {
formatted.push_str(" with ");
formatted.push_str(&self.bold(self.retry(format!(
"{} retr{}",
stats.retried,
if stats.retried == 1 { "y" } else { "ies" },
))));
}
(!formatted.is_empty())
.then(|| {
self.bold(format!(
" {}{formatted}{}",
self.bold("("),
self.bold(")"),
))
})
.unwrap_or_default()
}
/// Adds `s` to `singular` if the given `num` is not `1`.
fn maybe_plural(
&self,
singular: impl Into<Cow<'static, str>>,
num: usize,
) -> Cow<'static, str> {
self.bold(format!(
"{num} {}{}",
singular.into(),
(num != 1).then_some("s").unwrap_or_default(),
))
}
}