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
// 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.
//! Tools for composing CLI options.
//!
//! The main thing in this module is [`Opts`], which compose all the strongly
//! typed CLI options from [`Parser`], [`Runner`] and [`Writer`], and provide
//! filtering based on [`Regex`] or [tag expressions][1].
//!
//! The idea behind this is that [`Parser`], [`Runner`] and/or [`Writer`] may
//! want to introduce their own CLI options to allow tweaking themselves, but we
//! still do want them combine in a single CLI and avoid any boilerplate burden.
//!
//! If the implementation doesn't need any CLI options, it may just use the
//! prepared [`cli::Empty`] stub.
//!
//! [`cli::Empty`]: self::Empty
//! [`Parser`]: crate::Parser
//! [`Runner`]: crate::Runner
//! [`Writer`]: crate::Writer
//! [1]: https://cucumber.io/docs/cucumber/api#tag-expressions
use gherkin::tagexpr::TagOperation;
use regex::Regex;
use crate::writer::Coloring;
pub use clap::{Args, Parser};
/// Root CLI (command line interface) of a top-level [`Cucumber`] executor.
///
/// It combines all the nested CLIs of [`Parser`], [`Runner`] and [`Writer`],
/// and may be extended with custom CLI options additionally.
///
/// # Example
///
/// ```rust
/// # use std::{convert::Infallible, time::Duration};
/// #
/// # use async_trait::async_trait;
/// # use cucumber::{cli, WorldInit};
/// # use futures::FutureExt as _;
/// # use tokio::time;
/// #
/// # #[derive(Debug, WorldInit)]
/// # struct MyWorld;
/// #
/// # #[async_trait(?Send)]
/// # impl cucumber::World for MyWorld {
/// # type Error = Infallible;
/// #
/// # async fn new() -> Result<Self, Self::Error> {
/// # Ok(Self)
/// # }
/// # }
/// #
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() {
/// #[derive(clap::Args)] // also re-exported as `cli::Args`
/// struct CustomOpts {
/// /// Additional time to wait in before hook.
/// #[clap(
/// long,
/// parse(try_from_str = humantime::parse_duration)
/// )]
/// pre_pause: Option<Duration>,
/// }
///
/// let opts = cli::Opts::<_, _, _, CustomOpts>::parsed();
/// let pre_pause = opts.custom.pre_pause.unwrap_or_default();
///
/// MyWorld::cucumber()
/// .before(move |_, _, _, _| time::sleep(pre_pause).boxed_local())
/// .with_cli(opts)
/// .run_and_exit("tests/features/readme")
/// .await;
/// # }
/// ```
///
/// [`Cucumber`]: crate::Cucumber
/// [`Parser`]: crate::Parser
/// [`Runner`]: crate::Runner
/// [`Writer`]: crate::Writer
#[derive(Debug, Clone, clap::Parser)]
#[clap(
name = "cucumber",
about = "Run the tests, pet a dog!",
long_about = "Run the tests, pet a dog!"
)]
pub struct Opts<Parser, Runner, Writer, Custom = Empty>
where
Parser: Args,
Runner: Args,
Writer: Args,
Custom: Args,
{
/// Regex to filter scenarios by their name.
#[clap(
short = 'n',
long = "name",
name = "regex",
visible_alias = "scenario-name"
)]
pub re_filter: Option<Regex>,
/// Tag expression to filter scenarios by.
///
/// Note: Tags from Feature, Rule and Scenario are merged together on
/// filtering, so be careful about conflicting tags on different levels.
#[clap(
short = 't',
long = "tags",
name = "tagexpr",
conflicts_with = "regex"
)]
pub tags_filter: Option<TagOperation>,
/// [`Parser`] CLI options.
///
/// [`Parser`]: crate::Parser
#[clap(flatten)]
pub parser: Parser,
/// [`Runner`] CLI options.
///
/// [`Runner`]: crate::Runner
#[clap(flatten)]
pub runner: Runner,
/// [`Writer`] CLI options.
///
/// [`Writer`]: crate::Writer
#[clap(flatten)]
pub writer: Writer,
/// Additional custom CLI options.
#[clap(flatten)]
pub custom: Custom,
}
impl<Parser, Runner, Writer, Custom> Opts<Parser, Runner, Writer, Custom>
where
Parser: Args,
Runner: Args,
Writer: Args,
Custom: Args,
{
/// Shortcut for [`clap::Parser::parse()`], which doesn't require the trait
/// being imported.
#[must_use]
pub fn parsed() -> Self {
<Self as clap::Parser>::parse()
}
}
/// Indication whether a [`Writer`] using CLI options supports colored output.
///
/// [`Writer`]: crate::Writer
pub trait Colored {
/// Returns [`Coloring`] indicating whether a [`Writer`] using CLI options
/// supports colored output or not.
///
/// [`Writer`]: crate::Writer
#[must_use]
fn coloring(&self) -> Coloring {
Coloring::Never
}
}
/// Empty CLI options.
#[derive(Args, Clone, Copy, Debug)]
pub struct Empty;
impl Colored for Empty {}
/// Composes two [`clap::Args`] derivers together.
///
/// # Example
///
/// This struct is especially useful, when implementing custom [`Writer`]
/// wrapping another one:
/// ```rust
/// # use async_trait::async_trait;
/// # use cucumber::{cli, event, parser, writer, Event, World, Writer};
/// #
/// struct CustomWriter<Wr>(Wr);
///
/// #[derive(cli::Args)] // re-export of `clap::Args`
/// struct Cli {
/// #[clap(long)]
/// custom_option: Option<String>,
/// }
///
/// #[async_trait(?Send)]
/// impl<W, Wr> Writer<W> for CustomWriter<Wr>
/// where
/// W: World,
/// Wr: Writer<W>,
/// {
/// type Cli = cli::Compose<Cli, Wr::Cli>;
///
/// async fn handle_event(
/// &mut self,
/// ev: parser::Result<Event<event::Cucumber<W>>>,
/// cli: &Self::Cli,
/// ) {
/// // Some custom logic including `cli.left.custom_option`.
/// // ...
/// self.0.handle_event(ev, &cli.right).await;
/// }
/// }
///
/// // Useful blanket impls:
///
/// impl cli::Colored for Cli {}
///
/// #[async_trait(?Send)]
/// impl<'val, W, Wr, Val> writer::Arbitrary<'val, W, Val> for CustomWriter<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.0.write(val).await;
/// }
/// }
///
/// impl<W, Wr> writer::Failure<W> for CustomWriter<Wr>
/// where
/// W: World,
/// Self: Writer<W>,
/// Wr: writer::Failure<W>,
/// {
/// fn failed_steps(&self) -> usize {
/// self.0.failed_steps()
/// }
///
/// fn parsing_errors(&self) -> usize {
/// self.0.parsing_errors()
/// }
///
/// fn hook_errors(&self) -> usize {
/// self.0.hook_errors()
/// }
/// }
///
/// impl<Wr: writer::Normalized> writer::Normalized for CustomWriter<Wr> {}
///
/// impl<Wr: writer::NonTransforming> writer::NonTransforming
/// for CustomWriter<Wr>
/// {}
/// ```
///
/// [`Writer`]: crate::Writer
#[derive(Args, Debug)]
pub struct Compose<L: Args, R: Args> {
/// Left [`clap::Args`] deriver.
#[clap(flatten)]
pub left: L,
/// Right [`clap::Args`] deriver.
#[clap(flatten)]
pub right: R,
}
impl<L: Args, R: Args> Compose<L, R> {
/// Unpacks this [`Compose`] into the underlying CLIs.
#[must_use]
pub fn into_inner(self) -> (L, R) {
let Compose { left, right } = self;
(left, right)
}
}
impl<L, R> Colored for Compose<L, R>
where
L: Args + Colored,
R: Args + Colored,
{
fn coloring(&self) -> Coloring {
// Basically, founds "maximum" `Coloring` of CLI options.
match (self.left.coloring(), self.right.coloring()) {
(Coloring::Always, _) | (_, Coloring::Always) => Coloring::Always,
(Coloring::Auto, _) | (_, Coloring::Auto) => Coloring::Auto,
(Coloring::Never, Coloring::Never) => Coloring::Never,
}
}
}