Árbol de páginas

 

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

Saltar al final de los metadatos
Ir al inicio de los metadatos

Tabla de Contenidos

Disponible desde SonarQube 4.4

La página de Reglas está disponible desde SonarQube 4.4. En las versiones previas, las reglas se visualizaban desde las páginas de Perfil de Calidad.

En SonarQube, los plugins proporcionan reglas que se ejecutan sobre el código fuente y que generan evidencias - que se utilizan para calcular la deuda técnica. La página de reglas es el punto de entrada desde el que se pueden descubrir todas las reglas o se pueden crear nuevas basándose en plantillas.

Buscando Reglas

Pulsar sobre el "Reglas" en el menú superior para acceder a la página de búsqueda de reglas. Por defecto se ven todas las reglas disponibles en la siguiente interfaz:

La búsqueda ofrece los siguientes criterios de búsqueda:

  • Disponible Desde: Fecha en la que se añadió la regla en la instancia de SonarQube. Es útil para listar por ejemplo las reglas nuevas desde la última actualización de un plugin.
  • Características: La característica SQALE a la que pertenece la regla (véase Deuda Técnica).
  • Lenguaje: El lenguaje para el que la regla tiene efecto. 
  • Repositorio: El motor que aporta las reglas a SonarQube. Utilizar el repositorio "Manual Rules" para buscar las reglas manuales.
  • Severidad: La severidad original de la regla - como se definió por el plugin que aportó esta regla
  • Estado: Las reglas pueden tener 3 estados diferentes:
    • Beta: La regla ha sido implementada recientemente y no se ha obtenido aun feedback de los usuarios, de forma que podrían ser falsos positivos o falsos negativos.
    • Obsoleta: La regla no debería ser utilizada porque existe otra regla similar, pero mas potente y precisa.
    • Lista: La regla esta lista para ser utilizada en producción.
  • Etiqueta: Desde la versión 4.2 de SonarQube, es posible añadir etiquetas a reglas para clasificarlas y facilitar su búsqueda.
  • Plantillas: Muestra las plantillas de reglas que permiten crear reglas personalizadas (ver siguientes puntos de la página).

Si se selecciona un perfil de calidad, es podible marcar la activación del estado de una regla, si severidad activa o si es heredada o no. Ver la documentación de Perfiles de Calidad para saber mas sobre este aspecto.

Detalles de las Reglas

Las reglas se visualizan en detalle en el panel derecho de la página:

Las siguientes 2 acciones están disponibles únicamente si se tienen permisos de "Administrador de Umbrales y Perfiles de Calidad":

  • Añadir/Quitar etiquetas:
    • Es posible añadir etiquetas a una regla o crear nuevas (introduciendo el nombre en el campo de texto).
    • Tener en cuenta que algunas reglas tienen etiquetas predefinidas que no se pueden eliminar - se han asignado por los plugins que han proporcionado la regla.
  • Extender Descripción
    • Extender las descripciones de las reglas es útil para permitir a los usuarios conocer mas detalle de como se está utilizando una regla en concreto o para hacerla mas comprensible.
    • Tener en cuenta que la extensión se mostrará a los usuarios que no son administradores como parte normal de los detalles de la regla.

Plantillas de Reglas y Reglas Personalizadas

Las plantillas de reglas se proporcionan por los plugins para permitir a los usuarios definir sus propias reglas en SonarQube: Por ejemplo, la plantilla "Architectural Constraint" (utilizado en esta página como ejemplo) se puede utilizar para crear cualquier tipo de regla que comprueba accesos olvidados  de un conjunto de ficheros a otro.

En versiones anteriores de SonarQube, algunas reglas (equivalente a plantillas) se podían copiar para crear nuevas reglas (equivalente a reglas personalizadas) y era posible activar tanto la regla original como la nueva. Esto era un poco engañoso, así que SonarQube 4.4 deja claro que:

  • Plantillas de Reglas
    • Únicamente se pueden utilizar para crear reglas personalizadas
    • No pueden ser activadas porque simplemente son plantillas con parámetros vacíos
  • Reglas personalizadas
    • Se consideran como el resto de reglas
    • Pero pueden ser editadas o borradas en cualquier momento


Plantillas de Reglas

Es muy sencillo encontrar plantillas de reglas que pueden ser utilizadas para crear nuevas reglas:

Cuando se crea una regla personalizada, se tiene que rellenar la siguiente información:

  • Nombre
  • Clave (auto sugerida)
  • Descripción (Se soporta el formato Markdown)
  • Severidad por defecto
  • Estado
  • Parámetros especificados por la plantilla

Es sencillo navegar de una plantilla a sus reglas personalizadas: simplemente pulsar sobre el enlace de la sección "Reglas Personalizadas" y podrá profundizar en el detalle de la regla seleccionada.

Reglas Personalizadas

Las Reglas Personalizadas se consideran como cualquier otra regla, excepto que pueden ser modificadas por completo o incluso eliminadas.

Tener en cuenta que al borrar una regla no se borra físicamente de la instancia SonarQube sino que su estado pasa a ser "REMOVED". Esto permite visualizar las evidencias actuales o anteriores relacionadas con esta regla hasta que esta se eliminen completamente.

 

 

  • Sin etiquetas