Arquitectura



Configuración global

La configuración de Wakamiti se establece mediante un fichero yaml ubicado en el directorio de pruebas. Por defecto, Wakamiti buscará el fichero con el nombre wakamiti.yaml.

wakamiti.resourceTypes

  • Tipo: string obligatorio

Establece el tipo de recurso de los escenarios de prueba. Actualmente solo está disponible gherkin.

Ejemplo:

wakamiti:
  resourceTypes: gherkin

wakamiti.language

  • Tipo: locale
  • Por defecto: en

Establece el lenguaje de los escenarios de prueba.

wakamiti.resourcePath

  • Tipo: file
  • Por defecto: . (ruta donde se encuentra el fichero de configuración)

Establece la ruta donde se encuentran los ficheros de las pruebas.

Ejemplo:

wakamiti:
  resourcePath: /other/path

wakamiti.outputFilePath

  • Tipo: file
  • Por defecto: wakamiti.json (en el directorio actual)

Establece el directorio de salida del fichero con el resultado de las pruebas.

La ruta puede contener las siguientes variables de sustitución:

variable sustitución
%YYYY% año (4 dígitos)
%YY% año (2 dígitos)
%MM% mes
%DD% día de mes
%hh% hora (formato 24H)
%mm% minutos
%ss% segundos
%sss% milisegundos (3 dígitos)
%DATE% %YYYY%%MM%%DD%
%TIME% %hh%%mm%%ss%%ssss%
%execID% ID único de ejecucicón

Ejemplo:

wakamiti:
  outputFilePath: result/wakamiti.json

wakamiti.outputFilePerTestCase

  • Tipo: boolean
  • Por defecto: false

Establece si se debe generar un fichero de salida por cada caso de test. En caso de activarse, el valor de wakamiti.outputFilePath será el directorio destini, y el nombre del fichero será el propio ID del caso de test.

Ejemplo:

wakamiti:
  outputFilePerTestCase: true

wakamiti.tagFilter

  • Tipo: string

Filtra los escenarios etiquetados con la expresión indicada.

Ejemplo:

wakamiti:
  tagFilter: not Ignore

wakamiti.idTagPattern

  • Tipo: regex
  • Por defecto: ID-(\w*)

Establece el patrón de identificadores de los escenarios. Debe contener una expresión regular válida.

Ejemplo:

wakamiti:
  idTagPattern: ([0-9]+)

wakamiti.strictTestCaseID

  • Tipo: boolean
  • Por defecto: false

Establece si se debe asegurar que cada caso de test esté debidamente etiquetado con un valor que cumpla con el patrón de idTagPattern. En caso de activarse y que no se cumpla dicha condición, la ejecución se detendrá con un error informando de ello.

Ejemplo:

wakamiti:
  strictTestCaseID: true

wakamiti.launcher.modules

  • Tipo: string[]

Establece los módulos que serán utilizados durante las pruebas. Estos módulos son artefactos maven ubicados en un repositorio indicado en la configuración. Se debe indicar con el patrón <groupId>:<artifactId>:<version>.

Ejemplo:

wakamiti:
  launcher:
    modules:
      - es.iti.wakamiti:wakamiti-rest:1.0.0
      - es.iti.wakamiti:wakamiti-db:1.0.0
      - mysql:mysql-connector-java:8.0.28

wakamiti.report.generation

  • Tipo: boolean
  • Por defecto: true

Indica si se generará el informe con el resultado de las pruebas al terminar la ejecución o no.

Ejemplo:

wakamiti:
  report: 
    generation: "false"

wakamiti.redefinition.definitionTag

  • Tipo: string
  • Por defecto: definition

Establece la etiqueta para indicar que la caracteristica es una definición.

Ejemplo:

wakamiti:
  redefinition:
    definitionTag: def

wakamiti.redefinition.implementationTag

  • Tipo: string
  • Por defecto: implementation

Establece la etiqueta para indicar que la caracteristica es una implementación.

Ejemplo:

wakamiti:
  redefinition:
    implementationTag: impl

wakamiti.properties.hidden

  • Tipo: string[]

Establece las propiedades que permanecerán ocultas en el informe de pruebas.

Ejemplo:

wakamiti:
  properties:
    hidden: 
      - token
      - credentials.password

wakamiti.log.path

  • Tipo: file

Establece el directorio donde se creará un fichero de log con nombre wakamiti-${yyyyMMddhhmmss}.log, donde ${yyyyMMddhhmmss} es el patrón de la fecha del sistema. Por defecto no se creará el log.

Ejemplo:

wakamiti:
  log:
    path: results

wakamiti.log.level

  • Tipo: string
  • por defecto: info

Establece el nivel de los logs de wakamiti. Dependiendo del nivel indicado se mostrará u omitirá más o menos información. Los posibles valores son: info, error, fatal, warning, debug, trace. Leer más

Ejemplo:

wakamiti:
  log:
    level: debug

