Add sidecar variants

.github/workflows/check-sidecar-tasks.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -eu
+
+make sidecar-tasks
+if ! git diff --quiet deploy/central/tasks-chart/templates; then
+    echo "Sidecar Tasks are not up-to-date! Run 'make sidecar-tasks' to update."
+    exit 1
+else
+    echo "Sidecar Tasks are up-to-date."
+fi

.github/workflows/main.yaml

@@ -157,6 +157,9 @@ jobs:
         uses: actions/setup-go@v2
         with:
           go-version: 1.16
+      -
+        name: Check if sidecar tasks are up-to-date
+        run: ./.github/workflows/check-sidecar-tasks.sh
       -
         name: Check if docs are up-to-date
         run: ./.github/workflows/check-docs.sh

Makefile

@@ -108,6 +108,11 @@ start-local-env:
 	cd scripts && ./start-local-env.sh
 .PHONY: start-local-env
 
+## Render sidecar task variants.
+sidecar-tasks:
+	go run cmd/sidecar-tasks/main.go
+.PHONY: sidecar-tasks
+
 ## Render documentation for tasks.
 docs:
 	go run cmd/docs/main.go

cmd/sidecar-tasks/main.go

@@ -0,0 +1,93 @@
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"log"
+	"strings"
+
+	tekton "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
+	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/yaml"
+)
+
+func main() {
+	tasksWithSidecars := []string{
+		"ods-build-go",
+		"ods-build-gradle",
+		"ods-build-python",
+		"ods-build-typescript",
+	}
+	t, err := parseTasks(tasksWithSidecars)
+	if err != nil {
+		log.Fatal(err)
+	}
+	adjustTasks(t)
+	err = writeTasks(t)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+func parseTasks(taskNames []string) (map[string]*tekton.ClusterTask, error) {
+	tasks := map[string]*tekton.ClusterTask{}
+	for _, task := range taskNames {
+		fmt.Printf("Parsing task %s ...\n", task)
+		b, err := ioutil.ReadFile(fmt.Sprintf("deploy/central/tasks-chart/templates/task-%s.yaml", task))
+		if err != nil {
+			return nil, err
+		}
+		var t tekton.ClusterTask
+		err = yaml.Unmarshal(b, &t)
+		if err != nil {
+			return nil, err
+		}
+		tasks[task] = &t
+	}
+	return tasks, nil
+}
+
+func adjustTasks(tasks map[string]*tekton.ClusterTask) {
+	for name, t := range tasks {
+		fmt.Printf("Adding sidecar to task %s ...\n", name)
+		nameParts := strings.Split(t.Name, "{{")
+		t.Name = strings.Replace(t.Name, "{{.Values.taskSuffix}}", "-with-sidecar{{.Values.taskSuffix}}", 1)
+		t.Spec.Description = t.Spec.Description + `
+**Sidecar variant!** Use this task if you need to run a container next to the build task.
+For example, this could be used to run a database to allow for integration tests.
+The sidecar image to must be supplied via ` + "`sidecar-image`" + `.
+Apart from the sidecar, the task is an exact copy of ` + "`" + nameParts[0] + "`" + `.`
+		t.Spec.Params = append(t.Spec.Params, tekton.ParamSpec{
+			Name:        "sidecar-image",
+			Description: "Image to use for sidecar",
+			Type:        tekton.ParamTypeString,
+		})
+		t.Spec.Sidecars = []tekton.Sidecar{
+			{
+				Container: corev1.Container{
+					Name:  "sidecar",
+					Image: "$(params.sidecar-image)",
+				},
+			},
+		}
+	}
+}
+
+func writeTasks(tasks map[string]*tekton.ClusterTask) error {
+	for name, t := range tasks {
+		fmt.Printf("Writing sidecar task %s ...\n", name)
+		out, err := yaml.Marshal(t)
+		if err != nil {
+			return err
+		}
+		out = append([]byte("# Generated by cmd/sidecar-tasks/main.go; DO NOT EDIT.\n"), out...)
+		err = ioutil.WriteFile(
+			fmt.Sprintf("deploy/central/tasks-chart/templates/task-%s-with-sidecar.yaml", name),
+			out, 0644,
+		)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}

deploy/cd-namespace/chart/templates/configmap-aqua.yaml

@@ -3,7 +3,7 @@ apiVersion: v1
 metadata:
   name: ods-aqua
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 data:
-  url: '{{ .Values.aquaUrl }}'
-  registry: '{{ .Values.aquaRegistry }}'
+  url: '{{.Values.aquaUrl}}'
+  registry: '{{.Values.aquaRegistry}}'

deploy/cd-namespace/chart/templates/configmap-bitbucket.yaml

@@ -3,7 +3,7 @@ apiVersion: v1
 metadata:
   name: ods-bitbucket
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 data:
-  url: '{{ .Values.bitbucketUrl }}'
-  repoBase: '{{ .Values.bitbucketUrl }}/scm'
+  url: '{{.Values.bitbucketUrl}}'
+  repoBase: '{{.Values.bitbucketUrl}}/scm'

deploy/cd-namespace/chart/templates/configmap-cluster.yaml

@@ -3,6 +3,6 @@ apiVersion: v1
 metadata:
   name: ods-cluster
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 data:
-  consoleUrl: '{{ .Values.consoleUrl }}'
+  consoleUrl: '{{.Values.consoleUrl}}'

deploy/cd-namespace/chart/templates/configmap-nexus.yaml

@@ -3,8 +3,8 @@ apiVersion: v1
 metadata:
   name: ods-nexus
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 data:
-  url: '{{ .Values.nexusUrl }}'
-  temporaryRepository: '{{ .Values.nexusTemporaryRepository }}'
-  permanentRepository: '{{ .Values.nexusPermanentRepository }}'
+  url: '{{.Values.nexusUrl}}'
+  temporaryRepository: '{{.Values.nexusTemporaryRepository}}'
+  permanentRepository: '{{.Values.nexusPermanentRepository}}'

deploy/cd-namespace/chart/templates/configmap-pipeline.yaml

@@ -3,6 +3,6 @@ apiVersion: v1
 metadata:
   name: ods-pipeline
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 data:
-  debug: '{{ .Values.debug }}'
+  debug: '{{.Values.debug}}'

deploy/cd-namespace/chart/templates/configmap-sonar.yaml

@@ -3,6 +3,6 @@ apiVersion: v1
 metadata:
   name: ods-sonar
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 data:
-  url: '{{ .Values.sonarUrl }}'
+  url: '{{.Values.sonarUrl}}'

deploy/cd-namespace/chart/templates/deployment-interceptor.yaml

@@ -1,24 +1,24 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ include "chart.fullname" . }}
+  name: {{ include "chart.fullname" .}}
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 spec:
-  replicas: {{ .Values.interceptor.replicaCount }}
+  replicas: {{.Values.interceptor.replicaCount}}
   selector:
     matchLabels:
