FuelLabs/sway

E2E test CLI flag/doc SWAY_TEST_VERBOSE inconsistency

Open

#3174 opened on Oct 27, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
P: lowgood first issuetesting

Description

Take the following sets of commands:

export SWAY_TEST_VERBOSE=1
cargo run --bin test

Now produces:

error: '1' isn't a valid value for '--verbose'
  [possible values: true, false]
When setting the env var `SWAY_TEST_VERBOSE=1` and running `cargo run --bin test`

Which is a breaking but reasonable change from the previous behavior.

The main issue is that the help text still documents the previous value (=1):

Usage: test [OPTIONS] [REGEX]

Arguments:
  [REGEX]  Only run tests matching this regex

Options:
  -e, --exclude <REGEX>     Exclude tests matching this regex
  -s, --skip-until <REGEX>  Skip all tests until a test matches this regex
      --abi-only            Only run tests with ABI JSON output validation [aliases: abi]
      --contract-only       Only run tests that deploy contracts [aliases: contract]
      --first-only          Only run the first test [aliases: first]
      --verbose             Print out warnings and errors [env: SWAY_TEST_VERBOSE=1]
      --locked              Intended for use in `CI` to ensure test lock files are up to date
  -h, --help                Print help information

Contributor guide

Tech stack
rust
Domain
clidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue is about the help text for the ` verbose` flag showing `SWAY TEST VERBOSE=1` but the accepted values are now boolean (true/false). Locate the CLI argument definition, likely in a file using clap (e.g., in `src/cli/` or similar). Update the help string from `env: SWAY TEST VERBOSE=1` to `env: SWAY TEST VERBOSE=true/false`. Verify that the error message is consistent. No linked PRs or assignees; the issue is open and uncontested.