Exportar e importar replays

Um bom conjunto de gravações é trabalho que vale guardar: as fixtures contra as quais uma suíte de testes roda, as respostas capturadas de um backend difícil de alcançar, os payloads ajustados na mão de uma demo. Exportar empacota os replays de um serviço em um arquivo; importar descompacta esse arquivo dentro de qualquer serviço, em qualquer simulação.

O que o arquivo contém

Um documento JSON só, mockzilla.replays/v1, comprimido com gzip na exportação. Ele leva as duas metades da configuração de replay de um serviço:

• as configurações de replay do serviço: ligado ou desligado, TTL, replay automático, só upstream,
• cada endpoint exportado com a chave de correspondência dele,
• as gravações, com status, tipo de conteúdo e o corpo da resposta em 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=="
            }
          ]
        }
      }
    }
  }
}

O documento não nomeia nenhuma simulação nem nenhum serviço: ele importa para o serviço que você apontar. Baixe um arquivo de exemplo, no diálogo de importação, entrega um pequeno e válido para começar.

Exportar

Em Replays, escolha o serviço, marque os endpoints que quer levar e clique em Exportar na barra que aparece. O número do lado é a quantidade de gravações que a seleção carrega.

O download se chama <serviço>-replays.json.gz. Cabem até 500 gravações em uma exportação; acesso de leitura já basta para fazer uma.

Importar

Clique em Importar acima das configurações, e depois solte o arquivo, procure ele, ou cole uma URL. .json e .json.gz funcionam, até 10 MB.

• Pular em caso de conflito decide o que acontece quando o destino já tem uma gravação sob o mesmo endpoint e os mesmos valores de correspondência: manter a que já está (o padrão) ou passar por cima com a importada.
• Ao terminar, o diálogo informa quantas gravações foram importadas e quantas foram puladas.

Uma importação traz a configuração junto: as chaves de correspondência e as configurações de serviço do arquivo caem na simulação junto com as gravações. Como em todo o Replays, as gravações são servidas na hora, enquanto a configuração vai no próximo deploy. Importar muda a simulação, então precisa do papel de editor.

Levar replays de um lado para outro

Como o arquivo não depende do serviço, a mesma exportação semeia vários lugares:

• A simulação de alguém do time: você exporta da sua, a pessoa importa na dela, e as duas rodam contra fixtures idênticas.
• Uma simulação nova: você recria uma sim, importa, e as gravações e as chaves de correspondência voltam sem reproduzir tráfego nenhum.
• Um conjunto canônico compartilhado: guarde o arquivo exportado onde o seu time guarda arquivo, um wiki, um bucket ou um repo, e deixe cada pessoa importar pela URL. Atualizar o arquivo atualiza o que a próxima importação traz.

Veja Gravar e ver replays para saber como as gravações são feitas e correspondidas em primeiro lugar.