pytest-test-analyzer

A powerful Python tool that analyzes pytest test files and generates comprehensive reports. Get deep insights into your test suite by analyzing test structure, decorator patterns, and test organization. Perfect for understanding and maintaining large test suites, tracking test coverage patterns, and identifying areas for test optimization.

Features

• 🔍 Analyzes pytest test files and directories
• 📊 Generates detailed statistics about test cases
• 🏷️ Tracks pytest markers and decorators
• 📝 Supports multiple output formats (HTML, Markdown, Text)
• 🎯 Filter tests by decorators
• 📈 Provides class-wise and marker-wise statistics
• 🎨 Beautiful HTML reports with charts

Installation

pip install pytest-test-analyzer

Usage

Basic Usage

Analyze a test directory and generate an HTML report:

pytest-test-analyzer --path "path/to/tests" --output report.html --format html

Command Line Options

pytest-test-analyzer --path PATH [--output OUTPUT] [--format FORMAT] [--include INCLUDE] [--exclude EXCLUDE]

• --path: Path(s) to Python test files or directories (required)
• --output: Output file path
• --format: Output format - txt, html, or md (default: html)
• --include: Include only tests with specific decorators
• --exclude: Exclude tests with specific decorators

Examples

Analyzing Test Files

1. Analyze a single test file:

   pytest-test-analyzer --path "tests/test_login.py" --output login_analysis.html --format html
   

2. Analyze multiple specific test files:

   pytest-test-analyzer --path "tests/test_login.py" "tests/test_registration.py" --output auth_analysis.html
   

3. Analyze test files with specific patterns:

   pytest-test-analyzer --path "tests/test_*_api.py" --output api_analysis.html
   

Analyzing Test Directories

1. Analyze a single test directory:

   pytest-test-analyzer --path ./tests --output report.html --format html
   

2. Analyze multiple test directories:

   pytest-test-analyzer --path ./tests ./integration_tests --output report.html
   

3. Analyze nested test directories:

   pytest-test-analyzer --path ./tests/unit ./tests/integration --output nested_analysis.html
   

Filtering Tests

1. Include only tests with specific decorators:

   pytest-test-analyzer --path ./tests --include pytest.mark.sanity pytest.mark.regression
   

2. Exclude tests with specific decorators:

   pytest-test-analyzer --path ./tests --exclude pytest.mark.skip pytest.mark.xfail
   

3. Combine file and decorator filters:

   pytest-test-analyzer --path "tests/test_api.py" --include pytest.mark.smoke --output api_smoke.html
   

Output Formats

1. Generate a markdown report:

   pytest-test-analyzer --path ./tests --output report.md --format md
   

2. Generate a text report:

   pytest-test-analyzer --path ./tests --output report.txt --format txt
   

3. Generate HTML report with custom name:

   pytest-test-analyzer --path ./tests --output custom_name.html --format html
   

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please open an issue on GitHub.