Use details from the @Test TestNG annotation if present (e.g. description)

vlad230 commented 2 years ago

Hi guys,

I'm starting this issue topic as suggested by @bitcoder here: https://github.com/cbeust/testng/issues/1673

I'm working on an integration between TestNG + Allure Reports + Xray Jenkins plugin + Jira Xray in order to report results.

I think it would be a good idea to implement the propagation of the @Test TestNG annotation details like description to Jira Xray in the following way:

Make the Jira ticket summary take the value of the @Test description (if available, otherwise keep the test method name) rather than just using the name of the test method, without the need for extra annotations like @XrayTest or @Xray.

This behaviour is already used by other reporting tools like Allure Reports and the "description" attribute is already present by default inside the testng-results.xml:

.. <test-method signature="testPassing()[pri:0, instance:ui.tests.FreeTextEditorTest@7f9ab969]" started-at="2022-09-13T12:09:37 UTC" name="testPassing" description="Dummy test pass" finished-at="2022-09-13T12:09:37 UTC" duration-ms="1" status="PASS"> <reporter-output> </reporter-output> ...

I have used the now deprecated com.xpandit.xray.xray-testng-extensions and I think it would be easy to fix this since this one was putting the name of the test method in the Jira summary rather than the available description.

Keep the @XrayTest annotation behaviour to overwrite the new default behaviour for people who need more detailed customization.

Thanks!