Pular para o conteúdo
Menu da documentação

CI e integrações

Portões no CI

Como o seu CI pede scan de segurança, roda a suíte de testes e o teste de carga na AIUBY e usa o resultado como portão do job.

#Chaves e escopos

Cada pedido usa uma chave de API com só o escopo daquela etapa. Guarde a chave como segredo do repositório.

EscopoLibera
security:scanPedir scan de um repositório do catálogo. Não lê achados nem registra exceção.
security:readConsultar o portão de severidade do repositório.
tests:runDisparar a suíte Playwright e consultar o portão da execução.
load-test:runDisparar cenários de carga e consultar o veredito.

#Scan e portão de segurança

O CI pede o scan pelo nome do repositório, acompanha a execução e decide pelo portão.

bash
curl -X POST https://aiuby.com/api/v1/engineering/security/scans \
  -H "Authorization: Bearer $AIUBY_API_KEY" -H "Content-Type: application/json" \
  -d '{"repo":"empresa/api","ref":"main","scanners":["sast","sca"]}'

curl "https://aiuby.com/api/v1/engineering/security/scans/$SCAN_ID" -H "Authorization: Bearer $AIUBY_API_KEY"

curl "https://aiuby.com/api/v1/engineering/security/gate?repo=empresa/api&failOn=high&epssAtLeast=0.1&kev=true" \
  -H "Authorization: Bearer $AIUBY_API_KEY"
  • O portão reprova sem scan concluído do ref padrão (no_scan), com scanner que não terminou bem (scanner_missing) e com resultado cortado (incomplete_scan).
  • epssAtLeast (0 a 1) e kev=true só acrescentam bloqueios: um CVE do catálogo KEV reprova mesmo com exceção aprovada, e CVE sem consulta recente ao EPSS e ao KEV reprova como intel_missing.
  • O repositório precisa estar conectado e no catálogo do workspace.

#Suíte de testes

Roda a suíte Playwright do repositório no executor gerenciado, contra um alvo com posse verificada no Test Automation, e devolve o portão com as falhas classificadas.

bash
curl -X POST https://aiuby.com/api/v1/tests/runs \
  -H "Authorization: Bearer $AIUBY_API_KEY" -H "Content-Type: application/json" \
  -d '{"repo":"empresa/web","target":"staging","ref":"'$GITHUB_SHA'","browsers":["chromium"],"shards":2}'

curl "https://aiuby.com/api/v1/tests/runs/$RUN_ID" -H "Authorization: Bearer $AIUBY_API_KEY"

A resposta da consulta traz status e gate (pending, passed ou failed).

#Teste de carga

A carga é gerada pelo agente de entrega instalado no seu cluster, só contra alvo com posse verificada e dentro dos tetos configurados do seu lado. O CI escolhe o ambiente e de 1 a 5 cenários já cadastrados.

bash
curl -X POST https://aiuby.com/api/v1/load-tests/runs \
  -H "Authorization: Bearer $AIUBY_API_KEY" -H "Content-Type: application/json" \
  -d '{"environmentId":"<ambiente>","scenarioIds":["<cenário>"]}'

curl "https://aiuby.com/api/v1/load-tests/runs/$RUN_ID" -H "Authorization: Bearer $AIUBY_API_KEY"

O veredito sai do p95 de latência e da taxa de erro definidos no cenário. Os cenários se listam em GET /api/v1/load-tests/scenarios.

#GitHub Actions

A AIUBY entrega duas ações compostas, sem dependências, que fazem as chamadas acima e falham o job quando o portão reprova: uma para a suíte de testes (entradas api-key, target, browsers, shards, wait) e outra para a carga (api-key, environment-id, scenario-ids, wait). Peça os arquivos à equipe e coloque-os no seu repositório.

Atenção

As ações não estão no GitHub Marketplace. Em outro CI (GitLab, Jenkins), use as chamadas desta página.