Création de votre plug-in de couverture de code

Cette rubrique décrit comment créer un plug-in de couverture de code. Vous devez maîtriser le concept de lotissement Silk Central. Dans Silk Central, un lotissement est requis avant chaque exécution. Un lotissement comprend tous les espaces de noms/packages/classes/méthodes dans l'application testée.

Remarque : L'API Silk Central requiert un fichier XML pour pouvoir être retournée dans le cadre d'exécutions de couverture de code. Cela signifie que si votre outil de couverture de code stocke les informations associées dans une base de données, vous devrez effectuer des étapes supplémentaires pour récupérer les données.
Remarque : L'exécution simultanée de tests dans le même atelier d'analyse de code par plusieurs serveurs d'exécution n'est pas prise en charge.
  1. Ajoutez la bibliothèque scc.jar à votre classpath, car elle comporte les interfaces devant être étendues. Le fichier JAR se trouve dans le répertoire lib du répertoire d'installation de Silk Central.
  2. Ajoutez les deux déclarations d'import suivantes : 
    import com.segue.scc.published.api.codeanalysis.CodeAnalysisProfile;
import com.segue.scc.published.api.codeanalysis.CodeAnalysisProfileException;
import com.segue.scc.published.api.codeanalysis.CodeAnalysisResult;
  3. Créez une classe qui implémente CodeAnalysisProfile.
  4. Ajoutez toutes les méthodes requises à partir de l'interface de couverture de code et répertoriées dans les étapes suivantes. Vous pouvez vous reporter à l'élément Exemple de classe d'interface pour connaître sa définition et implémenter manuellement les méthodes. À défaut, vous pouvez copier et coller la rubrique Exemple de classe d'interface, qui inclut les imports et les définitions de méthode.
    Remarque : Les méthodes des étapes suivantes que vous écrirez sont appelées par Silk Central lorsqu'elles sont requises. Cela signifie que vous ne les appellerez pas directement.
  5. Code getBaseline. Cette méthode doit renvoyer un fichier XML comprenant tous les espaces de noms/packages/classes/méthodes dans l'application. Reportez-vous au fichier de la rubrique Exemple de données XML pour plus d'informations sur le format du fichier. Vous devez valider le fichier XML à l'aide de l'exemple de fichier XSD. Reportez-vous à la rubrique Fichier XSD de couverture de code pour en savoir plus sur le fichier XSD.

    Cette fonction est appelée avant le démarrage de la couverture. Elle se déclenche lorsque le serveur d'exécution Silk Central démarre une exécution de test afin de lancer l'analyse de code et renvoyer tous les objets à couvrir. Le résultat doit être converti dans un fichier XML à l'aide du format spécifié dans le schéma XML inclus dans le dossier d'installation de CA-Framework.

  6. Code startCoverage. Cet appel doit indiquer à votre outil de couverture de code de démarrer la collecte des données. Renvoie la valeur Vrai en cas de démarrage.

    Cet appel est lancé par l'atelier de couverture de code Silk Central lorsque la méthode getBaseLine() est terminée. Vous devez y démarrer votre outil de couverture de code, qui collectera les données de couverture de code.

  7. Code stopCoverage. Cet appel doit indiquer à votre outil de couverture de code d'arrêter la collecte des données. Renvoie la valeur Vrai en cas de réussite.

    Cet appel est lancé après startCoverage ; il est déclenché par le serveur d'exécution Silk Central terminant une exécution de test afin d'arrêter l'analyse de code.

  8. Code getCoverage. Renvoie un fichier XML comportant les données collectées entre les méthodes startCoverage et stopCoverage. Reportez-vous à la rubrique Exemple de données XML pour plus d'informations sur le format du fichier. Vous devez valider le fichier XML à l'aide de l'exemple de fichier XSD. Reportez-vous à la rubrique Fichier XSD de couverture de code pour en savoir plus sur le fichier XSD.

    Cette fonction est appelée après stopCoverage() et renvoie toutes les données de couverture collectées. Le résultat doit être converti au format XML à l'aide du format spécifié dans le schéma XML.

  9. Code GetName. Doit indiquer le nom qui sera utilisé pour désigner l'outil de couverture de code. Par exemple, cette valeur sera utilisée comme l'une des valeurs dans la liste Profil d'Analyse de Code de la boîte de dialogue Modifier les Paramètres d'Analyse de Code.

    Celle-ci est appelée en premier lieu par l'atelier d'analyse de code Silk Central. Le nom du plug-in s'affiche dans la liste de couverture de code de Silk Central.

  10. Placez le plug-in dans un fichier .jar et insérez ce dernier dans un fichier .zip.
  11. Déployez votre plug-in aux emplacements suivants :
    • Dans le répertoire Plugins du dossier d'installation de Silk Central.
    • Dans le répertoire Plugins du dossier d'installation de CA-Framework.
Sujet parent : Intégration de couverture de code