<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA
 * Copyright (C) 2009-2011 - DIGITEO - Michael Baudin
 * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier: added 32/64bits separation
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 * Copyright (C) 2018 - Samuel GOUGEON
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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">
    <refnamediv>
        <refname>test_run</refname>
        <refpurpose>
            Lance les tests unitaires et de non régression présents dans un module ou dans un répertoire
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntaxe</title>
        <synopsis>
            status = test_run()
            status = test_run(module)
            status = test_run(module, test_name)
            status = test_run(module, test_name, options, exportToFile)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>module</term>
                <listitem>
                    <para>
                        Un tableau de chaînes de caractères : références des modules dont les tests
                        doivent être lancés :
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                nom d'un module interne de Scilab ("core", "time", ...)
                                ou d'un sous-module ("optimization|neldermead").
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                nom d'un module ATOMS ("module_lycee", "nisp", ...). Le module
                                doit être chargé dans la session Scilab avant de lancer test_run().
                                Voir <literal>atomsGetLoaded()(:,1)</literal> et
                                <link linkend="atomsLoad">atomsLoad(…)</link>.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                chemin absolu ou relatif du dossier principal d'un module externe
                                ayant une structure standard. Les fichiers de tests .tst sont
                                attendus dans les sous-dossiers ./test/unit_tests et/ou
                                ./test/nonreg_tests.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <literal>[]</literal> ou <literal>"[]"</literal> : tous les tests
                                des modules internes de Scilab sont lancés.
                            </para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>test_name</term>
                <listitem>
                    <para>
                        Noms des tests à effectuer (tableau de texte), ou <literal>[]</literal>
                        ou <literal>"[]"</literal> pour tous les tests disponibles pour le
                        module considéré.
                    </para>
                    <para>
                        Le joker * peut être utilisé, tel que dans <literal>*sin</literal>,
                        <literal>*sin</literal>, ou <literal>*sin*</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>options</term>
                <listitem>
                    <para>
                        Un tableau de chaînes de caractères : étiquettes des options à utiliser
                        pour le lot de tests (liste ci-après).
                        Indiquer <literal>[]</literal> ou <literal>"[]"</literal> pour utiliser
                        les options par défaut.
                    </para>
                    <variablelist>
                        <varlistentry>
                            <term>"no_check_ref"</term>
                            <listitem>
                                <para>n'effectue pas la comparaison entre les fichiers .dia et .dia.ref</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"no_check_error_output"</term>
                            <listitem>
                                <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>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"create_ref"</term>
                            <listitem>
                                <para>génère un fichier .dia.ref (pour les tests sans l'indicateur
                                  <literal>&lt;-- NO CHECK REF --></literal>), et ignore la comparaison
                                  avec tout précédent fichier .dia.ref</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"show_error"</term>
                            <listitem>
                                <para>affiche les 10 dernières lignes d'exécution du script si un test échoue.</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"show_diff"</term>
                            <listitem>
                                <para>
                                    si une différence avec le fichier .dia.ref est trouvée, affiche la différence avec une commande <literal>diff -u</literal>
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"list"</term>
                            <listitem>
                                <para>liste les tests disponibles (aucun test n'est exécuté)</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"help"</term>
                            <listitem>
                                <para>affiche des exemples d'utilisation de cette commande</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"mode_nw"</term>
                            <listitem>
                                <para>ajoute l'option "-nw" au lancement de chaque test</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"mode_nwni"</term>
                            <listitem>
                                <para>ajoute l'option "-nwni" au lancement de chaque test</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"mode_nwni_profiling"</term>
                            <listitem>
                                <para>ajoute les options "-nwni -profiling" pour permettre le profiling (seulement disponible sous linux)</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"nonreg_tests"</term>
                            <listitem>
                                <para>lance uniquement les tests de non régression</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"unit_tests"</term>
                            <listitem>
                                <para>lance uniquement les tests unitaires</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"skip_tests"</term>
                            <listitem>
                                <para>
                                    ignore les tests spécifiés dans <term>test_name</term>
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"enable_lt"</term>
                            <listitem>
                                <para>active les tests taggés à long temps d'exécution</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"short_summary"</term>
                            <listitem>
                                <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>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>exportToFile</term>
                <listitem>
                    <para>
                        une chaîne de caractères. Chemin d'accès à un fichier d'export.
                    </para>
                    <para>
                        Exporte le resultat de la passe de test dans le fichier XML <varname>exportToFile</varname>. Ce fichier suit le format XUnit.
                        L'utilisation de cet argument d'entrée active automatiquement les options <literal>"show_diff"</literal> et <literal>"show_error"</literal>.
                    </para>
                    <para>
                        Si le fichier spécifié par <varname>exportToFile</varname> existe préalablement, les résultats de tests sont ajoutés en fin de fichier.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>status</term>
                <listitem>
                    <para>
                        Une valeur booléenne.
                        Renvoie %t dans le cas où aucune erreur n'est détectée pour cette passe.
                        Renvoie %f sinon.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            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.
            Les ficheirs .tst se trouvent dans les répertoire SCI+"/modules/*/tests/unit_tests" et SCI+"/modules/*/tests/nonreg_tests".
        </para>
        <para>
            Tout d'abord, <literal>test_run</literal> vérifie que le test ne produit aucune erreur.
            Si le test produit une erreur, le test est considéré en échec.
        </para>
        <para>
            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>.
            Le fichier <literal>.dia.ref</literal> doit se trouver dans le même répertoire que le fichier <literal>.tst</literal> correspondant.
            Si les deux fichiers sont différents le test est considéré en échec.
        </para>
        <para>
            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.
        </para>
        <para>liste des tags disponbiles : </para>
        <itemizedlist>
            <listitem>
                <para>
                    &lt;-- INTERACTIVE TEST --&gt;
                    Le test est taggé Interactif. Les tests interactifs sont ignorés.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- LONG TIME EXECUTION --&gt;
                    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.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- NOT FIXED --&gt;
                    Le test est taggé comme non corrigé. Les tests non corrigés sont ignorés.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- TEST WITH GRAPHIC --&gt;
                    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).
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- NO TRY CATCH --&gt;
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- NO CHECK ERROR OUTPUT --&gt;
                    La sortie d'erreur standard de scilab n'est pas vérifiée.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- NO CHECK REF --&gt;
                    Les fichiers <literal>.dia</literal> et <literal>.dia.ref</literal> ne sont pas vérifiés.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- ENGLISH IMPOSED --&gt;
                    Le test est lancé avec l'option <literal>-l en_US</literal>
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- FRENCH IMPOSED --&gt;
                    Le test est lancé avec l'option <literal>-l fr_FR</literal>
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- CLI SHELL MODE --&gt;
                    Le test est exécuté avec l'option de lancement <literal>-nwni</literal>.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- WINDOWS ONLY --&gt;
                    Ignore le test sur tout autre système d'exploitation que Windows.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- UNIX ONLY --&gt;
                    Ignore le test sur tout autre système d'exploitation que Unix.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- LINUX ONLY --&gt;
                    Ignore le test sur tout autre système d'exploitation que GNU/Linux.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- MACOSX ONLY --&gt;
                    Ignore le test sur tout autre système d'exploitations que Mac OS X.
                </para>
            </listitem>
            <listitem>
                <para>
                    &lt;-- XCOS TEST --&gt;
                    Charge préalablement les librairies d'Xcos pour exécuter le test.
                </para>
            </listitem>
        </itemizedlist>
        <para>
            Chaque test est éxécuté dans un processus séparé, créé avec la commande <link linkend="host">host</link>.
            Ceci permet de continuer à lancer les tests même si l'environnement exécutant le test est devenu instable suite aux commandes passées.
            Cela permet aussi de rendre les tests indépendants les uns des autres.
        </para>
    </refsection>
    <refsection>
        <title>Tests spécifiques à une platforme</title>
        <para>
            Il est possible que le résultat d'un test dépende de l'OS sur lequel il est exécuté.
            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.
            Des fichiers <literal>.ref</literal> additionnels peuvent être créés avec des extensions spéciques à la plateforme :
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    <literal>.unix.dia.ref</literal> pour la plateforme Unix,
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>.linux.dia.ref</literal> pour la plateforme GNU/Linux,
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>.linux32.dia.ref</literal> pour la plateforme GNU/Linux 32bits,
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>.win.dia.ref</literal> pour la platforme Windows,
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>.win32.dia.ref</literal> pour la plateforme Windows 32bits,
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>.macosx.dia.ref</literal> pour la plateforme Max OS X.
                </para>
            </listitem>
        </itemizedlist>
        <para>
            L'algorithme est le suivant :
            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é.
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    Sur les plateformes Windows : <literal>.win.dia.ref</literal>, <literal>.win32.dia.ref</literal>
                </para>
            </listitem>
            <listitem>
                <para>
                    sur les plateformes Mac OS : <literal>.unix.dia.ref</literal>, <literal>.macosx.dia.ref</literal>,
                </para>
            </listitem>
            <listitem>
                <para>
                    sur les plateformes GNU/Linux : <literal>.unix.dia.ref</literal>, <literal>.linux.dia.ref</literal>, <literal>.linux32.dia.ref</literal>.
                </para>
            </listitem>
        </itemizedlist>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// Lance tous les tests
