Partage de livres de cuisine au sein d'une équipe

Partage de livres de cuisine au sein d'une équipe

Lorsqu'une personne crée une recette Sensei pour améliorer la qualité de son code ou sa productivité, tous les membres de l'équipe peuvent en bénéficier lorsque les livres de recettes sont partagés.

Sensei fournit un certain nombre de mécanismes pour le partage des livres de cuisine :

• Stocker les livres de cuisine dans le projet sous contrôle de version
• Stockage des livres de cuisine dans un dossier partagé
• Stocker les livres de cuisine dans Github
• Fichiers zippés sur HTTP(s)

En partageant les livres de recettes, Sensei aide les équipes à collaborer sur le partage des connaissances. Cette collaboration permet d'améliorer la communication et d'intégrer les approches convenues en matière de qualité du code.

Par exemple, partagez un livre de cuisine :

• aide les membres de l'équipe à partager des recettes utiles entre eux.
• aide les chefs d'équipe à codifier les pratiques de codage convenues, à l'intention du personnel subalterne, afin d'identifier les violations courantes et de trouver une solution rapide pour la version convenue. 
• une équipe AppSec pourrait créer des recettes pour mettre en évidence un problème dans le code, et l'équipe de développement pourrait écrire la solution rapide.

Les sections suivantes expliquent comment mettre en œuvre chacun des mécanismes de partage.

Stocker les livres de cuisine dans le projet sous contrôle de version

Le dossier projet .sensei est l'option par défaut lors de la création d'un fichier de livre de cuisine.

• `projet://.sensei`

Tous les livres de cuisine et les recettes seront stockés dans un dossier .sensei dans votre projet.

L'approche la plus simple pour le partage est d'ajouter le dossier projet .sensei au contrôle de version.

Le dossier .sensei peut alors être géré comme n'importe quel autre artefact de code partagé associé au projet. Les livres de cuisine sont stockés sous forme de configuration YAML, ce qui permet de les fusionner facilement au cours des processus de validation et de révision.

C'est l'approche adoptée pour le projet public sensei-blog-examples.

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

Le dossier .sensei contient le livre de cuisine avec toutes les recettes, et il est disponible pour tous ceux qui clonent le dépôt.

Stockez vos livres de cuisine dans n'importe quel dossier

Les équipes peuvent également utiliser des livres de cuisine stockés dans des endroits centraux.

L'enregistrement du livre de cuisine dans n'importe quel dossier avec des droits d'écriture partagés permettra à toute l'équipe de mettre à jour les recettes et de les importer dans n'importe quel projet sur lequel elle travaille.

L'emplacement correspond au chemin d'accès au répertoire.

Stocker les recettes dans Github

Sensei peut également accéder aux recettes stockées dans un dépôt Github. Les dépôts privés et publics sont pris en charge.

Github via SSH

L'accès au référentiel SSH est configuré à l'aide de la syntaxe suivante pour l'emplacement

git@github.com:SecureCodeWarrior/acookbook.git

Pour que cela fonctionne, le référentiel doit contenir le contenu d'un dossier de livres de cuisine.

Il est également possible de configurer la branche et le sous-dossier du livre de cuisine, par exemple dans la branche principale, dans le sous-dossier du livre de cuisine.

par exemple

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

Une clé SSH doit être configurée pour les dépôts privés.

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

La clé ne doit pas comporter de phrase d'authentification.

Github sur HTTPS

Il est également possible d'accéder à des dépôts publics via HTTPS, et la même syntaxe repo.git|branch|folder est utilisée, par exemple.

Pour notre projet d'exemples de blogs :

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

Pour notre exemple de protection de base, nous pouvons ignorer la branche et le sous-dossier car nous obtiendrons la branche principale par défaut, et le fichier `rules.sensei` se trouve dans le dossier racine... :

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

Zippé sur HTTP(s)

Sensei peut également accéder à des livres de cuisine zippés, via HTTP ou HTTPS.

Par exemple, si j'ai un serveur HTTP qui écoute localement sur le port 8000

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

Le fichier zip du livre de cuisine doit contenir le contenu d'un dossier du livre de cuisine, par exemple le fichier des règles.sensei .

Résumé du partage

Sensei soutient l'utilisation de plusieurs livres de cuisine afin qu'un programmeur individuel puisse disposer de recettes qui soutiennent son propre apprentissage et sa propre productivité.

Plus important encore, nous savons que les équipes travaillent plus efficacement lorsque les connaissances sont partagées. L'existence de référentiels partagés par l'équipe, par exemple pour un projet spécifique, une bibliothèque spécifique ou un ensemble partagé de modèles de migration, peut contribuer à stimuler la productivité de l'équipe et à codifier l'expérience de l'équipe.

Lorsqu'un livre de recettes est partagé, plusieurs équipes peuvent utiliser le même livre de recettes, ce qui peut également améliorer la collaboration entre les équipes de différentes disciplines, par exemple entre l'AppSec et le développement.

Avec les quatre mécanismes de partage disponibles, Sensei a au moins une approche que vous pouvez utiliser pour augmenter la collaboration sur le partage des connaissances.

---

Vous pouvez installer Sensei à partir d'IntelliJ en utilisant "Preferences \ Plugins" (Mac) ou "Settings \ Plugins" (Windows) puis en recherchant simplement "sensei secure code".

Tous les articles du blog Sensei , le code et les recettes sont sur Github :

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