scripts-reco

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

Log | Files | Refs | README |

commit d37de1a17e178cd67a99ffbde097bee627cc7823
parent afe7da1f868e7f3679e8479ea83d98330b47e155
Auteurice: Arthur Pons <arthur.pons@unistra.fr>
Date:   Thu, 20 Mar 2025 15:35:19 +0100

On commente le code de common

Diffstat:
M
bin/common.sh
 | 
18
+++++++++++++++++-

1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/bin/common.sh b/bin/common.sh
@@ -2,9 +2,13 @@
 
 set -e
 
+# L'identifiant de la suite de est apssé en argument ou, s'il n'y en a pas, le
+# résultat de la création d'un nouveau
 [ "$2" ] && id="$2" || id="$(mktemp -d /tmp/reco.XXX | cut -d'.' -f2)"
+
 tmpdir="/tmp/reco.$id"
 chmod -R 744 "$tmpdir"
+
 nom_modele="$(basename "$1" .sh)"
 printf "$id" | xclip -selection clipboard
 
@@ -13,6 +17,8 @@ jaune="\033[93m";bleu="\033[94m"
 norm="\033[0m"
 up_one_line="\033[1F";del_line="\033[0K"
 
+# demander question
+# Poser une question à l'utilisateurice
 demander() {
 	reponse=""
 	while [ "$reponse" != "o" ] && [ "$reponse" != "n" ];do
@@ -25,10 +31,14 @@ informer() { printf "$bleu$@$norm\n" >&2; }
 pause()    { printf "$bleu$@ (entrée pour continuer)$norm" >&2; read _; }
 sauver()   { tee -a "$tmpdir/$test_name"; }
 
+# tester nom_du_test
+# Lance un test
 tester() {
 	test_name="$1"
+	# On saute le test s'il a déjà été fait (système de reprise d'une suite de test)
 	< "$tmpdir/histo" grep -q "^$1 pass" && return
 	clear
+	# On lance le code du test
 	. "tests/$test_name"
 	demander "$test_name ok ou pas ?"
 	[ "$reponse" = "o" ] && reponse=OK || reponse=NOK
@@ -36,19 +46,25 @@ tester() {
 	$test_name : $reponse
 	-------
 	.
+	# On modifie l'historique pour dire que le test a été passé
 	< "$tmpdir/histo" sed "/^$test_name/ s/$/ pass/" > "$tmpdir/tmp"
 	mv "$tmpdir/tmp" "$tmpdir/histo"
 }
 
+# fin
+# Met fin à un test et construit le rapport final
 fin() {
 	printf "test $model_name, id $id\n----------\n" >> "$tmpdir/rapport_complet"
+	# Pour tous les tests on construit les chemins de leurs rapports
 	[ -f "$tmpdir/histo" ] && < "$tmpdir/histo" awk -v tmp=$tmpdir '{ printf "%s/%s\n",tmp,$1 }' |
+		# on stocke leurs contenus dans le rapport complet en supprimant les lignes vides
 		xargs cat | grep . | tee -a "$tmpdir/rapport_complet"
 	< "$tmpdir/rapport_complet" xclip -selection clipboard
 }
 
-# On lance le test
+# On construit le fichier d'historique en récupérant les noms de tests dans le script
 [ ! -f "$tmpdir/histo" ] && < "$1" awk '/tester/ { print $2 }' > "$tmpdir/histo"
 
+# Et on le lance
 pause "Identifiant du test : $id, nom : $nom_modele"
 . "$1"