Schnellstart

Von nichts zu einem bestandenen Test in fünf Minuten.

Alles hier benutzt das freie, quelloffene Kommandozeilenwerkzeug. Die Mac-App liest dieselben Dateien; Sie können sie später hinzunehmen oder nie.

1. Installieren

Mit Homebrew, auf macOS und 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

Das Werkzeug meldet sich unter zwei Namen, stamp und stampdrill. Es ist dasselbe Programm; diese Seite schreibt stamp.

2. Die erste Anfrage schreiben

Legen Sie eine Datei api/orders.stamp an. Eine Anfrage ist die Zeile, die Sie ohnehin schreiben würden, und darunter die Prüfungen, die Sie sonst im Kopf behalten:

@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" 

Senden Sie sie mit stamp run api/orders.stamp. Zeilen, die mit > beginnen, laufen, sobald die Antwort da ist: assert hält fest, ob etwas stimmt, set gibt einen Wert an spätere Anfragen weiter.

3. Dimensionen statt einer Liste von Umgebungen

Eine environment.stamp benennt die Achsen, entlang derer Ihre API variiert, und sagt für jede Gruppe von Variablen, wo sie gilt:

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"))
}

Wählen Sie beim Lauf einen Wert je Achse: stamp run api/orders.stamp env=staging region=latam. Der genaueste passende Satz gewinnt, und * steht für jeden Wert.

4. Einen Testplan schreiben

Ein Plan liegt neben den Anfragen, die er ausführt. Er wiederholt sich über eine Matrix aus Dimensionen, nimmt Zeilen aus CSV oder JSON und gibt jeder Iteration eine eigene Sitzung, damit keine Token zwischen ihnen überlaufen:

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 . führt die Pläne aus und beendet sich mit einem Fehlercode, wenn eine Prüfung fehlschlägt.

5. In CI ausführen

Die Linux-Builds sind vollständig statisch und brauchen nichts weiter auf dem Rechner. Ein Schritt genügt:

stamp test . --junit reports/junit.xml

Der Exit-Code ist 1, wenn eine Prüfung fehlschlägt, und 2, wenn eine Datei nicht gelesen werden kann, sodass eine kaputte Datei von einem fehlgeschlagenen Test zu unterscheiden ist. --html schreibt stattdessen einen Bericht für Menschen.

Weiter