Merge pull request #1289 from Vlatombe/JENKINS-70392

Author: Vlatombe

src/main/java/org/csanchez/jenkins/plugins/kubernetes/KubernetesFactoryAdapter.java

@@ -1,6 +1,7 @@
 package org.csanchez.jenkins.plugins.kubernetes;
 
 
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
 import java.util.Base64;
 import java.util.Collections;
 import java.util.logging.Logger;
@@ -18,7 +19,6 @@
 
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.ConfigBuilder;
-import io.fabric8.kubernetes.client.DefaultKubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import org.jenkinsci.plugins.kubernetes.auth.KubernetesAuth;
 import org.jenkinsci.plugins.kubernetes.auth.KubernetesAuthConfig;
@@ -144,7 +144,10 @@ public KubernetesClient createClient() throws KubernetesAuthException {
                 }
             }
         }
-        return new DefaultKubernetesClient(builder.build());
+        // TODO post 2.362 use jenkins.util.SetContextClassLoader
+        try (WithContextClassLoader ignored = new WithContextClassLoader(getClass().getClassLoader())) {
+            return new KubernetesClientBuilder().withConfig(builder.build()).build();
+        }
     }
     private String getProxyPasswordDecrypted(ProxyConfiguration p) {
         String passwordEncrypted = p.getPassword();
@@ -184,4 +187,19 @@ private static StandardCredentials resolveCredentials(@CheckForNull String crede
         }
         return c;
     }
+
+    private static class WithContextClassLoader implements AutoCloseable {
+
+        private final ClassLoader previousClassLoader;
+
+        public WithContextClassLoader(ClassLoader classLoader) {
+            this.previousClassLoader = Thread.currentThread().getContextClassLoader();
+            Thread.currentThread().setContextClassLoader(classLoader);
+        }
+
+        @Override
+        public void close() {
+            Thread.currentThread().setContextClassLoader(previousClassLoader);
+        }
+    }
 }

src/test/java/org/csanchez/jenkins/plugins/kubernetes/KubernetesTestUtil.java

@@ -23,11 +23,31 @@
  */
 package org.csanchez.jenkins.plugins.kubernetes;
 
-import static java.util.logging.Level.*;
-import static org.junit.Assume.*;
+import static java.util.logging.Level.FINE;
+import static java.util.logging.Level.INFO;
+import static java.util.logging.Level.WARNING;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assume.assumeNoException;
+import static org.junit.Assume.assumeTrue;
 
 import edu.umd.cs.findbugs.annotations.CheckForNull;
+import hudson.Util;
+import io.fabric8.kubernetes.api.model.NamespaceBuilder;
+import io.fabric8.kubernetes.api.model.Node;
+import io.fabric8.kubernetes.api.model.PodList;
+import io.fabric8.kubernetes.api.model.Secret;
+import io.fabric8.kubernetes.api.model.SecretBuilder;
+import io.fabric8.kubernetes.client.Config;
+import io.fabric8.kubernetes.client.ConfigBuilder;
+import io.fabric8.kubernetes.client.DefaultKubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.fabric8.kubernetes.client.KubernetesClientException;
+import io.fabric8.kubernetes.client.utils.Serialization;
 import java.io.IOException;
+import java.net.InetAddress;
+import java.net.URL;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -40,32 +60,15 @@
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
-
-import hudson.Util;
+import jenkins.model.Jenkins;
+import jenkins.model.JenkinsLocationConfiguration;
 import org.apache.commons.compress.utils.IOUtils;
 import org.apache.commons.lang.StringUtils;
 import org.jenkinsci.plugins.kubernetes.auth.KubernetesAuthException;
 import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
 import org.junit.rules.TestName;
