Merge pull request #107 from ashwanthkumar/set-user-agent-in-connection

Fix the GetPipelineInstance URL for fetching pipeline run details
ashwanthkumar · Mar 10, 2020 · c8d78ce · c8d78ce
2 parents 23ebba6 + b9507e3
commit c8d78ce
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 29 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>in.ashwanthkumar</groupId>
     <artifactId>gocd-slack-notifier</artifactId>
-    <version>2.0.1</version>
+    <version>2.0.2-RC2</version>
     <packaging>jar</packaging>
 
     <properties>

diff --git a/src/main/java/in/ashwanthkumar/gocd/slack/jsonapi/Server.java b/src/main/java/in/ashwanthkumar/gocd/slack/jsonapi/Server.java
@@ -49,6 +49,7 @@ JsonElement getUrl(URL url)
         HttpURLConnection request = httpConnectionUtil.getConnection(normalizedUrl);
         // @since 20.1.0
         request.setRequestProperty("Accept", "application/vnd.go.cd.v1+json");
+        request.setRequestProperty("User-Agent", "plugin/slack.notifier");
 
         // Add in our HTTP authorization credentials if we have them.
         // Favor the API Token over username/password
@@ -84,7 +85,7 @@ public History getPipelineHistory(String pipelineName)
      */
     public Pipeline getPipelineInstance(String pipelineName, int pipelineCounter)
             throws MalformedURLException, IOException {
-        URL url = new URL(String.format("%s/go/api/pipelines/%s/instance/%d",
+        URL url = new URL(String.format("%s/go/api/pipelines/%s/%d",
                 mRules.getGoAPIServerHost(), pipelineName, pipelineCounter));
         JsonElement json = getUrl(url);
         return httpConnectionUtil.convertResponse(json, Pipeline.class);

diff --git a/src/main/resources/plugin.xml b/src/main/resources/plugin.xml
@@ -2,7 +2,7 @@
 <go-plugin id="slack.notifier" version="1">
     <about>
         <name>Slack Notification Plugin</name>
-        <version>2.0.1</version>
+        <version>2.0.2-RC2</version>
         <target-go-version>20.1.0</target-go-version>
         <description>Plugin to send build notifications to slack</description>
         <vendor>

diff --git a/src/test/java/in/ashwanthkumar/gocd/slack/jsonapi/ServerTest.java b/src/test/java/in/ashwanthkumar/gocd/slack/jsonapi/ServerTest.java
@@ -8,15 +8,11 @@
 import java.net.HttpURLConnection;
 import java.net.URL;
 
-import static org.hamcrest.CoreMatchers.not;
-import static org.hamcrest.CoreMatchers.startsWith;
 import static org.hamcrest.core.Is.is;
 import static org.junit.Assert.assertThat;
 import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.anyString;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.*;
 
 public class ServerTest {
 
@@ -68,7 +64,7 @@ public void testGetPipelineInstance() throws Exception {
         verify(httpConnectionUtil).getConnection(
                 url.capture()
         );
-        assertThat(url.getValue().toString(), is("https://example.org/go/api/pipelines/pipeline-test/instance/42"));
+        assertThat(url.getValue().toString(), is("https://example.org/go/api/pipelines/pipeline-test/42"));
     }
 
     @Test
@@ -84,6 +80,7 @@ public void shouldConnectWithAPIToken() throws IOException {
 
         server.getUrl(new URL("http://exmaple.org/"));
 
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
         verify(conn).setRequestProperty("Authorization", "Bearer a-valid-token-from-gocd-server");
     }
 
@@ -101,6 +98,7 @@ public void shouldConnectWithUserPassCredentials() throws IOException {
 
         server.getUrl(new URL("http://exmaple.org/"));
 
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
         verify(conn).setRequestProperty("Authorization", "Basic bG9naW46cGFzcw==");
     }
 
@@ -119,8 +117,10 @@ public void shouldConnectWithAPITokenFavoringOverUserPassCredential() throws IOE
 
         server.getUrl(new URL("http://exmaple.org/"));
 
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
         verify(conn).setRequestProperty("Authorization", "Bearer a-valid-token-from-gocd-server");
     }
+
     @Test
     public void shouldNotSetAuthorizationHeaderWithoutCredentials() throws IOException {
         HttpConnectionUtil httpConnectionUtil = mockConnection();
@@ -133,11 +133,8 @@ public void shouldNotSetAuthorizationHeaderWithoutCredentials() throws IOExcepti
 
         server.getUrl(new URL("http://exmaple.org/"));
 
-        ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
-        verify(conn).setRequestProperty(anyString(), valueCaptor.capture());
-        for (String value : valueCaptor.getAllValues()) {
-            assertThat(value, not(startsWith("Authorization")));
-        }
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
+        verify(conn, never()).setRequestProperty(eq("Authorization"), anyString());
     }
 
     @Test
@@ -154,11 +151,8 @@ public void shouldNotSetAuthorizationHeaderWithEmptyPassword() throws IOExceptio
 
         server.getUrl(new URL("http://exmaple.org/"));
 
-        ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
-        verify(conn).setRequestProperty(anyString(), valueCaptor.capture());
-        for (String value : valueCaptor.getAllValues()) {
-            assertThat(value, not(startsWith("Authorization")));
-        }
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
+        verify(conn, never()).setRequestProperty(eq("Authorization"), anyString());
     }
 
     @Test
@@ -175,11 +169,8 @@ public void shouldNotSetAuthorizationHeaderWithEmptyLoginName() throws IOExcepti
 
         server.getUrl(new URL("http://exmaple.org/"));
 
-        ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
-        verify(conn).setRequestProperty(anyString(), valueCaptor.capture());
-        for (String value : valueCaptor.getAllValues()) {
-            assertThat(value, not(startsWith("Authorization")));
-        }
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
+        verify(conn, never()).setRequestProperty(eq("Authorization"), anyString());
     }
 
     @Test
@@ -196,11 +187,8 @@ public void shouldNotSetAuthorizationHeaderWithEmptyPasswordCredentials() throws
 
         server.getUrl(new URL("http://exmaple.org/"));
 
-        ArgumentCaptor<String> valueCaptor = ArgumentCaptor.forClass(String.class);
-        verify(conn).setRequestProperty(anyString(), valueCaptor.capture());
-        for (String value : valueCaptor.getAllValues()) {
-            assertThat(value, not(startsWith("Authorization")));
-        }
+        verify(conn).setRequestProperty(eq("User-Agent"), anyString());
+        verify(conn, never()).setRequestProperty(eq("Authorization"), anyString());
     }
 
     private HttpConnectionUtil mockConnection() throws IOException {