-      {{- include "chart.selectorLabels" . | nindent 6 }}
+      {{- include "chart.selectorLabels" . | nindent 6}}
   template:
     metadata:
       labels:
-        {{- include "chart.selectorLabels" . | nindent 8 }}
+        {{- include "chart.selectorLabels" . | nindent 8}}
     spec:
       containers:
-        - name: {{ .Chart.Name }}
+        - name: {{.Chart.Name}}
           securityContext: {}
-          image: "{{ .Values.interceptor.image.registry }}/{{ .Values.interceptor.image.namespace | default .Release.Namespace }}/{{ .Values.interceptor.image.repository | default .Chart.Name }}:{{ .Values.interceptor.image.tag | default .Chart.AppVersion }}"
-          imagePullPolicy: {{ .Values.interceptor.image.pullPolicy }}
+          image: "{{.Values.interceptor.image.registry}}/{{.Values.interceptor.image.namespace | default .Release.Namespace}}/{{.Values.interceptor.image.repository | default .Chart.Name}}:{{.Values.interceptor.image.tag | default .Chart.AppVersion}}"
+          imagePullPolicy: {{.Values.interceptor.image.pullPolicy}}
           ports:
             - name: http
               containerPort: 8080
@@ -35,7 +35,7 @@ spec:
                   key: password
                   name: ods-bitbucket-auth
             - name: API_HOST
-              value: '{{ .Values.interceptor.apiHost }}'
+              value: '{{.Values.interceptor.apiHost}}'
           readinessProbe:
             httpGet:
               path: /health
@@ -49,6 +49,6 @@ spec:
             failureThreshold: 20
             periodSeconds: 3
           resources:
-            {{- toYaml .Values.interceptor.resources | nindent 12 }}
-      serviceAccountName: '{{ .Values.serviceAccountName }}'
-      serviceAccount: '{{ .Values.serviceAccountName }}'
+            {{- toYaml .Values.interceptor.resources | nindent 12}}
+      serviceAccountName: '{{.Values.serviceAccountName}}'
+      serviceAccount: '{{.Values.serviceAccountName}}'

deploy/cd-namespace/chart/templates/event_listener.yaml

@@ -1,16 +1,16 @@
 apiVersion: triggers.tekton.dev/v1alpha1
 kind: EventListener
 metadata:
-  name: {{ include "chart.fullname" . }}
+  name: {{ include "chart.fullname" .}}
   finalizers:
     - eventlisteners.triggers.tekton.dev
 spec:
   podTemplate: {}
-  serviceAccountName: '{{ .Values.serviceAccountName }}'
+  serviceAccountName: '{{.Values.serviceAccountName}}'
   triggers:
     - bindings:
         - kind: TriggerBinding
-          ref: {{ include "chart.fullname" . }}
+          ref: {{ include "chart.fullname" .}}
       interceptors:
         - bitbucket:
             secretRef:
@@ -20,8 +20,8 @@ spec:
             objectRef:
               apiVersion: v1
               kind: Service
