Crucible: Collaborative code review
Crucible es una herramienta de Atlassian que permite revisar código con flujos de trabajo, discutir con el equipo de trabajo sobre los cambios realizados, llevar un seguimiento de las modificaciones hechas e informar de todos los cambios.
En este tutorial aprenderemos a añadir un repositorio, crear un nuevo proyecto y crear y ejecutar diversas revisiones de código. Todo esto integrando Crucible con Jira Software.
Instalación
El primer paso será instalar y configurar la herramienta. Podemos descargar el instalador desde aquí.
Una vez se instale podemos navegar hacia la carpeta de instalación e iniciar el archivo ejecutable"Start Crucible".
El siguiente paso será descomprimir el archivo y abrir el archivo .profile en un editor de texto para añadirle lo siguiente:
La instalación está hecha en mac
FISHEYE_INST="Ruta al directorio donde está descomprimido Crucible"export FISHEYE_INST
A continuación, abrimos una terminal, nos situamos dentro del directorio de Crucible y ejecutamos el comando bin/start.sh.Cuando ejectuemos el comando debería abrirse en el navegador una pestaña con un localhost en el puerto 8060.
Con eso ya tendremos activa nuestra instancia de Crucible. Cuando queramos deternla tendremos que ejecutar el comando bin/stop.sh.
Repositorios
Con Crucible ya en ejecución podremos comenzar a añadir repositorios al servidor. Una vez los tengamos añadidos, podremos crear dentro los proyectos sobre los que queremos ejecutar la revisión del código.
Para añadir un repositorio nos dirigimos al área de Administración seleccionando la rueda que se encuentra en la parte superior derecha.
Veremos un menú y dentro de él una opción que indicará Añadir Repositorio.
Seleccionamos el tipo de repositorio y rellenamos el formulario con el nombre y la descripción del mismo. El nombre es el único valor del formulario que es obligatorio.
Proyectos
El proceso para crear proyectos es muy similar al proceso de los repositorios. Nos dirigimos al panel de Administración de Crucible y seleccionamos el menú de Proyectos. Click al botón para añadir uno nuevo.
A continuación, veremos un formulario donde tendremos que indicar el nombre del proyecto, la calve, el repositorio por defecto del proyecto, el esquema de permisos y otros campos más.
Con todo esto ya tendremos creado nuestro proyecto y podremos comenzar a crear una review del código del propio proyecto.
Reviews
Con el proyecto ya creado dentro del repositorio, podemos crear la revisión del código del proyecto haciendo click en el botón Crear Revisión.
El siguiente paso será elegir el proyecto sobre el que hacer la revisión.
Seguidamente elegiremos las características que queremos que se ejecuten en la revisión y ya podemos lanzarla.
Uso de Crucible
Una de las grandes ventajas que aporta Crucible, más allá de las auditorías de código y la revisión del código del proyecto, es la capacidad de subir todas las revisiones del código a un proyecto que esté alojado en Bitbucket o en Github.
También podemos decidir qué roles se tendrán durante el proceso de la review:
- Moderadores: El moderador es la persona responsable de crear la review, aprobarla, determinar cuándo está terminada y, lo más importante, hacer una recopilación de los resultados obtenidos.
- Autores: El autor es la persona que se encarga de actuar en función de los resultados de la review y hacer los cambios pertinentes al código.
- Reviewers: Los reviewers son las perosnas encargadas de revisar el cambio que se va a realizar en el código. Pueden realizar comentarios sobre los resultados de la revisión para poder aportar ideas al Autor.
Las reviews del código de una aplicación son muy importantes, ya no sólo para resaltar errores que puedan existir, si no también para poder encontrar maneras de optimizar el código y aumentar la eficiencia del mismo.