added possibility to separate lines in javadoc description (via allure-framework#195)

sspotanin · baev · commit be3468cc854e · 2018-02-13T14:10:22.000+03:00
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Description.java b/allure-java-commons/src/main/java/io/qameta/allure/Description.java
@@ -26,4 +26,5 @@
      * @return boolean flag to enable description extraction from javadoc.
      */
     boolean useJavaDoc() default false;
+
 }
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java b/allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java
@@ -36,6 +36,9 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static io.qameta.allure.util.PropertiesUtils.loadAllureProperties;
+import static java.lang.Boolean.parseBoolean;
+
 /**
  * The collection of Allure utils methods.
  */
@@ -46,6 +49,7 @@ public final class ResultsUtils {
     public static final String ALLURE_HOST_NAME_ENV = "ALLURE_HOST_NAME";
     public static final String ALLURE_THREAD_NAME_SYSPROP = "allure.threadName";
     public static final String ALLURE_THREAD_NAME_ENV = "ALLURE_THREAD_NAME";
+    public static final String ALLURE_SEPARATE_LINES_SYSPROP = "allure.description.javadoc.separateLines";
 
     public static final String ISSUE_LINK_TYPE = "issue";
     public static final String TMS_LINK_TYPE = "tms";
@@ -217,7 +221,7 @@ public static MessageDigest getMd5Digest() {
     }
 
     private static String getLinkUrl(final String name, final String type) {
-        final Properties properties = PropertiesUtils.loadAllureProperties();
+        final Properties properties = loadAllureProperties();
         final String pattern = properties.getProperty(getLinkTypePatternPropertyName(type));
         if (Objects.isNull(pattern)) {
             return null;
@@ -264,7 +268,11 @@ public static void processDescription(final ClassLoader classLoader, final Metho
                             .getResource(ALLURE_DESCRIPTIONS_PACKAGE + signatureHash))
                             .orElseThrow(IOException::new);
                     description = Resources.toString(resource, Charset.defaultCharset());
-                    item.withDescriptionHtml(description);
+                    if (separateLines()) {
+                        item.withDescriptionHtml(description.replace("\n", "<br />"));
+                    } else {
+                        item.withDescriptionHtml(description);
+                    }
                 } catch (IOException e) {
                     LOGGER.warn("Unable to process description resource file for method {} {}", name, e.getMessage());
                 }
@@ -275,4 +283,8 @@ public static void processDescription(final ClassLoader classLoader, final Metho
         }
     }
 
+    private static boolean separateLines() {
+        return parseBoolean(loadAllureProperties().getProperty(ALLURE_SEPARATE_LINES_SYSPROP));
+    }
+
 }
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
@@ -35,6 +35,7 @@
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
+import static io.qameta.allure.util.ResultsUtils.ALLURE_SEPARATE_LINES_SYSPROP;
 import static java.lang.String.format;
 import static java.util.Arrays.asList;
 import static java.util.Collections.singletonList;
@@ -127,6 +128,29 @@ public void testWithTimeout() {
                         "Step of the test with no timeout"));
     }
 
+    @Feature("Descriptions")
+    @Test(description = "Javadoc descriptions with line separation")
+    public void descriptionsWithLineSeparationTest() {
+        String initialSeparateLines = System.getProperty(ALLURE_SEPARATE_LINES_SYSPROP);
+        if (!Boolean.parseBoolean(initialSeparateLines)) {
+            System.setProperty(ALLURE_SEPARATE_LINES_SYSPROP, "true");
+        }
+        try {
+            final String testDescription = "Sample test description<br /> - next line<br /> - another line<br />";
+            runTestNgSuites("suites/descriptions-test.xml");
+            List<TestResult> testResult = results.getTestResults();
+
+            assertThat(testResult).as("Test case result has not been written")
+                    .hasSize(2)
+                    .filteredOn(result -> result.getName().equals("testSeparated"))
+                    .extracting(result -> result.getDescriptionHtml().trim())
+                    .as("Javadoc description of test case has not been processed correctly")
+                    .contains(testDescription);
+        } finally {
+            System.setProperty(ALLURE_SEPARATE_LINES_SYSPROP, String.valueOf(initialSeparateLines));
+        }
+    }
+
     @Feature("Descriptions")
     @Test(description = "Javadoc descriptions of tests")
     public void descriptionsTest() {
@@ -135,7 +159,8 @@ public void descriptionsTest() {
         List<TestResult> testResult = results.getTestResults();
 
         assertThat(testResult).as("Test case result has not been written")
-                .hasSize(1).first()
+                .hasSize(2)
+                .filteredOn(result -> result.getName().equals("test"))
                 .extracting(result -> result.getDescriptionHtml().trim())
                 .as("Javadoc description of test case has not been processed")
                 .contains(testDescription);
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
@@ -18,6 +18,17 @@ public void test() {
         step();
     }
 
+    /**
+     * Sample test description
+     * - next line
+     * - another line
+     */
+    @Description(useJavaDoc = true)
+    @Test
+    public void testSeparated() {
+        step();
+    }
+
     /**
      * Sample step description
      */

Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,5 @@`
`26`	`26`	`* @return boolean flag to enable description extraction from javadoc.`
`27`	`27`	`*/`
`28`	`28`	`boolean useJavaDoc() default false;`
	`29`	`+`
`29`	`30`	`}`