Versenden von E-Mail-Benachrichtigungen mit Polyspace Bug Finder Server-Ergebnissen

Wenn Sie eine Polyspace^®-Analyse als Teil der kontinuierlichen Integration durchführen, erzeugt jede neue Codeübermittlung neue Ergebnisse. Sie sehen nicht nur neue Ergebnisse in den abgeänderten Komponenten, sondern auch in den Komponenten, die von den abgeänderten Komponenten abhängig waren. Sie können E-Mail-Benachrichtigungen einrichten, damit Komponentenverantwortliche benachrichtigt werden, wenn neue Polyspace-Ergebnisse in ihren Komponenten erscheinen.

Erstellen von E-Mail-Benachrichtigungen

So erstellen Sie E-Mail-Benachrichtigungen:

Exportieren Sie neue Analyseergebnisse in eine tabulatorgetrennte Textdatei (.tsv-Format). Für jedes Ergebnis enthält die Datei Links, über die das Ergebnis in der Polyspace Access-Weboberfläche geöffnet werden kann.
Wenden Sie Filter an, um bestimmte Arten von Ergebnissen zu exportieren, beispielsweise schwerwiegende Fehler. Bei Bedarf können Sie mithilfe von Such- und Ersetzungsfunktionen zusätzliche Filter auf die exportierten Dateien anwenden. Siehe Exportieren der Ergebnisse als E-Mail-Anhänge.
Senden Sie eine E-Mail mit der Ergebnisdatei im Anhang.
Wenn Sie beispielsweise ein E-Mail-Plugin in Jenkins verwenden, können Sie einen Schritt nach dem Build erstellen, um nach Abschluss der Analyse eine E-Mail zu versenden.

Wenn Sie das Polyspace-Plugin in Jenkins verwenden, können Sie die Polyspace-Hilfsprogramme für den gesamten E-Mail-Benachrichtigungsprozess nutzen. Siehe Sample Scripts for Polyspace Analysis with Jenkins.

Alternativ können Ergebnisse anhand ihrer Dateipfade direkt den Verantwortlichen zugewiesen werden. Sie können E-Mail-Benachrichtigungen einrichten, die eine separate Ergebnisdatei pro Verantwortlichem exportieren und jedem Verantwortlichen eine E-Mail mit der entsprechenden Ergebnisdatei im Anhang senden. Siehe Zuweisen von Verantwortlichen und Exportieren zugewiesener Ergebnisse.

Voraussetzungen

So führen Sie dieses Tutorial aus:

Sie müssen einige Ergebnisse auf den Polyspace Access™-Webserver hochgeladen haben. Wenn Sie das Tutorial Ausführen von Polyspace Bug Finder auf Servern und Hochladen der Ergebnisse in die Webschnittstelle abgeschlossen haben, sollten Sie einen Ordner testProject im Fensterbereich Project Explorer der Polyspace Access-Weboberfläche sehen. Der Ordner enthält ein Projekt mit dem Namen myFirstProject.
Um die Ergebnisse im Projekt mit myFirstProject ausgewählten Elementen anzuzeigen, klicken Sie bitte auf die Schaltfläche Review. Sie sehen eine Liste mit Fehlern. Die Spalte Information zeigt die Auswirkungen der Fehler. In diesem Tutorial werden nur schwerwiegende Fehler für E-Mail-Anhänge exportiert.
Sie müssen in der Lage sein, über die Befehlszeile mit der Polyspace Access-Schnittstelle zu interagieren. Navigieren Sie beispielsweise zu polyspaceserverroot\polyspace\bin und geben Sie Folgendes ein:
polyspace-access login -list-project
Hier ist polyspaceserverroot der Installationsordner Polyspace Bug Finder™ Server™, beispielsweise C:\Program Files\Polyspace Server\R2025b. Die Variable login bezieht sich auf die folgende Kombination von Optionen. Sie stellen diese Optionen bei jeder Verwendung des Befehls polyspace-access bereit.
-host hostName -port portNumber -login username -encrypted-password pwd
Hier ist hostName der Name des Polyspace Access-Webservers. Verwenden Sie für einen lokal gehosteten Server localhost. portNumber ist die optionale Portnummer des Servers. Wenn Sie die Portnummer weglassen, wird 9443 verwendet. username und pwd beziehen sich auf den Login und eine verschlüsselte Version Ihres Passworts. Um ein verschlüsseltes Passwort zu erstellen, geben Sie Folgendes ein:
polyspace-access -encrypt-password
Kopieren Sie das verschlüsselte Passwort und geben Sie dieses Passwort bei späteren Verwendungen des Befehls polyspace-access an.

Exportieren der Ergebnisse als E-Mail-Anhänge

