Restore old CLI options (#137)

Co-authored-by: tyranron <tyranron@gmail.com>

Author: ilslv

CHANGELOG.md

@@ -21,13 +21,15 @@ All user visible changes to `cucumber` crate will be documented in this file. Th
 - Replaced `#[given(step)]`, `#[when(step)]` and `#[then(step)]` function argument attributes with a single `#[step]`. ([#128])
 - Made test callbacks first argument `&mut World` instead of `World`. ([#128])
 - Made `#[step]` argument of step functions `Step` instead of `StepContext` again, while test callbacks still receive `StepContext` as a second parameter. ([#128])
-- CLI and [hooks](https://cucumber.io/docs/cucumber/api/#hooks) were removed, but are planned to be re-implemented with some changes in `0.11` release. ([#128])
+- Deprecated `--nocapture` and `--debug` CLI options to be completely redesigned in `0.11` release. ([#137])
+- [Hooks](https://cucumber.io/docs/cucumber/api/#hooks) were removed, but are planned to be re-implemented with some changes in `0.11` release. ([#128])
 
 ### Added
 
 - Ability to run `Scenario`s concurrently. ([#128])
 
 [#128]: /../../pull/128
+[#137]: /../../pull/137
 
 
 

Cargo.toml

@@ -31,6 +31,7 @@ macros = ["cucumber-codegen", "inventory"]
 [dependencies]
 async-trait = "0.1.40"
 atty = "0.2.14"
+clap = "3.0.0-beta.4"
 console = "0.14.1"
 derive_more = { version = "0.99.16", features = ["deref", "display", "error", "from"], default_features = false }
 either = "1.6"

src/cli.rs

@@ -0,0 +1,39 @@
+// Copyright (c) 2018-2021  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.
+
+//! CLI options.
+
+use clap::Clap;
+use regex::Regex;
+
+/// Run the tests, pet a dog!.
+///
+/// __WARNING__ ⚠️: This CLI exists only for backwards compatibility. In `0.11`
+///                 it will be completely reworked:
+///                 [cucumber-rs/cucumber#134][1].
+///
+/// [1]: https://github.com/cucumber-rs/cucumber/issues/134
+#[derive(Clap, Debug)]
+pub struct Opts {
+    /// Regex to select scenarios from.
+    #[clap(short = 'e', long = "expression", name = "regex")]
+    pub filter: Option<Regex>,
+
+    /// __WARNING__ ⚠️: This option does nothing at the moment and is deprecated
+    ///                 for removal in the next major release.
+    ///                 Any output of step functions is not captured by default.
+    #[clap(long)]
+    pub nocapture: bool,
+
+    /// __WARNING__ ⚠️: This option does nothing at the moment and is deprecated
+    ///                 for removal in the next major release.
+    #[clap(long)]
+    pub debug: bool,
+}

src/cucumber.rs

@@ -20,11 +20,12 @@ use std::{
     path::Path,
 };
 
+use clap::Clap as _;
 use futures::StreamExt as _;
 use regex::Regex;
 
 use crate::{
-    event, parser, runner, step, writer, ArbitraryWriter, FailureWriter,
+    cli, event, parser, runner, step, writer, ArbitraryWriter, FailureWriter,
     Parser, Runner, ScenarioType, Step, World, Writer, WriterExt as _,
 };
 
@@ -610,19 +611,7 @@ where
     ///
     /// [`Feature`]: gherkin::Feature
     pub async fn run(self, input: I) -> Wr {
-        let Cucumber {
-            parser,
-            runner,
-            mut writer,
-            ..
-        } = self;
-
-        let events_stream = runner.run(parser.parse(input));
-        futures::pin_mut!(events_stream);
-        while let Some(ev) = events_stream.next().await {
-            writer.handle_event(ev).await;
-        }
-        writer
+        self.filter_run(input, |_, _, _| true).await
     }
 
     /// Runs [`Cucumber`] with [`Scenario`]s filter.
@@ -684,6 +673,7 @@ where
     ///
     /// [`Feature`]: gherkin::Feature
     /// [`Scenario`]: gherkin::Scenario
+    #[allow(clippy::non_ascii_literal)]
     pub async fn filter_run<F>(self, input: I, filter: F) -> Wr
     where
         F: Fn(
@@ -693,6 +683,29 @@ where
             ) -> bool
             + 'static,
     {
+        let opts = cli::Opts::parse();
+        if opts.nocapture {
+            eprintln!(
+                "WARNING ⚠️: This option does nothing at the moment and is \
+                             deprecated for removal in the next major release. \
+                             Any output of step functions is not captured by \
+                             default.",
+            );
+        }
+        if opts.debug {
+            eprintln!(
+                "WARNING ⚠️: This option does nothing at the moment and is \
+                             deprecated for removal in the next major release.",
+            );
+        }
+        let filter = move |f: &gherkin::Feature,
+                           r: Option<&gherkin::Rule>,
+                           s: &gherkin::Scenario| {
+            opts.filter
+                .as_ref()
+                .map_or_else(|| filter(f, r, s), |f| f.is_match(&s.name))
+        };
+
         let Cucumber {
             parser,
             runner,

src/lib.rs

@@ -31,6 +31,7 @@
 )]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 
+pub mod cli;
 mod cucumber;
 pub mod event;
 pub mod feature;