Avoid crash when variable resolved to string with dollar sign #233

Author: tomasbjerre

CHANGELOG.md

@@ -3,6 +3,12 @@
 Changelog of Pull Request Notifier for Bitbucket.
 
 ## Unreleased
+### No issue
+  doc
+  
+  [d23fe8fe5b339d9](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/commit/d23fe8fe5b339d9) Tomas Bjerre *2017-07-16 05:55:13*
+
+## 3.2
 ### GitHub [#226](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/issues/226) REST API POST ISSUES
   Correcting markdown in REST-API
 

src/main/java/se/bjurr/prnfb/service/PrnfbRenderer.java

@@ -11,10 +11,15 @@
 
 import java.io.UnsupportedEncodingException;
 import java.util.Map;
+import java.util.regex.Matcher;
 
 import org.apache.commons.lang3.StringEscapeUtils;
 import org.slf4j.Logger;
 
+import se.bjurr.prnfb.http.ClientKeyStore;
+import se.bjurr.prnfb.listener.PrnfbPullRequestAction;
+import se.bjurr.prnfb.settings.PrnfbNotification;
+
 import com.atlassian.bitbucket.pull.PullRequest;
 import com.atlassian.bitbucket.repository.RepositoryService;
 import com.atlassian.bitbucket.server.ApplicationPropertiesService;
@@ -23,10 +28,6 @@
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Supplier;
 
-import se.bjurr.prnfb.http.ClientKeyStore;
-import se.bjurr.prnfb.listener.PrnfbPullRequestAction;
-import se.bjurr.prnfb.settings.PrnfbNotification;
-
 public class PrnfbRenderer {
   public enum ENCODE_FOR {
     NONE,
@@ -91,6 +92,7 @@ String getRenderedStringResolved(
       replaceWith = resolved;
     }
     try {
+      replaceWith = Matcher.quoteReplacement(replaceWith);
       string = string.replaceAll(regExpStr, replaceWith);
     } catch (IllegalArgumentException e) {
       throw new RuntimeException("Tried to replace " + regExpStr + " with " + replaceWith, e);

src/main/java/se/bjurr/prnfb/service/PrnfbVariable.java

@@ -82,7 +82,7 @@ public String resolve(
           for (PrnfbVariable v : PrnfbVariable.values()) {
             if (v != EVERYTHING_URL //
                 && v != PULL_REQUEST_DESCRIPTION) {
-              parts.add(v.name() + "=\\${" + v.name() + "}");
+              parts.add(v.name() + "=${" + v.name() + "}");
             }
           }
           Collections.sort(parts);

src/test/java/se/bjurr/prnfb/service/PrnfbRendererTest.java

@@ -13,6 +13,7 @@
 import static se.bjurr.prnfb.service.PrnfbVariable.PULL_REQUEST_DESCRIPTION;
 import static se.bjurr.prnfb.service.PrnfbVariable.PULL_REQUEST_FROM_HASH;
 import static se.bjurr.prnfb.service.PrnfbVariable.PULL_REQUEST_MERGE_COMMIT;
+import static se.bjurr.prnfb.service.PrnfbVariable.PULL_REQUEST_TITLE;
 import static se.bjurr.prnfb.settings.PrnfbNotificationBuilder.prnfbNotificationBuilder;
 
 import java.io.UnsupportedEncodingException;
@@ -24,6 +25,15 @@
 import org.junit.Test;
 import org.mockito.Mock;
 
+import se.bjurr.prnfb.http.ClientKeyStore;
+import se.bjurr.prnfb.http.HttpResponse;
+import se.bjurr.prnfb.http.Invoker;
+import se.bjurr.prnfb.http.UrlInvoker;
+import se.bjurr.prnfb.listener.PrnfbPullRequestAction;
+import se.bjurr.prnfb.service.PrnfbRenderer.ENCODE_FOR;
+import se.bjurr.prnfb.settings.PrnfbNotification;
+import se.bjurr.prnfb.settings.ValidationException;
+
 import com.atlassian.bitbucket.pull.PullRequest;
 import com.atlassian.bitbucket.pull.PullRequestParticipant;
 import com.atlassian.bitbucket.pull.PullRequestRef;
@@ -34,15 +44,6 @@
 import com.google.common.base.Supplier;
 import com.google.common.base.Suppliers;
 
-import se.bjurr.prnfb.http.ClientKeyStore;
-import se.bjurr.prnfb.http.HttpResponse;
-import se.bjurr.prnfb.http.Invoker;
-import se.bjurr.prnfb.http.UrlInvoker;
-import se.bjurr.prnfb.listener.PrnfbPullRequestAction;
-import se.bjurr.prnfb.service.PrnfbRenderer.ENCODE_FOR;
-import se.bjurr.prnfb.settings.PrnfbNotification;
-import se.bjurr.prnfb.settings.ValidationException;
-
 public class PrnfbRendererTest {
 
   @Mock private ApplicationUser applicationUser;
@@ -133,6 +134,20 @@ public void testThatEverythingCanBeRendered() throws UnsupportedEncodingExceptio
         .startsWith("asd ");
   }
 
+  @Test
+  public void testThatDollarInStringCanBeRendered() throws UnsupportedEncodingException {
+    String actual =
+        sut.getRenderedStringResolved(
+            "asd ${" + PULL_REQUEST_TITLE.name() + "} asd",
+            encodeFor,
+            sut.regexp(PULL_REQUEST_TITLE),
+            "BNRSD-387 Fix circular reference logging on $host errors in RSD abstract client");
+
+    assertThat(actual) //
+        .isEqualTo(
+            "asd BNRSD-387 Fix circular reference logging on $host errors in RSD abstract client asd");
+  }
+
   @Test
   public void testThatIfAVariableChrashesOnResolveItWillBeEmpty() {
     String actual =

src/test/java/se/bjurr/prnfb/service/PrnfbVariableTest.java

@@ -13,6 +13,10 @@
 
 import org.junit.Test;
 
+import se.bjurr.prnfb.http.ClientKeyStore;
+import se.bjurr.prnfb.listener.PrnfbPullRequestAction;
+import se.bjurr.prnfb.settings.PrnfbNotification;
+
 import com.atlassian.bitbucket.pull.PullRequest;
 import com.atlassian.bitbucket.repository.RepositoryService;
 import com.atlassian.bitbucket.server.ApplicationPropertiesService;
@@ -22,10 +26,6 @@
 import com.google.common.io.Files;
 import com.google.common.io.Resources;
 
-import se.bjurr.prnfb.http.ClientKeyStore;
-import se.bjurr.prnfb.listener.PrnfbPullRequestAction;
-import se.bjurr.prnfb.settings.PrnfbNotification;
-
 public class PrnfbVariableTest {
 
   private ApplicationUser applicationUser;
@@ -80,7 +80,7 @@ public void testThatEverythingVariableIsResolvedToEveryOtherVariable() {
     for (PrnfbVariable v : PrnfbVariable.values()) {
       if (v != EVERYTHING_URL && v != PULL_REQUEST_DESCRIPTION) {
         assertThat(actual) //
-            .containsOnlyOnce(v.name() + "=\\${" + v.name() + "}") //
+            .containsOnlyOnce(v.name() + "=${" + v.name() + "}") //
             .doesNotContain(EVERYTHING_URL.name());
       }
     }