Konfigurieren Sie SonarQube-Scans in Pipelines Jenkins .

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer

    • Konfigurieren Sie SonarQube-Scans in Pipelines Jenkins.

    Vorbereitungen

    Stellen Sie sicher, dass Sie die folgenden Voraussetzungen erfüllen, bevor Sie Ihre Jenkins-Pipelines für Sonar-ScansQube konfigurieren
    • Community-Edition von SonarCloud oder SonarQube Version 8.6.1
    • SonarQube Scanner für Jenkins 2.4 oder höher ist in Ihrer Jenkins-Instanz/Umgebung installiert.
    • ServiceNow DevOps Plugin-Version 1.27 oder höher für Jenkins.
    • Stellen Sie sicher, dass SonarQube -Scans konfiguriert sind und in Ihren Jenkins -Pipelines vorhanden sind, indem Sie das Plugin „SonarQube Scanner“ für Jenkins verwenden. Weitere Informationen finden Sie unter
    • Ein SonarQube-Tool wird erstellt und mit dem SonarQube-Server verbunden. Weitere Informationen finden Sie unter Integration von DevOps Change-Geschwindigkeit in SonarQube.
    Erforderliche Rolle: sn_devops.admin

    Warum und wann dieser Vorgang ausgeführt wird

    Wenn Sie eine Pipeline mit SonarQube -Scanausführungen ausführen, werden die Details aus der Pipeline ServiceNow DevOps in Jenkins abgerufen. Mit dem Plugin Jenkins überprüfen wir, ob die Scan-Ausführung in der Pipeline Jenkins konfiguriert ist, und suchen in jeder Orchestration-Phase mithilfe des Tags „withSonarQubeEnv“ nach Sonar-ScansQube. Wenn in einer beliebigen Phase der Ausführung der Pipeline eine Sonar-AnalyseQube-Analyse stattgefunden hat, fügen wir als Teil unserer Endbenachrichtigung ein Modell mit scanID- und URL- Details für jeden Scan in einer bestimmten Phase hinzu. Diese Scan-Analysen oder Details werden korreliert und in der zugehörigen Liste „Zusammenfassung der Softwarequalität“ unter Change-Anforderungen und Aufgabenausführungen angezeigt.

    Prozedur

    1. Navigieren Sie in Jenkins zu Verwalten Sie Jenkins > Konfigurieren Sie das System, aktivieren Sie im Abschnitt SonarQube-Server das Kontrollkästchen Einschleusung der SonarQube-Serverkonfiguration als Build-Umgebungsvariablen aktivieren, und füllen Sie die Felder aus.
      Tabelle : 1. SonarQube-Installationen
      Feld Beschreibung
      Name Ein eindeutiger Name für die Konfiguration/das Projekt
      Server-URL URL oder IP-Adresse des SonarQube-Servers.
      Serverauthentifizierung Wählen Sie den entsprechenden Authentifizierungstokentyp für die Konfiguration aus.
      Hinweis:
      Verwenden Sie dieselben SonarQube-Serverdetails oder -Werte, wenn Sie die SonarQube -Tools in ServiceNow DevOps sowie in der Pipeline Jenkins erstellen.
    2. Klicken Sie auf Verbindung testen.
      Vergewissern Sie sich, dass die Meldung „Verbindung erfolgreich“ angezeigt wird.
    3. Klicken Sie auf Übernehmen und Speichern.
    4. 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 angezeigt. Eingehende Ereignisse werden für Benachrichtigungen erstellt, und Subflows werden basierend auf dem Benachrichtigungstyp und der Fähigkeit ausgelöst.

    Nächste Maßnahme

    Hinweis:

    Navigieren Sie zur Pipeline-UI, um die Scan-Details unter anzuzeigen Qualität > Softwarequalitätsergebnisse.

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