Plugin Gendoc

Aurore Penault

Le plugin de génération de documents offre quatre principales fonctionnalités séparées en deux groupes : d'une part, celles concernant la création de rapports et d'autre part celles permettant l'échange de données entre différents projets.

Les données générées ou exportées concernent le plan de tests, les campagnes et les exigences (si le plugin est présent).

L'accès aux fonctionnalités du plugin de génération de documents se fait via le bouton « Outils », présent dans les trois premiers onglets de Salomé : « Gestion des tests », « Gestion des campagnes » et « Gestion des données ».


Table des matières


Générer le document des tests

Pour générer le document des tests, il faut tout d'abord sélectionner le sous-menu « Générer le document des tests ».

Image accueilGenererTest

Ensuite, une fenêtre à onglets apparaît.

Image onglet1GenererTest

Dans cette fenêtre, le seul champ obligatoire est celui contenant le nom du fichier html résultant de la génération. Dans ce premier onglet, l'utilisateur peut également choisir de générer le rapport de tests en mode multi-frames. Par défaut, le rapport est généré en html simple, ce qui est le mode à privilégier pour toute impression, en revanche, le mode multi-frames facilite la navigation.

Un deuxième onglet permet d'ajouter une mise en forme au rapport de test. Deux options existent : soit la mise en forme est générée automatiquement après remplissage d'un formulaire, soit l'utilisateur donne sa propre mise en forme par l'intermédiaire de pages html.

Image onglet2GenererTest

Le formulaire se présente de la façon suivante :

Image formulaireGenererTest

Le troisième onglet de cette fenêtre propose différentes options. Une première option permet de sélectionner les tests que l'on veut inclure dans le rapport Les deux options suivantes concernent les graphiques, la première permet d'inclure ou non le graphique récapitulatif dans le rapport, la deuxième permet de sélectionner le mode, noir et blanc ou couleur, en cas d'impression. La dernière option proposée concerne l'inclusion des fichiers attachés.

Image onglet3GenererTest

Le bouton "Sélection des tests..." ouvre une fenêtre qui permet de sélectionner des tests. Cette fenêtre se découpe en deux parties. La première, à gauche, contient l'ensemble du plan de tests et la deuxième, à droite, contient les tests sélectionnés. Pour ajouter ou supprimer des tests à la sélection, il suffit de sélectionner des tests (ou des familles ou des suites) dans l'une ou l'autre des parties puis de cliquer sur la flèche correspondante. Par ailleurs, les touches "Shift" et "Ctrl" peuvent être utilisées pour faire de la sélection multiple.

Image selectTests


Générer le document des campagnes

Pour générer le document des campagnes, il faut tout d'abord sélectionner le sous-menu « Générer le document des campagnes ».

Image accueilGenererCamp

Comme pour la génération du document se rapportant aux tests, le seul champ obligatoire est celui qui indique le nom du fichier résultat. Dans l'onglet principal de cette fenêtre, le choix peut être fait de ne pas inclure les exécutions ou les résultats d'exécutions dans le rapport. Une option permet également de générer le rapport en html multi-frames, ce qui facilite la navigation dans le document.

Image onglet1GenererCamp

L'onglet mise en forme est le même que celui de la génération du document pour les tests, il permet d'intégrer une mise en page soit en remplissant un formulaire soit en intégrant ses propres documents html au rapport.

Image onglet2GenererCamp

Ce dernier onglet présente différentes options. Une première option de filtrage permet de sélectionner les différentes campagnes et exécutions à intégrer dans le document résultant. Une autre option permet de sélectionner les graphiques récapitulatifs à inclure dans le document. Enfin, l'utilisateur peut choisir d'inclure le contenu des fichiers attachés, suivant le type des fichiers, dans le rapport.

Image onglet3GenererCamp


Exporter les données d'un projet

Cette option du plugin de génération de documents permet d'exporter les données au format XML. Pour exporter les données, il suffit de sélectionner le sous-menu « Exporter au format XML ».

Image accueilExport

Ensuite, la donnée du nom du fichier XML résultat est suffisante à l'export de données. L'utilisateur possède néanmoins deux options : soit il exporte toutes ses données, c'est-à-dire l'ensemble du plan de tests mais aussi les campagnes contenues dans son projet. Soit il choisit de n'exporter que le plan de tests et dans ce cas, il peut également choisir les tests à exporter.

Image fenetreExport


Importer des données dans un projet

Cette option du plugin de génération de documents permet d'importer des données issues d'un fichier XML dans un projet. On accède à cette fonctionnalité grâce au sous-menu « Importer des données à partir d'un fichier XML ».

Image accueilImport

L'onglet principal permet d'indiquer le fichier XML à partir duquel l'import des données doit être fait. Il permet également de choisir d'importer uniquement les données du plan de tests. Dans ce cas, l'utilisateur peut également sélectionner les tests à importer.

Image onglet1Import

Le deuxième onglet propose plusieurs options pour l'import des données. Les deux premières options concernent la suppression des données du projet qui n'apparaissent pas dans le document XML. Si la première option est cochée, les données du projet qui n'apparaissent pas dans le document XML sont supprimés, cette option ne concerne pas les actions d'un test manuel et les données relatives à cette action. La sélection de la deuxième option entraîne la suppression des actions des tests manuels et des données qui lui sont rattachées, dans le cas où ils n'apparaissent pas dans le document d'import.

Lorsque des tests ont été exécutés, certaines données ne peuvent plus être modifiées. Dans ce cas, le traitement dépend de l'option sélectionnée. Soit l'utilisateur choisit de conserver les données de son projet telles quelles et de copier les données dans son projet avec un nom préfixé par "copy_", soit seule la mise à jour des données qui ne sont pas sources de conflit est demandée, soit l'utilisateur choisit de conserver les données de son projet telles quelles.

