Feat/Support for local plugin proxy

README.md

@@ -20,7 +20,7 @@ Plugin is used to send actionable messages in [Outlook](http://outlook.com), [Of
 
 #### Global configuration values used as default in jobs
 
-![GlobalConfigurationDefault](.README/globalconfigdefault.png?raw=true)
+![GlobalConfiguratio![img.png](.README/globalconfig.png)nDefault](.README/globalconfigdefault.png?raw=true)
 
 ### Microsoft Teams
 

src/main/java/jenkins/plugins/office365connector/HttpWorker.java

@@ -13,7 +13,6 @@
  */
 package jenkins.plugins.office365connector;
 
-import java.io.IOException;
 import java.io.PrintStream;
 import java.io.UnsupportedEncodingException;
 import java.nio.charset.StandardCharsets;
@@ -43,17 +42,20 @@ public class HttpWorker implements Runnable {
 
     private final PrintStream logger;
 
+    private final Proxy pluginProxy;
+
     private final String url;
     private final String data;
     private final int timeout;
 
     private static final int RETRIES = 3;
 
-    public HttpWorker(String url, String data, int timeout, PrintStream logger) {
+    public HttpWorker(String url, String data, int timeout, PrintStream logger, Proxy pluginProxy) {
         this.url = url;
         this.data = data;
         this.timeout = timeout;
         this.logger = logger;
+        this.pluginProxy = pluginProxy;
     }
 
     /**
@@ -92,7 +94,7 @@ public void run() {
                 } else {
                     success = true;
                 }
-            } catch (IOException e) {
+            } catch (Exception e) {
                 log("Failed to post data to webhook - %s", url);
                 e.printStackTrace(logger);
             } finally {
@@ -105,8 +107,16 @@ public void run() {
     private HttpClient getHttpClient() {
         HttpClient client = new HttpClient();
         Jenkins jenkins = Jenkins.get();
+        if (pluginProxy.proxyConfigured()) {
+            client.getHostConfiguration().setProxy(pluginProxy.getIp(), pluginProxy.getPort());
+            if (StringUtils.isNotBlank(pluginProxy.getUsername())) {
+                client.getState().setProxyCredentials(AuthScope.ANY,
+                        new UsernamePasswordCredentials(pluginProxy.getUsername(), pluginProxy.getPassword()));
+            }
+        }
         if (jenkins != null) {
             ProxyConfiguration proxy = jenkins.proxy;
+            // Check job proxy first
             if (proxy != null) {
                 List<Pattern> noHostProxyPatterns = proxy.getNoProxyHostPatterns();
                 if (!isNoProxyHost(this.url, noHostProxyPatterns)) {

src/main/java/jenkins/plugins/office365connector/Office365ConnectorWebhookNotifier.java

@@ -112,7 +112,7 @@ private void executeWorker(Webhook webhook, Card card) {
         try {
             String url = run.getEnvironment(taskListener).expand(webhook.getUrl());
             String data = gson.toJson(card);
-            HttpWorker worker = new HttpWorker(url, data, webhook.getTimeout(), taskListener.getLogger());
+            HttpWorker worker = new HttpWorker(url, data, webhook.getTimeout(), taskListener.getLogger(), webhook.getPluginProxy());
             worker.submit();
         } catch (IOException | InterruptedException | RejectedExecutionException e) {
             log(String.format("Failed to notify webhook: %s", webhook.getName()));

src/main/java/jenkins/plugins/office365connector/Proxy.java

@@ -0,0 +1,55 @@
+package jenkins.plugins.office365connector;
+
+import org.apache.commons.lang.StringUtils;
+
+public class Proxy {
+
+    private String ip;
+    private Integer port;
+    private String username;
+    private String password;
+
+
+    public Proxy(String ip, Integer port, String username, String password) {
+        this.ip = ip;
+        this.port = port;
+        this.username = username;
+        this.password = password;
+    }
+
+    public String getIp() {
+        return ip;
+    }
+
+    public void setIp(String ip) {
+        this.ip = ip;
+    }
+
+    public int getPort() {
+        return port;
+    }
+
+    public void setPort(int port) {
+        this.port = port;
+    }
+
+    public String getUsername() {
+        return username;
+    }
+
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    public String getPassword() {
+        return password;
+    }
+
+    public void setPassword(String password) {
+        this.password = password;
+    }
+
+    public Boolean proxyConfigured() {
+        return (!StringUtils.isEmpty(this.ip) && !StringUtils.isEmpty(String.valueOf(this.port)));
+    }
+}

src/main/java/jenkins/plugins/office365connector/Webhook.java

@@ -50,6 +50,8 @@ public class Webhook extends AbstractDescribableImpl<Webhook> {
 
     private int timeout;
 
+    private Proxy pluginProxy;
+
     private List<Macro> macros = Collections.emptyList();
 
     private List<FactDefinition> factDefinitions = Collections.emptyList();
@@ -62,6 +64,9 @@ public DescriptorImpl getDescriptor() {
     @DataBoundConstructor
     public Webhook(String url) {
         this.url = StringUtils.isEmpty(url) ? getDescriptor().getGlobalUrl() : url;
+
+        DescriptorImpl globalConfig = getDescriptor();
+        this.setProxyPluginConfiguration(globalConfig.getIp(), globalConfig.getPort(), globalConfig.getUsername(), globalConfig.getPassword());
     }
 
     public String getUrl() {
@@ -72,6 +77,14 @@ public String getName() {
         return Util.fixEmptyAndTrim(StringUtils.isEmpty(name) ? getDescriptor().getGlobalName() : name);
     }
 
+    public Proxy getPluginProxy() {
+        return this.pluginProxy;
+    }
+
+    public void setProxyPluginConfiguration(String proxyIp, Integer proxyPort, String proxyUsername, String proxyPassword) {
+        this.pluginProxy = new Proxy(proxyIp, proxyPort, proxyUsername, proxyPassword);
+    }
+
     @DataBoundSetter
     public void setName(String name) {
         this.name = Util.fixEmptyAndTrim(name);
@@ -183,6 +196,12 @@ public static class DescriptorImpl extends Descriptor<Webhook> {
         private String globalUrl;
         private String globalName;
 
+        private String ip;
+        private String username;
+        private String password;
+
+        private Integer port;
+
         public DescriptorImpl() {
             load();
         }
@@ -193,6 +212,42 @@ public String getDisplayName() {
             return "Webhook";
         }
 
+        public String getIp() {
+            return ip;
+        }
+
+        @DataBoundSetter
+        public void setIp(String ip) {
+            this.ip = ip;
+        }
+
+        public String getUsername() {
+            return username;
+        }
+
+        @DataBoundSetter
+        public void setUsername(String username) {
+            this.username = username;
+        }
+
+        public String getPassword() {
+            return password;
+        }
+
+        @DataBoundSetter
+        public void setPassword(String password) {
+            this.password = password;
+        }
+
+        public Integer getPort() {
+            return port;
+        }
+
+        @DataBoundSetter
+        public void setPort(Integer port) {
+            this.port = port;
+        }
+
         public int getDefaultTimeout() {
             return Webhook.DEFAULT_TIMEOUT;
         }

src/main/resources/jenkins/plugins/office365connector/Webhook/config.jelly

@@ -14,7 +14,7 @@
                 This section defines for which build statuses the notification is sent.
             </f:description>
 
-            <f:entry title="Notify Build Start" field="startNotification">
+            <f:entry title="Notify Build Start" field="startNotification" >
                 <f:checkbox/>
             </f:entry>
 

src/main/resources/jenkins/plugins/office365connector/Webhook/global.jelly

@@ -7,5 +7,25 @@
             <f:entry title="Name" field="globalName">
                 <f:textbox/>
             </f:entry>
+        <f:advanced>
+            <f:section title="Proxy Config">
+                <f:description>
+                    This section defines the Office365Connector proxy settings that will apply to all webhook notifications. This
+                    proxy configuration will be prioritized over the Jenkins global proxy config
+                </f:description>
+                <f:entry title="IP" field="ip">
+                    <f:textbox/>
+                </f:entry>
+                <f:entry title="Port" field="port">
+                    <f:textbox/>
+                </f:entry>
+                <f:entry title="Username" field="username">
+                    <f:textbox/>
+                </f:entry>
+                <f:entry title="Password" field="password">
+                    <f:password/>
+                </f:entry>
+            </f:section>
+        </f:advanced>
     </f:section>
 </j:jelly>

src/main/resources/jenkins/plugins/office365connector/Webhook/help-ip.html

@@ -0,0 +1 @@
+<div align="help">The IP address of the proxy server</div>

src/main/resources/jenkins/plugins/office365connector/Webhook/help-port.html

@@ -0,0 +1 @@
+<div align="help">This field works in conjunction with the ip field to specify the HTTP proxy port.</div>

src/main/resources/jenkins/plugins/office365connector/Webhook/help-username.html

@@ -0,0 +1 @@
+<div align="help">This field works in conjunction with the proxy server field to specify the username used to authenticate with the proxy.</div>

src/test/java/jenkins/plugins/office365connector/HttpWorkerTest.java

@@ -33,11 +33,12 @@ public void setUp() {
     }
 
     @Test
-    public void HttpWorker_getHttpClient_NoProxy() throws NoSuchMethodException {
+    public void HttpWorker_getHttpClient_NoJenkinsProxy() throws NoSuchMethodException {
 
         // given
         // from @Before
-        HttpWorker httpWorker = new HttpWorker("http://127.0.0.1", "{}", 30, System.out);
+        Proxy thisPluginProxy = new Proxy(null, null, null, null);
+        HttpWorker httpWorker = new HttpWorker("http://127.0.0.1", "{}", 30, System.out, thisPluginProxy);
         Method method = HttpWorker.class.getDeclaredMethod("getHttpClient");
         method.setAccessible(true);
 
@@ -50,15 +51,16 @@ public void HttpWorker_getHttpClient_NoProxy() throws NoSuchMethodException {
     }
 
     @Test
-    public void HttpWorker_getHttpClient_Proxy() throws NoSuchMethodException {
+    public void HttpWorker_getHttpClient_JenkinsProxy() throws NoSuchMethodException {
 
         // given
         // from @Before
+        Proxy thisPluginProxy = new Proxy(null, null, null, null);
         Jenkins jenkins = Jenkins.get();
         ProxyConfiguration proxyConfiguration = new ProxyConfiguration("name", 123, null, null, "*mockwebsite.com*");
         jenkins.proxy = proxyConfiguration;
 
-        HttpWorker httpWorker = new HttpWorker("http://127.0.0.1", "{}", 30, System.out);
+        HttpWorker httpWorker = new HttpWorker("http://127.0.0.1", "{}", 30, System.out, thisPluginProxy);
         Method method = HttpWorker.class.getDeclaredMethod("getHttpClient");
         method.setAccessible(true);
 
@@ -71,15 +73,16 @@ public void HttpWorker_getHttpClient_Proxy() throws NoSuchMethodException {
     }
 
     @Test
-    public void HttpWorker_getHttpClient_Proxy_Ignored() throws NoSuchMethodException {
+    public void HttpWorker_getHttpClient_JenkinsProxy_Ignored() throws NoSuchMethodException {
 
         // given
         // from @Before
+        Proxy thisPluginProxy = new Proxy(null, null, null, null);
         Jenkins jenkins = Jenkins.get();
         ProxyConfiguration proxyConfiguration = new ProxyConfiguration("name", 123, null, null, "*mockwebsite.com*");
         jenkins.proxy = proxyConfiguration;
 
-        HttpWorker httpWorker = new HttpWorker("http://mockwebsite.com", "{}", 30, System.out);
+        HttpWorker httpWorker = new HttpWorker("http://mockwebsite.com", "{}", 30, System.out, thisPluginProxy);
         Method method = HttpWorker.class.getDeclaredMethod("getHttpClient");
         method.setAccessible(true);
 
@@ -90,4 +93,22 @@ public void HttpWorker_getHttpClient_Proxy_Ignored() throws NoSuchMethodExceptio
         assertThat(httpClient.getHostConfiguration().getProxyHost()).isNull();
         assertThat(httpClient.getHostConfiguration().getProxyPort()).isEqualTo(-1);
     }
-}
+
+    @Test
+    public void HttpWorker_getHttpClient_PluginProxy() throws NoSuchMethodException {
+
+        // given
+        // from @Before
+        Proxy thisPluginProxy = new Proxy("10.0.0.1", 12345, null, null);
+        HttpWorker httpWorker = new HttpWorker("http://127.0.0.1", "{}", 30, System.out, thisPluginProxy);
+        Method method = HttpWorker.class.getDeclaredMethod("getHttpClient");
+        method.setAccessible(true);
+
+        // when
+        HttpClient httpClient = (HttpClient) ReflectionUtils.invokeMethod(method, httpWorker);
+
+        // then
+        assertThat(httpClient.getHostConfiguration().getProxyHost()).isEqualTo(thisPluginProxy.getIp());
+        assertThat(httpClient.getHostConfiguration().getProxyPort()).isEqualTo(thisPluginProxy.getPort());
+    }
+}

src/test/java/jenkins/plugins/office365connector/ProxyTest.java

@@ -0,0 +1,49 @@
+package jenkins.plugins.office365connector;
+
+import junit.framework.TestCase;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class ProxyTest {
+
+    private Proxy proxyTest;
+    private Proxy proxyTestNoCredentials;
+
+    @Before
+    public void setUp() {
+        proxyTest = new Proxy("10.0.0.1", 65654, "myUsername", "myPassword");
+        proxyTestNoCredentials = new Proxy("10.0.0.1", 65654, null, null);
+    }
+
+    @Test
+    public void getIp() {
+        assertThat("10.0.0.1").isEqualTo(proxyTest.getIp());
+    }
+
+    @Test
+    public void getPort() {
+        assertThat(65654).isEqualTo(proxyTest.getPort());
+    }
+
+    @Test
+    public void getUsername() {
+        assertThat("myUsername").isEqualTo(proxyTest.getUsername());
+    }
+
+    @Test
+    public void getPassword() {
+        assertThat("myPassword").isEqualTo(proxyTest.getPassword());
+    }
+
+    @Test
+    public void proxyConfigured_True() {
+        assertThat(proxyTest.proxyConfigured().equals(true));
+    }
+
+    @Test
+    public void proxyConfigured_False() {
+        assertThat(proxyTest.proxyConfigured().equals(false));
+    }
+}