1 <?xml version="1.0" encoding="UTF-8"?>
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5 * Copyright (C) 2009-2011 - DIGITEO - Michael Baudin
6 * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier: added 32/64bits separation
7 * Copyright (C) 2012 - 2016 - Scilab Enterprises
8 * Copyright (C) 2018 - Samuel GOUGEON
10 * This file is hereby licensed under the terms of the GNU GPL v2.0,
11 * pursuant to article 5.3.4 of the CeCILL v.2.1.
12 * This file was originally licensed under the terms of the CeCILL v2.1,
13 * and continues to be available under such terms.
14 * For more information, see the COPYING file which you should have received
15 * along with this program.
18 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
19 xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
20 xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
21 xmlns:scilab="http://www.scilab.org" xml:id="test_run" xml:lang="fr">
23 <refname>test_run</refname>
25 Lance les tests unitaires et de non régression présents dans un module ou dans un répertoire
29 <title>Syntaxe</title>
32 status = test_run(module)
33 status = test_run(module, test_name)
34 status = test_run(module, test_name, options, exportToFile)
38 <title>Arguments</title>
44 Un tableau de chaînes de caractères ou <literal>[]</literal> (ou <literal>"[]"</literal>). Nom des modules ou répertoires à tester, tous les modules internes de scilab si <literal>[]</literal>
49 le nom d'un module interne de Scilab ("core", "time", ...) ou d'un sous-module ("optimization|neldermead").
54 le nom d'un module ATOMS ("module_lycee", "nisp", ...). Pour être pris en compte le module doit être chargé à l'appel de test_run().
59 le chemin absolu vers le répertoire d'un module.
66 <term>test_name</term>
69 Noms des tests à effectuer (tableau de texte), ou <literal>[]</literal>
70 ou <literal>"[]"</literal> pour tous les tests disponibles pour le
74 Le joker * peut être utilisé, tel que dans <literal>*sin</literal>,
75 <literal>*sin</literal>, ou <literal>*sin*</literal>.
83 Un tableau de chaînes de caractères : étiquettes des options à utiliser
84 pour le lot de tests (liste ci-après).
85 Indiquer <literal>[]</literal> ou <literal>"[]"</literal> pour utiliser
86 les options par défaut.
90 <term>"no_check_ref"</term>
92 <para>n'effectue pas la comparaison entre les fichiers .dia et .dia.ref</para>
96 <term>"no_check_error_output"</term>
98 <para>ignore les messages affichés en sortie d'erreur standard. Cette option peut être utilisé pour certains messages présents en sortie d'erreur dans la localisation par exemple.</para>
102 <term>"create_ref"</term>
104 <para>génère un fichier .dia.ref (pour les tests sans l'indicateur
105 <literal><-- NO CHECK REF --></literal>), et ignore la comparaison
106 avec tout précédent fichier .dia.ref</para>
110 <term>"show_error"</term>
112 <para>affiche les 10 dernières lignes d'exécution du script si un test échoue.</para>
116 <term>"show_diff"</term>
119 si une différence avec le fichier .dia.ref est trouvée, affiche la différence avec une commande <literal>diff -u</literal>
126 <para>liste les tests disponibles (aucun test n'est exécuté)</para>
132 <para>affiche des exemples d'utilisation de cette commande</para>
136 <term>"mode_nw"</term>
138 <para>ajoute l'option "-nw" au lancement de chaque test</para>
142 <term>"mode_nwni"</term>
144 <para>ajoute l'option "-nwni" au lancement de chaque test</para>
148 <term>"mode_nwni_profiling"</term>
150 <para>ajoute les options "-nwni -profiling" pour permettre le profiling (seulement disponible sous linux)</para>
154 <term>"nonreg_tests"</term>
156 <para>lance uniquement les tests de non régression</para>
160 <term>"unit_tests"</term>
162 <para>lance uniquement les tests unitaires</para>
166 <term>"skip_tests"</term>
169 ignore les tests spécifiés dans <term>test_name</term>
174 <term>"enable_lt"</term>
176 <para>active les tests taggés à long temps d'exécution</para>
180 <term>"short_summary"</term>
182 <para>n'affiche pas les statistiques complètes d'exécutions (seuls le nombre de tests exécutés, réussis, échoués et ignorés sont affichés sur une seule ligne de résumé)</para>
189 <term>exportToFile</term>
192 une chaîne de caractères. Chemin d'accès à un fichier d'export.
195 Exporte le resultat de la passe de test dans le fichier XML <varname>exportToFile</varname>. Ce fichier suit le format XUnit.
196 L'utilisation de cet argument d'entrée active automatiquement les options <literal>"show_diff"</literal> et <literal>"show_error"</literal>.
199 Si le fichier spécifié par <varname>exportToFile</varname> existe préalablement, les résultats de tests sont ajoutés en fin de fichier.
207 Une valeur booléenne.
208 Renvoie %t dans le cas où aucune erreur n'est détectée pour cette passe.
216 <title>Description</title>
218 Cherche les fichiers .tst dans les répertoires unit_tests et nonreg_tests, les exécute et affiche un résumé des succès et échecs pour la passe de test.
219 Les ficheirs .tst se trouvent dans les répertoire SCI+"/modules/*/tests/unit_tests" et SCI+"/modules/*/tests/nonreg_tests".
222 Tout d'abord, <literal>test_run</literal> vérifie que le test ne produit aucune erreur.
223 Si le test produit une erreur, le test est considéré en échec.
226 Ensuite, <literal>test_run</literal> s'assure que les commandes et l'affichage de leurs résultats dans la console sont conformes à un fichier de référence préalablement constitué. Chaque exécution d'un test donne lieu à un fichier <literal>.dia</literal> qui est comparé à une fichier <literal>.dia.ref</literal>.
227 Le fichier <literal>.dia.ref</literal> doit se trouver dans le même répertoire que le fichier <literal>.tst</literal> correspondant.
228 Si les deux fichiers sont différents le test est considéré en échec.
231 Des tags spécifiques insérés dans les fichiers .tst peuvent modifier la gestion des fichiers .tst. Ces tags se trouvent dans des commentaires Scilab présents dans le fichier de test.
233 <para>liste des tags disponbiles : </para>
237 <-- INTERACTIVE TEST -->
238 Le test est taggé Interactif. Les tests interactifs sont ignorés.
243 <-- LONG TIME EXECUTION -->
244 Le test est taggé comme étant long à exécuter. Ces test sont ignorés sauf si l'option <literal>"enable-lt"</literal> est spécifiée.
249 <-- NOT FIXED -->
250 Le test est taggé comme non corrigé. Les tests non corrigés sont ignorés.
255 <-- TEST WITH GRAPHIC -->
256 Ce test est taggé comme nécessitant les fonctionnalités graphiques de Scilab. Ils sont automatiquement exécutés avec l'option de lancement "-nw" (mode par défaut).
261 <-- NO TRY CATCH -->
266 <-- NO CHECK ERROR OUTPUT -->
267 La sortie d'erreur standard de scilab n'est pas vérifiée.
272 <-- NO CHECK REF -->
273 Les fichiers <literal>.dia</literal> et <literal>.dia.ref</literal> ne sont pas vérifiés.
278 <-- ENGLISH IMPOSED -->
279 Le test est lancé avec l'option <literal>-l en_US</literal>
284 <-- FRENCH IMPOSED -->
285 Le test est lancé avec l'option <literal>-l fr_FR</literal>
290 <-- CLI SHELL MODE -->
291 (anciennement <-- JVM NOT MANDATORY --> maintenant obsolète)
292 Le test est exécuté avec l'option de lancement <literal>-nwni</literal>.
297 <-- WINDOWS ONLY -->
298 Ignore le test sur tout autre système d'exploitation que Windows.
303 <-- UNIX ONLY -->
304 Ignore le test sur tout autre système d'exploitation que Unix.
309 <-- LINUX ONLY -->
310 Ignore le test sur tout autre système d'exploitation que GNU/Linux.
315 <-- MACOSX ONLY -->
316 Ignore le test sur tout autre système d'exploitations que Mac OS X.
321 <-- XCOS TEST -->
322 Charge préalablement les librairies d'Xcos pour exécuter le test.
327 Chaque test est éxécuté dans un processus séparé, créé avec la commande <link linkend="host">host</link>.
328 Ceci permet de continuer à lancer les tests même si l'environnement exécutant le test est devenu instable suite aux commandes passées.
329 Cela permet aussi de rendre les tests indépendants les uns des autres.
333 <title>Tests spécifiques à une platforme</title>
335 Il est possible que le résultat d'un test dépende de l'OS sur lequel il est exécuté.
336 Si tel est le cas, le fichier <literal>.ref</literal> peut dépendre d'une plateforme et le test peut échouer sur les autres plateformes.
337 Des fichiers <literal>.ref</literal> additionnels peuvent être créés avec des extensions spéciques à la plateforme :
342 <literal>.unix.dia.ref</literal> pour la plateforme Unix,
347 <literal>.linux.dia.ref</literal> pour la plateforme GNU/Linux,
352 <literal>.linux32.dia.ref</literal> pour la plateforme GNU/Linux 32bits,
357 <literal>.win.dia.ref</literal> pour la platforme Windows,
362 <literal>.win32.dia.ref</literal> pour la plateforme Windows 32bits,
367 <literal>.macosx.dia.ref</literal> pour la plateforme Max OS X.
372 L'algorithme est le suivant :
373 D'abord les fichiers <literal>.ref</literal> sont sélectionnés pour le test. Si ces fichiers n'existent pas le fichier <literal>platform.ref</literal> est examiné pour la platforme sur lequel le test est lancé.
378 Sur les plateformes Windows : <literal>.win.dia.ref</literal>, <literal>.win32.dia.ref</literal>
383 sur les plateformes Mac OS : <literal>.unix.dia.ref</literal>, <literal>.macosx.dia.ref</literal>,
388 sur les plateformes GNU/Linux : <literal>.unix.dia.ref</literal>, <literal>.linux.dia.ref</literal>, <literal>.linux32.dia.ref</literal>.
394 <title>Examples</title>
395 <programlisting role="example"><![CDATA[
396 // Lance tous les tests
397 // Cela peut prendre du temps...
398 // =============================================
403 // test_run("[]","[]");
406 // Teste un ou plusieurs modules
407 // =============================================
409 // Teste un seul module
412 // Teste plusieurs modules
413 test_run(['time','string']);
415 // Teste un sous-module
416 test_run('optimization|neldermead');
418 // Test défini par le chemin d'accès
419 test_run(SCI+'/modules/core');
421 // Lance un test spécifique
422 // =============================================
425 test_run('time','datenum');
428 test_run('time',['datenum';'calendar']);
430 // Ignorer plusieurs tests
431 // =============================================
433 test_run('time',['datenum';'calendar'],'skip_tests');
436 // =============================================
438 // sans comparaison entre .dia et .dia.ref
439 test_run('time','datenum','no_check_ref');
441 // création d'un fichier .dia.ref
442 // test_run([],[],'create_ref');
444 // liste des tests disponibles
445 test_run([],[],'list');
447 // affichage des exemples d'utilisation de la commande
448 test_run([],[],'help');
450 // Exécution de tous les tests de non régression
451 test_run([],[],'nonreg_test');
453 // Exécution de tous les tests unitaires
454 test_run([],[],'unit_test');
456 // non vérification de la sortie d'erreur standard (std err)
457 test_run('boolean','bug_2799','no_check_error_output');
459 // Combinaisons d'options
460 test_run([],[],['no_check_ref','mode_nw']);
463 test_run time [] no_check_ref //tests time module with no_check_ref option
466 <programlisting role="example"><![CDATA[
467 // lance les tests d'un module externe
468 test_run('SCI/contrib/toolbox_skeleton')
471 <programlisting role="example"><![CDATA[
473 test_run('boolean',[],[],TMPDIR+"/boolean_test_run.xml");
474 test_run('time','datenum',[],TMPDIR+"/time_datenum_test_run.xml");
477 <emphasis role="bold">Sélections avec joker * :</emphasis>
479 <programlisting role="example"><![CDATA[
480 test_run elementary_functions *space
481 test_run elementary_functions dec2*
482 test_run string *ascii*
485 --> test_run elementary_functions *space
486 TMPDIR = C:\MyPath\AppData\Local\Temp\SCI_TMP_3668_1147
488 001/002 - [elementary_functions] logspace....................passed
489 002/002 - [elementary_functions] linspace....................passed
490 --------------------------------------------------------------------------
494 --> test_run elementary_functions dec2*
495 TMPDIR = C:\MyPath\AppData\Local\Temp\SCI_TMP_3668_1147
497 001/004 - [elementary_functions] dec2oct.....................passed
498 002/004 - [elementary_functions] dec2hex.....................passed
499 003/004 - [elementary_functions] dec2bin.....................passed
500 004/004 - [elementary_functions] dec2base....................passed
501 --------------------------------------------------------------------------
505 --> test_run string *ascii*
506 TMPDIR = C:\MyPath\AppData\Local\Temp\SCI_TMP_3668_1147
508 001/003 - [string] isascii...................................passed
509 002/003 - [string] asciimat..................................passed
510 003/003 - [string] ascii.....................................passed
511 --------------------------------------------------------------------------
517 <title>Design interne</title>
519 Les tests sont exécutés dans un répertoire temporaire, non pas dans le repertoire les contenant.
522 Les scripts de tests ne sont pas exécutés tels qu'écrit, un en-tête et un pied de page spécifiques sont rajoutés à chaque test.
523 Le but est d'instrumenter le fichier de tests afin de rediriger les sorties dans un fichier de log spécique au test.
526 La durée d'exécution pour chaque test est fixé à 5 minutes. Pour
527 désactiver la terminaison du test après ce délai, utilisez le tag
528 <literal>LONG TIME EXECUTION</literal>.
531 <refsection role="see also">
532 <title>Voir aussi</title>
533 <simplelist type="inline">
535 <link linkend="debug">debug</link>
538 <link linkend="covStart">covStart</link>
541 <link linkend="profile">profile</link>
544 <link linkend="slint">slint</link>
547 <ulink url="https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382.aspx">
548 Liste des codes de résultat d'exécution de MS Windows
554 <title>Historique</title>
557 <revnumber>5.4.0</revnumber>
558 <revdescription>test_run renvoie un statut:
559 <itemizedlist><listitem>
560 Renvoie %t si aucune erreur n'est détectée
563 Renvoie %f si une erreur est détectée
567 <literal>show_diff</literal> et <literal>show_error</literal> ajoutés comme nouvelles options
570 tag <literal>CLI SHELL MODE</literal> ajouté. Remplace <literal>JVM NOT MANDATORY</literal> (toujours supporté)
573 <literal>test_run</literal> peut fonctionner sur un module externe.
576 Quatrième paramètre d'appel pour l'export vers un fichier XML XUnit
581 <revnumber>5.5.0</revnumber>
582 <revdescription>séparation 32/64bits disponible</revdescription>
585 <revnumber>6.0.0</revnumber>
587 <para>mode profiling ajouté pour permettre l'analyse du profil d'exécution avec valgrind (Linux uniquement)</para>
589 durée d'exécution maximale d'un test sans <literal>LONG TIME EXECUTION</literal> configurée à 5 minutes.
594 <revnumber>6.0.2</revnumber>
596 <para>Les noms de tests avec joker * sont désormais utilisables,
597 tels que sin*, *sin, ou *sin*