-              name: {{ include "chart.fullname" . }}
-              namespace: {{ .Release.Namespace }}
-      name: {{ include "chart.fullname" . }}
+              name: {{ include "chart.fullname" .}}
+              namespace: {{.Release.Namespace}}
+      name: {{ include "chart.fullname" .}}
       template:
-        ref: {{ include "chart.fullname" . }}
+        ref: {{ include "chart.fullname" .}}

deploy/cd-namespace/chart/templates/pvc.yaml

@@ -2,8 +2,8 @@ kind: PersistentVolumeClaim
 apiVersion: v1
 metadata:
   annotations:
-    volume.beta.kubernetes.io/storage-provisioner: '{{ .Values.storageProvisioner }}'
-  name: {{ include "chart.fullname" . }}
+    volume.beta.kubernetes.io/storage-provisioner: '{{.Values.storageProvisioner}}'
+  name: {{ include "chart.fullname" .}}
   finalizers:
     - kubernetes.io/pvc-protection
 spec:
@@ -12,5 +12,5 @@ spec:
   resources:
     requests:
       storage: 2Gi
-  storageClassName: '{{ .Values.storageClassName }}'
+  storageClassName: '{{.Values.storageClassName}}'
   volumeMode: Filesystem

deploy/cd-namespace/chart/templates/secret-aqua-auth.yaml

@@ -3,8 +3,8 @@ kind: Secret
 metadata:
   name: ods-aqua-auth
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 stringData:
-  password: '{{ .Values.aquaPassword }}'
-  username: '{{ .Values.aquaUsername }}'
+  password: '{{.Values.aquaPassword}}'
+  username: '{{.Values.aquaUsername}}'
 type: kubernetes.io/basic-auth

deploy/cd-namespace/chart/templates/secret-bitbucket-auth.yaml

@@ -3,10 +3,10 @@ kind: Secret
 metadata:
   name: ods-bitbucket-auth
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
   annotations:
-    tekton.dev/git-0: '{{ .Values.bitbucketUrl }}'
+    tekton.dev/git-0: '{{.Values.bitbucketUrl}}'
 stringData:
-  password: '{{ .Values.bitbucketAccessToken }}'
-  username: '{{ .Values.bitbucketUsername }}'
+  password: '{{.Values.bitbucketAccessToken}}'
+  username: '{{.Values.bitbucketUsername}}'
 type: kubernetes.io/basic-auth

deploy/cd-namespace/chart/templates/secret-bitbucket-webhook.yaml

@@ -3,7 +3,7 @@ kind: Secret
 metadata:
   name: ods-bitbucket-webhook
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 stringData:
-  secret: '{{ .Values.bitbucketWebhookSecret }}'
+  secret: '{{.Values.bitbucketWebhookSecret}}'
 type: Opaque

deploy/cd-namespace/chart/templates/secret-nexus-auth.yaml

@@ -3,8 +3,8 @@ kind: Secret
 metadata:
   name: ods-nexus-auth
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 stringData:
-  password: '{{ .Values.nexusPassword }}'
-  username: '{{ .Values.nexusUsername }}'
+  password: '{{.Values.nexusPassword}}'
+  username: '{{.Values.nexusUsername}}'
 type: kubernetes.io/basic-auth

deploy/cd-namespace/chart/templates/secret-sonar-auth.yaml

@@ -3,8 +3,8 @@ kind: Secret
 metadata:
   name: ods-sonar-auth
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 stringData:
-  password: '{{ .Values.sonarAuthToken }}'
-  username: '{{ .Values.sonarUsername }}'
+  password: '{{.Values.sonarAuthToken}}'
+  username: '{{.Values.sonarUsername}}'
 type: kubernetes.io/basic-auth

deploy/cd-namespace/chart/templates/service-interceptor.yaml

@@ -1,9 +1,9 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: {{ include "chart.fullname" . }}
+  name: {{ include "chart.fullname" .}}
   labels:
-    {{- include "chart.labels" . | nindent 4 }}
+    {{- include "chart.labels" . | nindent 4}}
 spec:
   type: ClusterIP
   ports:
@@ -12,4 +12,4 @@ spec:
       protocol: TCP
       name: http
   selector:
-    {{- include "chart.selectorLabels" . | nindent 4 }}
+    {{- include "chart.selectorLabels" . | nindent 4}}

deploy/cd-namespace/chart/templates/trigger_binding.yaml

@@ -1,7 +1,7 @@
 apiVersion: triggers.tekton.dev/v1alpha1
 kind: TriggerBinding
 metadata:
-  name: {{ include "chart.fullname" . }}
+  name: {{ include "chart.fullname" .}}
 spec:
   params:
     - name: pipeline-name

deploy/cd-namespace/chart/templates/trigger_template.yaml

@@ -1,7 +1,7 @@
 apiVersion: triggers.tekton.dev/v1alpha1
 kind: TriggerTemplate
 metadata:
-  name: {{ include "chart.fullname" . }}
+  name: {{ include "chart.fullname" .}}
 spec:
   params:
     - description: The PVC backing up the pipeline