-
-import io.fabric8.kubernetes.api.model.NamespaceBuilder;
-import io.fabric8.kubernetes.api.model.Node;
-import io.fabric8.kubernetes.api.model.PodList;
-import io.fabric8.kubernetes.api.model.Secret;
-import io.fabric8.kubernetes.api.model.SecretBuilder;
-import io.fabric8.kubernetes.client.Config;
-import io.fabric8.kubernetes.client.ConfigBuilder;
-import io.fabric8.kubernetes.client.DefaultKubernetesClient;
-import io.fabric8.kubernetes.client.KubernetesClient;
-import io.fabric8.kubernetes.client.KubernetesClientException;
-import io.fabric8.kubernetes.client.utils.Serialization;
-import java.net.InetAddress;
-import java.net.URL;
-import jenkins.model.Jenkins;
-import jenkins.model.JenkinsLocationConfiguration;
-import static org.junit.Assert.*;
 import org.jvnet.hudson.test.JenkinsRule;
 
 public class KubernetesTestUtil {
@@ -139,8 +142,7 @@ public static void setupHost(KubernetesCloud cloud) throws Exception {
     }
 
     public static void assumeKubernetes() throws Exception {
-        try (DefaultKubernetesClient client = new DefaultKubernetesClient(
-                new ConfigBuilder(Config.autoConfigure(null)).build())) {
+        try (KubernetesClient client = new KubernetesClientBuilder().build()) {
             client.pods().list();
         } catch (Exception e) {
             assumeNoException(e);

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/AbstractKubernetesPipelineRJRTest.java

@@ -0,0 +1,42 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline;
+
+import static org.csanchez.jenkins.plugins.kubernetes.KubernetesTestUtil.assumeKubernetes;
+
+import org.csanchez.jenkins.plugins.kubernetes.KubernetesTestUtil;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.CreateWorkflowJobThenScheduleRun;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.RunId;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.SetupCloud;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Rule;
+import org.junit.rules.TestName;
+import org.jvnet.hudson.test.RealJenkinsRule;
+
+public abstract class AbstractKubernetesPipelineRJRTest {
+
+    @Rule
+    public TestName name = new TestName();
+
+    @Rule
+    public RealJenkinsRule rjr = new RealJenkinsRule();
+
+    protected RunId runId;
+
+    private SetupCloud setup;
+
+    public AbstractKubernetesPipelineRJRTest(SetupCloud setup) {
+        this.setup = setup;
+    }
+
+    @BeforeClass
+    public static void isKubernetesConfigured() throws Exception {
+        assumeKubernetes();
+    }
+
+    @Before
+    public void setUp() throws Throwable {
+        rjr.startJenkins();
+        rjr.runRemotely(setup);
+        runId = rjr.runRemotely(new CreateWorkflowJobThenScheduleRun(KubernetesTestUtil.loadPipelineScript(getClass(), name.getMethodName() + ".groovy")));
+    }
+}

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesPipelineRJRTest.java

@@ -0,0 +1,20 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline;
+
+import java.net.UnknownHostException;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.AssertBuildStatusSuccess;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.SetupCloud;
+import org.junit.Ignore;
+import org.junit.Test;
+
+public class KubernetesPipelineRJRTest extends AbstractKubernetesPipelineRJRTest {
+    public KubernetesPipelineRJRTest() throws UnknownHostException {
+        super(new SetupCloud());
+    }
+
+    @Test
+    @Ignore // Need RealJenkinsRule to accept a custom port
+    public void basicPipeline() throws Throwable {
+        rjr.runRemotely(new AssertBuildStatusSuccess(runId));
+    }
+}
+

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesPipelineWebsocketRJRTest.java

@@ -0,0 +1,31 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline;
+
+import static org.csanchez.jenkins.plugins.kubernetes.KubernetesTestUtil.assumeKubernetes;
+
+import java.net.UnknownHostException;
+import org.csanchez.jenkins.plugins.kubernetes.KubernetesTestUtil;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.AssertBuildStatusSuccess;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.CreateWorkflowJobThenScheduleRun;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.RunId;
+import org.csanchez.jenkins.plugins.kubernetes.pipeline.steps.SetupCloud;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Ignore;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TestName;
+import org.jvnet.hudson.test.RealJenkinsRule;
+
+public class KubernetesPipelineWebsocketRJRTest extends AbstractKubernetesPipelineRJRTest{
+
+    public KubernetesPipelineWebsocketRJRTest() throws UnknownHostException {
+        super(new SetupCloud(true));
+    }
+    @Test
+    @Ignore // Need RealJenkinsRule to accept a custom port
+    public void basicPipeline() throws Throwable {
+        rjr.runRemotely(new AssertBuildStatusSuccess(runId));
+    }
+
+}
+

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/steps/AssertBuildStatusSuccess.java

@@ -0,0 +1,21 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline.steps;
+
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.RealJenkinsRule;
+
+public class AssertBuildStatusSuccess implements RealJenkinsRule.Step {
+    private RunId runId;
+
+    public AssertBuildStatusSuccess(RunId runId) {
+        this.runId = runId;
+    }
+
+    @Override
+    public void run(JenkinsRule r) throws Throwable {
+        WorkflowJob p = r.jenkins.getItemByFullName(runId.name, WorkflowJob.class);
+        WorkflowRun b = p.getBuildByNumber(runId.number);
+        r.assertBuildStatusSuccess(r.waitForCompletion(b));
+    }
+}

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/steps/CreateWorkflowJobThenScheduleRun.java

@@ -0,0 +1,27 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline.steps;
+
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.RealJenkinsRule;
+
+/**
+ * Creates a workflow job using the specified script, then schedules it and returns a reference to the run.
+ */
+public class CreateWorkflowJobThenScheduleRun implements RealJenkinsRule.Step2<RunId> {
+    private String script;
+
+    public CreateWorkflowJobThenScheduleRun(String script) {
+        this.script = script;
+    }
+
+    @Override
+    public RunId run(JenkinsRule r) throws Throwable {
+        WorkflowJob project = r.createProject(WorkflowJob.class);
+        project.setDefinition(new CpsFlowDefinition(script, true));
+        project.save();
+        WorkflowRun b = project.scheduleBuild2(0).get();
+        return new RunId(project.getFullName(), b.number);
+    }
+}

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/steps/RunId.java

@@ -0,0 +1,24 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline.steps;
+
+import java.io.Serializable;
+
+/**
+ * Lightweight, serializable reference to a run which can be passed around steps.
+ */
+public class RunId implements Serializable {
+    String name;
+    int number;
+
+    RunId(String name, int number) {
+        this.name = name;
+        this.number = number;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public int getNumber() {
+        return number;
+    }
+}

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/steps/SetupCloud.java

@@ -0,0 +1,46 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline.steps;
+
+import java.net.InetAddress;
+import java.net.URL;
+import java.net.UnknownHostException;
+import jenkins.model.JenkinsLocationConfiguration;
+import org.apache.commons.lang3.StringUtils;
+import org.csanchez.jenkins.plugins.kubernetes.KubernetesCloud;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.RealJenkinsRule;
+
+/**
+ * Sets up a Kubernetes cloud instance named kubernetes.
+ */
+public class SetupCloud implements RealJenkinsRule.Step {
+    private String hostAddress;
+    private Integer agentPort;
+
+    private boolean websocket;
+
+    public SetupCloud(boolean websocket) throws UnknownHostException {
+        hostAddress = StringUtils.defaultIfBlank(System.getProperty("jenkins.host.address"), InetAddress.getLocalHost().getHostAddress());
+        agentPort = Integer.getInteger("slaveAgentPort");
+        this.websocket = websocket;
+    }
+
+    public SetupCloud() throws UnknownHostException {
+        this(false);
+    }
+
+    @Override
+    public void run(JenkinsRule r) throws Throwable {
+        KubernetesCloud cloud = new KubernetesCloud("kubernetes");
+        cloud.setWebSocket(websocket);
+        r.jenkins.clouds.add(cloud);
+        // Agents running in Kubernetes (minikube) need to connect to this server, so localhost does not work
+        URL url = new URL(JenkinsLocationConfiguration.get().getUrl());
+        System.err.println("Calling home to address: " + hostAddress);
+        URL nonLocalhostUrl = new URL(url.getProtocol(), hostAddress, url.getPort(), url.getFile());
+        cloud.setJenkinsUrl(nonLocalhostUrl.toString());
+        if (agentPort != null) {
+            r.jenkins.setSlaveAgentPort(agentPort);
+        }
+        r.jenkins.save();
+    }
+}

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/steps/package-info.java

@@ -0,0 +1,4 @@
+package org.csanchez.jenkins.plugins.kubernetes.pipeline.steps;
+/**
+ * Reusable steps for tests relying on RealJenkinsRule.
+ */