Primeros pasos
De cero a una prueba que pasa en cinco minutos.
Todo lo de aquí usa la herramienta de línea de comandos, gratuita y de código abierto. La app de Mac lee los mismos archivos; puede añadirla más tarde o nunca.
1. Instalar
Con Homebrew, en macOS y en Linux:
$ stamp run api/orders.stamp env=staging region=latam
→ POST https://api.staging.latam.example.com/api/login orders.stamp › logIn
200 OK 142 ms 612 bytes
✓ status == 200
→ GET https://api.staging.latam.example.com/api/orders?limit=20 orders.stamp › orders
200 OK 88 ms 4 KB
✓ all(body.items, o => o.total > 0)
│ 20 orders
✓ 2 requests, 2 assertions
Se instala con dos nombres, stamp y stampdrill. Son el mismo programa; esta página escribe stamp.
2. Escribir la primera petición
Cree un archivo api/orders.stamp. Una petición es la línea que escribiría de todos modos, y debajo las comprobaciones que normalmente guarda en la cabeza:
@base = {{host}}/api
### Log in
POST {{base}}/login
Content-Type: application/json
{ "username": "{{username}}", "password": "{{password}}" }
> assert status == 200
> set token = body.token
### Orders
@needs logIn
@auth bearer {{token}}
GET {{base}}/orders?limit=20
> assert all(body.items, o => o.total > 0)
> print length(body.items) + " orders"
Envíela con stamp run api/orders.stamp. Las líneas que empiezan por > se ejecutan cuando llega la respuesta: assert deja constancia de si algo se cumple, set pasa un valor a las peticiones siguientes.
3. Dimensiones en lugar de una lista de entornos
Un archivo environment.stamp nombra los ejes por los que varía su API y dice, para cada grupo de variables, dónde se aplica:
dimension env = test, staging, prod
dimension region = latam, mena, apac, dach
vars {
host = localhost(8080)
}
vars env=staging|prod {
host = "api." + env + "." + region + ".example.com"
}
vars env=prod {
password = secret(getenv("PROD_PASSWORD"))
}
Elija un valor por eje al ejecutar: stamp run api/orders.stamp env=staging region=latam. Gana el conjunto más específico que encaje, y * significa cualquier valor.
4. Escribir un plan de pruebas
Un plan vive junto a las peticiones que ejecuta. Se repite sobre una matriz de dimensiones, toma filas de CSV o JSON y da a cada iteración su propia sesión, para que ningún token se filtre entre ellas:
plan Checkout {
matrix env = staging|prod, region = *
parallel 4
retry 2 every 500ms
setup { run logIn }
step "Browse" {
run listProducts with limit = 5
expect status == 200
expect time < 800
set productId = body[0].id
}
concurrently 10 {
sync "go"
run redeemCoupon with code = "WELCOME"
}
expect count(results, r => r.status == 200) == 1
}
stamp test . ejecuta los planes y sale con un código de error si falla alguna comprobación.
5. Ejecutarlo en CI
Las compilaciones de Linux son totalmente estáticas y no necesitan nada más en la máquina. Basta un paso:
stamp test . --junit reports/junit.xml
El código de salida es 1 cuando falla una comprobación y 2 cuando un archivo no se puede leer, así que un archivo roto se distingue de una prueba fallida. Con --html escribe en su lugar un informe para personas.
Seguir
- La guía cubre cada función, desde la terminal y desde la app. Está en inglés.
- La referencia del lenguaje describe toda la gramática
.stamp, también en inglés. - La visión general, si prefiere ver primero de qué se trata.