How to rename the test cases of html report generated by PyTest

Question

Below is the HTML report generated by PyTest with Test case name as "test_demo.py::test_demo_framework[0]" instead of this method's name I want to display some actual tests name like "Verify username and password" which ideally describes what kind of test was performed and gives a better understanding to the Report reader, obviously from method name/number, it's hard to identify what was tested as part this Tests.

I want to rename the yellow highlighted Testcases's name.

You may want to look at his [answer](https://stackoverflow.com/questions/59996968/pytest-best-way-to-add-test-description-long-test-name-in-the-report-with-out) — syfluqs, Feb 29 '20 at 16:22

score 3 · Accepted Answer · answered May 15 '20 at 18:57

3

Use this hookwrapper in conftest:

@pytest.mark.hookwrapper
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result() 
    test_fn = item.obj
    docstring = getattr(test_fn, '__doc__')
    if docstring:
        report.nodeid = docstring

And for each test you run, you will have a specific name. Also you can make it dynamic(using a parameter) - eg:

def test_username(my_username):
 test_username.__doc__ = "Verify username and password for: " + str(my_username)

answered May 15 '20 at 18:57

Ana G

46
2

Thanks @Ana G for suggesting the dynamic approach. – PraveenS May 21 '20 at 05:31
Unfortunately this approach doesn't work with xdist. An assertion in the xdist code fails if `report.nodeid` is changed. – John29 Jul 14 '21 at 20:59

score 1 · Answer 2 · answered Aug 11 '22 at 15:18

I'm not worthy enough yet to comment, so here goes the answer.

xdist indeed does not like changed report.nodeid, but there's a workaround:

@pytest.mark.hookwrapper
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result() 
    test_fn = item.obj
    docstring = getattr(test_fn, '__doc__')
    if docstring:
        report.docstring = docstring

And then you can use the following hook to overwrite the TC name in the report (again, in conftest.py):

@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):
    for cell in cells:
        if cell.attr.class_ == "col-name":
            if hasattr(report, "docstring"):
                cell[0] = report.docstring
            break

How to rename the test cases of html report generated by PyTest

2 Answers2