✒️ABAP / Las herramientas de ABAP para asegurar la calidad del código Por Felipe Arrona Rodriguez

Las Herramientas de ABAP para asegurar la calidad del código

1| Las herramientas que nos proporciona ABAP para asegurar la calidad del código
Cuando escribimos programas en ABAP es decir cuando desarrollamos en ABAP, ya sea que estemos creando un programa nuevo o estemos modificando un programa ya existente, necesitamos generar código de calidad; y con esto nos referimos a que tenemos que crear código ABAP que cumpla con las cuestiones relativas al rendimiento, la sintaxis, la seguridad, la obsolecencia y el cumplimiento de convenciones de nombres o estándares, entre otras varias cuestiones importantes más.

Particularmente dos de estas herramientas son sumamente importantes para el programa ABAP, ya que con su aplicación vamos a aumentar en gran medida la calidad de nuestros desarrollos. Que son:

• La verificación amplia del programa: A la cual podemos acceder a través de la transacción SLIN.

La verificación ampliada del programa realiza una verificación completa que incluye las interfaces de los procedimientos externos llamados desde el programa, por ejemplo, verificando si el número y el tipo de los parámetros de la interfaz en una llamada de procedimiento externo es correcto. Es solo una verificación estática. No se pueden eliminar todas las circunstancias que podrían dar lugar a situaciones excepcionales o errores en tiempo de ejecución.

También se verifica entre otras cuestiones si el programa se encuentra activado, si se utiliza sentencias ABAP obsoletas, si se utilizan textos harcodeados en el programa en lugar de utilizar elementos de texto, si existen problemas de semántica, si existen advertencias de sintaxis, entre otras verificaciones más.

• El inspector de código: Al cual podemos acceder a través de la transacción SCI.

El inspector de código es una herramienta que se utiliza para comprobar los objetos del repositorio ABAP. Con el inspector de código podemos verificar objetos individuales o conjuntos de objetos para el rendimiento, la seguridad, la sintaxis y el cumplimiento de las convenciones de nombres. En el inspector de código podemos definir inspecciones que con la ayuda de variantes de verificación, examinan ciertos conjuntos de objetos.

También podemos acceder a la verificación ampliada del programa y al inspector de código a través del menú de la transacción SE38, es decir desde el editor ABAP, mientras estamos visualizando o modificando un programa.

1.1| La verificación ampliada del programa
Cuando ejecutamos la transacción SLIN vamos a visualizar la siguiente pantalla de selección donde podemos configurar la verificación que vamos a realizar.

Veamos cuál es el objetivo de las verificaciones más comúnmente utilizadas que ofrece la verificación ampliada del programa:

Interfases PERFORM/FORM: Aquí están agrupados los test que verifican las llamadas de subrutinas PERFORM externas y las definiciones FORM.

Las siguientes verificaciones para las llamadas PERFORM externas:

• Se verifica si la definición FORM existe en el programa indicado.
• Se verifica si el programa que contiene la definición FORM llamada existe y no es un include.
• Se verifica si coincide la cantidad de parámetros actuales con los parámetros formales.
• Se verifica si coinciden las categorías de los parámetros USING, CHANGING y TABLES.
• Se verifica si si los parámetros actuales y los parámetros formales son compatibles.
• Se verifica si un literal se transfiere a un parámetro estructurado o en un parámetro de la categoría CHANGIN.
• Se realizan las siguientes verificaciones para las definiciones FORM.
• Se verifica si para una definición FORM existe una llamada PERFORM.
• Se verifica si existen parámetros FORM sin tipo.
• Se verifica si las excepciones que pueden producirse mediante PERFORM llamado externo o CALL FUNCTION en una definición FORM, aparecen en la cláusula RAISING de FORM.

Interfases CALL FUNCTION: Aquí están agrupados los tests que verifican la llamada y la definición de módulos de funciones.

