scripts-reco

git clone git://bebou.netlib.re/scripts-reco

Log | Files | Refs | README |

commit 61f7a7066e1d364da6915e696b1fb02d876a168a
parent c2b5bbb22f16227396ca919e095a9d4a771c110b
Auteurice: Arthur Pons <arthur.pons@unistra.fr>
Date:   Wed, 12 Mar 2025 21:15:31 +0100

Documentation plus complète

Diffstat:
M
README
 | 
72
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----------

1 file changed, 61 insertions(+), 11 deletions(-)
diff --git a/README b/README
@@ -10,20 +10,28 @@ Lancer une suite de tests :
 
 	$ ./omen.sh
 
-Il est possible que certains tests vous demandent un mot de passe pour avoir
-les droits nécessaires à leur bon fonctionnement.
+Il est possible qu'il vous soit demandé en cours de route d'entrer le mot de
+passe du compte root ou le votre si vous êtes sudoers.
+
+## Fonctionnement général
+
+L'idée est d'avoir un ensemble de tests sous forme de scripts dans le dossier
+`tests`. Ces tests peuvent être assemblés dans une suite de test qui aident au
+reconditionnement d'un PC portable. Le début d'une suite de test instanciera
+certaines variables et fonctions qui peuvent être utilisées dans les tests.
+Ces variables et fonctions sont détaillées par la suite.
 
 ## Dépendances
 
-  * feh
-  * dmidecode
-  * ffmpeg
-  * awk, grep, sed, sort
-  * shell
-  * mktemp -d
-  * aplay/arecord
-  * iw
-  * xclip
+test | liste dépendances
+-----|------------------
+tous | shell, awk, grep, sed, sort
+rapport | dmidecode
+écran | feh
+webcam | ffmpeg
+audio | aplay/arecord
+wifi | iw
+bluetooth | bluetoothctl (bluez)
 
 Sous debian ces dépendances peuvent-être installées en faisant :
 
@@ -32,3 +40,45 @@ Sous debian ces dépendances peuvent-être installées en faisant :
 A noter que `ffmpeg` est un paquet très lourd. Il pourrait être intéressant de
 le remplacer.
 
+## Ecrire un test
+
+Un test est un script se trouvant dans le dossier `tests`. Il peut être
+écrit dans le langage de son choix. Les variables et fonctions shell
+disponibles pertinents lors d'un test lorsqu'il sera appelé dans une suite de
+test sont :
+
+Les variables
+
+  * `$tmpdir` - le chemin du dossier temporaire créé pour cette suite de test.
+    On peut y stocker des choses, pour le test en cours ou les suivants.
+
+Les fonctions
+
+  * `inform blabla` - Affiche un message informatif et invite à appuyer sur
+    entrée pour continuer. Typiquement utilisé en début de test pour préparer
+    l'opérateurice à ce qu'il va se passer.
+
+## Ecrire une suite de test
+
+Une suite de test est un script constitué d'un ensemble ordonné de tests se
+trouvant dans `tests`. Cette suite de test peut à priori se trouver n'importe
+où. Elle **doit** commencer par :
+
+    #! /usr/bin/env ./common.sh
+
+Qui en fait script exécuté par `common.sh`. C'est ce script qui prépare les
+fonctions et variables importantes. On utilise ensuite la fonction
+`launch_test` suivi du nom d'un test existant pour déclarer les tests qui
+seront exécutés :
+
+    launch_test rapport
+    launch_test ecran
+    launch_test audio
+    launch_test webcam
+    launch_test wifi
+    launch_test bluetooth
+
+On fini par la fonction affichant le rapport de fin :
+
+    end
+