plainbox-run – En ligne dans le Cloud

PROGRAMME:

Nom

plainbox-run - exécuter une tâche de test

SYNOPSIS

plainbox run [-h] [--non-interactive] [-n] [--dont-suppress-output]
[-f FORMAT] [-p OPTIONS] [-o FICHIER] [-t TRANSPORT]
[--transport-where OÙ] [--transport-options OPTIONS]
[-T TEST-PLAN-ID] [-i MOTIF] [-x MOTIF] [-w LISTE BLANCHE]

DESCRIPTION

Exécuter une tâche de test

Cette commande exécute zéro ou plusieurs tâches Plainbox dans le cadre d'une seule session et enregistre le
Résultats des tests. Plainbox suivra l'algorithme de haut niveau suivant lors de l'exécution.
de cette commande.

1. Analysez les arguments de la ligne de commande et vérifiez s'il existe une session qui peut être reprise (voir
REPRISE ci-dessous). Si tel est le cas, proposez à l'utilisateur de reprendre sa session. Si la reprise
Si l'opération échoue, passez à la séance de qualification suivante. Proposez enfin de créer une nouvelle session.
session.

2. Si la session est en cours de reprise, rejouez les effets de l'exécution de la session à partir du
l'état sur disque. Cela recrée les tâches générées et réintroduit les mêmes ressources dans
l'état de la session. Autrement dit, aucune tâche précédemment exécutée n'est réexécutée.

Si la session reprise était sur le point d'exécuter une tâche, proposez de l'ignorer.
permet aux opérateurs de test d'ignorer les tâches qui ont provoqué le plantage du système dans le passé
(par exemple, tests de suspension du système)

Si la session n'est pas reprise (une nouvelle session a été créée), définissez le incomplet
drapeau.

3. Utilisez la sélection de tâches (voir CHOIX OFFRES D'EMPLOIS (ci-dessous) pour obtenir la liste d'exécution. Cette étape
implique la résolution des dépendances entre les tâches et la réorganisation des tâches si nécessaire.

4. Suivez la liste d'exécution, en exécutant chaque tâche dans l'ordre si possible. Les tâches peuvent être bloquées.
à partir de l'exécution par des dépendances ayant échoué ou ayant échoué (évaluation d'un résultat non vrai)
expressions de ressources.

