Replays exportieren und importieren

Ein guter Satz Aufzeichnungen ist Arbeit, die man behalten will: die Fixtures, gegen die eine Testsuite läuft, die eingefangenen Antworten eines schwer erreichbaren Backends, die von Hand getunten Payloads einer Demo. Export packt die Replays eines Service in eine Datei; Import entpackt diese Datei in jeden Service, auf jeder Simulation.

Was die Datei enthält

Ein JSON-Dokument, mockzilla.replays/v1, beim Export gegzippt. Es trägt beide Hälften der Replay-Einrichtung eines Service:

• die Replay-Einstellungen des Service: an oder aus, TTL, Auto-Replay, Nur-Upstream,
• jeden exportierten Endpunkt mit seinem Match-Key,
• die Aufzeichnungen, mit Status, Inhaltstyp und dem Antwortbody in Base64.

{
  "format": "mockzilla.replays/v1",
  "replay": {
    "enabled": true,
    "duration": "24h",
    "endpoints": {
      "/pets/{petId}": {
        "GET": {
          "match": { "path": ["petId"], "query": [], "body": [] },
          "recordings": [
            {
              "match": { "path:petId": "42" },
              "source": "manual",
              "status": 200,
              "contentType": "application/json",
              "body": "eyJpZCI6NDIsIm5hbWUiOiJSZXgifQ=="
            }
          ]
        }
      }
    }
  }
}

Das Dokument nennt keine Simulation und keinen Service: Es importiert in den Service, auf den du zeigst. Beispieldatei herunterladen im Import-Dialog gibt eine kleine gültige zum Starten heraus.

Exportieren

Wähle in Replays den Service, hake die Endpunkte an und klicke Exportieren in der Leiste, die erscheint. Die Zahl daneben ist die Menge der Aufzeichnungen in der Auswahl.

Der Download heißt <service>-replays.json.gz. Bis zu 500 Aufzeichnungen passen in einen Export; Leserechte reichen dafür.

Importieren

Klicke Importieren über den Einstellungen, dann lege die Datei ab, wähle sie aus oder füge eine URL ein. .json und .json.gz funktionieren beide, bis 10 MB.

• Bei Konflikt überspringen entscheidet, was passiert, wenn das Ziel unter demselben Endpunkt und denselben Match-Werten schon eine Aufzeichnung hält: die vorhandene behalten (der Standard) oder mit der importierten überschreiben.
• Am Ende meldet der Dialog, wie viele Aufzeichnungen importiert und wie viele übersprungen wurden.

Ein Import bringt die Konfiguration mit: Die Match-Keys und Service-Einstellungen aus der Datei landen neben den Aufzeichnungen in der Simulation. Wie überall bei Replays werden die Aufzeichnungen sofort ausgeliefert, die Konfiguration greift mit dem nächsten Deploy. Ein Import verändert die Simulation und braucht darum die Editor-Rolle.

Replays bewegen

Weil die Datei an keinen Service gebunden ist, füttert derselbe Export viele Ziele:

• Die Simulation im Team: Du exportierst aus deiner, jemand importiert in seine, und beide laufen gegen identische Fixtures.
• Eine frische Simulation: Sim neu anlegen, importieren, und Aufzeichnungen samt Match-Keys sind zurück, ohne Traffic abzuspielen.
• Ein geteilter Referenzsatz: Lege die exportierte Datei dorthin, wo dein Team Dateien ablegt, ein Wiki, einen Bucket oder ein Repo, und alle importieren sie per URL. Wer die Datei aktualisiert, aktualisiert, was der nächste Import bringt.

Siehe Replays aufzeichnen und ansehen dafür, wie Aufzeichnungen überhaupt entstehen und gematcht werden.