Configurer les scans SonarQube sur Jenkins les pipelines

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture
  • Configurer les scans SonarQube sur Jenkins les pipelines.

    Avant de commencer

    Assurez-vous de répondre aux conditions préalables suivantes avant de configurer vos pipelines Jenkins pour les analyses SonarQube
    • SonarCloud ou SonarQube version 8.6.1 édition communautaire
    • SonarQube Scanner pour Jenkins 2.4 ou supérieur est installé sur votre instance/environnement Jenkins.
    • ServiceNow DevOps version du module d’extension 1.27 ou ultérieure pour Jenkins.
    • Assurez-vous que les analyses SonarQube sont configurées et existent sur vos Jenkins pipelines à l’aide du plugin SonarQube Scanner pour Jenkins. Pour plus d'informations, consultez
    • Un outil SonarQube est créé et est connecté au serveur SonarQube. Pour plus d'informations, consultez SonarQube intégration avec Changements de vélocité DevOps.
    Rôle requis : sn_devops.admin

    Pourquoi et quand exécuter cette tâche

    Lorsque vous exécutez un pipeline qui comporte des exécutions d’analyse SonarQube , les détails sont extraits ServiceNow DevOps du Jenkins pipeline. À l’aide du module d’extensionJenkins, nous vérifions si l’exécution de l’analyse est configurée dans le pipeline et vérifions les analyses SonarQube à chaque étape de l’orchestrationJenkins, à l’aide de la balise withSonarQubeEnv. Si une analyse SonarQube a eu lieu à n’importe quelle étape de l’exécution du pipeline, dans le cadre de notre notification de fin, nous ajoutons un modèle avec les détails scanID et URL pour chaque analyse qui se produit dans une étape particulière. Ces analyses ou détails d’analyse sont corrélés et affichés dans la liste connexe Résumé de la qualité logicielle à partir des demandes de changement et des exécutions de tâches.

    Procédure

    1. Dans Jenkins, accédez à Gérer Jenkins > Configurer le système, cochez la case Activer l’injection de la configuration du serveur SonarQube en tant que variables d’environnement de compilation dans la section Serveurs SonarQube , et remplissez les champs.
      Tableau 1. SonarQube Installations
      Champ Description
      Nom Nom unique pour la configuration/le projet.
      URL serveur URL ou adresse IP du serveur SonarQube.
      Authentification du serveur Sélectionnez le type de jeton d’authentification approprié pour la configuration.
      Remarque :
      Utilisez ces mêmes détails ou valeurs de serveur SonarQube lors de la création des outils SonarQube dans ServiceNow DevOps et dans le Jenkins pipeline.
    2. Cliquez sur Test de la connexion.
      Vérifiez que le message de réussite de connexion s’affiche.
    3. Cliquez sur Appliquer et enregistrer.
    4. Exécutez le pipeline.

    Résultats

    En fonction des résultats de l’analyse à différentes étapes de l’exécution du pipeline, les résultats sont affichés à l’étape correspondante du pipeline. Des événements entrants sont créés pour les notifications et des flux secondaires sont déclenchés en fonction du type et de l’aptitude de notification.

    Que faire ensuite

    Remarque :

    Accédez à l’interface utilisateur du pipeline pour afficher les détails de l’analyse sous le Qualité > Résultats de qualité logicielle.

    • Affichez les détails de l’analyse dans le cadre des exécutions de tâches. Affichez les détails de toutes les analyses Sonar qui font partie de l’exécution de la tâche mappée à une étape d’exécution de pipeline de version ou de mise en production.
      1. Accédez à la DevOps > Orchestrer > Exécution de tâches cliquez sur un enregistrement d’exécution de tâche pertinent.
      2. Cliquez sur la liste connexe Résumé de la qualité logicielle.
      3. Cliquez sur un enregistrement d’ID d’analyse pertinent.
      Le résumé de l’analyse de la qualité logicielle et les détails de l’analyse s’affichent.
    • Affichez les détails de l’analyse dans le cadre de la demande de changement. Afficher toutes les analyses qui faisaient partie de ce pipeline de version/mise en production dans le Résultats de qualité logicielle > Résumé de la qualité logicielle liste connexe.
      1. Accédez à la DevOps > Orchestrer > Demandes de changement de pipeline
      2. Cliquez sur la liste connexe Résumé de la qualité logicielle.
      3. Cliquez sur un enregistrement d’ID d’analyse pertinent.
      Le résumé de l’analyse de la qualité logicielle et les détails de l’analyse s’affichent.