// Cela peut prendre du temps...
// =============================================

// test_run();
// test_run([]);
// test_run([],[]);
// test_run("[]","[]");
// test_run [] [];

// Teste un ou plusieurs modules
// =============================================

// Teste un seul module
test_run('time');

// Teste plusieurs modules
test_run(['time','string']);

// Teste un sous-module
test_run('optimization|neldermead');

// Test défini par le chemin d'accès
test_run(SCI+'/modules/core');

// Lance un test spécifique
// =============================================

// Un seul test
test_run('time','datenum');

// Plusieurs tests
test_run('time',['datenum';'calendar']);

// Ignorer plusieurs tests
// =============================================

test_run('time',['datenum';'calendar'],'skip_tests');

// Options
// =============================================

// sans comparaison entre .dia et .dia.ref
test_run('time','datenum','no_check_ref');

// création d'un fichier .dia.ref
// test_run([],[],'create_ref');

// liste des tests disponibles
test_run([],[],'list');

// affichage des exemples d'utilisation de la commande
test_run([],[],'help');

// Exécution de tous les tests de non régression
test_run([],[],'nonreg_test');

// Exécution de tous les tests unitaires
test_run([],[],'unit_test');

// non vérification de la sortie d'erreur standard (std err)
test_run('boolean','bug_2799','no_check_error_output');

