fix special symbols in step names (fixes #73, via #96)

ehborisov · baev · commit b8763dcf5835 · 2017-07-07T16:35:40.000+03:00
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/util/NamingUtils.java b/allure-java-commons/src/main/java/io/qameta/allure/util/NamingUtils.java
@@ -36,7 +36,7 @@ public static String processNameTemplate(final String template, final Map<String
         while (matcher.find()) {
             final String pattern = matcher.group(1);
             final String replacement = processPattern(pattern, params).orElseGet(matcher::group);
-            matcher.appendReplacement(sb, replacement);
+            matcher.appendReplacement(sb, Matcher.quoteReplacement(replacement));
         }
         matcher.appendTail(sb);
         return sb.toString();
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/StepsTest.java b/allure-java-commons/src/test/java/io/qameta/allure/StepsTest.java
@@ -55,8 +55,34 @@ public void shouldTransformPlaceholdersToPropertyValues() {
                         + " \"1111222233334444\", \"{missing}\", true");
     }
 
+    @Test
+    public void shouldNotFailOnSpecialSymbolsInNameString() {
+        final AllureResultsWriterStub results = new AllureResultsWriterStub();
+        final AllureLifecycle lifecycle = new AllureLifecycle(results);
+        StepsAspects.setLifecycle(lifecycle);
+
+        final String uuid = UUID.randomUUID().toString();
+        final TestResult result = new TestResult().withUuid(uuid);
+        lifecycle.scheduleTestCase(result);
+        lifecycle.startTestCase(uuid);
+
+        final String parameter = "$abc";
+        checkData(parameter);
+
+        lifecycle.stopTestCase(uuid);
+        lifecycle.writeTestCase(uuid);
+        assertThat(results.getTestResults())
+                .flatExtracting(TestResult::getSteps)
+                .extracting(StepResult::getName)
+                .containsExactly("TestData = $abc");
+    }
+
     @Step("\"{user.emails.address}\", \"{user.emails}\", \"{user.emails.attachments}\", \"{user.password}\", \"{}\"," +
             " \"{user.card.number}\", \"{missing}\", {staySignedIn}")
     private void loginWith(final DummyUser user, final boolean staySignedIn) {
     }
+
+    @Step("TestData = {value}")
+    public void checkData(final String value) {
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public static String processNameTemplate(final String template, final Map<String`
`36`	`36`	`while (matcher.find()) {`
`37`	`37`	`final String pattern = matcher.group(1);`
`38`	`38`	`final String replacement = processPattern(pattern, params).orElseGet(matcher::group);`
`39`		`- matcher.appendReplacement(sb, replacement);`
	`39`	`+ matcher.appendReplacement(sb, Matcher.quoteReplacement(replacement));`
`40`	`40`	`}`
`41`	`41`	`matcher.appendTail(sb);`
`42`	`42`	`return sb.toString();`