feat(fw/consume): write the test class & function docstrings to _info["description"] for use in hive reports

[danceratopz]

🗒️ Description

This PR:

• Adds new fields "description" and "url" in the _info section.
  • description contains the current test class and test function docstrings concatenated.
  • url provides a permalink to the test function python source on Github.
• Uses these new fields and sends it to the Hive Server when creating a new HiveTest in the pytest_hive plugin. This makes a test description available in HiveView.

This will blow up the size of the test fixtures a bit and heavily parametrized fixtures will contain a lot of duplicate information.

This does not attempt to solve the problem of documenting test parametrizations, but this approach could be extended in the future to accommodate for better documentation of parametrized test cases.

Fixture Example

        "_info": {
            "hash": "0x49c7ec7f916b13baf19e826ce163bec98d07cb1ef05820d26f0a3e68d2ffe03e",
            "comment": "`execution-spec-tests` generated test",
            "filling-transition-tool": "evm version 1.14.1-unstable-d6e91e2e-20240507",
            "description": "Test function documentation:\n\n    Fill stack with PUSH0, then OR all values and save using SSTORE.",
            "url": "https://github.com/ethereum/execution-spec-tests/blob/826425cf5b1215f285027746d116c72f04bae44c/tests/shanghai/eip3855_push0/test_push0.py#L75",
            "reference-spec": "https://github.com/ethereum/EIPs/blob/master/EIPS/eip-3855.md",
            "reference-spec-version": "42034250ae8dd4b21fdc6795773893c6f1e74d3a"
        }

Consume/Hive Test Report Description Example

Todo

• Clean-up duplicate info contained in class and function docstrings in the scope of this PR.
• Test in hiveview.
• Fix hiveview test display name (just use consume pytest test id).
• Fix annoying bug introduced in framework tests.

🔗 Related Issues

None

✅ Checklist

• All: Set appropriate labels for the changes.
• All: Considered squashing commits to improve commit history.
• All: Added an entry to CHANGELOG.md.
• All: Considered updating the online docs in the ./docs/ directory.
• Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
• Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
• Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

[spencer-tb]

Thanks for fixing this! Added a couple comments :)

[danceratopz]

@spencer-tb Here's the size difference in fixture directories with and without "description" and "url" fields. Seems reasonable, imo.

➜ du -hs fixtures-description/ fixtures-main
82M	fixtures-description/
80M	fixtures-main

execution-spec-tests on  main [$!?] via 🐍 310-est-gentest-rpc-refactor 
➜ du -s fixtures-description/ fixtures-main
83748	fixtures-description/
81096	fixtures-main

[marioevz]

This is awesome 😀

[marioevz]

Looking good so far! Some very subtle comments.

[marioevz]

LGTM!

You can apply or discard the comment I made.