Merge pull request #141 from garethjevans/params

garethjevans · web-flow · commit b1e971eadf7f · 2021-04-30T16:19:45.000+01:00
feat: add some default parameters when starting a pipelinerun
diff --git a/pom.xml b/pom.xml
@@ -88,6 +88,12 @@
             <artifactId>git</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>github-branch-source</artifactId>
+            <version>2.9.7</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>envinject</artifactId>
@@ -133,6 +139,21 @@
               <artifactId>jackson-module-jaxb-annotations</artifactId>
               <version>2.12.1</version>
           </dependency>
+          <dependency>
+              <groupId>com.squareup.okio</groupId>
+              <artifactId>okio</artifactId>
+              <version>1.17.5</version>
+          </dependency>
+          <dependency>
+              <groupId>com.squareup.okhttp3</groupId>
+              <artifactId>okhttp</artifactId>
+              <version>3.14.9</version>
+          </dependency>
+          <dependency>
+              <groupId>com.squareup.okhttp3</groupId>
+              <artifactId>logging-interceptor</artifactId>
+              <version>3.14.9</version>
+          </dependency>
       </dependencies>
     </dependencyManagement>
 
diff --git a/src/main/java/org/waveywaves/jenkins/plugins/tekton/client/TektonUtils.java b/src/main/java/org/waveywaves/jenkins/plugins/tekton/client/TektonUtils.java
@@ -142,7 +142,6 @@ public static InputStream urlToByteArrayStream(URL url) {
             }
         }
 
-
         return inputStream;
     }
 
diff --git a/src/main/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/CreateRaw.java b/src/main/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/CreateRaw.java
@@ -20,8 +20,11 @@
 import hudson.util.ListBoxModel;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.tekton.client.TektonClient;
+import io.fabric8.tekton.pipeline.v1beta1.ArrayOrString;
+import io.fabric8.tekton.pipeline.v1beta1.Param;
 import io.fabric8.tekton.pipeline.v1beta1.Pipeline;
 import io.fabric8.tekton.pipeline.v1beta1.PipelineRun;
+import io.fabric8.tekton.pipeline.v1beta1.PipelineRunSpec;
 import io.fabric8.tekton.pipeline.v1beta1.Task;
 import io.fabric8.tekton.pipeline.v1beta1.TaskRun;
 import io.jenkins.plugins.checks.api.ChecksConclusion;
@@ -32,6 +35,9 @@
 import io.jenkins.plugins.checks.api.ChecksStatus;
 import java.time.LocalDateTime;
 import java.time.ZoneOffset;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Optional;
 import org.jenkinsci.Symbol;
 import org.jenkinsci.plugins.displayurlapi.DisplayURLProvider;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -143,7 +149,7 @@ public String getClusterName() {
         return clusterName;
     }
 
