Kochbücher innerhalb eines Teams teilen

Kochbücher innerhalb eines Teams teilen

Wenn eine Person ein Sensei-Rezept erstellt, um ihre Codequalität oder Produktivität zu verbessern, kann jeder im Team davon profitieren, wenn die Kochbücher geteilt werden.

Sensei bietet eine Reihe von Mechanismen zum Teilen von Kochbüchern:

• Speichern Sie Kochbücher im Projekt unter Versionskontrolle
• Speichern von Kochbüchern in einem gemeinsamen Ordner
• Speichere Kochbücher auf Github
• Gezippte Dateien über HTTP (s)

Durch das Teilen der Kochbücher hilft Sensei den Teams, beim Wissensaustausch zusammenzuarbeiten. Die Zusammenarbeit trägt dazu bei, die Kommunikation zu verbessern und die vereinbarten Konzepte zur Codequalität zu verankern.

Zum Beispiel ein Kochbuch teilen:

• hilft Teammitgliedern, nützliche Rezepte miteinander zu teilen.
• unterstützt Teamleiter bei der Kodifizierung vereinbarter Programmierpraktiken für Nachwuchskräfte, um häufige Verstöße zu identifizieren und die vereinbarte Version schnell zu beheben.
• fördert die Zusammenarbeit zwischen den Teams, z. B. könnte ein AppSec-Team Rezepte erstellen, um ein Problem im Code hervorzuheben, und das Entwicklungsteam könnte die schnelle Lösung schreiben.

In den nächsten Abschnitten wird erklärt, wie die einzelnen Sharing-Mechanismen implementiert werden.

Speichern Sie Kochbücher im Projekt unter Versionskontrolle

Der Projekt-Ordner .sensei ist die Standardoption beim Erstellen einer Kochbuchdatei.

• `projekt: //.sensei`

Alle Kochbücher und Rezepte würden in einem .sensei-Ordner in Ihrem Projekt gespeichert.

Die einfachste Methode zum Teilen besteht darin, den Projekt-Ordner .sensei zur Versionskontrolle hinzuzufügen.

Dann kann der Ordner.sensei wie jedes andere geteilte Code-Artefakt verwaltet werden, das mit dem Projekt verknüpft ist. Die Kochbücher werden als YAML-Konfiguration gespeichert, sodass sie bei jedem Commit- und Überprüfungsprozess einfach zusammengeführt werden können.

Dies ist der Ansatz, der für das Projekt public sensei-blog-examples verfolgt wurde.

• https://github.com/SecureCodeWarrior/sensei-blog-examples

Der Ordner.sensei enthält das Kochbuch mit allen Rezepten, und sie sind für jeden verfügbar, der das Repository klont.

Speichern Sie Kochbücher in einem beliebigen Ordner

Teams können auch Kochbücher verwenden, die an zentralen Orten gespeichert sind.

Wenn Sie das Kochbuch in einem beliebigen Ordner mit gemeinsamen Schreibzugriffsberechtigungen speichern, kann das gesamte Team die Rezepte aktualisieren und sie in jedes Projekt importieren, an dem es gerade arbeitet.

Der Speicherort würde auf den Verzeichnispfad gesetzt.

Rezepte auf Github speichern

Sensei kann auch auf Rezepte zugreifen, die in einem Github-Repo gespeichert sind. Sowohl private als auch öffentliche Repositorys werden unterstützt.

Github über SSH

Der SSH-Repository-Zugriff wird mit der folgenden Syntax für den Standort konfiguriert

git@github.com/: SecureCodeWarrior/acookbook.git

Damit das funktioniert, würde das Repository den Inhalt eines Kochbuchordners enthalten.

Es ist auch möglich, den Zweig und den Unterordner für das Kochbuch zu konfigurieren, z. B. im Master-Zweig im Kochbuch-Unterordner

z. B.

• git@github.com/: secucodewarrior/sensei-blog-examples.git|master|.sensei

Für private Repositorys muss ein SSH-Schlüssel konfiguriert werden.

• https://github.com/settings/keys

Und der Schlüssel sollte keine Passphrase haben.

Github über HTTPS

Es ist auch möglich, über HTTPS auf öffentliche Repositorys zuzugreifen, und es wird dieselbe repo.git|branch|folder-Syntax verwendet, z.

Für unser Blog-Beispielprojekt:

• https://github.com/SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

Für unser Basic Protection-Beispielset können wir den Branch und den Unterordner ignorieren, da wir standardmäßig den Master-Branch erhalten und die Datei `rules.sensei` sich im Stammordner befindet. :

• https://github.com/SecureCodeWarrior/cookbook-basic-protection-set

Per HTTP (s) gezippt

Sensei kann auch über HTTP oder HTTPS auf gezippte Kochbücher zugreifen.

zB wenn ich einen HTTP-Server hatte, der lokal auf Port 8000 lauscht

• http://localhost:8000/rules.sensei.zip

Die ZIP-Kochbuchdatei sollte den Inhalt eines Kochbuchordners enthalten, z. B. die Datei rules.sensei.

Zusammenfassung teilen

Sensei unterstützt die Verwendung mehrerer Kochbücher, sodass ein einzelner Programmierer Rezepte haben kann, die sein eigenes Lernen und seine Produktivität unterstützen.

Noch wichtiger ist, dass wir wissen, dass Teams am effektivsten arbeiten, wenn Wissen geteilt wird. Gemeinsame Team-Repositorys, z. B. für ein bestimmtes Projekt, eine bestimmte Bibliothek oder für eine gemeinsame Gruppe von Migrationsmustern, können dazu beitragen, die Produktivität des Teams zu steigern und die Erfahrung des Teams zu kodifizieren.

Wenn ein Kochbuch gemeinsam genutzt wird, können mehrere Teams dasselbe Kochbuch verwenden, was auch die Zusammenarbeit zwischen Teams aus verschiedenen Disziplinen, z. B. AppSec bis hin zur Entwicklung, verbessern kann.

Da Sensei vier zentrale Austauschmechanismen zur Verfügung hat, hat Sensei hoffentlich mindestens einen Ansatz, mit dem Sie die Zusammenarbeit beim Wissensaustausch verbessern können.

---

Sie können Sensei von IntelliJ aus mit „Preferences\ Plugins“ (Mac) oder „Settings\ Plugins“ (Windows) installieren und dann einfach nach „Sensei Secure Code“ suchen.

Alle Codes und Rezepte für Sensei-Blogposts sind auf Github in:

•  https://github.com/SecureCodeWarrior/sensei-blog-examples