wakamiti.logs.ansi.enabled

  • Tipo: boolean
  • por defecto: true

Establece si los logs por consola deben usar códigos de control ANSI.

Ejemplo:

wakamiti:
  logs:
    ansi:
      enabled: true
  • Tipo: boolean
  • por defecto: true

Establece si se debe mostrar el logo de Wakamiti en los logs por consola al inicio de la ejecución.

Ejemplo:

wakamiti:
  logs:
    showLogo: true

wakamiti.logs.showElapsedTime

  • Tipo: boolean
  • por defecto: true

Establece si se debe mostrar los tiempos transcurridos en los logs por consola.

Ejemplo:

wakamiti:
  logs:
    showElapsedTime: true

wakamiti.junit.treatStepsAsTests

  • Tipo: boolean
  • por defecto: false

Establece si, al usar el runner JUnit de Wakamiti, se debe notificar cada paso como test (para que los informes y resultados derivados de JUnit sean más relevantes).

Ejemplo:

wakamiti:
  junit:
    treatStepsAsTests: true

wakamiti.nonRegisteredStepProviders

  • Tipo: string[]

Permite incluir proveedores de pasos de forma dinámica, sin de que formen parte de ningún plugin. De esta manera, se pueden crear pasos ad hoc para necesidades del proyecto específico a testear.

Ejemplo:

wakamiti:
  nonRegisteredStepProviders:
    - com.example.CustomSteps

mavenFetcher.remoteRepositories

  • Tipo: URL[]

Establece repositorios remotos.

Ejemplo:

mavenFetcher:
  remoteRepositories: https://repo.maven.apache.org/maven2;file:///home/user/.m2/repository

mavenFetcher.localRepository

  • Tipo: file

Establece la ubicación del repositorio local.

Ejemplo:

mavenFetcher:
  localRepository: /usr/mvn-repo

Configuración de features

Adicionalmente, a la configuración global, se pueden incluir propiedades específicas en cada fichero feature.

language

  • Tipo: locale
  • Por defecto: en

Establece el idioma (identificado mediante ISO 639-1) en el que se va a escribir los escenarios del fichero.

Ejemplo:

# language: es
Feature: ...

dataFormatLanguage

  • Tipo: locale
  • Por defecto: en

Establece el idioma (identificado mediante ISO 639-1) en el que se va a escribir los valores de los parámetros de los pasos, en los casos en los que se acepten formatos localizados, como el caso de fechas y números que usen separadores.

Ejemplo:

# language: es
# dataFormatLanguage: en  
Feature: ...

modules

  • Tipo: string[]

Restringe los pasos que se van a usar en un fichero, para evitar posibles conflictos de expresiones entre varios plugins que no se hayan diseñado para trabajar juntos.

Ejemplo:

#modules: database-steps, rest-steps
Feature: ...

redefinition.stepMap

  • Tipo: integer[]

Para los casos en los que un escenario esté representado a nivel de definición y de implementación, esta propiedad permite realizar la correspondencia entre los pasos de definición y de la implementación, en el caso que no sea una traslacion 1-a-1.

El valor debe ser una lista de números separada por -, en la que cada número indica la cantidad de pasos de implementación que corresponden al paso de definición de la misma posición. Por ejemplo, el valor 1-2-1 implica la siguiente correspondencia:

definición implementación
1 1
2 2,3
3 4

Esta propiedad se debe definicion en la parte de la implementación, encima del escenario en cuestión. Además, el escenario debe tener un identificador unívoco.

Ejemplo:

@implementation
Feature: ...

  
# redefinition.stepMap: 2-1-2  
@ID-43242   
Scenario: ...

Tipos de datos

text

Cualquier texto entrecomillado con ''.

Ejemplo: 'texto de ejemplo'.

word

Cualquier palabra (admite guiones).

Ejemplo: AB_C-1D.

file

Una ruta local (relativa o absoluta).

Ejemplo: 'dir/file.yaml'.

url

Ejemplo: https://localhost/test.

integer

Un número entero.

Ejemplo: 14.

decimal

Un número con decimales.

Ejemplo: 14.5.

date

Una fecha con formato yyyy-MM-dd.

Ejemplo: '2022-02-22'.

time

Una hora con formato hh:mm, hh:mm:ss o hh:mm:ss.SSS.

Ejemplo: '12:05:06.468'.

datetime

Una fecha y hora con formato yyyy-MM-ddThh:mm, yyyy-MM-ddThh:mm:ss o yyyy-MM-ddThh:mm:ss.SSS.

Ejemplo: '2022-02-22T12:05:06.468'.

text-assertion

Comparador de textos. Ver más.

Ejemplo: es igual a 'algo'.

long-assertion

Comparador de números enteros. Ver más.

Ejemplo: es igual o mayor que 13.

float-assertion

Comparador de números decimales. Ver más.

Ejemplo: es igual o menor que 10.02.

document

Bloque de texto ubicado en la siguiente línea de la descripción del paso. Ver más.