-    protected String createWithResourceSpecificClient(TektonResourceType resourceType, InputStream inputStream) throws Exception {
+    protected String createWithResourceSpecificClient(TektonResourceType resourceType, InputStream inputStream, EnvVars envVars) throws Exception {
         switch (resourceType) {
             case task:
                 return createTask(inputStream);
@@ -152,7 +158,7 @@ protected String createWithResourceSpecificClient(TektonResourceType resourceTyp
             case pipeline:
                 return createPipeline(inputStream);
             case pipelinerun:
-                return createPipelineRun(inputStream);
+                return createPipelineRun(inputStream, envVars);
             default:
                 return "";
         }
@@ -220,35 +226,71 @@ public String createPipeline(InputStream inputStream) {
         return resourceName;
     }
 
-    public String createPipelineRun(InputStream inputStream) throws Exception {
+    public String createPipelineRun(InputStream inputStream, EnvVars envVars) throws Exception {
         if (pipelineRunClient == null) {
             TektonClient tc = (TektonClient) tektonClient;
             setPipelineRunClient(tc.v1beta1().pipelineRuns());
         }
         String resourceName;
-        PipelineRun pipelineRun = pipelineRunClient.load(inputStream).get();
+        final PipelineRun pipelineRun = pipelineRunClient.load(inputStream).get();
         if (!Strings.isNullOrEmpty(namespace) && Strings.isNullOrEmpty(pipelineRun.getMetadata().getNamespace())) {
             pipelineRun.getMetadata().setNamespace(namespace);
         }
+
+        // GIT_BRANCH=origin/main
+        // GIT_COMMIT=bb1ef888f5375bb19d5bb227e35bfcfed49759ed
+        // GIT_PREVIOUS_COMMIT=9c7648f892913dfa12963a38fe489b1291e033a8
+        // GIT_PREVIOUS_SUCCESSFUL_COMMIT=9c7648f892913dfa12963a38fe489b1291e033a8
+        // GIT_URL=https://github.com/garethjevans/test-tekton-client
+
+        setParamOnPipelineRunSpec(pipelineRun.getSpec(), "BUILD_ID", envVars.get("BUILD_ID"));
+        // JOB_NAME
+        // JOB_SPEC
+        // JOB_TYPE
+        // PULL_BASE_REF
+        setParamOnPipelineRunSpec(pipelineRun.getSpec(), "PULL_BASE_SHA", envVars.get("GIT_COMMIT"));
+        // PULL_NUMBER
+        // PULL_PULL_REF
+        // PULL_PULL_SHA
+        // PULL_REFS
+        // REPO_NAME
+        // REPO_OWNER
+        setParamOnPipelineRunSpec(pipelineRun.getSpec(), "REPO_URL", envVars.get("GIT_URL"));
+
         String ns = pipelineRun.getMetadata().getNamespace();
-        if (Strings.isNullOrEmpty(ns)) {
-            pipelineRun = pipelineRunClient.create(pipelineRun);
-        } else {
-            pipelineRun = pipelineRunClient.inNamespace(ns).create(pipelineRun);
-        }
-        resourceName = pipelineRun.getMetadata().getName();
+
+        LOGGER.info("Creating PipelineRun " + pipelineRun);
+
+        PipelineRun updatedPipelineRun = Strings.isNullOrEmpty(ns) ?
+                pipelineRunClient.create(pipelineRun) :
+                pipelineRunClient.inNamespace(ns).create(pipelineRun);
+
+        resourceName = updatedPipelineRun.getMetadata().getName();
 
         ChecksDetails checkDetails = new ChecksDetails.ChecksDetailsBuilder()
-                .withName("Tekton: " + pipelineRun.getMetadata().getName())
+                .withName("Tekton: " + updatedPipelineRun.getMetadata().getName())
                 .withStatus(ChecksStatus.IN_PROGRESS)
                 .withConclusion(ChecksConclusion.NONE)
                 .build();
         checksPublisher.publish(checkDetails);
 
-        streamPipelineRunLogsToConsole(pipelineRun);
+        streamPipelineRunLogsToConsole(updatedPipelineRun);
+
         return resourceName;
     }
 
+    private void setParamOnPipelineRunSpec(@NonNull PipelineRunSpec spec, String paramName, String paramValue) {
+        if (spec.getParams() == null) {
+            spec.setParams(new ArrayList<>());
+        }
+        Optional<Param> param = spec.getParams().stream().filter(p -> p.getName().equals(paramName)).findAny();
+        if (param.isPresent()) {
+            param.get().setValue(new ArrayOrString(paramValue));
+        } else {
+            spec.getParams().add(new Param(paramName, new ArrayOrString(paramValue)));
+        }
+    }
+
     public void streamTaskRunLogsToConsole(TaskRun taskRun) throws Exception {
         synchronized (consoleLogger) {
             KubernetesClient kc = (KubernetesClient) kubernetesClient;
@@ -338,7 +380,7 @@ protected String runCreate(Run<?, ?> run, FilePath workspace, EnvVars envVars) {
                 } else {
                     TektonResourceType resourceType = kind.get(0);
                     LOGGER.info("creating kind " + resourceType.name());
-                    createdResourceName = createWithResourceSpecificClient(resourceType, new ByteArrayInputStream(data));
+                    createdResourceName = createWithResourceSpecificClient(resourceType, new ByteArrayInputStream(data), envVars);
                 }
             }
         } catch (Throwable e) {
@@ -488,6 +530,7 @@ private byte[] processTektonCatalog(EnvVars envVars, File dir, File file, byte[]
         builder.command(binary, "-b", "--add-defaults", "-f", filePath, "-o", outputFile.getPath());
         if (envVars != null) {
             for (Map.Entry<String, String> entry : envVars.entrySet()) {
+                LOGGER.info("Adding env var " + entry.getKey() + "=" + entry.getValue());
                 builder.environment().put(entry.getKey(), entry.getValue());
             }
         }
diff --git a/src/main/java/org/waveywaves/jenkins/plugins/tekton/client/logwatch/PipelineRunLogWatch.java b/src/main/java/org/waveywaves/jenkins/plugins/tekton/client/logwatch/PipelineRunLogWatch.java
@@ -94,6 +94,7 @@ public void run() {
                         }
                     }
                 }
+
                 if (taskComplete) {
                     logMessageLn("completed PipelineTask " + pipelineTaskName);
                     break;
diff --git a/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/CreateRawMockServerTest.java b/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/CreateRawMockServerTest.java
@@ -1,5 +1,6 @@
 package org.waveywaves.jenkins.plugins.tekton.client.build.create;
 
+import hudson.EnvVars;
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinition;
 import io.fabric8.kubernetes.client.KubernetesClient;
 
@@ -95,15 +96,15 @@ public void testTaskRunCreate() {
 
         // Mocked Responses
         TaskRunBuilder taskRunBuilder = new TaskRunBuilder()
-                .withNewMetadata().withName("home-is-set-1234").endMetadata();
-        List<TaskRun> trList = new ArrayList<TaskRun>();
-        TaskRun testTaskRun = taskRunBuilder.build();
-        trList.add(testTaskRun);
-        TaskRunList taskRunList = new TaskRunList();
-        taskRunList.setItems(trList);
+                .withNewMetadata()
+                    .withName("home-is-set-1234")
+                .endMetadata();
+        TaskRunList taskRunList = new TaskRunListBuilder()
+                .addToItems(taskRunBuilder.build())
+                .build();
 
         server.expect().post().withPath("/apis/tekton.dev/v1beta1/namespaces/test/taskruns")
-                .andReturn(HttpURLConnection.HTTP_CREATED, testTaskRun).once();
+                .andReturn(HttpURLConnection.HTTP_CREATED, taskRunBuilder.build()).once();
         server.expect().get().withPath("/apis/tekton.dev/v1beta1/namespaces/test/taskruns")
                 .andReturn(HttpURLConnection.HTTP_OK, taskRunList).once();
 
@@ -151,15 +152,15 @@ public void testPipelineCreate() {
 
         // Mocked Responses
         PipelineBuilder pipelineBuilder = new PipelineBuilder()
-                .withNewMetadata().withName("testPipeline").endMetadata();
-        List<Pipeline> pList = new ArrayList<Pipeline>();
-        Pipeline testPipeline = pipelineBuilder.build();
-        pList.add(testPipeline);
-        PipelineList pipelineList = new PipelineList();
-        pipelineList.setItems(pList);
+                .withNewMetadata()
+                    .withName("testPipeline")
+                .endMetadata();
+        PipelineList pipelineList = new PipelineListBuilder()
+                .addToItems(pipelineBuilder.build())
+                .build();
 
         server.expect().post().withPath("/apis/tekton.dev/v1beta1/namespaces/test/pipelines")
-                .andReturn(HttpURLConnection.HTTP_CREATED, testPipeline).once();
+                .andReturn(HttpURLConnection.HTTP_CREATED, pipelineBuilder.build()).once();
         server.expect().get().withPath("/apis/tekton.dev/v1beta1/namespaces/test/pipelines")
                 .andReturn(HttpURLConnection.HTTP_OK, pipelineList).once();
 
@@ -185,7 +186,9 @@ public void testPipelineRunCreate() {
         String testPipelineRunYaml = "apiVersion: tekton.dev/v1beta1\n" +
                 "kind: PipelineRun\n" +
                 "metadata:\n" +
-                "  name: testPipelineRun\n";
+                "  name: testPipelineRun\n" +
+                "spec:\n" +
+                "  params: []\n";
 
         KubernetesClient client = server.getClient();
         InputStream crdAsInputStream = getClass().getResourceAsStream("/pipeline-crd.yaml");
@@ -195,15 +198,19 @@ public void testPipelineRunCreate() {
 
         // Mocked Responses
         PipelineRunBuilder pipelineRunBuilder = new PipelineRunBuilder()
-                .withNewMetadata().withName("testPipelineRun").endMetadata();
-        List<PipelineRun> prList = new ArrayList<PipelineRun>();
-        PipelineRun testPipelineRun = pipelineRunBuilder.build();
-        prList.add(testPipelineRun);
-        PipelineRunList pipelineRunList = new PipelineRunList();
-        pipelineRunList.setItems(prList);
+                .withNewMetadata()
+                    .withName("testPipelineRun")
+                .endMetadata()
+                .withNewSpec()
+                    .withParams(new Param("param", new ArrayOrString("value")))
+                .endSpec();
+
+        PipelineRunList pipelineRunList = new PipelineRunListBuilder()
+                .addToItems(pipelineRunBuilder.build())
+                .build();
 
         server.expect().post().withPath("/apis/tekton.dev/v1beta1/namespaces/test/pipelines")
-                .andReturn(HttpURLConnection.HTTP_CREATED, testPipelineRun).once();
+                .andReturn(HttpURLConnection.HTTP_CREATED, pipelineRunBuilder.build()).once();
         server.expect().get().withPath("/apis/tekton.dev/v1beta1/namespaces/test/pipelines")
                 .andReturn(HttpURLConnection.HTTP_OK, pipelineRunList).once();
 
@@ -226,7 +233,7 @@ public void streamPipelineRunLogsToConsole(PipelineRun pipelineRun) {
         String createdPipelineName = "";
         try {
             createdPipelineName = createRaw.createPipelineRun(
-                    new ByteArrayInputStream(testPipelineRunYaml.getBytes(StandardCharsets.UTF_8)));
+                    new ByteArrayInputStream(testPipelineRunYaml.getBytes(StandardCharsets.UTF_8)), new EnvVars());
         } catch (Exception e) {
             fail(e.getMessage(), e);
         }
diff --git a/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/mock/CreateRawMock.java b/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/mock/CreateRawMock.java
@@ -1,5 +1,6 @@
 package org.waveywaves.jenkins.plugins.tekton.client.build.create.mock;
 
+import hudson.EnvVars;
 import io.fabric8.tekton.pipeline.v1beta1.PipelineRun;
 import io.fabric8.tekton.pipeline.v1beta1.TaskRun;
 import org.waveywaves.jenkins.plugins.tekton.client.TektonUtils;
@@ -28,7 +29,7 @@ public String createPipeline(InputStream inputStream) {
     }
 
     @Override
-    public String createPipelineRun(InputStream inputStream) { return TektonUtils.TektonResourceType.pipelinerun.toString(); }
+    public String createPipelineRun(InputStream inputStream, EnvVars envVars) { return TektonUtils.TektonResourceType.pipelinerun.toString(); }
 
     @Override
     public void streamTaskRunLogsToConsole(TaskRun taskRun) {
diff --git a/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/mock/FakeCreateRaw.java b/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/create/mock/FakeCreateRaw.java
@@ -1,5 +1,6 @@
 package org.waveywaves.jenkins.plugins.tekton.client.build.create.mock;
 
+import hudson.EnvVars;
 import org.apache.commons.io.IOUtils;
 
 import java.io.IOException;
@@ -33,7 +34,7 @@ public String createPipeline(InputStream inputStream) {
     }
 
     @Override
-    public String createPipelineRun(InputStream inputStream) {
+    public String createPipelineRun(InputStream inputStream, EnvVars envVars) {
         return createResource(inputStream);
     }
 
diff --git a/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/delete/DeleteRawMockServerTest.java b/src/test/java/org/waveywaves/jenkins/plugins/tekton/client/build/delete/DeleteRawMockServerTest.java

Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,6 @@ public static InputStream urlToByteArrayStream(URL url) {`
`142`	`142`	`}`
`143`	`143`	`}`
`144`	`144`
`145`		`-`
`146`	`145`	`return inputStream;`
`147`	`146`	`}`
`148`	`147`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,7 @@ public void run() {`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	`}`
	`97`	`+`
`97`	`98`	`if (taskComplete) {`
`98`	`99`	`logMessageLn("completed PipelineTask " + pipelineTaskName);`
`99`	`100`	`break;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package org.waveywaves.jenkins.plugins.tekton.client.build.create.mock;`
`2`	`2`
	`3`	`+import hudson.EnvVars;`
`3`	`4`	`import org.apache.commons.io.IOUtils;`
`4`	`5`
`5`	`6`	`import java.io.IOException;`
`@@ -33,7 +34,7 @@ public String createPipeline(InputStream inputStream) {`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`@Override`
`36`		`- public String createPipelineRun(InputStream inputStream) {`
	`37`	`+ public String createPipelineRun(InputStream inputStream, EnvVars envVars) {`
`37`	`38`	`return createResource(inputStream);`
`38`	`39`	`}`
`39`	`40`