FuelLabs/sway

E2E test CLI flag/doc SWAY_TEST_VERBOSE inconsistency

Open

#3 174 ouverte le 27 oct. 2022

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Rust (5 421 forks)batch import
P: lowgood first issuetesting

Métriques du dépôt

Stars
 (61 702 stars)
Métriques de merge PR
 (Merge moyen 22h 6m) (16 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Le problème concerne le texte d'aide pour le drapeau ` verbose` qui affiche `SWAY TEST VERBOSE=1`, mais les valeurs acceptées sont maintenant booléennes (true/false). Localisez la définition de l'argument CLI, probablement dans un fichier utilisant clap (par exemple dans `src/cli/` ou similaire). Mettez à jour la chaîne d'aide de `env: SWAY TEST VERBOSE=1` à `env: SWAY TEST VERBOSE=true/false`. Vérifiez que le message d'erreur est cohérent. Aucune PR liée ou assigné ; le problème est ouvert et non contesté.
Stack technique
rust
Domaine
clitesting
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90