Modificación de la visibilidad de métodos y clases para JUnit 5

Modificación de la visibilidad de métodos y clases para JUnit 5

Uno de los placeres de la programación es el aprendizaje constante necesario para mantenerse al día. Uno de los problemas es que desarrollamos familiaridad y patrones de uso que pueden afectar la adopción de nuevos enfoques. Sensei puede ayudar en la migración identificando patrones obsoletos y sugiriéndonos la solución a seguir.

Por ejemplo, cuando migré de JUnit 4 a JUnit 5, estaba acostumbrado a escribir todas mis clases y métodos de prueba como públicos. Pero con JUnit 5, pueden tener visibilidad de paquete.

p. ej., en lugar de:

public class Junit5VisibilityTest {
    @Test
    public void thisDoesNotNeedToBePublic(){
        Assertions.assertTrue(true);
    }
}

Realmente prefiero escribir:

class Junit5VisibilityTest {
    @Test
    void thisDoesNotNeedToBePublic(){
        Assertions.assertTrue(true);
    }
}

Me tomó un tiempo desarrollar la memoria muscular para programar así, y todavía me equivoco de vez en cuando.

Uso de Sensei

Con Sensei puedo crear recetas que encuentren los métodos y clases públicos, y modificar las declaraciones para que tengan visibilidad de paquete automáticamente.

Para lograr esto, creé una receta:

Nombre - JUnit: Los métodos de prueba de JUnit 5 no necesitan ser públicos
Descripción - Los métodos de prueba de JUnit 5 no necesitan visibilidad pública
Nivel - Error

Lo clasifiqué como Error porque quiero erradicar esta práctica de codificación y deseo una mayor visibilidad del problema mientras escribo código en el IDE.

Modificación de la declaración de clase

Para encontrar las clases, busco cualquier clase que tenga una anotación secundaria @Test de JUnit 5, es decir, org.junit.jupiter.api.Test

Y donde la clase tenga el modificador public:

buscar:
  clase:
    con:
      hijo:
        anotación:
          tipo: "org.junit.jupiter.api.Test"
    modificador: "public"

Entonces, la corrección rápida cambia el modificador para eliminar la visibilidad y dejarla por defecto, lo cual equivale a visibilidad de paquete, que es lo que busco.

correccionesDisponibles:
- nombre: "eliminar visibilidad public de la clase de prueba JUnit 5"
  acciones:
  - cambiarModificadores:
      visibilidad: ""

Modificación de las declaraciones de métodos

La receta para modificar la declaración de métodos es muy similar a la de la clase.

Primero, busco los métodos públicos anotados con @Test de JUnit 5.

buscar:
  método:
    anotación:
      tipo: "org.junit.jupiter.api.Test"
    modificador: "public"

Y luego cambio el modificador a visibilidad por defecto.

correccionesDisponibles:
- nombre: "Eliminar visibilidad public del método @Test"
  acciones:
  - cambiarModificadores:
      visibilidad: ""

Consejo: Modificar múltiples métodos

Sensei tiene la capacidad de aplicar la corrección rápida a todas las infracciones en el archivo actual.

Cuando uso alt+enter para aplicar la corrección rápida.

Si despliego el menú con el nombre de la corrección rápida, puedo ver una opción para:

"Corregir todo: problemas de 'JUnit: los métodos de prueba de JUnit 5 no necesitan ser públicos' en el archivo"

Al seleccionar esa opción, Sensei modificará todas las apariciones del problema, no solo la que seleccioné.

Modificación de la clase

Del mismo modo que un método no necesita ser público, tampoco lo necesita la clase.

Puedo crear una receta y una corrección rápida para modificar la clase.

Nombre - JUnit: Las clases de prueba de JUnit 5 no necesitan ser públicas
Descripción - Las clases de prueba de JUnit 5 no necesitan ser públicas
Nivel - Error

Cuando encuentro una clase que es pública y tiene un método con una anotación @Test, quiero cambiar su visibilidad.

buscar:
  clase:
    modificador: "public"
    anyOf:
    - hijo:
        método:
          anotación:
            tipo: "Test"

Puedo realizar el cambio en la definición de la clase nuevamente con la acción changeModifiers.

correccionesDisponibles:
- nombre: "Eliminar visibilidad pública de la clase @Test"
  acciones:  
- changeModifiers:
      visibilidad: ""

Resumen

Una herramienta de análisis estático me alertó inicialmente sobre este enfoque recomendado en JUnit. Sin embargo, la herramienta no me ayudó a desarrollar la memoria muscular necesaria para cambiar mi código mientras programo.

Utiliza el 'Nivel' para recibir alertas. Cuando se trata de un problema que intento erradicar de mi código, inicialmente lo marco como 'Error' y luego reduzco la severidad a medida que me acostumbro a la nueva forma de programar.

Recuerda que puedes usar Sensei para solucionar todos los problemas del archivo actual al mismo tiempo, utilizando la opción del menú desplegable al aplicar el QuickFix.

Al crear una receta en Sensei, puedo ver mi antiguo enfoque de codificación en tiempo real. Y usar QuickFix para reforzar el nuevo enfoque si ocasionalmente cometo un error al programar.

---

Puedes instalar Sensei desde IntelliJ usando "Preferences \ Plugins" (Mac) o "Settings \ Plugins" (Windows) y simplemente buscar "sensei secure code".

El código fuente y las recetas para esto se encuentran en el repositorio `sensei-blog-examples` en la cuenta de GitHub de Secure Code Warrior, dentro del módulo `junitexamples`.

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