Executar Testes (Jest)

Executa a suíte de testes com Jest e retorna um resumo com contagens de testes e suites.

Endpoint

POST /api/tests/run

Parâmetros

  • token (query): Token opcional para acesso. Alternativa ao header x-test-token.
  • x-test-token (header): Token opcional para acesso. Tem precedência sobre token.
  • watch (query, boolean): Executa em modo watch. Padrão false.
  • coverage (query, boolean): Coleta cobertura. Padrão false.
  • testPathPattern (query, string): Regex para filtrar caminhos de testes.
  • testNamePattern (query, string): Regex para filtrar nomes de testes.

Exemplo de requisição

curl -X POST "$BASE_URL/api/tests/run?coverage=true&testPathPattern=unit" \
  -H "x-test-token: $TEST_ENDPOINT_TOKEN"

Exemplo de resposta

{
  "success": true,
  "numTotalTests": 42,
  "numPassedTests": 40,
  "numFailedTests": 2,
  "numPendingTests": 0,
  "numTotalTestSuites": 10,
  "numPassedTestSuites": 9,
  "numFailedTestSuites": 1,
  "numRuntimeErrorTestSuites": 0,
  "startTime": 1736950000000,
  "endTime": 1736950050000,
  "coverageMap": "enabled"
}

Erros

CódigoDescrição
401Token inválido ou ausente
403Endpoint desabilitado (ENABLE_TEST_ENDPOINT diferente de true)
500Jest ausente na imagem ou ambiente