cli.rs.html -- source
Description: Source to the Rust file `src/libtest/cli.rs`.
Keywords: rust, rustlang, rust-lang

      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

    //! Module converting command-line arguments into test configuration.

    use std::env;
    use std::path::PathBuf;

    use super::helpers::isatty;
    use super::options::{ColorConfig, Options, OutputFormat, RunIgnored};
    use super::time::TestTimeOptions;

    #[derive(Debug)]
    pub struct TestOpts {
        pub list: bool,
        pub filter: Option<String>,
        pub filter_exact: bool,
        pub force_run_in_process: bool,
        pub exclude_should_panic: bool,
        pub run_ignored: RunIgnored,
        pub run_tests: bool,
        pub bench_benchmarks: bool,
        pub logfile: Option<PathBuf>,
        pub nocapture: bool,
        pub color: ColorConfig,
        pub format: OutputFormat,
        pub test_threads: Option<usize>,
        pub skip: Vec<String>,
        pub time_options: Option<TestTimeOptions>,
        pub options: Options,
    }

    impl TestOpts {
        pub fn use_color(&self) -> bool {
            match self.color {
                ColorConfig::AutoColor => !self.nocapture && isatty::stdout_isatty(),
                ColorConfig::AlwaysColor => true,
                ColorConfig::NeverColor => false,
            }
        }
    }

    /// Result of parsing the options.
    pub type OptRes = Result<TestOpts, String>;
    /// Result of parsing the option part.
    type OptPartRes<T> = Result<T, String>;

    fn optgroups() -> getopts::Options {
        let mut opts = getopts::Options::new();
        opts.optflag("", "include-ignored", "Run ignored and not ignored tests")
            .optflag("", "ignored", "Run only ignored tests")
            .optflag("", "force-run-in-process", "Forces tests to run in-process when panic=abort")
            .optflag("", "exclude-should-panic", "Excludes tests marked as should_panic")
            .optflag("", "test", "Run tests and not benchmarks")
            .optflag("", "bench", "Run benchmarks instead of tests")
            .optflag("", "list", "List all tests and benchmarks")
            .optflag("h", "help", "Display this message (longer with --help)")
            .optopt(
                "",
                "logfile",
                "Write logs to the specified file instead \
                 of stdout",
                "PATH",
            )
            .optflag(
                "",
                "nocapture",
                "don't capture stdout/stderr of each \
                 task, allow printing directly",
            )
            .optopt(
                "",
                "test-threads",
                "Number of threads used for running tests \
                 in parallel",
                "n_threads",
            )
            .optmulti(
                "",
                "skip",
                "Skip tests whose names contain FILTER (this flag can \
                 be used multiple times)",
                "FILTER",
            )
            .optflag(
                "q",
                "quiet",
                "Display one character per test instead of one line. \
                 Alias to --format=terse",
            )
            .optflag("", "exact", "Exactly match filters rather than by substring")
            .optopt(
                "",
                "color",
                "Configure coloring of output:
                auto   = colorize if stdout is a tty and tests are run on serially (default);
                always = always colorize output;
                never  = never colorize output;",
                "auto|always|never",
            )
            .optopt(
                "",
                "format",
                "Configure formatting of output:
                pretty = Print verbose output;
                terse  = Display one character per test;
                json   = Output a json document",
                "pretty|terse|json",
            )
            .optflag("", "show-output", "Show captured stdout of successful tests")
            .optopt(
                "Z",
                "",
                "Enable nightly-only flags:
                unstable-options = Allow use of experimental features",
                "unstable-options",
            )
            .optflagopt(
                "",
                "report-time",
                "Show execution time of each test. Awailable values:
                plain   = do not colorize the execution time (default);
                colored = colorize output according to the `color` parameter value;

                Threshold values for colorized output can be configured via
                `RUST_TEST_TIME_UNIT`, `RUST_TEST_TIME_INTEGRATION` and
                `RUST_TEST_TIME_DOCTEST` environment variables.

                Expected format of environment variable is `VARIABLE=WARN_TIME,CRITICAL_TIME`.
                Durations must be specified in milliseconds, e.g. `500,2000` means that the warn time
                is 0.5 seconds, and the critical time is 2 seconds.

                Not available for --format=terse",
                "plain|colored",
            )
            .optflag(
                "",
                "ensure-time",
                "Treat excess of the test execution time limit as error.

                Threshold values for this option can be configured via
                `RUST_TEST_TIME_UNIT`, `RUST_TEST_TIME_INTEGRATION` and
                `RUST_TEST_TIME_DOCTEST` environment variables.

                Expected format of environment variable is `VARIABLE=WARN_TIME,CRITICAL_TIME`.

                `CRITICAL_TIME` here means the limit that should not be exceeded by test.
                ",
            );
        opts
    }

    fn usage(binary: &str, options: &getopts::Options) {
        let message = format!("Usage: {} [OPTIONS] [FILTER]", binary);
        println!(
            r#"{usage}

    The FILTER string is tested against the name of all tests, and only those
    tests whose names contain the filter are run.

    By default, all tests are run in parallel. This can be altered with the
    --test-threads flag or the RUST_TEST_THREADS environment variable when running
    tests (set it to 1).

    All tests have their standard output and standard error captured by default.
    This can be overridden with the --nocapture flag or setting RUST_TEST_NOCAPTURE
    environment variable to a value other than "0". Logging is not captured by default.

    Test Attributes:

        `#[test]`        - Indicates a function is a test to be run. This function
                           takes no arguments.
        `#[bench]`       - Indicates a function is a benchmark to be run. This
                           function takes one argument (test::Bencher).
        `#[should_panic]` - This function (also labeled with `#[test]`) will only pass if
                            the code causes a panic (an assertion failure or panic!)
                            A message may be provided, which the failure string must
                            contain: #[should_panic(expected = "foo")].
        `#[ignore]`       - When applied to a function which is already attributed as a
                            test, then the test runner will ignore these tests during
                            normal test runs. Running with --ignored or --include-ignored will run
                            these tests."#,
            usage = options.usage(&message)
        );
    }

    /// Parses command line arguments into test options.
    /// Returns `None` if help was requested (since we only show help message and don't run tests),
    /// returns `Some(Err(..))` if provided arguments are incorrect,
    /// otherwise creates a `TestOpts` object and returns it.
    pub fn parse_opts(args: &[String]) -> Option<OptRes> {
        // Parse matches.
        let opts = optgroups();
        let args = args.get(1..).unwrap_or(args);
        let matches = match opts.parse(args) {
            Ok(m) => m,
            Err(f) => return Some(Err(f.to_string())),
        };

        // Check if help was requested.
        if matches.opt_present("h") {
            // Show help and do nothing more.
            usage(&args[0], &opts);
            return None;
        }

        // Actually parse the opts.
        let opts_result = parse_opts_impl(matches);

        Some(opts_result)
    }

    // Gets the option value and checks if unstable features are enabled.
    macro_rules! unstable_optflag {
        ($matches:ident, $allow_unstable:ident, $option_name:literal) => {{
            let opt = $matches.opt_present($option_name);
            if !$allow_unstable && opt {
                return Err(format!(
                    "The \"{}\" flag is only accepted on the nightly compiler with -Z unstable-options",
                    $option_name
                ));
            }

            opt
        }};
    }

    // Implementation of `parse_opts` that doesn't care about help message
    // and returns a `Result`.
    fn parse_opts_impl(matches: getopts::Matches) -> OptRes {
        let allow_unstable = get_allow_unstable(&matches)?;

        // Unstable flags
        let force_run_in_process = unstable_optflag!(matches, allow_unstable, "force-run-in-process");
        let exclude_should_panic = unstable_optflag!(matches, allow_unstable, "exclude-should-panic");
        let include_ignored = unstable_optflag!(matches, allow_unstable, "include-ignored");
        let time_options = get_time_options(&matches, allow_unstable)?;

        let quiet = matches.opt_present("quiet");
        let exact = matches.opt_present("exact");
        let list = matches.opt_present("list");
        let skip = matches.opt_strs("skip");

        let bench_benchmarks = matches.opt_present("bench");
        let run_tests = !bench_benchmarks || matches.opt_present("test");

        let logfile = get_log_file(&matches)?;
        let run_ignored = get_run_ignored(&matches, include_ignored)?;
        let filter = get_filter(&matches)?;
        let nocapture = get_nocapture(&matches)?;
        let test_threads = get_test_threads(&matches)?;
        let color = get_color_config(&matches)?;
        let format = get_format(&matches, quiet, allow_unstable)?;

        let options = Options::new().display_output(matches.opt_present("show-output"));

        let test_opts = TestOpts {
            list,
            filter,
            filter_exact: exact,
            force_run_in_process,
            exclude_should_panic,
            run_ignored,
            run_tests,
            bench_benchmarks,
            logfile,
            nocapture,
            color,
            format,
            test_threads,
            skip,
            time_options,
            options,
        };

        Ok(test_opts)
    }

    // FIXME: Copied from librustc_ast until linkage errors are resolved. Issue #47566
    fn is_nightly() -> bool {
        // Whether this is a feature-staged build, i.e., on the beta or stable channel
        let disable_unstable_features = option_env!("CFG_DISABLE_UNSTABLE_FEATURES").is_some();
        // Whether we should enable unstable features for bootstrapping
        let bootstrap = env::var("RUSTC_BOOTSTRAP").is_ok();

        bootstrap || !disable_unstable_features
    }

    // Gets the CLI options associated with `report-time` feature.
    fn get_time_options(
        matches: &getopts::Matches,
        allow_unstable: bool,
    ) -> OptPartRes<Option<TestTimeOptions>> {
        let report_time = unstable_optflag!(matches, allow_unstable, "report-time");
        let colored_opt_str = matches.opt_str("report-time");
        let mut report_time_colored = report_time && colored_opt_str == Some("colored".into());
        let ensure_test_time = unstable_optflag!(matches, allow_unstable, "ensure-time");

        // If `ensure-test-time` option is provided, time output is enforced,
        // so user won't be confused if any of tests will silently fail.
        let options = if report_time || ensure_test_time {
            if ensure_test_time && !report_time {
                report_time_colored = true;
            }
            Some(TestTimeOptions::new_from_env(ensure_test_time, report_time_colored))
        } else {
            None
        };

        Ok(options)
    }

    fn get_test_threads(matches: &getopts::Matches) -> OptPartRes<Option<usize>> {
        let test_threads = match matches.opt_str("test-threads") {
            Some(n_str) => match n_str.parse::<usize>() {
                Ok(0) => return Err("argument for --test-threads must not be 0".to_string()),
                Ok(n) => Some(n),
                Err(e) => {
                    return Err(format!(
                        "argument for --test-threads must be a number > 0 \
                         (error: {})",
                        e
                    ));
                }
            },
            None => None,
        };

        Ok(test_threads)
    }

    fn get_format(
        matches: &getopts::Matches,
        quiet: bool,
        allow_unstable: bool,
    ) -> OptPartRes<OutputFormat> {
        let format = match matches.opt_str("format").as_ref().map(|s| &**s) {
            None if quiet => OutputFormat::Terse,
            Some("pretty") | None => OutputFormat::Pretty,
            Some("terse") => OutputFormat::Terse,
            Some("json") => {
                if !allow_unstable {
                    return Err("The \"json\" format is only accepted on the nightly compiler".into());
                }
                OutputFormat::Json
            }

            Some(v) => {
                return Err(format!(
                    "argument for --format must be pretty, terse, or json (was \
                     {})",
                    v
                ));
            }
        };

        Ok(format)
    }

    fn get_color_config(matches: &getopts::Matches) -> OptPartRes<ColorConfig> {
        let color = match matches.opt_str("color").as_ref().map(|s| &**s) {
            Some("auto") | None => ColorConfig::AutoColor,
            Some("always") => ColorConfig::AlwaysColor,
            Some("never") => ColorConfig::NeverColor,

            Some(v) => {
                return Err(format!(
                    "argument for --color must be auto, always, or never (was \
                     {})",
                    v
                ));
            }
        };

        Ok(color)
    }

    fn get_nocapture(matches: &getopts::Matches) -> OptPartRes<bool> {
        let mut nocapture = matches.opt_present("nocapture");
        if !nocapture {
            nocapture = match env::var("RUST_TEST_NOCAPTURE") {
                Ok(val) => &val != "0",
                Err(_) => false,
            };
        }

        Ok(nocapture)
    }

    fn get_run_ignored(matches: &getopts::Matches, include_ignored: bool) -> OptPartRes<RunIgnored> {
        let run_ignored = match (include_ignored, matches.opt_present("ignored")) {
            (true, true) => {
                return Err("the options --include-ignored and --ignored are mutually exclusive".into());
            }
            (true, false) => RunIgnored::Yes,
            (false, true) => RunIgnored::Only,
            (false, false) => RunIgnored::No,
        };

        Ok(run_ignored)
    }

    fn get_filter(matches: &getopts::Matches) -> OptPartRes<Option<String>> {
        let filter = if !matches.free.is_empty() { Some(matches.free[0].clone()) } else { None };

        Ok(filter)
    }

    fn get_allow_unstable(matches: &getopts::Matches) -> OptPartRes<bool> {
        let mut allow_unstable = false;

        if let Some(opt) = matches.opt_str("Z") {
            if !is_nightly() {
                return Err("the option `Z` is only accepted on the nightly compiler".into());
            }

            match &*opt {
                "unstable-options" => {
                    allow_unstable = true;
                }
                _ => {
                    return Err("Unrecognized option to `Z`".into());
                }
            }
        };

        Ok(allow_unstable)
    }

    fn get_log_file(matches: &getopts::Matches) -> OptPartRes<Option<PathBuf>> {
        let logfile = matches.opt_str("logfile").map(|s| PathBuf::from(&s));

        Ok(logfile)
    }