Verwaltung von Codeanalyse-Richtlinien

Codeanalyse-Richtlinien sind eine Reihe von Regeln, die Sie auf verschiedene Projekte anwenden können und die Flexibilität bei der Einführung von Codierungsstandards ermöglichen.

Um die Codequalität zu verbessern, haben Sie als Administrator folgende Möglichkeiten:
  • Sie können Richtlinien mit unterschiedlichen Regeln erstellen.
  • Sie können auf der Seite Automatisierung verschiedene Richtlinien auf verschiedene Ordner anwenden.
  • Sie können bei der Verwaltung von Codeanalyse-Richtlinien einfach auf die Details der Richtlinienregeln zugreifen.

Aktivieren von Codeanalyse-Richtlinien

Als Administrator können Sie die Codeanalyse-Richtlinien aktivieren, indem Sie zur Registerkarte Verwaltung > Einstellungen > Richtlinien navigieren. Klicken Sie auf Bearbeiten, um die Codeanalyse-Richtlinien zu aktivieren. Folgendes passiert, wenn Sie die Codeanalyse-Richtlinien aktivieren:

  • Die Codeanalyse wird automatisch für alle Bots im öffentlichen Arbeitsbereich ausgeführt, die den Status Nicht gescannt haben und sich in Ordnern befinden, denen eine Codeanalyse-Richtlinie zugewiesen wurde. Dadurch werden die besten Codierungspraktiken für die Bots im öffentlichen Arbeitsbereich sichtbar. Die Code-Analyse wird alle fünf Minuten ausgeführt und scannt in fünf Minuten 1000 Bot-Dateien.
  • Die Codeanalyse wird aufgerufen, wenn Sie einen Bot im Bot Editor speichern.
  • Die Zusammenfassung der Codeanalyse-Ergebnisse ist auf der Seite Automatisierung sichtbar.
  • Die Ergebnisse der Codeanalyse werden auf der Registerkarte Assistent angezeigt.
  • Das Symbol „Code-Analyse ausführen“ ist über die Aktion auf Zeilenebene auf der Seite Automatisierung verfügbar. Wenn Sie die Codeanalyse auf der Seite Automatisierung ausführen, können Sie den Bericht über die Codeanalyse-Verletzung herunterladen.

Wenn Sie die Codeanalyse-Richtlinie deaktivieren, sind die Funktionen und Merkmale der Codeanalyse nicht verfügbar.

Auswirkungen der Hintergrundsuche auf die Leistung

Das automatische Scannen für die Codeanalyse ist ein Hintergrundjob, der im Control Roomläuft. Er wird alle fünf Minuten ausgeführt und scannt Dateien in Stapeln von 1000 Stück.

Um die Auswirkungen auf die Control Room Leistung zu minimieren, wird die automatische Code-Analyse nur auf einem einzigen Control Room Knoten ausgeführt (im Falle von Bereitstellungen mit mehreren Knoten). Es wird jeweils nur ein Hintergrund-Scanauftrag ausgeführt, d. h. der Auftrag läuft, bis er abgeschlossen ist, bevor eine weitere Instanz des Auftrags gestartet wird. Der Hintergrundjob scannt die Dateien der Reihe nach, so dass zu einem bestimmten Zeitpunkt maximal eine Datei vom Hintergrundjob gescannt wird.

Im Folgenden sind die Bedingungen aufgeführt, unter denen eine vollständige Überprüfung des gesamten öffentlichen Repositorys eingeleitet wird:
  • Die Richtlinie wird dem Stammordner hinzugefügt.
  • Die auf den Stammordner angewendete Richtlinie ändert sich.
  • Richtlinien werden zu allen Ordnern im öffentlichen Repository hinzugefügt oder geändert.
Anmerkung:
  • Bei größeren Repositories kann das Scannen im Hintergrund mehrere Stunden dauern.
  • Nur Dateien mit dem Status Nicht gescannt werden mit der automatischen Codeanalyse gescannt. Wenn Sie die Richtlinien ändern, werden alle Dateien in den Ordnern, die die aktualisierten Richtlinien haben, auf den Status Nicht gescannt gesetzt.

Unabhängig davon, ob die Codeanalyse aktiviert oder deaktiviert ist, können Sie immer noch mehrere Richtlinien erstellen und diese Richtlinien auf der Seite Automatisierung verschiedenen Ordnern zuweisen.

