Page tree

 

Ya soy un experto y estoy aquí para ayudar: ¡contesta preguntas pendientes y gana puntos!

Skip to end of metadata
Go to start of metadata

Mientras se ejecuta un análisis, SonarQube presenta una evidencia cada vez que una parte del código incumple una regla de codificación. El conjunto de reglas se define mediante un perfil de calidad asociado al proyecto. Los desarrolladores pueden también definir manualmente evidencias que no pueden ser detectadas por SonarQube (ejemplos: la implementación de un método no cumple los requisitos funcionales, el javadoc del método no concuerda con su implementación, etc.) 

Cada asunto tiene una de estas cinco severidades:

  1. BLOQUEANTE
    Error con una alta probabilidad de impactar en el comportamiento de las aplicaciones en producción: pérdida de memoria, conexión JDBC no cerrada, .... El código DEBE ser inmediatamente corregido.
  2. CRITICA
    Ya sea un error con una baja probabilidad de impacto en el comportamiento de la aplicación en producción o un tema que representa un fallo de seguridad: bloque catch vacío, inyección SQL, ... El código debe ser revisada de inmediato.
  3. MAYOR
    Defecto de calidad que puede tener un alto impacto en la productividad de los desarrolladores: trozo de código no cubierto, bloques duplicados, parámetros no utilizados, ...
  4. MENOR
    Defecto de calidad con un leve impacto en la productividad de los desarrolladores: lineas que no deberían ser tan largas, las sentencias "switch" deben tener al menos tres casos,...
  5. INFO
    Ni un error, ni un defecto de calidad, sólo un hallazgo.

Idealmente, el equipo no debería introducir nuevas evidencias (cualquier nueva deuda técnica). Los Plugins como Issues Report o Evidencias pueden ayudar a los desarrolladores porque permite la capacidad de realizar análisis locales para comprobar su código antes de devolverlo al SCM. Pero en la vida real, no siempre es posible codificar sin ninguna deuda técnica nueva, y a veces no vale la pena.

Así que se introducen nuevas evidencias. Los flujos de evidencias de SonarQube pueden ayudarle a manejar esas evidencias. Por defecto, hay siete cosas diferentes que puede hacer con una evidencia (a parte de arreglarla en el código!): Comentar, Asignar, Planificar, Confirmar, Cambiar Severidad, Resolver y Falso Positivo. Los plugins deben añadir más opciones, como enlazar con JIRA.

 

Estas acciones se dividen en cuatro categorías diferentes. La primera categoría es la de "revisión técnica".

Revisión Técnica

Confirmar, Falso Positivo y Cambiar severidad están en esta categoría, que presupone un examen inicial de un problema para verificar su validez. Supongamos que es hora de revisar la deuda técnica añadida en el último período de revisión - tanto si eso es un día, como una semana, o todo un sprint. Vas a través de cada nueva evidencia y haces una de tres cosas:

  • Confirmar - Para confirmar una evidencia, estás basicamente diciendo "Sí, es un problema."
  • Falso Positivo - Mirando en el contexto de la evidencia, te das cuenta de que por cualquier razón, esa evidencia no es actualmente una evidencia, erm... "problema". No es actualmente un problema. Por lo tanto tu lo marcas como un Falso Positivo y sigues adelante. Desaparecerá inmediatamente del desglose y tras el siguiente análisis del conteo de evidencias.
  • Cambiar Severidad - Esto está a medio camino entre las dos primeras opciones. Si, es un problema, pero no es tan malo como dice la regla a aplicar por defecto. O tal vez en realidad es mucho peor. De cualquier modo, ajusta la gravedad del problema para que esté en línea con lo que usted siente que se merece. El marcador en el desglose cambiará para mostrar la nueva severidad de inmediato, pero el cambio no se reflejará en sus recuentos de evidencias hasta después del siguiente análisis.

Disposición

Una vez que los problemas han sido objeto de una revisión técnica, es el momento de decidir que se va a hacer con ellos. Tienes hasta tres opciones, y mientras que las opciones de revisión técnica son mutuamente excluyentes (bueno, casi), puede que te encuentres utilizando estos tres sobre la misma evidencia: 

  • Asignar - Le asigna el tema a usted o a un compañero de equipo para el tratamiento inmediato. El cesionario recibirá notificación por correo electrónico de la asignación si se inscribió en las notificaciones, y la asignación se mostrará en cualquier sitio donde aparezca la evidencia, así como en ciertos widgets.






  • Planificar - Algunas evidencias necesitan de acción inmediata, pero otras es posible que desee poner fuera. La funcionalidad de Plan de Acción permite agrupar cuestiones en conjuntos, opcionalmente asignar fechas, y realizar un seguimiento conjunto de la resolución. Una vez que haya creado un plan de acción, la opción del Plan sobre un tema le permite poner el tema en el conjunto.


  • Enlace a JIRA - Asumiendo que tienes instalado el Evidencias, esta opción te permite crear un asunto de JIRA de una evidencia. La URL al asunto de JIRA se añadirá a la evidencia y un enlace a la evidencia se añadirá en el asunto de JIRA. Después de eso, sin embargo, no hay ninguna relación entre los dos. Actualizando el asunto de JIRA no va a modificar la evidencia el tema y viceversa.

General

Solo hay una opción bajo la categoría General: commentar. En cualquier momento durante el ciclo de vida de una evidencia, puedes registrar un comentario en ella. Los comentarios son mostrados en el detalle de la evidencia en un registro de funcionamiento. Tienes la posibilidad de editar o borrar los comentarios que has hecho.

Fin del juego

Si has estado haciendo los cálculos, ya sabrás que solamente queda una opción: Resolver. Utilice esta opción para indicar que usted piensa que ha solucionado una evidencia abierta. Si está usted en lo cierto. en el siguiente análisis se cambiará al estado cerrado. Si se equivoca, el estado cambiará a reabierto.

Así que eso es. Así es como SonarQube le permite gestionar evidencias: ayudándole a revisarlas, organizarl qué se debe corregir ahora y qué programar para más tarde, y realizar un seguimiento de ellas cuando los Planes salen bien.

Otras

  • Para más detalles sobre estos temas, por favor mira el apartado Revisando Evidencias.
  • Para saber cómo puedes manipular varias evidencias a la vez, ver Cambios masivos en evidencias
  • Las evidencias aparecen por las diferentes reglas, y las reglas se agrupan en perfiles de calidad. Sólo ciertos usuarios pueden editar los perfiles, pero todos los usuarios pueden ver las reglas. Para aprender más acerca de lo que hay en un perfil, consulta la sección de perfiles de calidad.

  • Para las versiones anteriores a la 3.6 SonarQube, ver evidencias y revisiones.

  • No labels