• Se verifica si en un módulo de funciones existe el grupo de funciones correspondiente y no contiene errores.
• Se verifica si existen los módulos de funciones llamados.
• Se verifica si se transfieren todos los parámetros necesarios.
• Se verifica que no se transfieren parámetros desconocido.
• Se verifica si los parámetros tienen la categoría correcta (IMPORT, EXPORT, TABLES, EXCEPTION).
• Se verifica si los parámetros actuales y los parámetros formales son compatibles.
• Se verifica si para EXCEPTIN's se realiza un tratamiento SY-SUBRC.
• Se verifica si la cláusula RAISING intercepta todas las excepciones correctamente.
• Se verifica si un módulo de funciones está identificado como obsoleto.
• Se verifica si un módulo de funciones contiene una entrada en la tabla base de datos TFDIR.
• Se verifica si para cada EXCEPTION existe un comando RAISE y si para cada comando RAISE aparece una EXCEPTION.

Interfases programas externas: Aquí se agrupan los tests que verifican las llamadas de las sentencias CALL TRANSACTION, LEAVE TO TRANSACTION; CALL DIALOG, SUBMIT y USER EXIT'S.

• Se verifica si existe un código de transacción en la tabla de base de datos TSTC, que es la tabla de códigos de transacciones de SAP
• Se verifica si existe un módulo de diálogo en la tabla de base de datos TDCT, que es la tabla de módulos de diálogo.
• Se verifica si un report llamado mediante SUBMIT tiene el tipo.
• Se verifica si los programas llamados son correctos sintácticamente.
• Se verifica si todos los parámetros SUBMIT indicados mediante WITH están definidos en el report.

STATUS GUI y barra de títulos: Realiza las siguientes verificaciones.

• Se verifica si el STATUS GUI está definido.
• Se verifica si el TÍTULO está definido.

Message: Aquí se agrupan los tests que verifican cuestiones relativas a los mensajes que se muestran en la pantalla de los programas.

• Se verifica si los mensajes dirigidos están definidos en la tabla base de datos T1002.
• Se verifica si la cantidad de parámetros transferidos con WITH coincide con la cantidad de parámetros formales en el mensaje o en el texto explicativo correspondiente.
• Se verifica si la sentencia MESSAGE necesita un texto explicativo, se verifica si existe el texto explicativo para MESSAGE, si el texto explicativo para MESSAGE está activado, si el texto explicativo para MESSAGE está obsoleto.

Cadenas caracteres: Este test contiene las siguientes verificaciones.

• Se verifica si en un string falta el elemento de texto.
• Se verifica si el elemento de texto no definido.
• Se verifica si el string en el texto fuente contiene caracteres no permitidos.
• Se verifica si strings diferentes con mismo ID de elemento de texto.
• Se verifica si un símbolo de texto no se utiliza.
• Se verifica si existe un texto de selección superfluo.

Propiedades del campo: Este test contiene las siguientes verificaciones

• Se verifica si existe una ayuda de búsqueda no definida.
• Se verifica si existen campos no utilizados o no leídos.
• Se verifica si el nombre de campo es idéntico a un tipo predefinido pero tiene otro tipo. El nombre de campo es idéntico a un nombre de operador.
• Se verifica si el nombre de campo contiene un guion como parte del nombre.

Sentencias superfluas: Este test contiene las siguientes verificaciones.

• Se verifica si el programa contiene sentencias BREAKPOINT.
• Se verifica si el programa contiene un flujo de control dependiente de usuario, es decir si se utiliza en una condición la variable del sistema SY-UNAME.
• Se verifica si existen sentencias trace, por ejemplo, para el análisis de tiempo de ejecución (SET RUN TIME..) o el comando SYNTAX-TRACE ON..
• Se verifica si una sentencia consta sólo de un punto.
• Se verifica si tras las sentencias EXIT, RETURN, STOP, RAISE o SUBMIT .... AND RETURN existen otras sentencias.

Sentencias problemáticas: Este test contiene las siguientes verificaciones.

• Se verifica si las mismas sentencias WHEN aparecen dos veces en una sentencias CASE-ENDCASE.
• Se verifica si la primera sentencia detrás de la sentencia CASE no es una sentencia WHEN.
• Se verifica si existen programas direccionados con la sentencia INCLUDE y si son del tipo I.
• Se verifica si se llama a la sentencia FREE MEMORY.
• Se verifica si existen nombres que empiezan por "%_" ya que están reservados para fines internos.
• Se verifica si la sentencia RAISE está fuera de un grupo de funciones.
• Se verifica si existe un literal numérico en una posición de cálculo, por ejemplo ADD '1' TO ....
• Se verifica si existe una sentencia WRITE TO que puede reemplazarse por MOVE TO.
• Se verifica si existe una declaración STOP en un módulo o módulo de funciones.
• Se verifica si existe un tratamiento de excepciones vacío.
• Se verifica si un campo se asigna a sí mismo.
• Se verifica si un string se compara con un campo C que contiene al final espacios en blanco.

Sentencias Obsoletas: En este test se verifica que en el programa no se estén utilizando sentencias ABAP clasificadas por SAP como obsoletas ya que a futuro estás sentencias van a dejar de funcionar por lo que el programa ABAP en donde se encuentran también dejará de funcionar tal como lo hace hasta ahora.

Vamos a tomar como ejemplo nuestro primer programa ABAP, el cual creamos en la lección "Mi primer programa ABAP" en esta misma unidad le vamos a ejecutar la herramienta de verificación ampliada del programa.

Agregamos una verificación más a las verificaciones que vienen tildadas por defecto, tildamos "Cadenas caracteres o Character Strings" y vamos a ejecutar la herramienta.

A continuación en la pantalla del reporte de salida que arroja la verificación ampliada del programa en donde se ve un error y tres advertencias para la verificación "Cadenas caracteres".

De todos los mensajes que arroja la verificación ampliada del programa debemos prestarle particular atención a los errores que son los que sin duda valen la pena corregir.

Tener el programa un texto entre comillas simples entonces dicho texto no se puede traducir a otros idiomas por lo que la forma de corregir esto es crear un elemento de texto y particularmente un símbolo de texto. Para ello vamos al menú Pasar a / Elementos de Texto / Símbolos de texto.

Creamos un símbolo de texto 001 con el texto "Este es mi primer programa", y luego activamos el símbolo de texto creado y por último hacemos clic en el botón BACK de la barrera de herramientas estándar para ir a modificar el código fuente del programa. Remplazamos el texto entre comillas simple por el símbolo de texto y activamos el programa.

Vamos a ejecutar la verificación ampliada del programa para comprobar el cambio que realizamos y en la verificación más a las verificaciones que vienen tildadas por defecto, tildamos "Cadenas caracteres" y ejecutamos herramienta.

Y por último verificamos que la herramienta ya no arroja errores.

1.2| El inspector de código
Existen ciertos conceptos básicos relativos al inspector de código que debemos definir antes de ver con un ejemplo como se utiliza esta poderosa herramienta, estos conceptos son:

• Variante de verificación: Define las reglas que se aplicarán, las verificaciones que se realizarán y la configuración de esas verificaciones.
• Conjunto de objetos: Define los objetos de desarrollo que se incluirán.
• Inspección: Define una combinación de variante de verificación y conjunto de objetos, en otras palabras, qué verificaciones se aplicarán a qué objetos de desarrollo.

Ejecutaremos el inspector de código con la variante de verificación global DEFAULT desde el menú Programa / Verificar / Code Inspecto.

El resultado de la ejecución muestra un error, cero advertencias y cero mensajes de información. El error nos indica que al tener el programa un texto entre comillas simples entonces dicho texto no se puede traducir a otros idiomas por lo que la forma de corregir esto es crear un elemento de texto y particularmente un símbolo de texto.

Antes de corregir el error y volver a ejecutar el inspector de código veamos la verificaciones que se incluyen dentro de la variante de verificación DEFAULT que acabamos de utilizar, para ello hacemos clicl en el botón Code Inspector de la barrera de herramientas.

Una vez dentro de las variantes de verificación vamos hacer clic en el botón de las caritas de modo que pase a global, luego escribimos DEFAULT y hacemos clic en visualizar.

A continuación vamos a visualizar el listado de test y particularmente los que tengan la marca de selección son aquellos que están incluidos en la variante de verificación DEFAULT.

Y para corregir el error que nos muestra el inspector de código reemplazamos el texto entre comillas simples por el símbolo de texto y activamos el programa. Y volvemos a ejecutar el inspector de código para comprobar que con el cambio que realizamos se corrigió el erro. Y finalmente comprobamos que la herramienta ya no detecta más errores.