Añadir parámetros a anotaciones mediante acciones de reescritura

En esta entrada del blog:

• Demostraremos cómo buscar y encontrar anotaciones
• Corregiremos anotaciones usando plantillas mustache

Sensei permite detectar patrones de código problemáticos y corregirlos para que cumplan con las implementaciones acordadas. En este ejemplo, utilizo @Disabled sin parámetros como el patrón de código problemático.

Anotación de prueba deshabilitada

Las pruebas deshabilitadas sin una razón específica pueden ser problemáticas a largo plazo, ya que solemos olvidar por qué las desactivamos.

@Disabled
   void thisTestMethodHasNoDisabledReason(){
    Assertions.fail("Esta prueba está deshabilitada y no debería ejecutarse");
    }

El riesgo es que, con el tiempo, la base de código evolucione, la prueba deshabilitada no se actualice conforme al propósito del código y termine siendo redundante, irrelevante y, potencialmente, nunca se vuelva a habilitar.

Durante las revisiones de código, solemos señalar que es buena práctica añadir una descripción explicativa como parámetro de la anotación.

@Disabled ("Deshabilitado para demostrar cómo añadir una razón")
    void thisTestMethodHasDisabledReason(){
   Assertions.fail("Esta prueba está deshabilitada y no debería ejecutarse");
   }

Una receta de Sensei

Podemos crear una receta para detectar cuándo se añade @Disabled sin explicación y una corrección rápida que nos recuerde incluir el motivo por el cual se deshabilitó.

Al planificar lo que voy a hacer, debo:

• detectar la anotación Disabled sin parámetros
• modificar la anotación Disabled para incluir un parámetro con el texto "TODO: añade una descripción aquí"

Crear una receta de advertencia

Uso Alt+Enter para crear una nueva receta.

Luego, añado el texto descriptivo básico en la información general.

Al configurar la regla como una advertencia, el código coincidente se resalta sin mostrarse como un error crítico.

Buscar la anotación

En el editor de recetas, cambio la búsqueda para que coincida con una anotación.

Esto resaltará todas las anotaciones en la vista previa.

Una vez hecho esto, quiero filtrar por el tipo de anotación.

Podría usar simplemente Disabled, pero califico completamente la clase con el paquete para que solo coincida con la anotación de JUnit 5. Como el código fuente se muestra en la vista previa, puedo copiarlo y pegarlo fácilmente desde el código real para evitar errores tipográficos.

Luego quiero buscar solo las anotaciones sin parámetros, y puedo usar la interfaz gráfica para hacerlo.

es decir, Buscar:

search:
  annotation:
    type: "org.junit.jupiter.api.Disabled"
    without:
       parameters:
          - {}

Crear una acción de corrección rápida de reescritura

Para mi corrección rápida, usaré una acción de reescritura.

Utilizo la funcionalidad Mostrar variables para ver las variables Mustache y previsualizar el contenido.

Y luego añado el código adicional necesario para crear el comentario de marcador de posición.

es decir, Corrección rápida:

availableFixes:
 - name: "Add a todo comment parameter"
   actions:
   - rewrite:
      to: "{{{ . }}}(\"TODO: add a description here\")"
      target: "self"

Sensei en acción

Hemos creado un breve vídeo que muestra el proceso de creación de recetas en acción.

Resumen

Al crear una corrección rápida de reescritura, es más fácil cuando podemos buscar el elemento de código que queremos reescribir, ya que entonces es la entidad "self" sobre la que podemos actuar.

En este ejemplo, utilicé una acción de reescritura para modificar la anotación. La reescritura es una acción de propósito general que puede aplicarse a cualquier elemento de código y es una buena opción predeterminada para explorar.