Feature/html report exporter

[aviralgarg05]

Description

Please include a summary of the changes and the related issue. Include relevant motivation and context.

Fixes # (issue)

Type of Change

Please delete options that are not relevant:

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Performance improvement
• Code refactoring
• Test coverage improvement
• Build/CI improvement

Changes Made

Please provide a detailed list of changes:

Testing

Please describe the tests you ran to verify your changes:

• Existing test suite passes (pytest)
• Added new tests for new functionality
• Manual testing performed
• Tested with multiple Python versions (3.10, 3.11, 3.12)

Test Configuration

• Python version:
• Operating System:
• Relevant adapters tested:

Test Results

# Paste relevant test output or results

Code Quality

• My code follows the project's style guidelines (Ruff, Black)
• I have run pre-commit run --all-files and addressed any issues
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings or errors
• I have added type hints where appropriate
• I have updated docstrings following Google style

Documentation

• I have updated relevant documentation (README, docs/, inline comments)
• I have added/updated docstrings for new/modified functions
• I have updated CHANGELOG.md under [Unreleased]
• I have added examples if introducing new features

Breaking Changes

If this PR introduces breaking changes, please describe:

• What breaks:
• Migration path for users:
• Deprecation warnings added (if applicable):

Dependencies

• No new dependencies added
• New dependencies added (list below with justification)

New dependencies:

• package-name: Reason for adding

Performance Impact

Describe any performance implications:

• No performance impact
• Performance improvement (describe and provide benchmarks)
• Potential performance regression (describe and justify)

Screenshots/Recordings (if applicable)

Add screenshots or recordings to help explain your changes:

Additional Context

Add any other context about the PR here:

• Links to related issues or PRs
• References to external documentation
• Design decisions and trade-offs
• Known limitations or future work

Checklist

• I have read the CONTRIBUTING.md guide
• My branch name follows the convention (feature/, fix/, docs/, etc.)
• My commit messages follow the conventional commit format
• I have tested my changes locally
• I have updated the documentation
• I have added tests that prove my fix is effective or that my feature works
• All new and existing tests pass
• I have checked for security vulnerabilities in any new dependencies

Reviewer Notes

Please pay special attention to:

Post-Merge Tasks

Tasks to complete after merging (if any):

• Update external documentation
• Announce in discussions/community
• Create follow-up issues for future work

Summary by CodeRabbit

• New Features

  • Added HTML report export feature that generates self-contained HTML documents with comprehensive test results, summary statistics, per-scenario success rates, and progress bar visualizations for easy sharing and review.

• Documentation

  • Updated documentation formatting by removing emoji icons from section headings for improved clarity and consistency.

• Security

  • Updated security contact email address in security policy documentation.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[continue]

Learn more

---

All Green is an AI agent that automatically:

✅ Addresses code review comments

✅ Fixes failing CI checks

✅ Resolves merge conflicts

---

Unsubscribe from All Green comments

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Updates SECURITY.md with new security contact email addresses, removes emoji icons from documentation headings, and introduces HTML report export functionality by adding a new render_html_report function and corresponding to_html method to the SuiteResult class.

Changes

Cohort / File(s)	Summary
Security Configuration SECURITY.md	Updated security contact email from opensource@agentunit.dev to gargaviral99@gmail.com in both "How to Report" and "Security Email" sections
Documentation Cleanup docs/architecture/advanced-features-roadmap.md	Removed emoji icons from section headings; content and structure unchanged
HTML Report Rendering src/agentunit/reporting/html.py	New module with render_html_report function that generates a complete, self-contained HTML report from SuiteResult, computing metrics, aggregating scenario results, escaping HTML, and including inline CSS and progress bars
Report Exporter Integration src/agentunit/reporting/results.py	Added to_html method to SuiteResult class to export results as HTML by invoking render_html_report and persisting output to file

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• aviralgarg05/agentunit#48: Introduces identical HTML report exporter functionality with the same render_html_report function and SuiteResult.to_html method.

✨ Finishing touches

• 📝 Generate docstrings

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1db98a6 and 1c1f9b4.

📒 Files selected for processing (4)

• SECURITY.md
• docs/architecture/advanced-features-roadmap.md
• src/agentunit/reporting/html.py
• src/agentunit/reporting/results.py

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}