Configurer les scans SonarQube sur Azure DevOps les pipelines

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture
  • Configurez les scans SonarQube ou SonarCloud sur les pipelines MS Azure DevOps . Vérifiez Azure DevOps les exécutions du pipeline pour les analyses SonarQube à chaque étape de l’exécution du pipeline et extrayez les listes et les détails des analyses de n’importe quelle étape vers Changements de vélocité DevOps. Explorez les détails de l’analyse en fonction des catégories.

    Avant de commencer

    Assurez-vous de remplir les conditions préalables suivantes avant de configurer les analyses SonarQube sur votre Azure DevOps pipeline :
    • Vous utilisez une version compatible de SonarQube. Consultez la rubrique Intégrations de Changements de vélocité DevOps pour connaître les versions d’outils prises en charge.
    • Connectez, configurez l’outil Azure DevOps et détectez les référentiels, tâches d’orchestration et pipelines existants.
    • Créez un enregistrement d’outil SonarQube. Pour plus d'informations, consultez SonarQube intégration avec Changements de vélocité DevOps.
    • Installez l’extension SonarQube à partir de Visual Studio Marketplace et configurez l’analyse de branche pour utiliser les tâches Azure DevOps dans vos définitions de version afin d’analyser vos projets. Pour plus d’informations, consultez la documentation de SonarQube.
    • Installez les tâches d’extension personnalisées suivantes sur votre Azure DevOps instance.
    Rôle requis :
    • admin ou sn_devops.admin dans Changements de vélocité DevOps
    • administrateur dans Azure DevOps
    • rôle d’administrateur dans SonarQube avec accès à tous les projets sur lesquels les scans SonarQube sont configurés.

    Pourquoi et quand exécuter cette tâche

    Par défaut, Azure DevOps vous fournit les tâches suivantes pour exécuter une analyse SonarQube sur les pipelines de build et de release :
    • Préparer l’analyse sur SonarCloud
    • Exécuter l’analyse de code
    • Publier le résultat de la porte de qualité
    Ajoutez et configurez des tâches d’extension personnalisées ServiceNow afin qu’elles soient des tâches par défaut, afin d’extraire les détails de l’analyse à ServiceNow DevOps partir des pipelines de version et de mise en Azure DevOps production. Les détails de l’analyse qui sont récupérés sont les suivants :
    • pipelineName
    • buildNumber
    • nom d’étape
    • branchName
    • sonarProjectKey
    • sonarInstanceUrl

    Procédure

    1. Installez et configurez l’intégration et SonarQube pour extraire l’analyse Azure DevOps d’analyse à partir des pipelines de version.
      1. Dans la Azure DevOps console, accédez à Organisation > SonarIntegrations > Pipelines > Tâches.
      2. Cliquez sur l’icône Ajouter des tâches ( Ajouter des tâches supplémentaires) et recherchez les ServiceNow extensions dans la barre de recherche Ajouter des tâches .
      3. Ajoutez les tâches suivantes.
        • ServiceNow DevOps Construire la tâche d’enregistrement Sonar.
        • ServiceNow DevOps Tâche Libérer l’enregistrement Sonar.
      4. Renseignez les champs du formulaire.
        Tableau 1. ServiceNow DevOps Construire/mettre en production l’enregistrement de Sonar
        Champ Description
        Nom d'affichage Se remplit automatiquement en entrant la clé et l’URL.
        ServiceNow extrémité Point ServiceNow de terminaison d’instance qui est automatiquement créé pendant la configuration de l’outil. Utilisez la même connexion de service pour cette tâche.
        Clé du projet Sonar Entrez la même valeur de clé de projet que celle que vous avez utilisée lors de la configuration de la tâche Préparer l’analyse sur SonarCloud .
        URL de l’instance Sonar Entrez la même URL que celle que vous avez utilisée pour vous connecter à l’outil Sonar lors de la création de l’outil.
        Nom de la tâche Nom de la Azure DevOps tâche de pipeline.

        Ce champ s’affiche uniquement pour la tâche d’inscription ServiceNow DevOps Release Sonar .

        Important :
        Dans la liste des tâches de la tâche de pipeline, assurez-vous que la tâche d’enregistrement ServiceNow DevOps Build Sonar ou d’inscription ServiceNow DevOps Release Sonar est ajoutée après la tâche Exécuter l’analyse du code .
      Vous avez configuré les pipelines de version pour envoyer les résultats de l’analyse du sonar à votre DevOps application. Les résultats de l’analyse sont mappés à l’aptitude de qualité logicielle sont traités par un flux secondaire du système de base associé (FetchSonarScanId), une fois qu’un événement est créé et traité dans la table Événements entrants.
    2. Associer les étapes de pipelines Azure dans DevOps.
    3. Exécutez le pipeline.

    Résultats

    Sur la base 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 dans ServiceNow DevOps. 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

    • 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.