Test Parameter Reporter

A utility that enhances test reports by documenting test parameters with different visibility levels.

Capabilities

Parameter Documentation

Create a function that records test parameters for reporting purposes with different visibility levels.

Test cases:

• When called with username="testuser", password="secret123", api_endpoint="https://api.example.com", internal_debug_flag=True, it records the username parameter as visible @test
• When called with the same parameters, it records the password parameter but masks the actual value @test
• When called with the same parameters, it records the api_endpoint parameter as visible @test
• When called with the same parameters, it hides the internal_debug_flag parameter from the report @test

Implementation

@generates

API

def record_test_parameters(username: str, password: str, api_endpoint: str, internal_debug_flag: bool) -> None:
    """
    Records test parameters for documentation in test reports.

    Args:
        username: The username for the test (visible in report)
        password: The password for the test (should be masked in report)
        api_endpoint: The API endpoint being tested (visible in report)
        internal_debug_flag: Internal debugging flag (should be hidden from report)
    """
    pass

Dependencies { .dependencies }

allure-python-commons { .dependency }

Provides test reporting and parameter management capabilities.

@satisfied-by