Compartir libros de cocina dentro de un equipo

Compartir libros de cocina dentro de un equipo

Cuando una persona crea una receta en Sensei para mejorar la calidad de su código o su productividad, todos los miembros del equipo pueden beneficiarse cuando se comparten los libros de cocina.

Sensei ofrece una serie de mecanismos para compartir libros de cocina:

• Almacenar libros de cocina en el proyecto bajo control de versiones
• Almacenamiento de libros de cocina en una carpeta compartida
• Almacenar libros de cocina en Github
• Archivos comprimidos a través de HTTP(s)

Al compartir los libros de cocina, Sensei ayuda a los equipos a colaborar en el intercambio de conocimientos. La colaboración ayuda a mejorar la comunicación y a integrar los enfoques de calidad de código acordados.

Por ejemplo, compartir un libro de cocina:

• ayuda a los miembros del equipo a compartir recetas útiles entre ellos.
• apoya a los jefes de equipo en la codificación de las prácticas de codificación acordadas, para el personal subalterno, con el fin de identificar las infracciones comunes con una solución rápida para la versión acordada. 
• promueve una mayor cooperación entre equipos, por ejemplo, un equipo de AppSec podría crear recetas para destacar un problema en el código, y el equipo de desarrollo podría escribir la solución rápida.

Las siguientes secciones explican cómo implementar cada uno de los mecanismos de compartición.

Almacenar libros de cocina en el proyecto bajo control de versiones

La carpeta del proyecto .sensei es la opción por defecto al crear un archivo de libro de cocina.

• `proyecto://. sensei `

Todos los libros de cocina y las recetas se guardarían en una carpeta .sensei en su proyecto.

La forma más sencilla de compartir es añadir la carpeta del proyecto .sensei al control de versiones.

A continuación, la carpeta .sensei puede gestionarse como cualquier otro artefacto de código compartido asociado al proyecto. Los libros de cocina se almacenan como configuración YAML, lo que facilita su fusión durante cualquier proceso de confirmación y revisión.

Este es el enfoque adoptado para el proyecto público sensei-blog-examples.

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

La carpeta .sensei contiene el libro de cocina con todas las recetas, y están disponibles para cualquiera que clone el repositorio.

Guarde los libros de cocina en cualquier carpeta

Los equipos también pueden utilizar libros de cocina almacenados en ubicaciones centrales.

Guardar el libro de recetas en cualquier carpeta con permisos de escritura compartidos permitirá a todo el equipo actualizar las recetas e importarlas a cualquier proyecto en el que estén trabajando.

La ubicación se establecería en la ruta del directorio.

Almacenar recetas en Github

Sensei también puede acceder a las recetas almacenadas en un repositorio de Github. Se admiten tanto los repositorios privados como los públicos.

Github sobre SSH

El acceso al Repositorio SSH se configura utilizando la siguiente sintaxis para la Ubicación

git@github.com:SecureCodeWarrior/acookbook.git

Para que esto funcione, el repositorio debería contener el contenido de una carpeta de libros de cocina.

También es posible configurar la rama y la subcarpeta para el libro de cocina, por ejemplo, en la rama maestra en la subcarpeta del libro de cocina

Por ejemplo

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

Es necesario configurar una clave SSH para los repositorios privados.

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

Y la clave no debe tener una frase de paso.

Github sobre HTTPS

También es posible acceder a los repositorios públicos a través de HTTPS, y se utiliza la misma sintaxis repo.git|branch|folder, por ejemplo

Para nuestro proyecto de ejemplos de blogs:

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

Para nuestro conjunto de ejemplos de Protección Básica, podemos ignorar la rama y la subcarpeta porque obtendremos la rama maestra por defecto, y el archivo `rules.sensei` está en la carpeta raíz.:

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

Comprimido a través de HTTP(s)

Sensei también puede acceder a los libros de cocina que están comprimidos, a través de HTTP o HTTPS.

Por ejemplo, si tuviera un servidor HTTP escuchando localmente en el puerto 8000

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

El archivo zip del libro de cocina debe contener el contenido de una carpeta del libro de cocina, por ejemplo, el archivo rules.sensei .

Resumen de la puesta en común

Sensei admite el uso de múltiples libros de cocina para que un programador individual pueda tener recetas que apoyen su propio aprendizaje y productividad.

Y lo que es más importante, sabemos que los equipos trabajan con mayor eficacia cuando se comparten los conocimientos. Disponer de repositorios de equipo compartidos, por ejemplo, para un proyecto específico, o una biblioteca concreta, o para un conjunto compartido de patrones de migración, puede ayudar a impulsar la productividad del equipo y codificar su experiencia.

Cuando se comparte un libro de cocina, varios equipos pueden utilizar el mismo libro de cocina, lo que también puede mejorar la colaboración entre equipos de diferentes disciplinas, por ejemplo, de AppSec a desarrollo.

Con cuatro mecanismos básicos de intercambio disponibles, es de esperar que Sensei tenga al menos un enfoque que pueda utilizar para aumentar la colaboración en el intercambio de conocimientos.

---

Puede instalar Sensei desde IntelliJ usando "Preferences \ Plugins" (Mac) o "Settings \ Plugins" (Windows) y luego sólo busque "sensei secure code".

Todo el código de las entradas del blog Sensei y las recetas están en Github en:

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