Répertoire de travail et localisation des résultats

La notion de répertoire de travail est particulièrement importante dans rTest.

ScenarioPlayer et les scénarios de test sont conçus pour pouvoir utiliser des chemins absolus ou relatifs. L'utilisation de chemins relatifs dans les scénarios est conseillée car elle facilite le déplacement des projets sur différents environnements (développement, test, recette, pré-production) ou différents systèmes d'exploitation.

Répertoire de travail

Le répertoire de travail est le répertoire contenant le fichier xml du scénario. Lorsqu'un chemin relatif est utilisé dans le scénario de test ou dans un paramètre de scenarioPlayer.fmw, celui-ci prend pour référence le répertoire de travail.

Répertoire de stockage du résultat ou répertoire cible

scenarioPlayer.fmw génère plusieurs documents qui sont stockés dans trois sous-répertoires du répertoire cible.

L'emplacement du répertoire cible est défini selon les règles suivantes :

  • Si le paramètre Result Directory (userdestdir) est laissé vide, le répertoire de travail est utilisé comme répertoire de stockage.

  • Si le paramètre Result Directory (userdestdir) contient un chemin absolu valide, ce chemin est utilisé comme répertoire cible. Le répertoire correspondant est créé s'il n'existe pas.

  • Si le paramètre Result Directory (userdestdir) contient un chemin relatif valide, l'emplacement du répertoire cible est évalué par rapport au répertoire de travail, donc à l'emplacement du scénario. Le répertoire correspondant est créé s'il n'existe pas.

  • Si la syntaxe utilisée pour définir le répertoire de stockage n'est pas correcte, le traitement s'interrompt avec une erreur.

Emplacement du fichier scénario

Le paramètre scenarioxml peut être défini de manière absolue ou bien relative par rapport au répertoire de travail existant au moment du lancement de fme.exe. Attention, ce répertoire est généralement différent du répertoire de travail utilisé par scenarioPlayer.fmw. Le répertoire de travail change donc au moment du lancement de FME avec scenarioPlayer.fmw. Si le traitement se termine correctement le répertoire de travail est réinitialisé à sa position initiale.

Résultats d'un contrôle

L'exécution de scenarioPlayer.fmw produit 4 types de résultats dans 3 répertoires distincts :

  • 2 rapports au format html dans ./rtreport (la version horodatée du rapport pour archivage et sa copie lastReport.html pour consultation)

  • 0 ou 1 fichier de contrôle au format json dans ./rtcontrol

  • 0 à n fichiers de log des traitements FME (process) dans ./rtlog

  • 1 fichier de log de scenarioPlayer.fmw dans ./rtlog

Note

Il est à noter que la génération des rapports HTML et du fichier de contrôle est contrôlée par le paramètre output de scenarioPlayer.
Le fichier de contrôle sert essentiellement à des fins de débogage et n'est généralement pas généré en phase de production.

Rapport HTML

  • Définition : Chaque exécution de scenarioPlayer produit un rapport au format HTML fournissant une synthèse lisible des principales informations du contrôle : nom du scénario, date du contrôle et statut de chacun des tests réalisés, liens vers les fichiers de log... Pour faciliter la consultation, chaque rapport est automatiquement dupliqué sous le nom lastReport.html au moment de sa création.

  • Nommage : Le rapport porte le nom du fichier de scénario, un suffixe d'horodatage et l'extension ".html", par exemple HelloWorld_1631122315071.html.

  • Emplacement : Les rapports sont stockés dans ./rtreport/

Fichier de contrôle

  • Définition : Le résultat brut au format JSON contient l'ensemble des informations relatives au dernier contrôle effectué.

  • Nommage : Il porte le nom du fichier de scénario, un suffixe d'horodatage et l'extension "".json", par exemple HelloWorld_1631122315891.json.

  • Emplacement : Les fichiers de contrôle sont stockés dans ./rtcontrol/

Log des process

  • Définition : Chaque élément rtest/processCollection/process du scénario correspond à un traitement FME dont l'exécution génère un journal (fichier .log) répertorié dans le rapport et le fichier de contrôle.

  • Nommage : Le fichier porte le nom du projet FME correspondant au process et un suffixe composé de : "_" + date en millisecondes + ".log" Par exemple : IGNFAttributeAlticoder_1618127989805.log pour le process IGNFAttributeAlticoder.fmw

  • Emplacement : Les fichiers de log sont stockés dans ./rtlog/

Log de scenarioPlayer

  • Définition : Le fichier de log de chaque exécution de scenarioPlayer est également conservé.

  • Nommage : Le nom de fichier est composé de la concaténation :

    • du préfixe : "sp_",

    • du nom de base du fichier scénario, par exemple : IGNFAttributeAlticoder,

    • d'un suffixe correspondant à l'heure d'exécution en millisecondes,

    • de l'extension ".log" Par exemple : sp_IGNFAttributeAlticoder_1618127989806.log pour le process IGNFAttributeAlticoder.fmw

  • Emplacement : Les fichiers de log sont stockés dans ./rtlog/