Sie können alle Ergebnisse eines Projekts oder nur bestimmte Arten von Ergebnissen exportieren.

Öffnen Sie ein Befehlsfenster. Navigieren Sie zu dem Ordner, in den Sie die Ergebnisse exportieren möchten.

Um alle Ergebnisse zu exportieren, geben Sie Folgendes ein:

polyspace-access login -export testProject/myFirstProject -output .\result.txt

Um nur Fehler mit hoher Auswirkung zu exportieren, geben Sie Folgendes ein:

polyspace-access login -export testProject/myFirstProject -defects High -output .\result_high_impact.txt

Öffnen Sie jede Textdatei in einem Tabellenkalkulationsprogramm wie beispielsweise Microsoft^® Excel^®. In der ersten Datei werden alle Fehler angezeigt, in der zweiten Datei hingegen nur die Fehler mit hoher Auswirkung. Anstelle von -defects High können Sie auch andere Filter anwenden. Beispiel:

Um nur neue Fehler im Vergleich zur vorherigen Analyse desselben Projekts anzuzeigen, verwenden Sie die Option -new-findings.
Um eine detailliertere Filterung vorzunehmen, können Sie Software-Qualitätsziele (SQOs) verwenden. Die Software-Qualitätsziele werden durch eine Reihe von SQO-Stufen festgelegt, die von 1 bis 6 nummeriert sind und zunehmend strengere Anforderungen stellen. Sie können die Anforderungen für jede Stufe in der Polyspace Access-Weboberfläche anpassen und anschließend die Option -open-findings-for-sqo mit der Stufennummer verwenden, um nur die Ergebnisse zu exportieren, die überprüft werden müssen, um die Anforderungen zu erfüllen. Siehe auch Evaluate Polyspace Bug Finder Results Against Bug Finder Quality Objectives.

Um alle Filteroptionen anzuzeigen, geben Sie Folgendes ein:

polyspace-access -h -export

Sie können Ihr E-Mail-Programm so konfigurieren, dass diese exportierten Dateien als Anhang versendet werden.

Bei Bedarf können Sie mithilfe von Such- und Ersetzungsfunktionen zusätzliche Filter auf die exportierten Dateien anwenden. Verwenden Sie beispielsweise Such- und Ersetzungsfunktionen in der Ergebnisdatei, um nur Ergebnisse aus bestimmten Dateien und Funktionen einzubeziehen. In Linux^® können Sie grep und sed verwenden, um nur Ergebnisse in bestimmten Dateien beizubehalten.

Anstatt in Textdateien zu exportieren, können Sie auch Berichte im PDF- oder Word-Format mithilfe vordefinierter Berichtsvorlagen erstellen. Weitere Informationen finden Sie unter polyspace-report-generator.

Zuweisen von Verantwortlichen und Exportieren zugewiesener Ergebnisse

Sie können den Ergebnissen in bestimmten Dateien oder Ordnern Verantwortlichen zuweisen. Anschließend können Sie eine Ergebnisdatei pro Verantwortlichem exportieren und jedem Verantwortlichen eine E-Mail mit der entsprechenden Datei im Anhang senden.

Sie können Verantwortliche in der Polyspace Access-Weboberfläche oder über die Befehlszeile zuweisen.

In diesem Tutorial weisen Sie alle Ergebnisse in der Datei numerical.c jsmith und alle Ergebnisse in der Datei dataflow.c jboyd zu.

polyspace-access login -set-unassigned-findings testProject/myFirstProject -owner jsmith -source-contains numerical.c
polyspace-access login -set-unassigned-findings testProject/myFirstProject -owner jboyd -source-contains dataflow.c

Nach der Zuweisung exportieren Sie eine Ergebnisdatei pro Verantwortlichem.

polyspace-access login -export testProject/myFirstProject -output .\results.txt -output-per-owner

Diese Dateien enthalten die exportierten Ergebnisse:

results.txt enthält alle Ergebnisse.
results_jsmith.txt und results_jboyd.txt enthalten Ergebnisse, die jsmith bzw. jboyd zugeordnet sind.
results.txt.owners.list enthält die Liste der Verantwortlichen, in diesem Fall:
```
jsmith
jboyd
```

Bevor Sie den Ergebnissen Verantwortliche zuweisen, verwenden Sie die Option -dryrun, um einen Probelauf der Zuweisungen durchzuführen. Ohne die Zuweisung durchzuführen, zeigt die Option die Dateien mit den zugewiesenen Ergebnissen und dem Verantwortlichen an, dem die Ergebnisse zugewiesen sind.

Siehe auch

polyspace-access -export (Polyspace Access) | polyspace-access -set-unassigned-findings (Polyspace Access) | polyspace-access -list-project (Polyspace Access)