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