Added support for proxy

- Implementation basing on org.apache.http.client.HttpClient was chosen, because this works with Jenkins StashNotifier as well.

Author: stoesselt

CHANGELOG.md

@@ -3,6 +3,24 @@
 
 Changelog of Violation comments to bitbucket server lib.
 
+## 1.48
+### No issue
+
+**PCLint**
+
+
+[68c09c2d9836709](https://github.com/tomasbjerre/violation-comments-to-bitbucket-server-lib/commit/68c09c2d9836709) Tomas Bjerre *2018-02-13 18:59:38*
+
+
+## 1.47
+### No issue
+
+**ViolationCommentsToBitbucketServerApi**
+
+
+[e8cd87fdd59f777](https://github.com/tomasbjerre/violation-comments-to-bitbucket-server-lib/commit/e8cd87fdd59f777) Tomas Bjerre *2018-02-10 07:55:37*
+
+
 ## 1.46
 ### GitHub #47 
 

build.gradle

@@ -23,6 +23,7 @@ dependencies {
  compile 'com.jayway.jsonpath:json-path:2.0.0'
  compile 'com.google.code.gson:gson:2.8.0'
  compile 'com.google.guava:guava:20.0'
+ compile 'org.apache.httpcomponents:httpclient:4.5.5'
 
  testCompile 'junit:junit:4.12'
  testCompile 'org.assertj:assertj-core:2.3.0'

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/BitbucketServerCommentsProvider.java

@@ -61,6 +61,10 @@ public BitbucketServerCommentsProvider(
     final String bitbucketServerPassword = violationCommentsToBitbucketApi.getPassword();
     final String bitbucketPersonalAccessToken =
         violationCommentsToBitbucketApi.getPersonalAccessToken();
+    final String proxyHostNameOrIp = violationCommentsToBitbucketApi.getProxyHostNameOrIp();
+    final Integer proxyHostPort = violationCommentsToBitbucketApi.getProxyHostPort();
+    final String proxyUser = violationCommentsToBitbucketApi.getProxyUser();
+    final String proxyPassword = violationCommentsToBitbucketApi.getProxyPassword();
     client =
         new BitbucketServerClient(
             bitbucketServerBaseUrl,
@@ -69,7 +73,11 @@ public BitbucketServerCommentsProvider(
             bitbucketServerPullRequestId,
             bitbucketServerUser,
             bitbucketServerPassword,
-            bitbucketPersonalAccessToken);
+            bitbucketPersonalAccessToken,
+            proxyHostNameOrIp,
+            proxyHostPort,
+            proxyUser,
+            proxyPassword);
     this.violationCommentsToBitbucketApi = violationCommentsToBitbucketApi;
   }
 

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/ViolationCommentsToBitbucketServerApi.java

@@ -35,6 +35,10 @@ public static ViolationCommentsToBitbucketServerApi violationCommentsToBitbucket
   private int commentOnlyChangedContentContext;
   private boolean shouldKeepOldComments;
   private String personalAccessToken;
+  private String proxyHostNameOrIp;
+  private Integer proxyHostPort = 0;
+  private String proxyUser;
+  private String proxyPassword;
 
   private ViolationCommentsToBitbucketServerApi() {}
 
@@ -113,6 +117,30 @@ public String getUsername() {
     return username;
   }
 
+  public boolean getShouldKeepOldComments() {
+    return shouldKeepOldComments;
+  }
+
+  public String getPersonalAccessToken() {
+    return personalAccessToken;
+  }
+
+  public String getProxyHostNameOrIp() {
+    return proxyHostNameOrIp;
+  }
+
+  public Integer getProxyHostPort() {
+    return proxyHostPort;
+  }
+
+  public String getProxyUser() {
+    return proxyUser;
+  }
+
+  public String getProxyPassword() {
+    return proxyPassword;
+  }
+
   private void populateFromEnvironmentVariables() {
     if (System.getProperty(propUsername) != null) {
       username = firstNonNull(username, System.getProperty(propUsername));
@@ -219,11 +247,24 @@ public ViolationCommentsToBitbucketServerApi withShouldKeepOldComments(
     return this;
   }
 
-  public boolean getShouldKeepOldComments() {
-    return shouldKeepOldComments;
+  public ViolationCommentsToBitbucketServerApi withProxyHostNameOrIp(
+      final String proxyHostNameOrIp) {
+    this.proxyHostNameOrIp = proxyHostNameOrIp;
+    return this;
   }
 
-  public String getPersonalAccessToken() {
-    return personalAccessToken;
+  public ViolationCommentsToBitbucketServerApi withProxyHostPort(final Integer proxyHostPort) {
+    this.proxyHostPort = proxyHostPort;
+    return this;
+  }
+
+  public ViolationCommentsToBitbucketServerApi withProxyUser(final String proxyUser) {
+    this.proxyUser = proxyUser;
+    return this;
+  }
+
+  public ViolationCommentsToBitbucketServerApi withProxyPassword(final String proxyPassword) {
+    this.proxyPassword = proxyPassword;
+    return this;
   }
 }

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/client/BitbucketServerClient.java

@@ -32,6 +32,7 @@ public static void setBitbucketServerInvoker(
   private final String bitbucketServerRepo;
   private final String bitbucketServerUser;
   private final String bitbucketPersonalAccessToken;
+  private final ProxyConfig proxyInformation;
 
   public BitbucketServerClient(
       final String bitbucketServerBaseUrl,
@@ -40,7 +41,11 @@ public BitbucketServerClient(
       final Integer bitbucketServerPullRequestId,
       final String bitbucketServerUser,
       final String bitbucketServerPassword,
-      final String bitbucketPersonalAccessToken) {
+      final String bitbucketPersonalAccessToken,
+      final String proxyHostNameOrIp,
+      final Integer proxyHostPort,
+      final String proxyUser,
+      final String proxyPassword) {
     if (bitbucketServerBaseUrl.endsWith("/")) {
       this.bitbucketServerBaseUrl =
           bitbucketServerBaseUrl.substring(0, bitbucketServerBaseUrl.length() - 1);
@@ -53,6 +58,8 @@ public BitbucketServerClient(
     this.bitbucketServerUser = bitbucketServerUser;
     this.bitbucketServerPassword = bitbucketServerPassword;
     this.bitbucketPersonalAccessToken = bitbucketPersonalAccessToken;
+    this.proxyInformation =
+        new ProxyConfig(proxyHostNameOrIp, proxyHostPort, proxyUser, proxyPassword);
   }
 
   private String getBitbucketServerPulLRequestBase() {
@@ -92,10 +99,10 @@ public void pullRequestComment(final String message) {
   private String doInvokeUrl(final String string, final Method method, final String postContent) {
     if (isNullOrEmpty(bitbucketServerUser) || isNullOrEmpty(bitbucketServerPassword)) {
       return bitbucketServerInvoker.invokeUrl(
-          string, method, postContent, bitbucketPersonalAccessToken);
+          string, method, postContent, bitbucketPersonalAccessToken, proxyInformation);
     } else {
-      return bitbucketServerInvoker.invokeUrl(
-          string, method, postContent, bitbucketServerUser, bitbucketServerPassword);
+      return bitbucketServerInvoker.invokeUrl(string, method, postContent, bitbucketServerUser, 
+          bitbucketServerPassword, proxyInformation);
     }
   }
 

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/client/BitbucketServerInvoker.java

@@ -3,19 +3,29 @@
 import static com.google.common.base.Charsets.UTF_8;
 import static com.google.common.base.Strings.isNullOrEmpty;
 
-import com.google.common.base.Throwables;
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.io.OutputStream;
 import java.io.UnsupportedEncodingException;
 import java.net.CookieHandler;
 import java.net.CookieManager;
 import java.net.CookiePolicy;
-import java.net.HttpURLConnection;
-import java.net.URL;
+import java.net.URI;
+
 import javax.xml.bind.DatatypeConverter;
 
+import org.apache.http.HttpResponse;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.config.RequestConfig;
+import org.apache.http.client.methods.HttpDelete;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpRequestBase;
+import org.apache.http.entity.StringEntity;
+import org.apache.http.impl.client.HttpClientBuilder;
+
+import com.google.common.base.Throwables;
+
 public class BitbucketServerInvoker {
 
   public enum Method {
@@ -25,19 +35,24 @@ public enum Method {
   }
 
   public String invokeUrl(
-      final String url, final Method method, final String postContent, final String bearer) {
+      final String url,
+      final Method method,
+      final String postContent,
+      final String bearer,
+      final ProxyConfig proxyConfig) {
 
     final String authorizationValue = "Bearer " + bearer;
 
-    return doInvokeUrl(url, method, postContent, authorizationValue);
+    return doInvokeUrl(url, method, postContent, authorizationValue, proxyConfig);
   }
 
   public String invokeUrl(
       final String url,
       final Method method,
       final String postContent,
       final String bitbucketServerUser,
-      final String bitbucketServerPassword) {
+      final String bitbucketServerPassword,
+      final ProxyConfig proxyConfig) {
 
     final String userAndPass = bitbucketServerUser + ":" + bitbucketServerPassword;
     String authString;
@@ -48,38 +63,59 @@ public String invokeUrl(
     }
     final String authorizationValue = "Basic " + authString;
 
-    return doInvokeUrl(url, method, postContent, authorizationValue);
+    return doInvokeUrl(url, method, postContent, authorizationValue, proxyConfig);
   }
 
   private String doInvokeUrl(
       final String url,
       final Method method,
       final String postContent,
-      final String authorizationValue) {
-    HttpURLConnection conn = null;
-    OutputStream output = null;
-    BufferedReader reader = null;
+      final String authorizationValue,
+      final ProxyConfig proxyConfig) {
+    BufferedReader bufferedReader = null;
     try {
       CookieHandler.setDefault(new CookieManager(null, CookiePolicy.ACCEPT_ALL));
-      conn = (HttpURLConnection) new URL(url).openConnection();
-      conn.setReadTimeout(30000);
-      conn.setConnectTimeout(30000);
-      conn.setRequestProperty("Authorization", authorizationValue);
-      conn.setRequestMethod(method.name());
-      final String charset = "UTF-8";
-      conn.setDoOutput(true);
-      conn.setRequestProperty("X-Atlassian-Token", "no-check");
-      conn.setRequestProperty("Content-Type", "application/json");
-      conn.setRequestProperty("Accept", "application/json");
-      conn.connect();
-      if (!isNullOrEmpty(postContent)) {
-        output = conn.getOutputStream();
-        output.write(postContent.getBytes(charset));
+      // Preparation of the request
+      HttpRequestBase request;
+      switch (method) {
+      case DELETE:
+        request = new HttpDelete();
+        break;
+      case GET:
+        request = new HttpGet();
+        break;
+      case POST:
+        request = new HttpPost();
+        break;
+      default:
+        throw new IllegalArgumentException(
+            "Unsupported http method:\n" + url + "\n" + method + "\n" + postContent);
       }
-      reader = new BufferedReader(new InputStreamReader(conn.getInputStream(), UTF_8));
+      request.setURI(new URI(url));
+      RequestConfig.Builder requestBuilder =
+          RequestConfig.custom().setConnectionRequestTimeout(30000).setConnectTimeout(30000);
+      request.setConfig(requestBuilder.build());
+      request.addHeader("Authorization", authorizationValue);
+      request.addHeader("X-Atlassian-Token", "no-check");
+      request.addHeader("Content-Type", "application/json");
+      request.addHeader("Accept", "application/json");
+
+      if (request instanceof HttpPost && !isNullOrEmpty(postContent)) {
+        StringEntity entity = new StringEntity(postContent, UTF_8);
+        ((HttpPost) request).setEntity(entity);
+      }
+
+      HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
+      proxyConfig.addTo(httpClientBuilder);
+      HttpClient httpClient = httpClientBuilder.build();
+
+      // Execute the request and get the response
+      HttpResponse response = httpClient.execute(request);
+      bufferedReader =
+          new BufferedReader(new InputStreamReader(response.getEntity().getContent(), UTF_8));
       final StringBuilder stringBuilder = new StringBuilder();
       String line = null;
-      while ((line = reader.readLine()) != null) {
+      while ((line = bufferedReader.readLine()) != null) {
         stringBuilder.append(line + "\n");
       }
       final String json = stringBuilder.toString();
@@ -88,15 +124,10 @@ private String doInvokeUrl(
       throw new RuntimeException("Error calling:\n" + url + "\n" + method + "\n" + postContent, e);
     } finally {
       try {
-        if (conn != null) {
-          conn.disconnect();
-        }
-        if (reader != null) {
-          reader.close();
-        }
-        if (output != null) {
-          output.close();
+        if (bufferedReader != null) {
+          bufferedReader.close();
         }
+
       } catch (final IOException e) {
         throw Throwables.propagate(e);
       }

src/main/java/se/bjurr/violations/comments/bitbucketserver/lib/client/ProxyConfig.java

@@ -0,0 +1,47 @@
+package se.bjurr.violations.comments.bitbucketserver.lib.client;
+
+import static com.google.common.base.Strings.isNullOrEmpty;
+
+import org.apache.http.HttpHost;
+import org.apache.http.auth.AuthScope;
+import org.apache.http.auth.UsernamePasswordCredentials;
+import org.apache.http.client.CredentialsProvider;
+import org.apache.http.impl.client.BasicCredentialsProvider;
+import org.apache.http.impl.client.HttpClientBuilder;
+import org.apache.http.impl.client.ProxyAuthenticationStrategy;
+
+public class ProxyConfig {
+
+  private final String proxyHostNameOrIp;
+  private final Integer proxyHostPort;
+  private final String proxyUser;
+  private final String proxyPassword;
+
+  public ProxyConfig(
+      String proxyHostNameOrIp, Integer proxyHostPort, String proxyUser, String proxyPassword) {
+    this.proxyHostNameOrIp = proxyHostNameOrIp;
+    this.proxyHostPort = proxyHostPort;
+    this.proxyUser = proxyUser;
+    this.proxyPassword = proxyPassword;
+  }
+
+  public HttpClientBuilder addTo(HttpClientBuilder builder) {
+    if (!isNullOrEmpty(proxyHostNameOrIp)) {
+      HttpHost proxyHost = new HttpHost(proxyHostNameOrIp, proxyHostPort);
+      builder = builder.setProxy(proxyHost);
+
+      if (!isNullOrEmpty(proxyUser)) {
+        CredentialsProvider credsProvider = new BasicCredentialsProvider();
+        credsProvider.setCredentials(
+            new AuthScope(proxyHostNameOrIp, proxyHostPort),
+            new UsernamePasswordCredentials(proxyUser, proxyPassword));
+
+        builder =
+            builder
+                .setDefaultCredentialsProvider(credsProvider)
+                .setProxyAuthenticationStrategy(new ProxyAuthenticationStrategy());
+      }
+    }
+    return builder;
+  }
+}