Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotation Description with "useJavaDoc=true" using JUnit4 does not show in Allure Reports #982

Closed
focbenz opened this issue Jun 24, 2020 · 2 comments
Labels
type:bug Something isn't working

Comments

@focbenz
Copy link

focbenz commented Jun 24, 2020

Describe the bug
The Allure Report does not show the description if Maven JUnit4 is used with the Annotation @Description(useJavaDoc = true)

To Reproduce
Use the Git Repo: https://github.com/focbenz/allure-junit-example/tree/bug/javadoc-description-not-in-report or the following
Steps to reproduce the behavior:

  1. Add @Description(useJavaDoc = true) to an existing JUnit4 test case. e.g.
/**
  * This Javadoc describes the test that just passes. Demonstrates the use of Javadoc as test description.
  */
@Test
@Description(useJavaDoc = true)
public void simpleTestWithDescriptionFromJavadoc() throws Exception {
	assertThat(1, is(1));
}
  1. Run 'mvn clean test allure:report allure:serve' to see the report
  2. Check the description of test method simpleTestWithDescriptionFromJavadoc

Expected behavior
See the Javadoc as description in the report for the SimpleTest method simpleTestWithDescriptionFromJavadoc.

Screenshots
Allure_JUnit4_NoDescriptionFromJavadoc

Environment (please complete the following information):

There is a sample project available as fork from the allure-junit-sample project:
https://github.com/focbenz/allure-junit-example/tree/bug/javadoc-description-not-in-report

Allure version 2.13.3
Test framework JUnit@4.12
Allure adaptor allure-junit4@2.13.3
Generate report using allure-maven@2.10

Additional context

  • The resource files are correctly generated in target\test-classes\allureDescriptions by the AnnotationProcessor
  • but the content is not written in the descriptionHtml nodes of the result files

But:

  • Just using the annotation @description("Documentation") works.
  • Running the same configuration as described with the JUnit5 framework generates the report correctly.
@focbenz focbenz added the type:bug Something isn't working label Jun 24, 2020
@okuzovkovupgrade
Copy link

Same thing in TestNG integration. Any plans to fix it?

@netmikey
Copy link

Same thing in JUnit5 integration. Would be very interested in a fix for this!

@baev baev transferred this issue from allure-framework/allure2 Dec 1, 2023
@baev baev closed this as completed in 43c4d6b Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants