fediverse-devnet / feditest

A testing framework for distributed, heterogeneous systems communicating with complex protocols, such as the Fediverse
https://feditest.org/
MIT License
30 stars 5 forks source link

Annotate the webfinger tests with descriptions #140

Closed jernst closed 2 months ago

jernst commented 3 months ago

... so the descriptions show up in the reports, not just the test identifiers.

steve-bate commented 3 months ago

Do you thinking of something along the lines of using __doc__ strings?

@test
def test_something():
    """This is a description of a test of something."""
   # The test
jernst commented 2 months ago

That's already working in the sandbox, e.g. the docstrings from https://github.com/fediverse-devnet/feditest-tests-sandbox/blob/develop/tests/sandbox/example_test_with_functions.py show up in the report.

steve-bate commented 2 months ago

Great!