ucloud-newman-runner 0.17.0

Runner automatizado para execução de testes Newman (Postman CLI) com geração de relatórios (HTML, CSV, texto) e envio de email via Mailjet. Ideal para automação de QA, pipelines CI/CD e ambientes multi-cliente. Palavras-chave: newman, postman, api testing, relatórios, mailjet, ci/cd, automação, multi-cliente, python, cli.

ucloud-newman-runner

Automatize a execução de testes de APIs Postman/Newman, gere relatórios HTML customizados (Jinja2) e envie resultados por e-mail. Pronto para CI/CD, PyPI e Docker.

---

Visão Geral

O ucloud-newman-runner é um runner Python para automação de testes de APIs via Newman (Postman CLI), com geração de relatórios HTML, CSV e texto, além de envio automático por e-mail (Mailjet). Ideal para times de QA, pipelines CI/CD e ambientes multi-cliente.

• Execução automatizada de coleções Postman
• Relatórios HTML customizados (Jinja2)
• Envio de resultados por e-mail (Mailjet)
• Geração opcional de CSV e TXT
• Pronto para uso local, CI/CD, PyPI e Docker

---

Instalação Rápida

PyPI

pip install ucloud-newman-runner

Docker

docker pull ucloudservices/ucloud-newman-runner:latest
docker run --rm -v $(pwd):/data ucloudservices/ucloud-newman-runner:latest --run --collection /data/colecao.json --environment /data/env.json ...

---

Uso Básico

ucloud-newman-runner --run \
  --collection <colecao.json> \
  --environment <env.json> \
  --destination ./results/ \
  --mailjet-api-key <API_KEY> \
  --mailjet-api-secret <API_SECRET> \
  --send-email-to [e-mail]

Veja todos os parâmetros e exemplos em docs/USAGE.md.

Dica: Todos os parâmetros podem ser definidos por variável de ambiente (ex: MAILJET_API_KEY).

---

Estrutura do Projeto

ucloud-newman-runner/
├── src/runner/           # Core do runner (run.py, config.py, emailer.py, reporting.py)
├── src/runner/templates/ # Templates Jinja2 para relatórios
├── tests/                # Testes automatizados (pytest)
├── requirements.txt      # Dependências principais
├── pyproject.toml        # Configuração de build PyPI
├── .ci/                  # Dockerfile, entrypoint, CI/CD
├── README.md, LICENSE, ...

Mais detalhes em docs/ESTRUTURA.md.

---

Troubleshooting Rápido

• Template não encontrado:
  • Instale via pip e use o comando global. Para dev, o runner faz fallback automático.
• Erro ao enviar e-mail:
  • Verifique as credenciais do Mailjet e conectividade com a API.
• Permissão de escrita:
  • Garanta permissão nos diretórios de destino dos relatórios.
• Newman não encontrado:
  • Instale Node.js 18.12+, Newman e newman-reporter-htmlextra globalmente.

Veja mais dicas em docs/TROUBLESHOOTING.md.

---

Contribuição

1. Fork o projeto e crie uma branch para sua feature.
2. Siga PEP 8, use type hints e escreva testes.
3. Execute pytest e pre-commit antes de abrir PR.
4. Detalhe sua contribuição no PR e aguarde review.

Consulte docs/CONTRIBUTING.md para padrões e fluxo completo.

---

Licença

MIT. Veja o arquivo LICENSE.

---

Links Úteis

• PyPI: ucloud-newman-runner
• DockerHub: ucloudservices/ucloud-newman-runner
• Guia de Uso
• Guia de Estrutura
• Troubleshooting
• Guia de Contribuição