// Combinaisons d'options
test_run([],[],['no_check_ref','mode_nw']);

// Console mode
test_run time [] no_check_ref //tests time module with no_check_ref option
 ]]></programlisting>

        <programlisting role="example"><![CDATA[
// lance les tests d'un module externe
test_run('SCI/contrib/toolbox_skeleton')
 ]]></programlisting>

        <programlisting role="example"><![CDATA[
// Export XML Xunit
test_run('boolean',[],[],TMPDIR+"/boolean_test_run.xml");
test_run('time','datenum',[],TMPDIR+"/time_datenum_test_run.xml");
 ]]></programlisting>
        <para>
            <emphasis role="bold">Sélections avec joker * :</emphasis>
        </para>
        <programlisting role="example"><![CDATA[
test_run elementary_functions *space
test_run elementary_functions dec2*
test_run string *ascii*
 ]]></programlisting>
    <screen><![CDATA[
--> test_run elementary_functions *space
   TMPDIR = C:\MyPath\AppData\Local\Temp\SCI_TMP_3668_1147

   001/002 - [elementary_functions] logspace....................passed
   002/002 - [elementary_functions] linspace....................passed
   --------------------------------------------------------------------------
   Summary
../..

--> test_run elementary_functions dec2*
   TMPDIR = C:\MyPath\AppData\Local\Temp\SCI_TMP_3668_1147

   001/004 - [elementary_functions] dec2oct.....................passed
   002/004 - [elementary_functions] dec2hex.....................passed
   003/004 - [elementary_functions] dec2bin.....................passed
   004/004 - [elementary_functions] dec2base....................passed
   --------------------------------------------------------------------------
   Summary
../..

--> test_run string *ascii*
   TMPDIR = C:\MyPath\AppData\Local\Temp\SCI_TMP_3668_1147

   001/003 - [string] isascii...................................passed
   002/003 - [string] asciimat..................................passed
   003/003 - [string] ascii.....................................passed
   --------------------------------------------------------------------------
   Summary
../..
]]></screen>
    </refsection>
    <refsection>
        <title>Fonctionnement</title>
        <para>
            Les scripts de tests .tst originaux sont copiés et exécutés dans un répertoire temporaire
            contenant également les résultats d'exécution.
        </para>
        <para>
            Avant exécution, un en-tête et un pied de page spécifiques sont rajoutés à chaque script
            <literal>.tst</literal> copié. Ces ajouts permettent de rediriger les sorties d'exécution
            dans un journal spécifique au test créé dans le même répertoire.
        </para>
        <para>
            La durée d'exécution pour chaque test est fixée à 5 minutes. Pour
            désactiver la terminaison du test après ce délai, utilisez le tag
            <literal>LONG TIME EXECUTION</literal>.
        </para>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="atomsTest">atomsTest</link>
            </member>
            <member>
                <link linkend="debug">debug</link>
            </member>
            <member>
                <link linkend="covStart">covStart</link>
            </member>
            <member>
                <link linkend="profile">profile</link>
            </member>
            <member>
                <link linkend="slint">slint</link>
            </member>
            <member>
                <ulink url="https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382.aspx">
                  Liste des codes de résultat d'exécution de MS Windows
                </ulink>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Historique</title>
        <revhistory>
            <revision>
                <revnumber>5.4.0</revnumber>
                <revdescription>test_run renvoie un statut:
                    <itemizedlist><listitem>
                            Renvoie %t si aucune erreur n'est détectée
                        </listitem>
                        <listitem>
                            Renvoie %f si une erreur est détectée
                        </listitem>
                    </itemizedlist>
                    <para>
                        <literal>show_diff</literal> et <literal>show_error</literal> ajoutés comme nouvelles options
                    </para>
                    <para>
                        tag <literal>CLI SHELL MODE</literal> ajouté. Remplace <literal>JVM NOT MANDATORY</literal> (toujours supporté)
                    </para>
                    <para>
                        <literal>test_run</literal> peut fonctionner sur un module externe.
                    </para>
                    <para>
                        Quatrième paramètre d'appel pour l'export vers un fichier XML XUnit
                    </para>
                </revdescription>
            </revision>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revdescription>séparation 32/64bits disponible</revdescription>
            </revision>
            <revision>
                <revnumber>6.0.0</revnumber>
                <revdescription>
                    <para>mode profiling ajouté pour permettre l'analyse du profil d'exécution avec valgrind (Linux uniquement)</para>
                    <para>
                        durée d'exécution maximale d'un test sans <literal>LONG TIME EXECUTION</literal> configurée à 5 minutes.
                    </para>
                </revdescription>
            </revision>
            <revision>
                <revnumber>6.0.2</revnumber>
                <revdescription>
                    <para>Les noms de tests avec joker * sont désormais utilisables,
                        tels que sin*, *sin, ou *sin*
                    </para>
                </revdescription>
            </revision>
            <revision>
                <revnumber>2023.0.0</revnumber>
                <revdescription>
                    <para> Tag <literal>JVM NOT MANDATORY</literal> supprimé.</para>
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