Image onglet2Import


Détails sur l'import des données dans un projet


Stratégie générale

Lorsque les données sont préexistantes dans le projet, une mise à jour de ces données est effectuée. Sinon, elles sont ajoutées, en conservant les références avec l'existant. Pour les propriétés des données, les données mises à jour conservent les informations du créateur et les données nouvelles ont comme créateur l'utilisateur en cours.

Avant l'import des données, l'utilisateur peut choisir des options qui sont valables en cas de conflit avec les données existantes dans le projet courant :


Gestion des suppressions

Avant l'import de données, l'utilisateur peut choisir des options qui lui permettront de supprimer les données de son projet qui ne sont pas dans le document XML. Il faut noter que ces options entraînent une suppression des données avant tout import du document XML, elles peuvent donc permettre de supprimer des conflits. La première option permet de supprimer toutes les données du projet qui n'apparaissent pas dans le document d'import. Cette option ne concerne pas les actions et les données relatives aux actions. Si l'utilisateur veut supprimer ces informations, il doit cocher la deuxième option. Les deux options de suppressions peuvent être actives ou inactives indépendamment l'une de l'autre.


Projet

Pour le projet, les données suivantes qui ne sont pas dans le document XML sont supprimées :


Tests

Dans le plan de tests, on supprime également les différentes données qui n'apparaissent pas dans le document XML :

Pour les tests manuels, si la suppression des actions est effectuée, les paramètres du test qui ne sont plus utilisés du fait de cette action, sont également supprimés.


Campagnes

Pour les campagnes, la stratégie est un peu différente. En effet, lorsque l'utilisateur crée des exécutions, un nom est proposé à l'utilisateur. Le nom des exécutions peut donc être identique dans le fichier XML et dans le projet Salomé mais en fait correspondre à deux exécutions différentes. Lors de l'import des données, deux exécutions seront alors créées, l'exécution présente dans le projet Salomé ne doit donc pas être modifiée. Le raisonnement est identique pour les résultats d'exécution, l'outil proposant également un nom de résultat par défaut lors de la création de ce résultat.

Les données supprimées sont :


Importer des données dans un projet Salomé

Lors de l'import, les données non présentes dans le projet sont ajoutées, sinon elles sont mises à jour.


Projet

Les paramètres du projet qui n'étaient pas présents dans le projet sont ajoutés, sinon leur description est mise à jour.

Pour les environnements, les données ajoutées ou mises à jour sont :


Tests

Pour les familles de test, il n'y a aucune précaution particulière à prendre, les données sont ajoutées ou mises à jour suivant les cas. Les données qui concernent les familles sont leur nom et leur description.

Les données à mettre à jour ou à ajouter pour les suites de tests sont leur nom, leur description et leurs éventuels attachements.

Pour les tests eux-mêmes, deux cas sont possibles :


Campagnes

La stratégie générale d'import des données est la même que pour les tests, mais il existe quelques différences au niveau de la gestion des jeux de données, des exécutions et des résultats d'exécution, dues au fait que l'outil propose des noms par défaut pour ces différentes données.

Par ailleurs, une vérification de la présence ou non d'un conflit est effectuée avant tout import de données. Un conflit est détecté lorsque la campagne qui doit être importée a le même nom qu'une campagne du projet, mais elle contient de nouveaux tests. Si un conflit est détecté, l'import s'effectue en fonction de l'option sélectionnée par l'utilisateur.

Pour les campagnes, les ajouts et les mises à jour concernent la description des campagnes, ses attachements, les jeux de données qui lui sont associées ainsi que les tests qui lui appartiennent. Pour les jeux de données, il faut vérifier que ceux qui ont le même nom sont exactement les mêmes. Pour cela, on vérifie que les différents paramètres valués dans les jeux de données du projet et du document XML sont les mêmes et qu'ils ont la même valeur. S'ils se révèlent différents, alors on crée un nouveau jeu de données avec le même nom que l'ancien suffixé par "_Bis".

Pour les mises à jour des données d'une exécution, il faut vérifier que les exécutions qui ont le même nom dans le document XML et dans le projet sont vraiment les mêmes. On vérifie donc que l'exécution analysée possède exactement le même jeu de données avec les mêmes valeurs pour chaque paramètre. Une vérification est également faite au niveau de l'environnement et des scripts de l'exécution. Si les exécutions s'avèrent différentes, on en crée alors une autre qui aura comme nom le même nom que l'exécution de départ suffixé par "_Bis".

Pour les résultats d'exécution, comme l'outil propose également des noms par défaut, il faut vérifier que les résultats sont identiques. Pour cela, une recherche des différences est effectuée au niveau des résultats d'exécution des tests, mais aussi au niveau des résultats des exécutions de chaque action s'il s'agit d'un test manuel. Comme pour les jeux de données et les exécutions, si les résultats d'exécutions sont différents, on crée un autre résultat d'exécution avec comme nom l'ancien résultat d'exécution suffixé par "_Bis".

À propos de ce document...

Plugin Gendoc

This document was generated using the LaTeX2HTML translator Version 2002-2-1 (1.71)

Copyright © 1993, 1994, 1995, 1996, Nikos Drakos, Computer Based Learning Unit, University of Leeds.
Copyright © 1997, 1998, 1999, Ross Moore, Mathematics Department, Macquarie University, Sydney.

The command line arguments were:
latex2html -split 1 -no_navigation -dir ../.././src_gendoc/plugins/gen_doc_xml/docs/html/fr -no_footnode fr/gen_doc_xml.tex

The translation was initiated by on 2006-05-17


2006-05-17