URL:
https://github.com/SSSD/sssd/pull/756
Title: #756: TESTS: Add test case title with @title in docstrings
mrniranjan commented:
"""
I have two questions:
1. Is the IDM-SSSD-TC string significant in any way for downstream testing? What
happens if we add a test that does not have this string?
It's a format that we have been using for test cases in Polarion. sssd team has
IDM-SSSD-TC, IPA uses IDM-IPA-TC . The test cases are first added manually in Polarion
and then when the junit.xml results are imported in Polarion, the Polarion junit importer
uses the test cases names in junit to match it what exists to create test runs.
2. Should we have a test that makes sure that test methods have a docstring in some
prescribed format?
I think so, Generally in downstream all the test cases (only pytest) have below
information in docstrings for each test case
@Title
@Description
@Setup
@Steps
@expectedResults
At least @Title is required if not others to create test run in Polarion.
"""
See the full comment at
https://github.com/SSSD/sssd/pull/756#issuecomment-465571884