fix(error-handling): Improved error handling for special characters i…

…n fields (see #JENKINS-47858) fixes https://issues.jenkins-ci.org/browse/JENKINS-47858
jenkinsci · Nov 10, 2017 · 2a3a542 · 2a3a542
1 parent 2e79ca6
commit 2a3a542
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 7 deletions.
diff --git a/pom.xml b/pom.xml
@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
@@ -8,14 +9,14 @@
   </parent>
 
   <properties>
-    <artifactSuffix />
+    <artifactSuffix/>
     <jenkins.version>1.653</jenkins.version>
     <maven.compiler.source>1.7</maven.compiler.source>
     <maven.compiler.target>1.7</maven.compiler.target>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <java.level>7</java.level>
-    <failsafeArgLine />
+    <failsafeArgLine/>
     <skipITs>false</skipITs>
     <workflow.version>1.11</workflow.version>
     <!-- Project Libs-->
@@ -86,7 +87,7 @@
               <featureBranchPrefix>feature-</featureBranchPrefix>
               <releaseBranchPrefix>release-</releaseBranchPrefix>
               <hotfixBranchPrefix>hotfix-</hotfixBranchPrefix>
-              <versionTagPrefix />
+              <versionTagPrefix/>
             </flowInitContext>
           </configuration>
         </plugin>
@@ -235,6 +236,11 @@
       <artifactId>jna</artifactId>
       <version>3.2.2</version>
     </dependency>
+    <dependency>
+      <groupId>com.googlecode.json-simple</groupId>
+      <artifactId>json-simple</artifactId>
+      <version>1.1.1</version>
+    </dependency>
     <!-- for workflow support -->
     <dependency>
       <groupId>org.jenkins-ci.plugins.workflow</groupId>

diff --git a/src/main/java/jenkins/plugins/rocketchatnotifier/rocket/RocketChatClientCallBuilder.java b/src/main/java/jenkins/plugins/rocketchatnotifier/rocket/RocketChatClientCallBuilder.java
@@ -92,11 +92,12 @@ protected Response buildCall(RocketChatRestApiV1 call, RocketChatQueryParams que
 
   private void login() throws IOException {
     HttpResponse<JsonNode> loginResult;
+    String apiURL = serverUrl + "v1/login";
 
     try {
-      loginResult = Unirest.post(serverUrl + "v1/login").field("user", user).field("password", password).asJson();
+      loginResult = Unirest.post(apiURL).field("user", user).field("password", password).asJson();
     } catch (UnirestException e) {
-      throw new IOException(e);
+      throw new IOException("Please check if the server API " + apiURL + " is correct");
     } catch (Exception e) {
       throw new IOException(e);
     }

diff --git a/src/main/java/jenkins/plugins/rocketchatnotifier/rocket/RocketChatClientImpl.java b/src/main/java/jenkins/plugins/rocketchatnotifier/rocket/RocketChatClientImpl.java
@@ -5,6 +5,7 @@
 import jenkins.plugins.rocketchatnotifier.model.Response;
 import jenkins.plugins.rocketchatnotifier.model.Room;
 import jenkins.plugins.rocketchatnotifier.model.User;
+import org.json.simple.JSONValue;
 import sun.security.validator.ValidatorException;
 
 import java.io.IOException;
@@ -36,7 +37,7 @@ public class RocketChatClientImpl implements RocketChatClient {
    * @param password  of the user to authenticate with
    */
   public RocketChatClientImpl(String serverUrl, String user, String password) {
-    this.callBuilder = new RocketChatClientCallBuilder(serverUrl, user, password);
+    this.callBuilder = new RocketChatClientCallBuilder(serverUrl, JSONValue.escape(user), JSONValue.escape(password));
   }
 
   @Override

diff --git a/src/test/java/jenkins/plugins/rocketchatnotifier/rocket/RocketChatClientCallBuilderTest.java b/src/test/java/jenkins/plugins/rocketchatnotifier/rocket/RocketChatClientCallBuilderTest.java
@@ -0,0 +1,18 @@
+package jenkins.plugins.rocketchatnotifier.rocket;
+
+import org.junit.Test;
+
+import java.io.IOException;
+
+public class RocketChatClientCallBuilderTest {
+
+  @Test(expected = IOException.class)
+  public void shouldEscapeSpecialCharacters() throws Exception {
+    // given
+    RocketChatClientCallBuilder rocketCallBuilder = new RocketChatClientCallBuilder("https://open.rocket.chat/", "]\",", "]\",");
+    // when
+    rocketCallBuilder.buildCall(RocketChatRestApiV1.ChannelsList);
+    // then error
+  }
+
+}