Im folgenden Video wird gezeigt, wie Sie die Code-Analyserichtlinie aktivieren:

Erstellen und Zuweisen von Richtlinien für die Codeanalyse

Sie können mehrere benannte Richtlinien für die Codeanalyse konfigurieren. Mit dieser Funktion können Sie verschiedene Richtlinien mit verschiedenen Regeln erstellen, die mit unterschiedlichen Einstellungen und unterschiedlichen Schweregraden konfiguriert sind. Sie können diese benannten Codeanalyse-Richtlinien verwenden, um verschiedene Codequalitätsstandards zu definieren und auf verschiedene Automatisierungsprojekte anzuwenden, indem Sie die Richtlinie bestimmten Ordnern zuordnen. Dies bietet die Flexibilität, bei bestehenden und älteren Projekten schrittweise Qualitätsstandards für den Code einzuführen und bei neueren Projekten strengere Standards anzuwenden.

Sie benötigen die Berechtigungen Richtlinien anzeigen und Richtlinien verwalten, um eine Code-Analyse-Richtlinie einzurichten. Mit diesen Berechtigungen können Sie Richtlinien anzeigen, bearbeiten und zuweisen, die festlegen, wie Entwickler Automatisierungen erstellen können. Die Berechtigung Richtlinien verwalten ermöglicht die Zuordnung von Richtlinien zu Ordnern, auf die Sie Zugriff haben.

Die Seite Verwaltung > Richtlinien hat zwei Registerkarten: Richtlinien und Zuweisen. Sie können diese Richtlinien auf der Registerkarte Richtlinien erstellen und benennen. Sie können eine beliebige Anzahl von Richtlinien erstellen. Sie können nach jeder Richtlinie suchen, indem Sie die Suchfunktion oben verwenden. Sie können entweder den Richtliniennamen oder die Beschreibung im Richtlinienauswahlfenster verwenden, um nach einer Richtlinie zu suchen. Sie können auch alle Richtlinien anzeigen, bearbeiten und löschen, indem Sie auf das Aktionsmenü (drei Punkte übereinander) auf der rechten Seite klicken und die entsprechende Aktion auswählen.

Verwenden Sie die Registerkarte Zuweisen, um einem Ordner auf der Seite Automatisierung eine Richtlinie zuzuweisen. Sie können optional die zugewiesene Richtlinie für jeden Ordner entfernen, indem Sie auf das Aktionsmenü (drei Punkte übereinander) auf der rechten Seite klicken und die Option Zuweisung für Richtline aufheben wählen.

Popup-Fenster mit einer Zusammenfassung der Richtlinie: Das Popup-Fenster mit einer Zusammenfassung der Richtlinie bietet einen schnellen und einfachen Überblick über die in der Richtlinie definierten Regeldetails und deren Schweregrad. Mit diesem Popup-Fenster ist es einfacher zu verstehen, welche Richtlinie auf verschiedene Ordner angewendet wird, ohne zwischen den Registerkarten für Richtlinien und Zuweisungen im Richtlinienmanager hin und her zu navigieren. Außerdem können Sie so schnell entscheiden, welche Richtlinie Sie einem bestimmten Ordner zuweisen möchten.

Dieses Popup-Fenster mit der Zusammenfassung der Richtlinien wird auf den folgenden Registerkarten angezeigt:
  • Registerkarte Richtlinie: Klicken Sie auf die Anzahl der Regeln.
  • Registerkarte Zuweisen: Klicken Sie entweder auf die zugewiesene Richtlinie oder auf die Anzahl der Regeln in der Option Richtlinie zuweisen .

Richtlinienverhalten bei Ordneroperationen

In der folgenden Tabelle wird das Verhalten der Richtlinien beschrieben, wenn bestimmte Vorgänge im Ordner ausgeführt werden.
Ordner-Operation Richtlinienverhalten
Erstellen Der Ordner erbt die Richtlinie vom nächsten übergeordneten Ordner.
Umbenennen Der Ordner behält die derzeitige Richtlinie bei.
Bewegen Der Ordner behält entweder die aktuelle Richtlinie bei oder erbt die Richtlinie vom nächsten übergeordneten Ordner.
Löschen Die dem Ordner zugewiesene Richtlinie wird entfernt.

Wenn Sie eine Codeanalyse für einen Bot durchführen, wird die entsprechende Richtlinie für den Ordner (zugewiesen oder geerbt) verwendet, in dem sich der Bot befindet.