devcontainers / devcontainers/cli

[Features][test-lib] Add message arg to the check function

Ouverte
#1,010 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
TypeScript
Étoiles
3k
Forks
457
Merge moyen
13 h 17 min
PR mergées (30 j)
6

Description

I would like to propose a change to the check function of the dev-container-features-test-lib script.

The function should take a message to display when the test fails, like other testing frameworks have.

The current function code is:
https://github.com/devcontainers/cli/blob/c246645f97fba402c3b1b95983e573e92bcec464/src/spec-node/featuresCLI/utils.ts#L75-L91

I propose to add a message on $2 or the last argument.
Any thoughts on this?

I would suggest something like this:
```bash
check() {
LABEL=$1
MESSAGE = $2 or ${!#}

#
# the rest of the function
#
}
```

The new function should work like the examples below, and be backwards compatible

```bash
old:
check "java version LTS installed as default" \
grep "LTS" <(java --version)

new:
check "java version LTS installed as default" \
grep "LTS" <(java --version) \
"REASON: The installed version is: $(java --version)"

or

check "java version LTS installed as default" \
"REASON: The installed version is: $(java --version)" \
grep "LTS" <(java --version)
```

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par src/spec-node/featuresCLI/utils.ts#L75-L91 et examinez comment la fonction check est appelée par les tests de fonctionnalités existants. Définissez comment le message facultatif est distingué des arguments de la commande, préservez la forme d’appel actuelle et vérifiez que les vérifications échouées affichent le message fourni.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
shell, typescript
Domaine
testing-qa
Type d'issue
Fonctionnalité
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
50/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.