Skip to main content

Modern HTML formatter for Behave BDD reports

Project description

html-report-modern-formatter

Um formatter moderno em HTML para Behave, que gera relatórios interativos e visuais dos cenários BDD.

✨ Recursos

  • Relatórios em HTML com layout moderno e responsivo
  • Contabilização correta de cenários Passados, Falhados, Ignorados e Erros
  • Gráficos de pizza e cards de resumo
  • Suporte a screenshots por step (via Selenium)
  • Integração com tags @skip para cenários ignorados

🚀 Instalação

  • Após publicação no PyPI:
    pip install html-report-modern-formatter
    

🛠 Uso

  • Execute o Behave com o formatter:
    behave -f modern_html -o reports/results.html
    

📂 Estrutura do relatório

  • Resumo: cards com total de cenários por status
  • Gráfico: pizza com distribuição dos resultados
  • Detalhes: cada cenário com seus steps e screenshots

⚙️ Configuração de hooks

  • No arquivo environment.py, adicione os hooks abaixo para suportar cenários ignorados e screenshots:
    import os
    from datetime import datetime
    
    def before_scenario(context, scenario):
        # Ignora cenários marcados com @skip sem executar steps/hooks subsequentes
        if "skip" in scenario.tags:
            scenario.skip("Ignorado pelo marcador @skip")
    
    def after_step(context, step):
        # cria pasta se não existir
        os.makedirs("reports/screenshots", exist_ok=True)
    
        # gera nome único com timestamp
        timestamp = datetime.now().strftime("%y_%m_%d_%H_%M_%S")
        image_name = step.name.replace(' ', '_').replace('"', '')
        filename = f"reports/screenshots/{image_name}_{timestamp}.png"
    
        # salva screenshot via Selenium (somente se driver existir)
        if hasattr(context, "driver"):
            context.driver.save_screenshot(filename)
            # caminho relativo para o HTML
            step.screenshot = f"screenshots/{image_name}_{timestamp}.png"
        
    

📸 Screenshots

  • Os screenshots capturados em cada step são exibidos automaticamente no relatório HTML.

📜 Licença

  • Distribuído sob a licença MIT. Veja LICENSE para mais detalhes.

📦 Descrição para PyPI

Modern HTML formatter for Behave BDD reports. Generates interactive HTML reports with scenario statistics, charts, and screenshots support. Handles passed, failed, skipped, and error scenarios correctly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

html_report_modern_formatter-0.1.4.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

html_report_modern_formatter-0.1.4-py3-none-any.whl (2.4 kB view details)

Uploaded Python 3

File details

Details for the file html_report_modern_formatter-0.1.4.tar.gz.

File metadata

File hashes

Hashes for html_report_modern_formatter-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a67c007a67ec2d86944a8ed76639588eb68d6985335faa9e1d989a1eef4b5590
MD5 d61279b92811287dabec91595bf10bb1
BLAKE2b-256 30c503947bb8d50d8fe96ebfb6218f4a878455fef49b4e98864af20a20c4e7ea

See more details on using hashes here.

File details

Details for the file html_report_modern_formatter-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for html_report_modern_formatter-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 71a483e430e9c52fae8b8784c97f90f89266ab9b6249c0d2b7ef65142a730b7a
MD5 cf96bd8cf2b225e70f89492b89ba69ff
BLAKE2b-256 cf09739679af0c3db343bf3a806dcb8ab3c4f1e31c048a1dec92bb5b31fb1d4c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page