Pipeline-Operation: Code-Scan
Geschrieben für die alte Benutzeroberfläche
Dieser Artikel wurde für die alte Benutzeroberfläche geschrieben. Die Anweisungen sind weiterhin verwendbar, aber die Screenshots sind veraltet. In einigen Fällen wurden die in den Anweisungen genannten Elemente verschoben oder geändert. Wenn Sie ein Element nicht finden können, siehe den Wo ist es hin Artikel.
Übersicht
Die Code-Scan Die Operation analysiert Ihre Salesforce-Metadaten, um vor der Bereitstellung Codequalitätsprobleme zu identifizieren. Durch statische Codeanalyse meldet sie Regelverstöße in den Apex-Klassen, Triggern und anderen Komponenten eines Branches, um zu bestätigen, dass sie Ihren definierten Codierungsstandards entsprechen. Der Code-Scan-Regelsatz umfasst:
Codierungsstil und bewährte Verfahren: Verbessern Sie Lesbarkeit, Wartbarkeit und Konsistenz in Ihrer gesamten Codebasis.
Bewährte Sicherheitspraktiken: Identifizieren Sie häufige Sicherheitslücken und riskante Muster in Ihrem Code.
Leistungsempfehlungen: Heben Sie ineffiziente Logik hervor, bevor sie sich auf Endbenutzer auswirkt.
Sie können einen Schweregrad-Schwellenwert festlegen, um die Pipeline abzubrechen, wenn Verstöße einen bestimmten Level erreichen oder überschreiten. Das Ausführen von Code-Scans in Ihrer Pipeline hilft dabei, eine gleichbleibende Codequalität aufrechtzuerhalten, und ermöglicht es Ihnen, zuverlässige, sichere und reaktionsschnelle Komponenten bereitzustellen.
In diesem Artikel wird erläutert, wie die Code-Scan-Operation konfiguriert und verwendet wird. Weitere Informationen finden Sie in den folgenden Abschnitten:
Bewährte Methoden
Führen Sie Code-Scans automatisch vor jeder Bereitstellung aus.
Legen Sie Schweregrad-Schwellenwerte auf Grundlage von CI/CD-Regeln fest.
Überprüfen Sie regelmäßig das Code-Scan-Ergebnis und beheben Sie wiederkehrende Probleme.
Kombinieren Sie Code-Scan mit einem manuellen Schritt um vor der Bereitstellung in der Produktion eine Prüfung und Genehmigung zu verlangen.
Sorgen Sie für konsistente Code-Scan Konfigurationen in allen Umgebungen.
Scan-Typen
Die Code-Scan-Operation unterstützt zwei Scan-Typen: Apex PMD und Flosum Scan. Lesen Sie die folgenden Beschreibungen, um den Scan-Typ auszuwählen, der am besten zu den Qualitätsstandards Ihres Teams passt.
Apex PMD
Apex PMD ist ein Open-Source-Regelsatz, der häufige Probleme in Salesforce-Komponenten erkennt. Er enthält weniger Regeln als Flosum Scan und schließt Scans schneller ab, was ihn zu einer schlanken Option für schnelles Feedback macht. Wählen Sie Apex PMD, wenn seine Basisprüfungen Ihren Anforderungen entsprechen oder Sie lieber weniger Probleme erkennen möchten.
Flosum Scan
Flosum Scan ist der umfassendste Regelsatz von DevOps, entwickelt für Teams, die den höchsten Standard an Codequalität verlangen. Er umfasst jede Regel aus Apex PMD plus Hunderte zusätzlicher Prüfungen, etwa das 6-Fache der Abdeckung von Apex PMD, und erweitert die statische Analyse auf Sprachen, die von Apex PMD nicht abgedeckt werden, einschließlich Salesforce Flow und TypeScript. Diese erweiterte Abdeckung liefert tiefere Analysen und strengere Validierungen und gibt Ihnen bei jeder Bereitstellung mehr Sicherheit. Wählen Sie Flosum Scan für den umfassendsten Schutz Ihres Salesforce-Codes.
Warum Flosum Scan?
Breitere Sprachabdeckung: Bietet erstklassige Unterstützung für Salesforce Flow und TypeScript, die beide nicht von Apex PMD.
Tiefere Lightning-Abdeckung: Enthält 381 Regeln für JavaScript und Lightning Web Components, verglichen mit 19 in Apex PMD.
Strengere Metadatenvalidierung: Wendet 18 Regeln auf Salesforce-Metadaten, verglichen mit 2 in Apex PMD.
Kontinuierlich erweitert: Der Flosum Scan Regelsatz wird von Flosum gepflegt und wird wachsen, um mit den Änderungen der Salesforce-Plattform Schritt zu halten.
Regelabdeckung nach Sprache
Die folgende Tabelle listet die von jedem Scan-Typ unterstützten Sprachen auf. Das Diagramm vergleicht die Regelabdeckung der einzelnen Scan-Typen über die unterstützten Sprachen hinweg. Verwenden Sie diese Informationen, um sicherzustellen, dass der von Ihnen ausgewählte Scan-Typ ausreichende Regelsätze für die in Ihrem Branch verwendeten Sprachen bereitstellt.
JavaScript / Lightning Web Components
TypeScript
Apex
Salesforce-Metadaten
HTML / Salesforce Lightning Design System
Salesforce Flow
Visualforce
Schweregrade
Wenn der Code-Scan ein Problem findet, weist er ihm einen Schweregrad zu, der widerspiegelt, wie kritisch das Problem für die Qualität Ihres Codes ist. Verwenden Sie diese Stufen, um Korrekturen zu priorisieren und den Schweregrad-Schwellenwert festzulegen, der bestimmt, wann die Operation fehlschlägt.
Blocker
Schwerwiegende Sicherheitsrisiken oder kritische Fehler, die zu einem Systemausfall oder Datenverlust führen können.
Kritisch
Erhebliche Probleme, die in der Regel gegen die Salesforce-AppExchange-Standards verstoßen.
Wesentlich
Verstöße gegen bewährte Verfahren oder Leistungsprobleme, die die Wartbarkeit beeinträchtigen.
Gering
Codequalitätsprobleme mit geringer Auswirkung oder stilistische Inkonsistenzen.
Info
Informative Meldungen, die keine Aktion erfordern.
Konfiguration der Code-Scan-Operation
Operation und Typ auswählen
Klicken Sie auf das Vorgang Dropdown-Menü.
Auswählen Code-Scan.
Klicken Sie auf das Prüfart Dropdown-Menü.
Wählen Sie die Art des Code-Scans aus, die ausgeführt werden soll. Siehe den Pipeline-Operation: Code-Scan obigen Abschnitt für weitere Details.
Beschreibung und Schwellenwert eingeben
(Optional) Im Beschreibung Textfeld geben Sie eine Zusammenfassung dessen ein, was dieser Code-Scan ausführt.
Klicken Sie auf das Schweregrad-Schwellenwert Dropdown-Menü.
Wählen Sie den niedrigsten Schweregrad aus, der dazu führt, dass die Code-Scan-Operation fehlschlägt. Siehe den Pipeline-Operation: Code-Scan obigen Abschnitt für weitere Details.
Code-Scan-Ergebnisse
Zusammenfassung und Protokoll
Sobald der Code-Scan abgeschlossen ist, können Sie die Ergebniszusammenfassung anzeigen, indem Sie den Code-Scan Schritt aus den Pipeline-Ergebnissen auswählen.
Die Zusammenfassung der Code-Scan-Ergebnisse die folgenden Informationen anzeigt:
Status
Abgeschlossen wenn alle gefundenen Probleme unter dem festgelegten Schweregrad-Schwellenwert liegen.
Ausnahme wenn ein Problem den Schweregrad-Schwellenwert erreicht oder überschreitet.
Dauer
Zeit, die der Code-Scan zum Abschluss benötigt hat, angezeigt in Stunden, Minuten und Sekunden.
Datum des Starts/Endes
Das Datum und die Uhrzeit, zu der der Code-Scan gestartet und beendet wurde.
Gefundene Probleme
Anzahl der auf jeder Schweregradstufe gefundenen Probleme.
Protokoll
Protokolleinträge für den Code-Scan-Job. Verwenden Sie das Protokoll, um den Status des Jobs und etwaige Fehlermeldungen zu überprüfen.
Beispiel für ein Code-Scan-Protokoll:
Code-Scan-Ergebnisse
Sie können die Code-Scan-Ergebnisse anzeigen, um zu sehen, in welchen Dateien Ihres Branches der Scan Probleme gefunden hat und wie viele Probleme jeder Schweregradstufe gefunden wurden.
Klicken Sie Ergebnis anzeigen.
Am oberen Rand der Ergebnisseite steht die Gesamtzahl der für jeden Schweregrad gefundenen Probleme. Unter den Gesamtsummen befindet sich eine Liste der Komponentendateien mit Problemen sowie ein Balkendiagramm der nach Schweregrad geordneten Probleme.
Ergebnisse auf Dateiebene
Die Ergebnisse auf Dateiebene erläutern die Ursache jedes Problems und den Ort, an dem es in der Quelldatei auftritt. Prüfen Sie jedes Problem und nehmen Sie gegebenenfalls die erforderlichen Änderungen an der Komponente vor.
Klicken Sie auf eine Datei aus der Liste, um die vollständige Liste der Probleme anzuzeigen.
Falls verfügbar, klicken Sie auf Mehr anzeigen um weitere in dieser Datei gefundene Probleme anzuzeigen.
Der Screenshot und die folgende Tabelle erläutern die für jedes Problem angezeigten Informationen.
Schweregrad
Ein farbiger Kreis mit einem Buchstaben darin zeigt den Schweregrad an. Der Buchstabe entspricht dem ersten Buchstaben des Schweregradnamens, und die Farbe entspricht dem Schweregrad. Hinweis: Major und Minor beginnen beide mit M, aber Major ist orange und Minor ist grün.
Regelname
Der Name der Regel, die das Problem markiert hat.
Beschreibung des Verstoßes
Eine Beschreibung der Ursache des Problems.
Ort des Verstoßes
Die Zeilen- und Spaltennummer, an der das Problem gefunden wurde.
Zuletzt aktualisiert
War das hilfreich?