Si à tout moment un nouvel emploi est réintroduit dans le système (voir GÉNÉRÉ OFFRES D'EMPLOIS
(ci-dessous) puis la boucle est interrompue et le contrôle revient à l'étape 3 pour resélectionner les tâches.
Les résultats existants ne sont pas supprimés, donc les tâches qui ont déjà des résultats ne le sont pas.
exécuté à nouveau.

Avant et après l'exécution d'une tâche, l'état de la session est enregistré sur le disque pour permettre la reprise
d'un travail qui fait planter le système ou Plainbox lui-même.

5. Retirer le incomplet drapeau.

6. Exportez l'état de la session au format souhaité (voir EXPORTATION RÉSULTATS ) et utilise
le transport souhaité pour envoyer les résultats (voir TRANSPORT RÉSULTATS ).

7. Met le soumis drapeau.

CHOIX OFFRES D'EMPLOIS
Plainbox propose deux mécanismes de sélection de tâches. Ils peuvent être utilisés simultanément.
peut être utilisé plusieurs fois.

Sélection emplois avec motifs
Le premier mécanisme est exposé à travers le --include-motif RECONNAISSANCE option de ligne de commande.
Il demande à Plainbox de Sélectionner tout emploi dont l'identifiant entièrement qualifié correspond au
expression régulière RECONNAISSANCE.

Les tâches sélectionnées de cette manière seront, si possible, classées selon l'ordre de commande
arguments de ligne. Par exemple, la ligne de commande suivante exécuterait la tâche foo
avant d'exécuter le travail Bar:
plainbox exécuter -i '.*::foo' -i '.*::bar'

Sélection emplois avec listes blanches
Le deuxième mécanisme est le --liste blanche LISTE BLANCHE option de ligne de commande. Listes blanches (ou
Les listes blanches sont de simples fichiers texte.
composé d'une liste d'expressions régulières, identiques à celles qui peuvent être passées avec le
-i option.

Contrairement au -i Cependant, il existe deux types de listes blanches : les listes blanches autonomes
Non associé à un fournisseur Plainbox. Ces listes blanches peuvent être distribuées entièrement.
séparément de tout autre composant et n'ont donc aucune association avec un espace de noms.

Par conséquent, pour être pleinement qualifié, chaque modèle doit inclure à la fois l'espace de noms et le
Composants d'identification partiels. Par exemple, voici une liste blanche valide et entièrement qualifiée :

2013.com.canonical.plainbox::stub/.*

Il sélectionnera sans ambiguïté certains des travaux du fournisseur interne spécial StubBox
intégré à Plainbox. Il peut être enregistré sous n'importe quel nom de fichier et stocké dans n'importe quel emplacement.
répertoire et il sélectionnera toujours le même ensemble de tâches.

En revanche, les listes blanches associées à un fournisseur particulier, en étant stockées dans
le fournisseur par fournisseur listes blanches/ répertoire, comportent un espace de noms implicite. Ces listes blanches sont
généralement écrit sans mentionner le composant d'espace de noms.

Par exemple, le même modèle « stub/.* » peut être abrégé en :

bout/.*

En général, cette syntaxe est utilisée dans toutes les listes blanches spécifiques à un fournisseur particulier, sauf si
le mainteneur du fournisseur souhaite explicitement inclure un travail provenant d'un autre espace de noms (par
exemple, l'une des définitions de tâches Checkbox bien connues).

GÉNÉRÉ OFFRES D'EMPLOIS
Plainbox permet de générer des tâches à l'exécution. Deux raisons expliquent cette approche.
fonction.

Instanciation Tests pour Multiple Appareils
L'exemple classique est de sonder le matériel (par exemple, pour énumérer tous les espaces de stockage).
appareils) puis dupliquez chacun des tests spécifiques au magasin afin que tous les appareils soient
testé séparément.

À l'heure actuelle, les tâches ne peuvent être générées qu'à partir de tâches utilisant le type de plug-in locales. Emplois de
Ce type de tâche est censé imprimer des définitions de tâches entièrement conformes sur la sortie standard.
provoque quelques complexités et une limitation actuellement appliquée est celle générée
les tâches ne peuvent pas générer de tâches supplémentaires si l'une des tâches affectées doit s'exécuter comme une autre
utilisateur.

Une autre limitation est que les tâches ne peuvent pas remplacer les définitions existantes.

La création Parent-enfant Association
Une fonctionnalité relativement spécifique et héritée des travaux générés consiste à imprimer une copie textuelle de
définitions de tâches existantes à partir d'un locales définition de travail nommée d'après un thème de test générique ou
catégorie. Par exemple, la définition de tâche « Checkbox » __sans fil__ impressions, avec l'aide de
cat (1), toutes les définitions de tâches définies dans le fichier sans fil.txt.

Ce comportement est spécifique pour ne pas provoquer d'erreurs de redéfinition. Au lieu de cela,
les définitions gagnent le via attribut qui les relie à la tâche du générateur. Cette fonctionnalité est
Utilisé par des applications dérivées telles que Checkbox. Plainbox ne l'utilise pas actuellement.

REPRISE
Plainbox propose une fonctionnalité de reprise de session alors qu'une session qui a été interrompue
(volontairement ou en raison d'un dysfonctionnement) peut être repris et poursuivi efficacement
là où il s'était arrêté.

Lors de la reprise d'une session, vous pouvez avoir la possibilité de la réexécuter, de la réussir, de l'échouer ou de l'ignorer.
la tâche de test en cours d'exécution avant l'interruption de la session. Ceci est prévu
pour gérer les deux situations normales, comme un « test de redémarrage du système » où il est parfaitement
Il est possible de « réussir » le test sans relancer la commande. De plus, il peut être utilisé pour
gérer les cas anormaux où la machine se comporte mal et réexécuter le même test
faire en sorte que le problème se reproduise indéfiniment.

Limites
Cette fonctionnalité ne permet pas d'interrompre et de reprendre un travail de test déjà en cours.
exécuté. Ce travail sera redémarré depuis le début.

Plainbox essaie de garantir qu'une session unique est cohérente et que les hypothèses qui ont été retenues
au début de la session sont conservés à la fin. À cette fin, Plainbox s'efforcera
s'assurer que les définitions de tâches n'ont pas changé entre deux appels distincts qui ont fonctionné
avec une seule séance. Si une telle situation est détectée, la séance ne sera pas reprise.

EXPORTATION RÉSULTATS
Plainbox offre un moyen d'exporter l'état interne de la session dans un format plus utile
format pour un traitement ultérieur.

Sélection Exportateurs
L'exportateur peut être sélectionné à l'aide du --format de sortie Format option de ligne de commande. Une liste
des exportateurs disponibles (qui peuvent inclure des exportateurs tiers) peuvent être obtenus en passant
le --format de sortie ? option.

Certains formats sont plus utiles que d’autres dans la mesure où ils sont capables de transférer davantage de données.
l'état interne. Selon votre application, vous souhaiterez peut-être choisir l'état le plus générique.
format (json) et le traiter ultérieurement avec des outils supplémentaires, choisissez le format le plus basique
(texte) juste pour obtenir un simple résumé des résultats ou enfin choisir l'un des deux
formats spécialisés (xml et html) spécifiques au workflow Checkbox.

Les exportateurs suivants sont pris en charge dès la sortie de la boîte :

html
Cet exportateur crée une page HTML statique avec un rapport de test lisible. Il est utile.
pour communiquer avec d'autres humains et comme il est entièrement autonome et hors ligne, il
peut être envoyé par email ou archivé.

json
Cet exportateur crée un document JSON avec la représentation interne de la session
État. C'est l'exportateur le plus polyvalent et il est utile et facile à traiter ultérieurement.
Il n’est pas particulièrement lisible par l’homme, mais peut être très utile pour le débogage de haut niveau.
sans avoir à utiliser pdb et à connaître les rouages ​​de Plainbox.

rfc822
Cet exportateur crée des documents quasi-RFC822. Il est plutôt limité et peu utilisé.
Néanmoins, cela peut être utile dans certaines circonstances.

texte
Il s'agit de l'exportateur par défaut. Il imprime simplement une représentation lisible du test.
Résultats sans beaucoup de détails. Cependant, il ignore presque tout l'état interne.

XLSX
Cet exportateur crée un fichier .xlsx (format XML pour Microsoft Excel) autonome qui
Contient un rapport de test lisible par l'utilisateur. Il est assez similaire au rapport HTML, mais il est
plus facile à modifier. Il est utile pour communiquer avec d'autres humains et, comme il est entièrement
autonome et hors ligne, il peut être envoyé par e-mail ou archivé.

Cela dépend du package python3-xlsxwriter

hexadécimal
Cet exportateur crée un document XML au nom plutôt déroutant, applicable uniquement aux applications internes.
Flux de travail de l'équipe de certification matérielle canonique.

Il ne s'agit pas d'une représentation XML générique des résultats des tests, mais plutôt d'un certain nombre de
des constructions héritées qui ne sont conservées que pour des raisons de compatibilité avec d'autres outils internes. Si
si vous souhaitez un traitement générique, recherchez plutôt JSON.

Sélection Exportateur Options
Certains exportateurs proposent un ensemble d'options permettant de personnaliser davantage les données exportées.
La liste complète des options disponibles pour chaque exportateur peut être obtenue en passant le
--options-de-sortie ? option de ligne de commande.

Les options peuvent être spécifiées sous forme de liste séparée par des virgules. Certaines options agissent comme de simples indicateurs.
d'autres options peuvent prendre un argument avec le option=valeur syntaxe.

Les options d’exportation connues sont documentées ci-dessous :

json
avec-io-log :
Les données exportées incluront le journal d’entrée/sortie associé à chaque résultat de tâche.
Les données sont incluses dans leur forme native à trois tuples, sauf si l'une des squash-io-log
or flatten-io-log des options sont également utilisées.

Les journaux d'E/S sont des représentations des données produites par le processus créé à partir du
commande shell associée à certains travaux.

squash-io-log:
Lorsqu'il est utilisé avec avec-io-log option qui oblige Plainbox à rejeter le flux
nom et horodatage et inclure simplement une liste de chaînes binaires codées en base64.
l'option est plus utile pour reconstruire des « fichiers journaux » simples

flatten-io-log :
Lorsqu'il est utilisé avec avec-io-log option oblige Plainbox à concaténer tous les
les enregistrements séparés codés en base64 en une seule grande chaîne binaire codée en base64
représentant l'ensemble de la communication qui a eu lieu.

avec-liste-d'exécution :
Les données exportées incluront la liste d'exécution (séquence de tâches calculées à partir de la valeur souhaitée)
(liste des tâches).

avec-liste-de-tâches :
Les données exportées incluront la liste complète des emplois connus du système

avec-carte-ressources :
Les données exportées incluront la carte complète des ressources. Les ressources sont des enregistrements de
ensembles de valeurs clés associés à chaque résultat de tâche pour les tâches qui ont un plugin
type ressource. Ils devraient être imprimés pour Stdout par tel ressource emplois et
sont analysés et stockés par Plainbox.

avec-définitions-de-travail :
Les données exportées incluront certaines propriétés de chaque définition de tâche.
cet ensemble comprend les champs suivants : plug-in, a besoin, dépend, commander et
la description.

avec pièces jointes :
Les données exportées incluront des pièces jointes. Les pièces jointes sont créées à partir de Stdout courant
de chaque travail ayant un type de plugin l'attachementLes pièces jointes réelles sont
codé en base64.

avec-commentaires:
Les données exportées incluront les commentaires ajoutés par l'opérateur de test à chaque résultat de tâche
qui les a.

avec-emploi-via:
Les données exportées incluront les via attribut à côté de chaque résultat de tâche. Le via
l'attribut contient la somme de contrôle de la définition de tâche qui a généré un
Définition de tâche. Ceci est utile pour suivre les tâches générées par les tâches avec le plugin.
type locales.

avec-travail-hachage :
Les données exportées incluront les hachage attribut à côté de chaque résultat de tâche. Le hachage
L'attribut est la somme de contrôle des données de la définition de tâche. Il peut être utile en complément
avec avec-emploi-via.

machine-json :
Le document JSON généré sera minimal (dépourvu de tout espace blanc facultatif).
Cette option est préférable à utiliser si le résultat n'est pas destiné à être lu par des humains
car cela permet de gagner de la place.

rfc822
Toutes les options ont la même signification que pour le json exportateur: avec-io-log,
squash-io-log, flatten-io-log, avec-liste-d'exécution, avec-liste-de-travail, avec-carte-de-ressources,
avec-des-définitions-de-travail, avec pièces jointes, avec-commentaires, avec-emploi-via, avec-emploi-hachage. Le seul
l'exception est la machine-json option qui n'existe pas pour cet exportateur.

texte
Identique à la rfc822.

XLSX
avec-informations-système :
La feuille de calcul exportée comprendra une feuille de calcul détaillant les périphériques matériels basés
sur lspci, lsusb, udev, etc.

avec-résumé :
La feuille de calcul exportée inclura les chiffres de test. Cela inclut le pourcentage de
tests qui ont réussi, qui ont échoué, qui ont été ignorés et le nombre total.

avec-description-de-poste:
La feuille de calcul exportée inclura les descriptions de poste sur une feuille séparée

avec-des-pièces-jointes-de-texte :
La feuille de calcul exportée inclura des pièces jointes de texte sur une feuille séparée

xml
nom du client :
Cette option permet aux clients de remplacer le nom de l'application générant le
Document XML. Par défaut, ce nom est boîte simplePour utiliser cette option, passez
--options-de-sortie nom-client=autre-nom option de ligne de commande.

TRANSPORT RÉSULTATS
Les résultats exportés peuvent être enregistrés dans un fichier (il s'agit du transport par défaut le plus basique)
ou peuvent être confiés à l'un des systèmes de transport pour un traitement ultérieur. L'idée est que
les utilisateurs spécialisés peuvent fournir leurs propres systèmes de transport (souvent couplés à un
(exportateur) pour déplacer les résultats des tests du système testé vers un résultat de test central
dépôt.

Le transport peut être sélectionné avec le --le transport option. Encore une fois, comme pour les exportateurs, une liste de
les transports connus peuvent être obtenus en passant le --le transport ? option. Les transports ont besoin d'un
URL de destination qui peut être spécifiée avec le --transport-où= option. La syntaxe de
l'URL varie selon le type de transport.

Plainbox est équipé des transports suivants :

rampe de lancement
Ce transport peut envoyer les résultats exportés en utilisant xml exportateur vers le matériel Launchpad
Base de données. Il s'agit d'une fonctionnalité peu connue offerte par https://launchpad.net/ en ligne.

certificat
Ce transport peut envoyer les résultats exportés en utilisant le xml exportateur vers Canonical
Site Web de certification (https://certification.canonical.com).

Ce transport n'est d'aucune utilité pour quiconque, à l'exception de l'équipe de certification du matériel Canonical
qui maintient également Plainbox et Checkbox mais cela est mentionné ici pour être complet.

OPTIONS

Optionnel arguments:

--non interactif
ignorer les tests qui nécessitent de l'interactivité

-n, - à sec
ne gère pas vraiment la plupart des tâches

--ne pas supprimer la sortie
ne supprimez pas la sortie de certains types de plugins de travail

-f, --format de sortie
enregistrer les résultats des tests dans le FORMAT spécifié (réussir ? pour une liste de choix)

-p, --options-de-sortie
liste d'options séparées par des virgules pour le mécanisme d'exportation (passez ? pour une liste de
les choix)

-o, --fichier de sortie
enregistrer les résultats du test dans le FICHIER spécifié (ou sur stdout si FICHIER est -)

-t, --le transport
utilisez TRANSPORT pour envoyer les résultats quelque part (passez ? pour une liste de choix)

Choix possibles : ?

--transport-où
où envoyer les données en utilisant le transport sélectionné

--options-de-transport
liste séparée par des virgules d'options clé-valeur (k=v) à transmettre au transport

-T, --plan de test
charger le plan de test spécifié

-i, --include-motif
inclure des tâches correspondant à l'expression régulière donnée

-x, --exclude-motif
exclure les travaux correspondant à l'expression régulière donnée

-w, --liste blanche
charger la liste blanche contenant les modèles d'exécution

Utiliser plainbox-run en ligne à l'aide des services onworks.net