Ejemplo:

"""
Un texto 
multilínea
"""

table

Tabla de datos ubicada en la siguiente línea de la descipción del paso. Ver más.

Ejemplo:

| USER  | STATE | BLOCKING_DATE |
| user1 | 2     | <null>        |

Comparadores

Fragmentos de texto que se traducen en comparadores para distintos tipos de datos, reutilizables en cualquier paso. Los tipos de comparadores disponibles son:

  • text-assertion
  • integer-assertion
  • long-assertion
  • decimal-assertion

(no) es (igual a) ~x~

Tipo: numérico y texto. También admite las variantes es (igual a) ~x~ \(sin distinguir mayúsculas\) y es (igual a) ~x~ \(ignorando espacios\) para las comparaciones de tipo texto, y la versión en negativo.

Ejemplos

es 14
es igual a 22
es igual a 'algo'
es 'algo'
es igual a 'aLgo' (sin distinguir mayúsculas)
es igual a ' algo ' (ignorando espacios)
no es igual a 14

(no) es (mayor|menor) que ~x~

Tipo: numérico. También admite decimales y la versión en negativo.

Ejemplos

es mayor que 14
es mayor que 14.3
es menor que 14
es menor que 14.3
no es mayor que 14

(no) es (mayor|menor) o igual que ~x~

Tipo: numérico. También admite decimales y la versión en negativo.

Ejemplos

es mayor o igual que 14
es mayor o igual que 14.3
es menor o igual que 14
es menor o igual que 14.3
no es mayor o igual que 14

(no) empieza por ~x~

Tipo: texto. También admite la variante empieza por ~x~ \(sin distinguir mayúsculas\), y la versión en negativo.

Ejemplos

empieza por 'algo'
empieza por 'aLgo' (sin distinguir mayúsculas)
no empieza por 'algo'

(no) acaba en ~x~

Tipo: texto. También admite la variante acaba en ~x~ \(sin distinguir mayúsculas\), y la versión en negativo.

Ejemplos

acaba en 'algo'
acaba en 'aLgo' (sin distinguir mayúsculas)
no acaba en 'algo'

(no) contiene ~x~

Tipo: texto. También admite la variante contiene ~x~ \(sin distinguir mayúsculas\), y la versión en negativo.

Ejemplos

contiene 'algo'
contiene 'aLgo' (sin distinguir mayúsculas)
no contiene 'algo'

(no) es nulo

Tipo: numérico y texto. También admite la versión en negativo.

Ejemplos

es nulo
no es nulo

(no) está vacío

Tipo: numérico y texto. También admite la versión en negativo.

Ejemplos

está vacío
no está vacío

(no) es nulo o está vacío

Tipo: numérico y texto. También admite la versión en negativo.

Ejemplos

es nulo o está vacío
no es nulo o está vacío

Propiedades dinámicas

Wakamiti permite el uso de propiedades dinámicas con las que facilitar el paso de información a la ejecución de los escenarios mediante la sintaxis ${[descripción de la propiedad]}.

La [descripción de la propiedad] dependerá del tipo de propiedad que se desea aplicar.

Propiedad global

Obtener el valor de una propiedad global, mediante la sintaxis ${[name]}, donde [name] es el nombre de una propiedad que esté presente en la configuración de Wakamiti.

Ejemplos

Tenemos la siguiente configuración en el fichero wakamiti.yaml:

wakamiti:
  resourceTypes:
    - gherkin
    
  credentials:
    username: user
    password: s3cr3t

Tenemos el siguiente paso:

Dado que el servicio usa autenticación oauth con las credenciales '${credentials.username}':'${credentials.password}'

Al ejecutarse, se resolvería como:

Dado que el servicio usa autenticación oauth con las credenciales 'user':'s3cr3t'

Propiedad de resultado

Obtener el resultado de un paso anterior, mediante la sintaxis ${[número del paso]#[expresión xpath/jsonpath/gpath]}, donde [número de paso] es la posición del paso del cuál se quiere recuperar el resultado, y [expresión xpath/jsonpath/gpath] es la expresión para recuperar, de forma opcional, un dato concreto cuando el resultado es un objeto complejo, como un xml, un json o incluso un texto.

Ver más sobre JSONPath, XPath o GPath.

Ejemplos

Supongamos que el paso 1 devuelve lo siguiente:

{
  "headers": {
    "Content-type": "json/application",
    "Connection": "Keep-alive"
  },
  "body": {
    "items": [
      {
        "id": 4,
        "name": "Pepe"
      },
      {
        "id": 7,
        "name": "Ana"
      }
    ]
  },
  "statusCode": 200,
  "statusLine": "HTTP/1.1 200 OK"
}

Tenemos el siguiente paso:

Entonces un usuario identificado por '${1#$.body.items[0].id}' existe en la tabla de BBDD USERS

Al ejecutarse, se resolvería como:

Entonces un usuario identificado por '4' existe en la tabla de BBDD USERS