add support for javadoc descriptions for test fixtures (via allure-framework#212)

sspotanin · baev · commit 3509ac2124d9 · 2018-03-22T14:49:07.000+03:00
diff --git a/allure-testng/src/main/java/io/qameta/allure/testng/AllureTestNg.java b/allure-testng/src/main/java/io/qameta/allure/testng/AllureTestNg.java
@@ -393,11 +393,13 @@ private String getQualifiedName(final ITestNGMethod method) {
     }
 
     private FixtureResult getFixtureResult(final ITestNGMethod method) {
-        return new FixtureResult()
+        final FixtureResult fixtureResult = new FixtureResult()
                 .withName(getMethodName(method))
                 .withStart(System.currentTimeMillis())
                 .withDescription(method.getDescription())
                 .withStage(Stage.RUNNING);
+        processDescription(getClass().getClassLoader(), method.getConstructorOrMethod().getMethod(), fixtureResult);
+        return fixtureResult;
     }
 
     @Override
diff --git a/allure-testng/src/test/java/io/qameta/allure/testng/AllureTestNgTest.java b/allure-testng/src/test/java/io/qameta/allure/testng/AllureTestNgTest.java
@@ -166,6 +166,22 @@ public void descriptionsTest() {
                 .contains(testDescription);
     }
 
+    @Feature("Descriptions")
+    @Test(description = "Javadoc descriptions of befores")
+    public void descriptionsBefores() {
+        final String beforeClassDescription = "Before class description";
+        final String beforeMethodDescription = "Before method description";
+        runTestNgSuites("suites/descriptions-test.xml");
+        List<TestResultContainer> testContainers = results.getTestContainers();
+
+        assertThat(testContainers).as("Test containers has not been written")
+                .isNotEmpty()
+                .filteredOn(container -> !container.getBefores().isEmpty())
+                .extracting(container -> container.getBefores().get(0).getDescriptionHtml().trim())
+                .as("Javadoc descriptions of befores have not been processed")
+                .containsOnly(beforeClassDescription, beforeMethodDescription);
+    }
+
     @Feature("Failed tests")
     @Story("Failed")
     @Test(description = "Test failing by assertion")
diff --git a/allure-testng/src/test/java/io/qameta/allure/testng/samples/DescriptionsTest.java b/allure-testng/src/test/java/io/qameta/allure/testng/samples/DescriptionsTest.java
@@ -2,13 +2,33 @@
 
 import io.qameta.allure.Description;
 import io.qameta.allure.Step;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
 /**
  * @author Egor Borisov ehborisov@gmail.com
  */
 public class DescriptionsTest {
 
+    /**
+     * Before class description
+     */
+    @BeforeClass
+    @Description(useJavaDoc = true)
+    public void setUpClass() {
+
+    }
+
+    /**
+     * Before method description
+     */
+    @BeforeMethod
+    @Description(useJavaDoc = true)
+    public void setUpMethod() {
+
+    }
+
     /**
      * Sample test description
      */
@@ -36,4 +56,5 @@ public void testSeparated() {
     @Step("Step one")
     private void step() {
     }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -393,11 +393,13 @@ private String getQualifiedName(final ITestNGMethod method) {`
`393`	`393`	`}`
`394`	`394`
`395`	`395`	`private FixtureResult getFixtureResult(final ITestNGMethod method) {`
`396`		`- return new FixtureResult()`
	`396`	`+ final FixtureResult fixtureResult = new FixtureResult()`
`397`	`397`	`.withName(getMethodName(method))`
`398`	`398`	`.withStart(System.currentTimeMillis())`
`399`	`399`	`.withDescription(method.getDescription())`
`400`	`400`	`.withStage(Stage.RUNNING);`
	`401`	`+ processDescription(getClass().getClassLoader(), method.getConstructorOrMethod().getMethod(), fixtureResult);`
	`402`	`+ return fixtureResult;`
`401`	`403`	`}`
`402`	`404`
`403`	`405`	`@Override`