aaset (Automatic Ada Symbolic Execution Tool) es una herramienta para la ejecución simbólica de manera automática de código fuente Ada.
A través de un sencillo formulario web se debe indicar un módulo y subir el código fuente empaquetado en un fichero .tar
Una vez subido el código fuente se analizarán todos los procedimientos incluidos en el fichero de especificación con el mismo nombre que el módulo indicado en el formulario. Por ejemplo, si el módulo indicado es "prueba" se analizarán todos los procedimientos incluidos en el paquete prueba.ads.
Automáticamente se creará un nuevo paquete con un código fuente que declare todas las variables necesarias para realizar las llamadas a los procedimientos encontrados, estableciéndola como simbólicas mediante el uso de las librerías de KLEE. Finalmente, una vez las variables han sido declaras y hechas simbólicas se realizarán las llamadas a todos los procedimientos, pasándoles como argumentos las variables necesarias. De esto modo se ejecutaría la aplicación de manera simbólica.
Una vez generados mediante el uso de gnat-llvm los bytecodes del código fuente generado más un bytecode que incluya los bytecodes de cada uno de los paquetes incluidos en el tar (esto es necesario para linkarlo con el bytecode principal, al fin de marcar como internos todos los subprogramas dentro del código fuente proporcionado) se ejecuta simbólicamente la aplicación mediante KLEE, generando los casos de pruebas así como algunos errores en la ejecución.
Concluída la ejecución simbólica, se ejecutará la herramienta converter que se encargará de ejecutar los procedimientos declarados en el módulo de una manera concreta, utilizando los casos de prueba generados en la ejecución simbólica. La herramienta aaset creará automáticamente un nuevo paquete dentro de la herramienta converter que declare todas las variables necesarias para la llamada a todos los procedimientos declarados en la especificación del módulo indicado (de la misma manera que el código fuente para realizar la ejecución simbólica). Luego, leerá en el mismo orden en que fueron declaradas, tomadas como argumentos de ejecución una representación en entero de cada variable, obteniendo dicha representación de los casos de prueba, y convirtiendo esa representación en entero en un objeto del tipo correspondiente a cada variable. Cuando todas las variables estén asignadas a los valores del caso de prueba a analizar se realizarán las llamadas a todos los procedimientos declarados en la especificación del módulo, ejecutándose la aplicación de manera concreta, con el fin de buscar errores en tiempo de ejecución para cada uno de los casos de pruebas generados por KLEE durante la ejecución simbólica.
Por cada error encontrado en la ejecución simbólica o concreta en cada caso de prueba se generará un fichero .txt con la información del caso de prueba y los errores en cuestión. Finalmente, se convertirán todos esos ficheros .txt en el reporte en formato JSON con toda la información para ser presentada al usuario. Asimismo, también se devolverá un JSON con los errores de compilación en el caso de que el código fuente para realizar la ejecución simbólica no pueda ser generado, ya sea por errores en el código fuente proporcionado o por algún error en la generación del nuevo código fuente. La cabecera 'Content-Type' de la respuesta está marcada como application/json por lo que dependiendo del navegador la visualización será distinta, pudiendo requerir la instalación de algún plugin para la presentación 'amigable' del reporte JSON.
Para la ejecución de la herramienta es necesario tener instalado:
aaset utiliza web2py como Framework para el desarrollo del servidor web. web2py está incluido como un submódulo del presente repositorio, por lo que será necesario inicilializarlo al clonar el repositorio:
git clone --recurse-submodules https://github.com/mgarcp13/aaset.git
Por defecto, el módulo web2py se inicializa al contenido del repositorio remoto, que no incluye la aplicación que implementa el servidor web. Esta aplicación se encuentra empaquetada dentro del directorio web-application. Este directorio contiene un subdirectorio llamado aaset y un fichero w2p que es un empaquetado de la aplicación para ser instalado a través de las opciones de administrador de web2py. Con el subdirectorio aaset se puede instalar la aplicación simplemente copiándolo al directorio web2py/application:
cp -r ./web-application/aaset ./web2py/applications
Arrancar la aplicación web2py:
python3 web2py/web2py.py
Indicar una contraseña de administración, puerto e IP del servidor.
Desde un navegador conectarse a la URL 127.0.0.1:8000/aaset/main/load
Introducir el módulo y subir un tar con el código fuente. Una vez generado el reporte se mostrará el reporte JSON en un formato de tablas, además de información en texto con un pequeño resumen de la ejecución.
Para la ejecución de la herramienta a través del REST API es necesario iniciar flask, que es el framework con el que se ha desarrollado el servidor web. El primer paso es indicar a flask qué servicio web debe indicar hay que modificar la variable de entorno FLASK_APP indicando el fichero python que implementa el servicio, en este caso web_service.py incluido en el directorio raiz del proyecto:
export FLASK_APP=web_service.py
Una vez indicado el servicio web a ejecutar hay que iniciar flask. Esto se hace con el comando, desde el directorio raiz de la herramienta:
flask run
En el propio inicio de flask se indica la URL en la que está escuchando el servidor para atender las peticiones:
Ahora cualquier cliente que lo desee puede obtener el reporte enviando un formulario vía POST con los mismos datos que para la ejecución web, obteniendo el reporte en JSON crudo. Por ejemplo, para ejecutar la herramienta haciendo uso de curl el comando sería:
curl -X POST http://127.0.0.1:5000/report -F "file=@/tmp/sample.tar" -F "module=q_math"
Aunque para una visualización más amigable del JSON se recomienda el uso de la herramienta jq:
curl -X POST http://127.0.0.1:5000/report -F "file=@/tmp/sample.tar" -F "module=q_math" | jq
Otra posibilidad es haciendo uso de la herramienta Postman:
