Improved test_run to fail when a test generates an error on create_ref or no_check_ref
[scilab.git] / scilab / modules / development_tools / help / fr_FR / test_run.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  * Copyright (C) 2009-2011 - DIGITEO - Michael Baudin
6  * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier: added 32/64bits separation
7  *
8  * This file must be used under the terms of the CeCILL.
9  * This source file is licensed as described in the file COPYING, which
10  * you should have received as part of this distribution.  The terms
11  * are also available at
12  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
13  *
14  -->
15 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="test_run" xml:lang="fr">
16     <refnamediv>
17         <refname>test_run</refname>
18         <refpurpose>
19             Lance les tests unitaires et de non régression présents dans un module ou dans un répertoire. La passe de test vérifie d'abord que le test s'exécute sans erreur, puis que la sortie console (fichier <literal>dia</literal>) est conforme à un fichier de référence préalablement généré (fichier <literal>dia.ref</literal>).
20         </refpurpose>
21     </refnamediv>
22     <refsynopsisdiv>
23         <title>Syntaxe</title>
24         <synopsis>
25             status = test_run()
26             status = test_run(module)
27             status = test_run(module, test_name)
28             status = test_run(module, test_name, options, exportToFile)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Arguments</title>
33         <variablelist>
34             <varlistentry>
35                 <term>module</term>
36                 <listitem>
37                     <para>
38                         Un tableau de chaînes de caractères ou <literal>[]</literal>. Nom des modules ou répertoires à tester, tous les modules internes de scilab si <literal>[]</literal>
39                     </para>
40                     <itemizedlist>
41                         <listitem>
42                             <para>
43                                 le nom d'un module interne de Scilab ("core", "time", ...) ou d'un sous-module ("optimization|neldermead").
44                             </para>
45                         </listitem>
46                         <listitem>
47                             <para>
48                                 le nom d'un module ATOMS ("module_lycee", "nisp", ...). Pour être pris en compte le module doit être chargé à l'appel de test_run().
49                             </para>
50                         </listitem>
51                         <listitem>
52                             <para>
53                                 le chemin absolu vers le répertoire d'un module.
54                             </para>
55                         </listitem>
56                     </itemizedlist>
57                 </listitem>
58             </varlistentry>
59             <varlistentry>
60                 <term>test_name</term>
61                 <listitem>
62                     <para>
63                         Un tableau de chaînes de caractères ou <literal>[]</literal>. Le nom des tests à exécuter lors de cette passe de tests, tous les tests si <literal>[]</literal>
64                     </para>
65                 </listitem>
66             </varlistentry>
67             <varlistentry>
68                 <term>options</term>
69                 <listitem>
70                     <para>
71                         Un tableau de chaînes de caractères ou <literal>[]</literal>. Les options à utiliser pour la passe de test, les options par défaut si <literal>[]</literal>
72                     </para>
73                     <variablelist>
74                         <varlistentry>
75                             <term>"no_check_ref"</term>
76                             <listitem>
77                                 <para>n'effectue pas la comparaison entre les fichiers .dia et .dia.ref</para>
78                             </listitem>
79                         </varlistentry>
80                         <varlistentry>
81                             <term>"no_check_error_output"</term>
82                             <listitem>
83                                 <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>
84                             </listitem>
85                         </varlistentry>
86                         <varlistentry>
87                             <term>"create_ref"</term>
88                             <listitem>
89                                 <para>génère un fichier .dia.ref (ignore la comparaison avec tout précédent fichier .dia.ref)</para>
90                             </listitem>
91                         </varlistentry>
92                         <varlistentry>
93                             <term>"show_error"</term>
94                             <listitem>
95                                 <para>affiche les 10 dernières lignes d'exécution du script si un test échoue.</para>
96                             </listitem>
97                         </varlistentry>
98                         <varlistentry>
99                             <term>"show_diff"</term>
100                             <listitem>
101                                 <para>
102                                     si une différence avec le fichier .dia.ref est trouvée, affiche la différence avec une commande <literal>diff -u</literal>
103                                 </para>
104                             </listitem>
105                         </varlistentry>
106                         <varlistentry>
107                             <term>"list"</term>
108                             <listitem>
109                                 <para>liste les tests disponibles (aucun test n'est exécuté)</para>
110                             </listitem>
111                         </varlistentry>
112                         <varlistentry>
113                             <term>"help"</term>
114                             <listitem>
115                                 <para>affiche des exemples d'utilisation de cette commande</para>
116                             </listitem>
117                         </varlistentry>
118                         <varlistentry>
119                             <term>"mode_nw"</term>
120                             <listitem>
121                                 <para>ajoute l'option "-nw" au lancement de chaque test</para>
122                             </listitem>
123                         </varlistentry>
124                         <varlistentry>
125                             <term>"mode_nwni"</term>
126                             <listitem>
127                                 <para>ajoute l'option "-nwni" au lancement de chaque test</para>
128                             </listitem>
129                         </varlistentry>
130                         <varlistentry>
131                             <term>"mode_nwni_profiling"</term>
132                             <listitem>
133                                 <para>ajoute les options "-nwni -profiling" pour permettre le profiling (seulement disponible sous linux)</para>
134                             </listitem>
135                         </varlistentry>
136                         <varlistentry>
137                             <term>"nonreg_tests"</term>
138                             <listitem>
139                                 <para>lance uniquement les tests de non régression</para>
140                             </listitem>
141                         </varlistentry>
142                         <varlistentry>
143                             <term>"unit_tests"</term>
144                             <listitem>
145                                 <para>lance uniquement les tests unitaires</para>
146                             </listitem>
147                         </varlistentry>
148                         <varlistentry>
149                             <term>"skip_tests"</term>
150                             <listitem>
151                                 <para>
152                                     ignore les tests spécifiés dans <term>test_name</term>
153                                 </para>
154                             </listitem>
155                         </varlistentry>
156                         <varlistentry>
157                             <term>"enable_lt"</term>
158                             <listitem>
159                                 <para>active les tests taggés à long temps d'exécution</para>
160                             </listitem>
161                         </varlistentry>
162                         <varlistentry>
163                             <term>"short_summary"</term>
164                             <listitem>
165                                 <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>
166                             </listitem>
167                         </varlistentry>
168                     </variablelist>
169                 </listitem>
170             </varlistentry>
171             <varlistentry>
172                 <term>exportToFile</term>
173                 <listitem>
174                     <para>
175                         une chaîne de caractères. Chemin d'accès à un fichier d'export.
176                     </para>
177                     <para>
178                         Exporte le resultat de la passe de test dans le fichier XML <varname>exportToFile</varname>. Ce fichier suit le format XUnit.
179                         L'utilisation de cet argument d'entrée active automatiquement les options <literal>"show_diff"</literal> et <literal>"show_error"</literal>.
180                     </para>
181                     <para>
182                         Si le fichier spécifié par <varname>exportToFile</varname> existe préalablement, les résultats de tests sont ajoutés en fin de fichier.
183                     </para>
184                 </listitem>
185             </varlistentry>
186             <varlistentry>
187                 <term>status</term>
188                 <listitem>
189                     <para>
190                         Une valeur booléenne.
191                         Renvoie %t dans le cas où aucune erreur n'est détectée pour cette passe.
192                         Renvoie %f sinon.
193                     </para>
194                 </listitem>
195             </varlistentry>
196         </variablelist>
197     </refsection>
198     <refsection>
199         <title>Description</title>
200         <para>
201             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.
202             Les ficheirs .tst se trouvent dans les répertoire SCI+"/modules/*/tests/unit_tests" et SCI+"/modules/*/tests/nonreg_tests".
203         </para>
204         <para>
205             Tout d'abord, <literal>test_run</literal> vérifie que le test ne produit aucune erreur.
206             Si le test produit une erreur, le test est considéré en échec.
207         </para>
208         <para>
209             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>.
210             Le fichier <literal>.dia.ref</literal> doit se trouver dans le même répertoire que le fichier <literal>.tst</literal> correspondant.
211             Si les deux fichiers sont différents le test est considéré en échec.
212         </para>
213         <para>
214             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.
215         </para>
216         <para>liste des tags disponbiles : </para>
217         <itemizedlist>
218             <listitem>
219                 <para>
220                     &lt;-- INTERACTIVE TEST --&gt;
221                     Le test est taggé Interactif. Les tests interactifs sont ignorés.
222                 </para>
223             </listitem>
224             <listitem>
225                 <para>
226                     &lt;-- LONG TIME EXECUTION --&gt;
227                     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.
228                 </para>
229             </listitem>
230             <listitem>
231                 <para>
232                     &lt;-- NOT FIXED --&gt;
233                     Le test est taggé comme non corrigé. Les tests non corrigés sont ignorés.
234                 </para>
235             </listitem>
236             <listitem>
237                 <para>
238                     &lt;-- TEST WITH GRAPHIC --&gt;
239                     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).
240                 </para>
241             </listitem>
242             <listitem>
243                 <para>
244                     &lt;-- NO TRY CATCH --&gt;
245                 </para>
246             </listitem>
247             <listitem>
248                 <para>
249                     &lt;-- NO CHECK ERROR OUTPUT --&gt;
250                     La sortie d'erreur standard de scilab n'est pas vérifiée.
251                 </para>
252             </listitem>
253             <listitem>
254                 <para>
255                     &lt;-- NO CHECK REF --&gt;
256                     Les fichiers <literal>.dia</literal> et <literal>.dia.ref</literal> ne sont pas vérifiés.
257                 </para>
258             </listitem>
259             <listitem>
260                 <para>
261                     &lt;-- ENGLISH IMPOSED --&gt;
262                     Le test est lancé avec l'option <literal>-l en_US</literal>
263                 </para>
264             </listitem>
265             <listitem>
266                 <para>
267                     &lt;-- FRENCH IMPOSED --&gt;
268                     Le test est lancé avec l'option <literal>-l fr_FR</literal>
269                 </para>
270             </listitem>
271             <listitem>
272                 <para>
273                     &lt;-- CLI SHELL MODE --&gt;
274                     (anciennement &lt;-- JVM NOT MANDATORY --&gt; maintenant obsolète)
275                     Le test est exécuté avec l'option de lancement <literal>-nwni</literal>.
276                 </para>
277             </listitem>
278             <listitem>
279                 <para>
280                     &lt;-- WINDOWS ONLY --&gt;
281                     Ignore le test sur tout autre système d'exploitation que Windows.
282                 </para>
283             </listitem>
284             <listitem>
285                 <para>
286                     &lt;-- UNIX ONLY --&gt;
287                     Ignore le test sur tout autre système d'exploitation que Unix.
288                 </para>
289             </listitem>
290             <listitem>
291                 <para>
292                     &lt;-- LINUX ONLY --&gt;
293                     Ignore le test sur tout autre système d'exploitation que GNU/Linux.
294                 </para>
295             </listitem>
296             <listitem>
297                 <para>
298                     &lt;-- MACOSX ONLY --&gt;
299                     Ignore le test sur tout autre système d'exploitations que Mac OS X.
300                 </para>
301             </listitem>
302             <listitem>
303                 <para>
304                     &lt;-- XCOS TEST --&gt;
305                     Charge préalablement les librairies d'Xcos pour exécuter le test.
306                 </para>
307             </listitem>
308         </itemizedlist>
309         <para>
310             Chaque test est éxécuté dans un processus séparé, créé avec la commande <link linkend="host">host</link>.
311             Ceci permet de continuer à lancer les tests même si l'environnement exécutant le test est devenu instable suite aux commandes passées.
312             Cela permet aussi de rendre les tests indépendants les uns des autres.
313         </para>
314     </refsection>
315     <refsection>
316         <title>Tests spécifiques à une platforme</title>
317         <para>
318             Il est possible que le résultat d'un test dépende de l'OS sur lequel il est exécuté.
319             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.
320             Des fichiers <literal>.ref</literal> additionnels peuvent être créés avec des extensions spéciques à la plateforme :
321         </para>
322         <itemizedlist>
323             <listitem>
324                 <para>
325                     <literal>.unix.dia.ref</literal> pour la plateforme Unix,
326                 </para>
327             </listitem>
328             <listitem>
329                 <para>
330                     <literal>.linux.dia.ref</literal> pour la plateforme GNU/Linux,
331                 </para>
332             </listitem>
333             <listitem>
334                 <para>
335                     <literal>.linux32.dia.ref</literal> pour la plateforme GNU/Linux 32bits,
336                 </para>
337             </listitem>
338             <listitem>
339                 <para>
340                     <literal>.win.dia.ref</literal> pour la platforme Windows,
341                 </para>
342             </listitem>
343             <listitem>
344                 <para>
345                     <literal>.win32.dia.ref</literal> pour la plateforme Windows 32bits,
346                 </para>
347             </listitem>
348             <listitem>
349                 <para>
350                     <literal>.macosx.dia.ref</literal> pour la plateforme Max OS X.
351                 </para>
352             </listitem>
353         </itemizedlist>
354         <para>
355             L'algorithme est le suivant :
356             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é.
357         </para>
358         <itemizedlist>
359             <listitem>
360                 <para>
361                     Sur les plateformes Windows : <literal>.win.dia.ref</literal>, <literal>.win32.dia.ref</literal>
362                 </para>
363             </listitem>
364             <listitem>
365                 <para>
366                     sur les plateformes Mac OS : <literal>.unix.dia.ref</literal>, <literal>.macosx.dia.ref</literal>,
367                 </para>
368             </listitem>
369             <listitem>
370                 <para>
371                     sur les plateformes GNU/Linux : <literal>.unix.dia.ref</literal>, <literal>.linux.dia.ref</literal>, <literal>.linux32.dia.ref</literal>.
372                 </para>
373             </listitem>
374         </itemizedlist>
375     </refsection>
376     <refsection>
377         <title>Examples</title>
378         <programlisting role="example"><![CDATA[
379 // Lance tous les tests
380 // =============================================
381
382 test_run();
383 test_run([]);
384 test_run([],[]);
385
386 // Teste un ou plusieurs modules
387 // =============================================
388
389 // Teste un seul module
390 test_run('time');
391
392 // Teste plusieurs modules
393 test_run(['time','string']);
394
395 // Teste un sous-module
396 test_run('optimization|neldermead');
397
398 // Teste définit par le chemin d'accès
399 test_run(SCI+'/modules/core');
400
401 // Lance un test spécifique
402 // =============================================
403
404 // Un seul test
405 test_run('time','datenum');
406
407 // Plusieurs tests
408 test_run('time',['datenum';'calendar']);
409
410 // Ignorer plusieurs tests
411 // =============================================
412
413 test_run('time',['datenum';'calendar'],'skip_tests');
414
415 // Options
416 // =============================================
417
418 // sans comparaison entre .dia et .dia.ref
419 test_run('time','datenum','no_check_ref');
420
421 // création d'un fichier .dia.ref
422 test_run([],[],'create_ref');
423
424 // liste des tests disponibles
425 test_run([],[],'list');
426
427 // affichage des exemples d'utilisation de la commande
428 test_run([],[],'help');
429
430 // Exécution de tous les tests de non régression
431 test_run([],[],'nonreg_test');
432
433 // Exécution de tous les tests unitaires
434 test_run([],[],'unit_test');
435
436 // non vérification de la sortie d'erreur standard (std err)
437 test_run('boolean','bug_2799','no_check_error_output');
438
439 // Combinaisons d'options
440 test_run([],[],['no_check_ref','mode_nw']);
441  ]]></programlisting>
442         
443         <programlisting role="example"><![CDATA[
444 // lance les tests d'un module externe
445 test_run('SCI/contrib/toolbox_skeleton')
446  ]]></programlisting>
447         
448         <programlisting role="example"><![CDATA[
449 // Export XML Xunit
450 test_run('boolean',[],[],TMPDIR+"/boolean_test_run.xml");
451 test_run('time','datenum',[],TMPDIR+"/time_datenum_test_run.xml");
452  ]]></programlisting>
453     </refsection>
454     <refsection>
455         <title>Design interne</title>
456         <para>
457             Les tests sont exécutés dans un répertoire temporaire, non pas dans le repertoire les contenant.
458         </para>
459         <para>
460             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.
461             Le but est d'instrumenter le fichier de tests afin de rediriger les sorties dans un fichier de log spécique au test.
462         </para>
463     </refsection>
464     <refsection>
465         <title>Historique</title>
466         <revhistory>
467             <revision>
468                 <revnumber>5.4.0</revnumber>
469                 <revdescription>test_run renvoie un statut:
470                     <itemizedlist><listitem>
471                             Renvoie %t si aucune erreur n'est détectée
472                         </listitem>
473                         <listitem>
474                             Renvoie %f si une erreur est détectée
475                         </listitem>
476                     </itemizedlist>
477                     <para>
478                         <literal>show_diff</literal> et <literal>show_error</literal> ajoutés comme nouvelles options
479                     </para>
480                     <para>
481                         tag <literal>CLI SHELL MODE</literal> ajouté. Remplace <literal>JVM NOT MANDATORY</literal> (toujours supporté)
482                     </para>
483                     <para>
484                         <literal>test_run</literal> peut fonctionner sur un module externe.
485                     </para>
486                     <para>
487                         Quatrième paramètre d'appel pour l'export vers un fichier XML XUnit
488                     </para>
489                 </revdescription>
490             </revision>
491             <revision>
492                 <revnumber>5.5.0</revnumber>
493                 <revdescription>séparation 32/64bits disponible</revdescription>
494             </revision>
495             <revision>
496                 <revnumber>6.0.0</revnumber>
497                 <revdescription>mode profiling ajouté pour permettre l'analyse du profil d'exécution avec valgrind (Linux uniquement)</revdescription>
498             </revision>
499         </revhistory>
500     </refsection>
501 </refentry>