Ligne de commande
Traduit automatiquement de l’anglais.
Lire en anglaisLe package proxymail-qa a une commande, depuis la version 0.13.0. Utilisez-la dans un terminal pendant vos tests manuels, dans des scripts npm, dans une configuration d’exécution JetBrains ou VS Code, ou dans une étape CI. Elle fonctionne avec Node 18 ou ultérieur et ne demande aucune installation en dehors de npx.
Définir la clé d’API
Section intitulée « Définir la clé d’API »Créez une clé d’API et définissez-la comme
PROXYMAIL_QA_API_KEY. La commande lit la clé uniquement depuis l’environnement, jamais depuis une option, pour qu’elle reste hors de l’historique de votre shell.export PROXYMAIL_QA_API_KEY=qa_...Créer une adresse de test
Section intitulée « Créer une adresse de test »Dans un terminal, elle affiche l’adresse, le mot de passe, ainsi que le nom, le nom d’utilisateur, la date de naissance et le pays du persona, prêts à saisir dans le formulaire d’inscription. Le mot de passe est enregistré sur l’adresse et affiché cette seule fois.
npx proxymail-qa new --password --country JPAttendez le code ou le lien
Section intitulée « Attendez le code ou le lien »Inscrivez-vous avec l’adresse, puis :
Une attente dure 30 secondes, sauf si vous indiquez
--timeout. Si rien n’arrive, elle explique pourquoi, autant que Proxy Mail QA peut le savoir, et se termine avec le code 1.npx proxymail-qa wait-code k7f2@mailclub.devnpx proxymail-qa wait-link k7f2@mailclub.dev --type reset
Commandes
Section intitulée « Commandes »| Commande | Ce qu’il fait |
|---|---|
new |
Crée une adresse de test avec un persona. --password, --country, --age ou --dob, --one-name, --label, --site, --environment, --days, --no-persona |
wait-code <address> |
Attend un code de connexion. --type coupon pour un coupon, --since, --service, --unused, --timeout |
wait-link <address> |
Attend un lien. --type verify, reset, magic_signin ou invite (plusieurs, séparés par des virgules), --app pour le lien qui ouvre une app mobile |
persona <address> |
Affiche le persona de l’adresse |
form-values <file> |
Quoi saisir dans chaque champ d’un formulaire : voir ci-dessous |
npx proxymail-qa help <command> liste les options d’une commande. Ajoutez --json à n’importe quelle commande pour obtenir la réponse complète en JSON.
Dans les scripts et CI
Section intitulée « Dans les scripts et CI »Quand sa sortie va vers un pipe ou une variable, une commande n’affiche que la valeur : l’adresse, le code ou le lien. new --password affiche l’adresse, puis le mot de passe sur une deuxième ligne.
ADDRESS=$(npx proxymail-qa new --site staging.example.com --environment staging)# …sign up with $ADDRESS…CODE=$(npx proxymail-qa wait-code "$ADDRESS" --timeout 60)Le mot de passe est affiché pour qu’un script puisse l’utiliser : gardez-le dans une variable et ne l’affichez pas dans un journal CI. Dans une exécution (PROXYMAIL_QA_RUN, que l’Action GitHub définit), chaque appel est ajouté au rapport de l’exécution.
Sous forme de scripts npm, pour que l’équipe lance les mêmes commandes :
{ "scripts": { "inbox": "proxymail-qa new --password --site localhost:3000 --environment local", "code": "proxymail-qa wait-code" }}npm run inbox, puis npm run code -- k7f2@mailclub.dev. Dans les IDE JetBrains, ajoutez une configuration d’exécution de type npm pour chaque script, ou une configuration Shell Script qui lance npx proxymail-qa new.
Valeurs de formulaire
Section intitulée « Valeurs de formulaire »form-values prend un fichier JSON qui liste les champs d’un formulaire, et répond avec quoi saisir dans chacun, à partir d’une nouvelle adresse ou d’une adresse que vous indiquez avec --address. Il remplit les champs personnalisés du projet et les noms, dates et mots de passe qu’un formulaire demande, comme le fait formValues du client Node.js.
{ "fields": [ { "id": "email", "type": "email", "label": "Email" }, { "id": "name", "label": "Full name" }, { "id": "team", "type": "select", "label": "Team size", "options": [{ "value": "1-10" }, { "value": "11-50" }] } ], "page": "/signup"}npx proxymail-qa form-values signup-form.json --site staging.example.com --country PKIl affiche JSON : l’adresse, le persona, le mot de passe s’il en a été créé un, et une valeur par champ. Les options de la ligne de commande l’emportent sur les mêmes options du fichier. Utilisez - au lieu d’un nom de fichier pour lire les champs depuis l’entrée standard.
Codes de sortie
Section intitulée « Codes de sortie »| Code | Signification |
|---|---|
| 0 | Terminé |
| 1 | API a refusé, ou rien n’est arrivé à temps. La raison figure sur la sortie d’erreur standard |
| 2 | La commande était incorrecte, ou PROXYMAIL_QA_API_KEY n’est pas défini |
Une question sur cette page ?
Posez votre question dans la langue de votre choix. La documentation peut y répondre tout de suite, ou vous pouvez l'envoyer à l'équipe Proxy Mail QA, qui répond en anglais.