Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement failure reporting #91

Merged
merged 4 commits into from
Nov 25, 2020
Merged

Implement failure reporting #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9b5886
Implement failure reporting
gnunicorn Nov 24, 2020
b5f86ae
compile run results indepently from EventHandler and return it on run
gnunicorn Nov 24, 2020
1029129
clean old code
gnunicorn Nov 24, 2020
cb93416
let handle_event take a reference
gnunicorn Nov 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/cucumber.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ impl<W: World> Cucumber<W> {
s
}

pub async fn run(mut self) {
/// Run and report number of errors if any
pub async fn run(mut self) -> crate::runner::RunResult {
let runner = crate::runner::Runner::new(
self.steps.steps,
std::rc::Rc::new(self.features),
Expand All @@ -153,7 +154,13 @@ impl<W: World> Cucumber<W> {
let mut stream = runner.run();

while let Some(event) = stream.next().await {
self.event_handler.handle_event(event);
self.event_handler.handle_event(&event);

if let crate::event::CucumberEvent::Finished(result) = event {
return result
}
}

panic!("Invariant broken: no Finish event found before stream ended")
}
}
2 changes: 1 addition & 1 deletion src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ pub enum FeatureEvent {
pub enum CucumberEvent {
Starting,
Feature(Rc<gherkin::Feature>, FeatureEvent),
Finished,
Finished(crate::runner::RunResult),
}

#[derive(Debug, Clone, PartialEq, Eq)]
Expand Down
3 changes: 2 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ use std::panic::UnwindSafe;

pub use cucumber::Cucumber;
pub use examples::ExampleValues;
pub use runner::RunResult;
use std::any::Any;
pub use steps::Steps;

Expand Down Expand Up @@ -77,7 +78,7 @@ pub trait World: Sized + UnwindSafe + 'static {
/// User can replace the default `EventHandler` for a `Cucumber`
/// at construction time using `Cucumber::with_handler`.
pub trait EventHandler: 'static {
fn handle_event(&mut self, event: event::CucumberEvent);
fn handle_event(&mut self, event: &event::CucumberEvent);
}

pub type PanicError = Box<(dyn Any + Send + 'static)>;
Expand Down
143 changes: 42 additions & 101 deletions src/output/default.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,15 @@ use std::io::Write;
use std::path::PathBuf;
use std::rc::Rc;

use crate::event::{FailureKind, StepFailureKind};
use crate::runner::{RunResult, Stats};
use crate::event::{StepFailureKind};
use crate::{
event::{CucumberEvent, RuleEvent, ScenarioEvent, StepEvent},
EventHandler,
};
use gherkin::{Feature, Rule, Scenario, Step};

#[derive(Debug, Clone, Default)]
struct Counter {
total: u32,
skipped: u32,
passed: u32,
failed: u32,
timed_out: u32,
}

pub struct BasicOutput {
features: Counter,
rules: Counter,
scenarios: Counter,
steps: Counter,
started: std::time::Instant,
step_started: bool,
pending_feature_print_info: Option<(String, String)>,
printed_feature_start: bool,
Expand All @@ -40,11 +27,6 @@ pub struct BasicOutput {
impl Default for BasicOutput {
fn default() -> BasicOutput {
BasicOutput {
features: Default::default(),
rules: Default::default(),
scenarios: Default::default(),
steps: Default::default(),
started: std::time::Instant::now(),
step_started: false,
pending_feature_print_info: None,
printed_feature_start: false,
Expand Down Expand Up @@ -192,15 +174,13 @@ impl BasicOutput {

fn handle_step(
&mut self,
feature: Rc<Feature>,
rule: Option<Rc<Rule>>,
_scenario: Rc<Scenario>,
step: Rc<Step>,
event: StepEvent,
feature: &Rc<Feature>,
rule: Option<&Rc<Rule>>,
_scenario: &Rc<Scenario>,
step: &Rc<Step>,
event: &StepEvent,
is_bg: bool,
) {
self.steps.total += 1;

let cmt = self.file_line_col(feature.path.as_ref(), step.position);
let msg = if is_bg {
format!("(Background) {}", &step)
Expand All @@ -227,8 +207,6 @@ impl BasicOutput {
self.step_started = true;
}
StepEvent::Unimplemented => {
self.steps.skipped += 1;

self.writeln_cmt(
&format!("- {}", msg),
&cmt,
Expand All @@ -241,8 +219,6 @@ impl BasicOutput {
println!("Not yet implemented (skipped)");
}
StepEvent::Skipped => {
self.steps.skipped += 1;

self.writeln_cmt(
&format!("- {}", msg),
&cmt,
Expand All @@ -253,8 +229,6 @@ impl BasicOutput {
self.print_step_extras(&*step);
}
StepEvent::Passed(_output) => {
self.steps.passed += 1;

self.writeln_cmt(
&format!("✔ {}", msg),
&cmt,
Expand All @@ -265,8 +239,6 @@ impl BasicOutput {
self.print_step_extras(&*step);
}
StepEvent::Failed(StepFailureKind::Panic(output, panic_info)) => {
self.steps.failed += 1;

self.writeln_cmt(
&format!("✘ {}", msg),
&cmt,
Expand Down Expand Up @@ -344,8 +316,6 @@ impl BasicOutput {
);
}
StepEvent::Failed(StepFailureKind::TimedOut) => {
self.steps.timed_out += 1;

self.writeln_cmt(
&format!("✘ {}", msg),
&cmt,
Expand All @@ -371,14 +341,13 @@ impl BasicOutput {

fn handle_scenario(
&mut self,
feature: Rc<Feature>,
rule: Option<Rc<Rule>>,
scenario: Rc<Scenario>,
event: ScenarioEvent,
feature: &Rc<Feature>,
rule: Option<&Rc<Rule>>,
scenario: &Rc<Scenario>,
event: &ScenarioEvent,
) {
match event {
ScenarioEvent::Starting(example_values) => {
self.scenarios.total += 1;
let cmt = self.file_line_col(feature.path.as_ref(), scenario.position);
let text = if example_values.is_empty() {
format!("Scenario: {} ", &scenario.name)
Expand All @@ -398,88 +367,62 @@ impl BasicOutput {
ScenarioEvent::Step(step, event) => {
self.handle_step(feature, rule, scenario, step, event, false)
}
ScenarioEvent::Skipped => {
self.scenarios.skipped += 1;
}
ScenarioEvent::Passed => {
self.scenarios.passed += 1;
}
ScenarioEvent::Failed(FailureKind::Panic) => {
self.scenarios.failed += 1;
}
ScenarioEvent::Failed(FailureKind::TimedOut) => self.scenarios.timed_out += 1,
_ => {}
}
}

fn handle_rule(&mut self, feature: Rc<Feature>, rule: Rc<Rule>, event: RuleEvent) {
match event {
RuleEvent::Starting => {
self.rules.total += 1;

let cmt = self.file_line_col(feature.path.as_ref(), rule.position);
self.writeln_cmt(
&format!("Rule: {}", &rule.name),
&cmt,
" ",
termcolor::Color::White,
true,
);
}
RuleEvent::Scenario(scenario, event) => {
self.handle_scenario(feature, Some(rule), scenario, event)
}
RuleEvent::Skipped => {
self.rules.skipped += 1;
}
RuleEvent::Passed => {
self.rules.passed += 1;
}
RuleEvent::Failed(FailureKind::Panic) => {
self.rules.failed += 1;
}
RuleEvent::Failed(FailureKind::TimedOut) => {
self.rules.timed_out += 1;
}
fn handle_rule(&mut self, feature: &Rc<Feature>, rule: &Rc<Rule>, event: &RuleEvent) {
if let RuleEvent::Scenario(scenario, evt) = event {
self.handle_scenario(feature, Some(rule), scenario, evt)
} else if *event == RuleEvent::Starting {
let cmt = self.file_line_col(feature.path.as_ref(), rule.position);
self.writeln_cmt(
&format!("Rule: {}", &rule.name),
&cmt,
" ",
termcolor::Color::White,
true,
);
}
}

fn print_counter(&self, name: &str, counter: &Counter) {
fn print_counter(&self, name: &str, stats: &Stats) {
use termcolor::Color::*;

cprint!(bold White, "{} {} (", counter.total, name);
cprint!(bold White, "{} {} (", stats.total, name);

if counter.failed > 0 {
cprint!(bold Red, "{} failed", counter.failed);
if stats.failed > 0 {
cprint!(bold Red, "{} failed", stats.failed);
}

if counter.skipped > 0 {
if counter.failed > 0 {
if stats.skipped > 0 {
if stats.failed > 0 {
cprint!(bold White, ", ");
}
cprint!(bold Cyan, "{} skipped", counter.skipped);
cprint!(bold Cyan, "{} skipped", stats.skipped);
}

if counter.failed > 0 || counter.skipped > 0 {
if stats.failed > 0 || stats.skipped > 0 {
cprint!(bold White, ", ");
}

cprint!(bold Green, "{} passed", counter.passed);
cprint!(bold Green, "{} passed", stats.passed);
cprintln!(bold White, ")");
}

fn print_finish(&self) {
fn print_finish(&self, result: &RunResult) {
use termcolor::Color::*;

cprintln!(bold Blue, "[Summary]");
cprintln!(bold White, "{} features", self.features.total);
cprintln!(bold White, "{} features", result.features.total);

self.print_counter("scenarios", &self.scenarios);
if self.rules.total > 0 {
self.print_counter("rules", &self.rules);
self.print_counter("scenarios", &result.scenarios);
if result.rules.total > 0 {
self.print_counter("rules", &result.rules);
}
self.print_counter("steps", &self.steps);
self.print_counter("steps", &result.steps);

let t = self.started.elapsed();
let t = result.elapsed;
println!(
"\nFinished in {}.{} seconds.",
t.as_secs(),
Expand All @@ -489,16 +432,14 @@ impl BasicOutput {
}

impl EventHandler for BasicOutput {
fn handle_event(&mut self, event: CucumberEvent) {
fn handle_event(&mut self, event: &CucumberEvent) {
match event {
CucumberEvent::Starting => {
self.started = std::time::Instant::now();
cprintln!(bold termcolor::Color::Blue, "[Cucumber v{}]", env!("CARGO_PKG_VERSION"))
}
CucumberEvent::Finished => self.print_finish(),
CucumberEvent::Finished(ref r) => self.print_finish(r),
CucumberEvent::Feature(feature, event) => match event {
crate::event::FeatureEvent::Starting => {
self.features.total += 1;
let msg = format!("Feature: {}", &feature.name);
let cmt = self.file_line_col(feature.path.as_ref(), feature.position);
self.pending_feature_print_info = Some((msg, cmt));
Expand Down
Loading