Couverture de Jacoco dans le pipeline de Jenkins

Question

Quelqu'un peut-il me dire s'il existe un moyen d'exécuter Jacoco dans un pipeline Jenkins ? J'ai téléchargé le plugin mais je n'ai pas l'option pour Jacoco dans le 'Pipeline Syntax', qui est le Pipeline script aide .

A référencé cette URL : https://wiki.jenkins-ci.org/display/JENKINS/JaCoCo+Plugin qui n'a pas d'information pour un pipeline jenkins jacoco

Answer 1

La configuration des étapes de jacoco pipeline utilise ce format :

step([$class: 'JacocoPublisher', 
      execPattern: 'target/*.exec',
      classPattern: 'target/classes',
      sourcePattern: 'src/main/java',
      exclusionPattern: 'src/test*'
])

Ou avec une syntaxe plus simple pour le pipeline déclaratif :

jacoco( 
      execPattern: 'target/*.exec',
      classPattern: 'target/classes',
      sourcePattern: 'src/main/java',
      exclusionPattern: 'src/test*'
)

Vous trouverez d'autres options dans la section Référence des étapes du pipeline JaCoCo

Answer 2

Après avoir cherché sur Internet un exemple simple de la façon de procéder, j'ai fini par trouver l'outil "step" dans notre instance Jenkins.

Il sait comment générer des extraits de code du pipeline Jenkinsfile en fonction des plugins et des modules que vous avez installés.

En résumé, l'entrée de base ressemble à ceci :

stage('Build') {
     steps {
        sh './jenkins_build.sh'
        junit '*/build/test-results/*.xml'
        step( [ $class: 'JacocoPublisher' ] )
     }
}

La documentation de Jenkins a vraiment besoin d'une mise à jour avec quelques exemples en une ligne.

Answer 3

À partir de la version 2.2.1 du plugin Jacoco, vous pouvez désormais utiliser les éléments suivants jacoco(execPattern: 'target/jacoco.exec')

Personnellement, j'ai plusieurs fichiers Jacoco différents pour différentes exécutions et je voulais prendre en charge à la fois Maven et Gradle (donc build/ et target/ ), j'utilise donc jacoco(execPattern: '**/*.exec') .

Référence : https://github.com/jenkinsci/jacoco-plugin/pull/83

Answer 4

Si vous jetez un coup d'oeil sur un liste des plugins compatibles avec le pipeline vous verrez que le plugin Jenkins JaCoCo a été rendu compatible mais sans aucune mise à jour de la documentation, sauf entrée dans le journal des modifications :

Version 2.1.0 (29 septembre 2016)

JENKINS-27120 Ajout de la prise en charge du flux de travail pour l'éditeur JaCoCo

probablement parce que son utilisation est simple et similaire à celle de nombreuses autres étapes :

step([$class: 'JacocoPublisher', ...])

Answer 5

La meilleure façon d'utiliser Jacoco jenkins est de se charger de la génération de l'exécutable ( jacoco.exec ) dans l'application, puis de pointer l'emplacement de ce fichier dans le pipeline. Bien que pour un projet multi-modules, la configuration serait légèrement différente, référez-vous à : Couverture de code Jacoco pour un projet maven multi-modules

Jenkins Pipeline ressemblerait à :

jacoco(
    execPattern: '**/path_to_file/jacoco.exec',
    classPattern: '**/coverage/**',
    sourcePattern: '**/coverage/**',
    inclusionPattern: '**/*.class'
)