Primeros pasos

En este tutorial rápido aprenderás a:

  • Definir la configuración básica.
  • Definir un escenario.
  • Lanzar wakamiti.
  • Conocer el flujo de trabajo básico.

Ten en cuenta que este tutorial asume que tienes:

  • Algo de experiencia usando un terminal.
  • Algo de experiencia usando un editor de texto.
  • Comprensión básica de la sintaxis de gherkin.

Antes de empezar, necesitarás lo siguiente:

De forma opcional:

  • Instalar un IDE, como IntelliJ IDEA o VS Code. No es necesario tenerlo pero facilitará mucho el desarrollo de escenarios.

0. Poner en marcha la aplicación de ejemplo

Descomprime el zip descargado con el código fuente del tutorial, abre un terminal en ese directorio y levanta la aplicación con el siguiente comando:

docker compose up -d

1. Configurar Wakamiti

La configuración de Wakamiti se realiza mediante un fichero yaml que se situará en el directorio donde se ubiquen los tests. Por ejemplo, en el mismo con el código fuente del tutorial:

  tutorial
  ├── application-wakamiti.properties
  ├── docker-compose.yml
+ └── wakamiti.yaml

Esta es la configuración básica para poder ejecutar los tests:

wakamiti:
  resourceTypes:
    - gherkin
  launcher:
    modules:
      - mysql:mysql-connector-java:8.0.28
      - es.iti.wakamiti:rest-wakamiti-plugin:2.3.3
      - es.iti.wakamiti:db-wakamiti-plugin:2.3.3
      - es.iti.wakamiti:html-report-wakamiti-plugin:2.3.3
  htmlReport:
    title: Test
  rest:
    baseURL: http://host.docker.internal:9966/petclinic/api
  database:
    connection:
      url: jdbc:mysql://host.docker.internal:3309/petclinic?useUnicode=true
      username: root
      password: petclinic
      driver: com.mysql.cj.jdbc.Driver

NOTA
Ten en cuenta que cada plugin tiene su propia configuración, la cual puedes consultar en sus respectivos apartados. También puedes consultar otras opciones de configuración global.

2. Definir escenario

Cuando hacemos Behaviour-Driven Development utilizamos ejemplos concretos para especificar lo que queremos que haga el software. Los escenarios se escriben antes que el código de producción. Comienzan su vida como una especificación ejecutable. Cuando llega el código a producción, los escenarios adquieren un papel como documentación viva y pruebas automatizadas.

Un escenario pertenece a una característica concreta del software. Cada característica puede contener muchos escenarios, y se definen en archivos .feature que deberán estar en nuestro directorio de trabajo (o subdirectorio).

Un ejemplo concreto en este tutorial sería consultar un propietario de una mascota.

Crea un archivo vacío llamado example.feature con el siguiente contenido:

# language: es
Característica: Consultar propietarios
  
  Escenario: Se consulta un dueño existente
    Dado el servicio REST '/owners/{id}'
    Y el parámetro de ruta 'id' con el valor '20'
    Y que se ha insertado el siguiente usuario en la tabla de BBDD owners:
      | ID  | FIRST_NAME | LAST_NAME      |
      | 20  | Pepe       | Perez Martínez |
    Cuando se consulta el usuario
    Entonces el código de respuesta HTTP es 200
    Y la respuesta es parcialmente:
      """json
      {
        "id": 20,
        "firstName": "Pepe",
        "lastName": "Perez Martínez"
      }
      """

La segunda línea de este archivo comienza con la palabra clave Característica: seguida de un nombre. Es una buena idea usar un nombre similar al nombre del fichero.

La cuarta línea, Escenario: Se consulta un dueño existente, es un escenario, que es un ejemplo concreto que ilustra cómo se debe comportar el software.

El resto de líneas que comienzan con Dado, Cuando, Entonces, Y son los pasos de nuestro escenario, y es lo que Wakamiti ejecutará.

Ver más en detalle la sintaxis de gherkin.

3. Lanzar Wakamiti

Los test se ejecutan con el terminal, desde el directorio de trabajo (el que contiene las características de Wakamiti y el fichero .feature que hemos creado), con el siguiente comando:

  • Windows:
docker run --rm -v "%cd%:/wakamiti" wakamiti/wakamiti
  • Linux:
docker run --rm -v "$(pwd):/wakamiti" --add-host=host.docker.internal:host-gateway wakamiti/wakamiti

Con este comando, se lanzarán todos los tests que haya en el directorio, utilizando la última versión de wakamiti. Para trabajar con una versión específica, se debe de indicar en el comando docker: wakamiti/wakamiti:version, se pueden ver las versiones disponibles en el repositorio de dockerhub de Wakamiti.

4.Informes

Una vez ejecutados los tests, se generarán los resultados en dos formatos: wakamiti.json y wakamiti.html.

Los estados que existen actualmente en Wakamiti son:

  • PASSED: el caso de test está correcto, se recibe del sistema el mismo resultado que se espera.
  • NOT IMPLEMENTED: existe el caso de test, pero no están definidos sus pasos.
  • SKIPPED: no se ha ejecutado el caso de test.
  • UNDEFINED: no existe el paso en Wakamiti.
  • FAILED: hay un error de comprobación, no coincide lo que se espera de lo que devuelve el sistema.
  • ERROR: hay un error no esperado en el sistema (error de conexión, error en base de datos, error time out...).

¡Aquí la demo!