Konfigurieren Sie SonarQube-Scans in Pipelines Azure DevOps .

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 3 Minuten Lesedauer

    • Konfigurieren Sie SonarQube- oder SonarCloud-Scans in MS-Pipelines Azure DevOps. Überprüfen Sie die Ausführungen der Pipeline Azure DevOps auf SonarQube-Scans in jeder Phase der Ausführung der Pipeline, und rufen Sie Listen und Details von Scans aus jeder Phase bis DevOps Change-Geschwindigkeitab. Drilldown für die Scan-Details basierend auf Kategorien.

    Vorbereitungen

    Stellen Sie sicher, dass Sie die folgenden Voraussetzungen erfüllen, bevor Sie SonarQube-Scans in der Pipeline Azure DevOps konfigurieren:
    • Sie verwenden eine kompatible SonarQube-Version. Unterstützte Toolversionen finden Sie unter DevOps Change-Geschwindigkeit-Integrationen.
    • Stellen Sie eine Verbindung her, konfigurieren Sie das Tool Azure DevOps, und erkennen Sie vorhandene Repositorys, Orchestration-Aufgaben und Pipelines.
    • Erstellen Sie einen SonarQube-Tool-Datensatz. Weitere Informationen finden Sie unter Integration von DevOps Change-Geschwindigkeit in SonarQube.
    • Installieren Sie die SonarQube-Erweiterung aus dem Visual Studio Marketplace, und konfigurieren Sie die Verzweigungsanalyse, um die Azure DevOps-Aufgaben in Ihren Builddefinitionen zum Analysieren Ihrer Projekte zu verwenden. Weitere Informationen finden Sie in der SonarQube-Dokumentation.
    • Installieren Sie die folgenden anwenderdefinierten Erweiterungsaufgaben in Ihrer Instanz Azure DevOps.
    Erforderliche Rolle:
    • admin oder sn_devops.admin in DevOps Change-Geschwindigkeit
    • Administrator in Azure DevOps
    • -Administratorrolle in SonarQube mit Zugriff auf alle Projekte, für die SonarQube-Scans konfiguriert sind.

    Warum und wann dieser Vorgang ausgeführt wird

    Standardmäßig bietet Ihnen Azure DevOps die folgenden Aufgaben zum Ausführen eines SonarQube-Scans für Build- und Release-Pipelines:
    • Bereiten Sie die Analyse in SonarCloud vor
    • Codeanalyse ausführen
    • Veröffentlichen Sie das Quality-Gate-Ergebnis
    Fügen Sie anwenderdefinierte ServiceNow -Erweiterungsaufgaben in der Reihenfolge zu den Standardaufgaben hinzu, und konfigurieren Sie sie, um die Scan-Details für ServiceNow DevOps aus den Build- und Release-Pipelines von Azure DevOps abzurufen. Folgende Scan-Details werden abgerufen:
    • pipelineName
    • buildNumber
    • stageName
    • branchName
    • sonarProjectKey
    • sonarInstanceUrl

    Prozedur

    1. Richten Sie die Integration Azure DevOps und Sonarein, und konfigurieren Sie die Qube-Integration, um Scan-Analysen aus Build-Pipelines abzurufen.
      1. Navigieren Sie in der Azure DevOps -Konsole zu Organisation > SonarIntegrations > Pipelines > Aufträgean.
      2. Klicken Sie auf das Symbol Aufgaben hinzufügen ( Zusätzliche Aufgaben hinzufügen), und suchen Sie in der Suchleiste Aufgaben hinzufügen nach den Erweiterungen ServiceNow.
      3. Fügen Sie die folgenden Aufgaben hinzu.
        • ServiceNow DevOps Erstellen Sie die Aufgabe „Sonar-Registrierung“.
        • ServiceNow DevOps Release-Sonar-Registrierungsaufgabe.
      4. Füllen Sie die Felder des Formulars aus.
        Tabelle : 1. ServiceNow DevOps Build/Release-Sonar-Registrierung
        Feld Beschreibung
        Anzeigename Wird bei Eingabe des Schlüssels und der URL automatisch ausgefüllt.
        ServiceNow Endpunkt Der Endpunkt der Instanz ServiceNow, der während der Toolkonfiguration automatisch erstellt wird. Verwenden Sie dieselbe Serviceverbindung für diese Aufgabe.
        Sonar-Projektschlüssel Geben Sie den gleichen Projektschlüsselwert ein, den Sie bei der Konfiguration der Aufgabe Analyse in SonarCloud vorbereiten verwendet haben.
        Sonar-Instanz-URL Geben Sie die URL ein, die Sie verwendet haben, um bei der Toolerstellung eine Verbindung zum Sonar-Tool herzustellen.
        Auftragsname Der Name des Pipelineauftrags Azure DevOps.

        Dieses Feld wird nur für die Aufgabe „ServiceNow DevOps-Release-Sonar-Registrierung“ angezeigt.
        Wichtig:
        Stellen Sie in der Liste der Aufgaben für den Pipeline-Auftrag sicher, dass die Aufgabe „ ServiceNow DevOps Build-Sonar-Registrierung “ oder „ServiceNow DevOps-Release-Sonar-Registrierung“ nach der Aufgabe „ Codeanalyse ausführen“ hinzugefügt wird.
      Sie haben die Build-Pipelines so konfiguriert, dass Sonar-Scan-Ergebnisse an Ihre Anwendung DevOps gesendet werden. Scan-Ergebnisse werden der Softwarequalitäts-Fähigkeit zugeordnet und von einem zugehörigen Basissystem-Subflow (FetchSonarScanId) verarbeitet, sobald ein Ereignis erstellt und in der Tabelle „Eingehende Ereignisse“ verarbeitet wird.
    2. Ordnen Sie Azure Pipelines-Schritte in DevOps zu.
    3. Führen Sie die Pipeline aus.

    Ergebnisse

    Basierend auf den Scan-Ergebnissen in verschiedenen Phasen der Pipeline-Ausführung werden die Ergebnisse im entsprechenden Schritt der Pipeline in ServiceNow DevOpsangezeigt. Eingehende Ereignisse werden für Benachrichtigungen erstellt, und Subflows werden basierend auf dem Benachrichtigungstyp und der Fähigkeit ausgelöst.

    Nächste Maßnahme

    • Zeigen Sie Scan-Details als Teil von Aufgabenausführungen an. Zeigen Sie Details aller Sonar-Scans an, die Teil der Aufgabenausführung sind, die einem Build- oder Release-Pipeline-Ausführungsschritt zugeordnet ist.
      1. Navigieren zu DevOps > Orchestrieren > Aufgabenausführung Klicken Sie auf einen relevanten Aufgabenausführungs-Datensatz.
      2. Klicken Sie auf die zugehörige Liste „Zusammenfassung der Softwarequalität“.
      3. Klicken Sie auf einen relevanten Scan-ID-Datensatz.
      Die Softwarequalitätsprüfungszusammenfassung und die Scandetails werden angezeigt.
    • Zeigen Sie Scan-Details als Teil der Change-Anforderung an. Zeigen Sie alle Scans an, die Teil dieser Build-/Release-Pipeline waren, in der Softwarequalitätsergebnisse > Softwarequalitätszusammenfassung Zugehörige Liste.
      1. Navigieren zu DevOps > Orchestrieren > Pipeline-Change-Anforderungen
      2. Klicken Sie auf die zugehörige Liste „Zusammenfassung der Softwarequalität“.
      3. Klicken Sie auf einen relevanten Scan-ID-Datensatz.
      Die Softwarequalitätsprüfungszusammenfassung und die Scandetails werden angezeigt.