Generación de Reglas para PMD con XPath

RECU-0376 (Recurso Herramienta)

Descripción

PMD es una herramienta de calidad de código encargada de validar los estándares de construcción de un desarrollo. Es decir, chequea la sintaxis del código fuente que ha sido desarrollado, encontrando las ocurrencias de un determinado problema que haya sido previamente configurado para ser detectado.

Ejemplo

Si utilizamos la aplicación PMD Rule Designer, podemos probar su funcionamiento escribiendo código en la sección "Source Code", a continuación pulsar sobre el botón "GO", al hacer esto, obtenemos el árbol de sintaxis abstracta asociado con el código de ejemplo introducido:

Una vez hecho esto, utilizando el cursor podemos seleccionar en la zona del árbol de sintaxis abstracta obtenido, cada zona del código a la que queramos hacer referencia y construir nuestra regla XPATH deseada, por ejemplo:

//VariableDeclarator
 [../Type/ReferenceType/ClassOrInterfaceType
  [@Image = 'Factory'] and ..[@Final='false']]

Una vez escrita esta regla en la zona habilitada a tal efecto, la aplicación de diseño quedaría:

Para comprobar que la regla escrita se corresponde con lo que realmente necesitamos, sólo hay que pulsar sobre el botón "GO" obteniendo el resultado siguiente:

Una vez que hemos obtenido los resultados esperados, sólo nos queda obtener la regla pmd asociada, para ello no tenemos más que pulsar en el menú sobre "Actions" -> "Create Rule XML", esto nos abrirá una nueva ventana en la que rellenamos los nombres de la regla y el mensaje que queremos obtener cuando esta ocurra:

Después de rellenar pulsamos sobre el botón "Create Rule XML" para obtener el xml asociado a la regla creada, a continuación no tenemos más que copiar ese xml e introducirlo en un xml de reglas de pmd para que se testee en el proyecto que queramos.

Uso en MADEJA

A continuación mostramos un ejemplo de como generar una regla PMD con XPATH conforme se indica en MADEJA, para esto usaremos el PMD Rule Designer. Esta regla podemos usarla

  • Desde la configuración de PMD en Eclipse
    AvisoAviso
  • Descargándonos la aplicación en la siguiente url. Una vez descargada en el sistema local, procedemos a ejecutar el programa PMD Rule Designer situado en la carpeta: /pmd-4.2.2/bin/ y denominado designer.sh.

Contenidos relacionados

Recursos
Área: Verificación » Verificación de Entrega Software
Código Título Tipo Carácter
RECU-0375 Plugin de PMD para Eclipse Herramienta Recomendado