Add global variable for accessing the proxy settings in pipelines

Author: coder-hugo

pom.xml

@@ -97,7 +97,6 @@
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-cps</artifactId>
             <version>2.22</version>
-            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>

src/main/java/org/jenkinsci/plugins/workflow/vars/ProxyVar.java

@@ -0,0 +1,86 @@
+package org.jenkinsci.plugins.workflow.vars;
+
+
+import groovy.lang.Binding;
+import hudson.Extension;
+import hudson.ProxyConfiguration;
+import jenkins.model.Jenkins;
+import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
+import org.jenkinsci.plugins.workflow.cps.CpsScript;
+import org.jenkinsci.plugins.workflow.cps.GlobalVariable;
+
+import javax.annotation.Nonnull;
+import java.io.Serializable;
+import java.net.InetSocketAddress;
+import java.net.Proxy;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.regex.Pattern;
+
+/**
+ * @author Robin Müller
+ */
+@Extension
+public class ProxyVar extends GlobalVariable {
+
+    private static final String PROXY_VAR_NAME = "proxy";
+
+    @Nonnull
+    @Override
+    public String getName() {
+        return PROXY_VAR_NAME;
+    }
+
+    @Nonnull
+    @Override
+    public Object getValue(@Nonnull CpsScript cpsScript) throws Exception {
+        Binding binding = cpsScript.getBinding();
+        if (binding.hasVariable(PROXY_VAR_NAME)) {
+            return binding.getVariable(PROXY_VAR_NAME);
+        } else {
+            ProxySettings proxy = new ProxySettings(Jenkins.getActiveInstance().proxy);
+            binding.setVariable(PROXY_VAR_NAME, proxy);
+            return proxy;
+        }
+    }
+
+    public static class ProxySettings implements Serializable {
+
+        private final String proxyHost;
+        private final Integer proxyPort;
+        private final List<String> noProxyHosts;
+
+        public ProxySettings(ProxyConfiguration proxyConfiguration) {
+            if (proxyConfiguration != null) {
+                Proxy proxy = proxyConfiguration.createProxy(null);
+                InetSocketAddress address = (InetSocketAddress) proxy.address();
+                this.proxyHost = address.getHostName();
+                this.proxyPort = address.getPort();
+                this.noProxyHosts = new ArrayList<>();
+                for (Pattern noProxyHost : proxyConfiguration.getNoProxyHostPatterns()) {
+                    noProxyHosts.add(noProxyHost.toString().replace("\\.", ".").replace(".*", "*"));
+                }
+            } else {
+                this.proxyHost = null;
+                this.proxyPort = null;
+                this.noProxyHosts = Collections.emptyList();
+            }
+        }
+
+        @Whitelisted
+        public String getProxyHost() {
+            return proxyHost;
+        }
+
+        @Whitelisted
+        public Integer getProxyPort() {
+            return proxyPort;
+        }
+
+        @Whitelisted
+        public List<String> getNoProxyHosts() {
+            return noProxyHosts;
+        }
+    }
+}

src/main/resources/org/jenkinsci/plugins/workflow/vars/ProxyVar/help.jelly

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  Represents the Jenkins proxy configuration.<br/>
+  Available properties:
+  <ul>
+    <li>proxyHost (String)</li>
+    <li>proxyPort (Integer)</li>
+    <li>noProxyHosts (List&amp;lt;String&gt;)</li>
+  </ul>
+</j:jelly>

src/test/java/org/jenkinsci/plugins/workflow/vars/ProxyVarTest.java

@@ -0,0 +1,63 @@
+package org.jenkinsci.plugins.workflow.vars;
+
+import hudson.ProxyConfiguration;
+import hudson.model.Result;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+/**
+ * @author Robin Müller
+ */
+public class ProxyVarTest {
+
+    @Rule
+    public JenkinsRule jenkinsRule = new JenkinsRule();
+
+    @Test
+    public void test_proxy_not_set() throws Exception {
+        WorkflowJob job = jenkinsRule.jenkins.createProject(WorkflowJob.class, "workflow");
+        // leave out the subject
+        job.setDefinition(new CpsFlowDefinition("echo \"proxy: http://$proxy.proxyHost:$proxy.proxyPort\"", true));
+
+        WorkflowRun run = jenkinsRule.assertBuildStatus(Result.SUCCESS, job.scheduleBuild2(0).get());
+        jenkinsRule.assertLogContains("proxy: http://null:null", run);
+    }
+
+    @Test
+    public void test_proxy_set() throws Exception {
+        jenkinsRule.getInstance().proxy = new ProxyConfiguration("test", 8080);
+
+        WorkflowJob job = jenkinsRule.jenkins.createProject(WorkflowJob.class, "workflow");
+        // leave out the subject
+        job.setDefinition(new CpsFlowDefinition("echo \"proxy: http://$proxy.proxyHost:$proxy.proxyPort\"", true));
+
+        WorkflowRun run = jenkinsRule.assertBuildStatus(Result.SUCCESS, job.scheduleBuild2(0).get());
+        jenkinsRule.assertLogContains("proxy: http://test:8080", run);
+    }
+
+    @Test
+    public void test_noProxyHosts_not_set() throws Exception {
+        WorkflowJob job = jenkinsRule.jenkins.createProject(WorkflowJob.class, "workflow");
+        // leave out the subject
+        job.setDefinition(new CpsFlowDefinition("echo \"noProxyHosts: ${proxy.noProxyHosts.join(',')};\"", true));
+
+        WorkflowRun run = jenkinsRule.assertBuildStatus(Result.SUCCESS, job.scheduleBuild2(0).get());
+        jenkinsRule.assertLogContains("noProxyHosts: ;", run);
+    }
+
+    @Test
+    public void test_noProxyHosts_set() throws Exception {
+        jenkinsRule.getInstance().proxy = new ProxyConfiguration("test", 8080, null, null, "test.tld\n*.test.tld");
+
+        WorkflowJob job = jenkinsRule.jenkins.createProject(WorkflowJob.class, "workflow");
+        // leave out the subject
+        job.setDefinition(new CpsFlowDefinition("echo \"noProxyHosts: ${proxy.noProxyHosts.join(',')};\"", true));
+
+        WorkflowRun run = jenkinsRule.assertBuildStatus(Result.SUCCESS, job.scheduleBuild2(0).get());
+        jenkinsRule.assertLogContains("noProxyHosts: test.tld,*.test.tld;", run);
+    }
+}