Merge pull request #738 from chmouel/issue-737-use-pipelinerun-templates-in-pac-generate-command

Use Pipelinerun templates in pac generate command

Author: Shivam Mukhade

pkg/cmd/tknpac/generate/template.go

@@ -9,87 +9,73 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
-	"text/template"
+
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
 )
 
 type langOpts struct {
-	Language       string
-	detectionFile  string
-	Task           string
-	AnnotationTask string
+	detectionFile string
 }
 
 // I hate this part of the code so much.. but we are waiting for UBI images
 // having >1.6 golang for integrated templates.
 var languageDetection = map[string]langOpts{
 	"go": {
-		Language:       "Golang",
-		detectionFile:  "go.mod",
-		AnnotationTask: "golangci-lint",
-		Task: `- name: golangci-lint
-        taskRef:
-          name: golangci-lint
-        runAfter:
-          - fetch-repository
-        params:
-          - name: package
-            value: .
-        workspaces:
-        - name: source
-          workspace: source
-`,
+		detectionFile: "go.mod",
 	},
 	"python": {
-		Language:       "Python",
-		detectionFile:  "setup.py",
-		AnnotationTask: "pylint",
-		Task: `- name: pylint
-        taskRef:
-          name: pylint
-        runAfter:
-          - fetch-repository
-        workspaces:
-        - name: source
-          workspace: source
-`,
+		detectionFile: "setup.py",
+	},
+	"nodejs": {
+		detectionFile: "package.json",
 	},
+	"java": {
+		detectionFile: "pom.xml",
+	},
+	"generic": {},
 }
 
 //go:embed templates
 var resource embed.FS
 
-func (o *Opts) detectLanguage() (langOpts, error) {
+func (o *Opts) detectLanguage() (string, error) {
 	if o.language != "" {
 		if _, ok := languageDetection[o.language]; !ok {
-			return langOpts{}, fmt.Errorf("no template available for %s", o.language)
+			return "", fmt.Errorf("no template available for %s", o.language)
 		}
-		return languageDetection[o.language], nil
+		return o.language, nil
 	}
 
 	cs := o.IOStreams.ColorScheme()
-	for _, v := range languageDetection {
+	for t, v := range languageDetection {
+		if v.detectionFile == "" {
+			continue
+		}
 		fpath := filepath.Join(o.GitInfo.TopLevelPath, v.detectionFile)
 		if _, err := os.Stat(fpath); !os.IsNotExist(err) {
 			fmt.Fprintf(o.IOStreams.Out, "%s We have detected your repository using the programming language %s.\n",
 				cs.SuccessIcon(),
-				cs.Bold(v.Language),
+				cs.Bold(cases.Title(language.Und, cases.NoLower).String(t)),
 			)
-			return v, nil
+			return t, nil
 		}
 	}
-	return langOpts{}, nil
+	return "generic", nil
 }
 
-func (o *Opts) genTmpl() (bytes.Buffer, error) {
-	var outputBuffer bytes.Buffer
-	embedfile, err := resource.Open("templates/pipelinerun.yaml.tmpl")
+func (o *Opts) genTmpl() (*bytes.Buffer, error) {
+	lang, err := o.detectLanguage()
+	if err != nil {
+		return nil, err
+	}
+
+	embedfile, err := resource.Open(fmt.Sprintf("templates/%s.yaml", lang))
 	if err != nil {
 		log.Fatal(err)
 	}
 	defer embedfile.Close()
 	tmplB, _ := ioutil.ReadAll(embedfile)
-	// can't figure out how ParseFS works, so doing this manually..
-	t := template.Must(template.New("PipelineRun").Delims("<<", ">>").Parse(string(tmplB)))
 
 	prName := filepath.Base(o.GitInfo.URL)
 
@@ -99,19 +85,14 @@ func (o *Opts) genTmpl() (bytes.Buffer, error) {
 		prName = prName + "-" + strings.ReplaceAll(o.Event.EventType, "_", "-")
 	}
 
-	lang, err := o.detectLanguage()
-	if err != nil {
-		return bytes.Buffer{}, err
-	}
-	data := map[string]interface{}{
-		"prName":                  prName,
-		"event":                   o.Event,
-		"extra_task":              lang,
-		"use_cluster_task":        o.generateWithClusterTask,
-		"language_specific_tasks": "",
-	}
-	if err := t.Execute(&outputBuffer, data); err != nil {
-		return bytes.Buffer{}, err
-	}
-	return outputBuffer, nil
+	tmplB = bytes.ReplaceAll(tmplB, []byte("pipelinesascode.tekton.dev/on-event: \"pull_request\""),
+		[]byte(fmt.Sprintf("pipelinesascode.tekton.dev/on-event: \"%s\"", o.Event.EventType)))
+
+	tmplB = bytes.ReplaceAll(tmplB, []byte("pipelinesascode.tekton.dev/on-target-branch: \"main\""),
+		[]byte(fmt.Sprintf("pipelinesascode.tekton.dev/on-target-branch: \"%s\"", o.Event.BaseBranch)))
+
+	tmplB = bytes.ReplaceAll(tmplB, []byte(fmt.Sprintf("name: pipelinerun-%s", lang)),
+		[]byte(fmt.Sprintf("name: %s", prName)))
+
+	return bytes.NewBuffer(tmplB), nil
 }

pkg/cmd/tknpac/generate/templates/pipelinerun.yaml.tmpl renamed to pkg/cmd/tknpac/generate/templates/generic.yaml

@@ -2,38 +2,28 @@
 apiVersion: tekton.dev/v1beta1
 kind: PipelineRun
 metadata:
-  name: << .prName >>
+  name: pipelinerun-generic
   annotations:
     # The event we are targeting as seen from the webhook payload
     # this can be an array too, i.e: [pull_request, push]
-    pipelinesascode.tekton.dev/on-event: "<< .event.EventType >>"
+    pipelinesascode.tekton.dev/on-event: "pull_request"
 
     # The branch or tag we are targeting (ie: main, refs/tags/*)
-    pipelinesascode.tekton.dev/on-target-branch: "<< .event.BaseBranch >>"
-    << if .use_cluster_task >>
-    # If we want to use the git-clone task from hub we could specify the
-    # annotation `pipelinesascode.tekton.dev/task annotation` and reference it
-    # in the taskRef. Pipelines as Code when it sees this will grab it from hub
-    # and automatically use the latest version. right now by default we will
-    # use the `git-clone` ClusterTasks as shipped on this cluster.
-    #
-    # pipelinesascode.tekton.dev/task: "git-clone"
+    pipelinesascode.tekton.dev/on-target-branch: "main"
 
-    <<- else >>
     # Fetch the git-clone task from hub, we are able to reference later on it
     # with taskRef and it will automatically be embedded into our pipeline.
     pipelinesascode.tekton.dev/task: "git-clone"
-    << end >>
-    <<- if .extra_task.AnnotationTask >>
 
-    # Task for <<.extra_task.Language >>
-    pipelinesascode.tekton.dev/task-1: "[<< .extra_task.AnnotationTask >>]"
-    << end >>
+    # Use maven task from hub
+    pipelinesascode.tekton.dev/task-1: "[maven]"
+
     # You can add more tasks in here to reuse, browse the one you like from here
     # https://hub.tekton.dev/
     # example:
     # pipelinesascode.tekton.dev/task-2: "[maven, buildah]"
 
+
     # How many runs we want to keep attached to this event
     pipelinesascode.tekton.dev/max-keep-runs: "5"
 spec:
@@ -55,9 +45,7 @@ spec:
       - name: fetch-repository
         taskRef:
           name: git-clone
-          <<- if .use_cluster_task >>
           kind: ClusterTask
-          <<- end >>
         workspaces:
           - name: output
             workspace: source
@@ -68,9 +56,6 @@ spec:
             value: $(params.repo_url)
           - name: revision
             value: $(params.revision)
-      <<- if .extra_task.Task>>
-      << .extra_task.Task >>
-      <<- end >>
       # Customize this task if you like, or just do a taskRef
       # to one of the hub task.
       - name: noop-task

pkg/cmd/tknpac/generate/templates/go-template.yaml renamed to pkg/cmd/tknpac/generate/templates/go.yaml

@@ -2,7 +2,7 @@
 apiVersion: tekton.dev/v1beta1
 kind: PipelineRun
 metadata:
-  name: go-template
+  name: pipelinerun-go
   annotations:
     # The event we are targeting as seen from the webhook payload
     # this can be an array too, i.e: [pull_request, push]
@@ -15,7 +15,6 @@ metadata:
     # with taskRef and it will automatically be embedded into our pipeline.
     pipelinesascode.tekton.dev/task: "git-clone"
 
-
     # Task for Golang
     pipelinesascode.tekton.dev/task-1: "[golangci-lint]"
 

pkg/cmd/tknpac/generate/templates/java-template.yaml renamed to pkg/cmd/tknpac/generate/templates/java.yaml

@@ -2,7 +2,7 @@
 apiVersion: tekton.dev/v1beta1
 kind: PipelineRun
 metadata:
-  name: java-template
+  name: pipelinerun-java
   annotations:
     # The event we are targeting as seen from the webhook payload
     # this can be an array too, i.e: [pull_request, push]
@@ -30,22 +30,11 @@ spec:
       value: "{{ repo_url }}"
     - name: revision
       value: "{{ revision }}"
-    - name: image_name
-      value: ""
-    - name: app_name
-      value: ""
-    - name: path_context
-      value: ""
-    - name: version
-      value: ""
   pipelineSpec:
     params:
       - name: repo_url
       - name: revision
       - name: image_name
-      - name: app_name
-      - name: path_context
-      - name: version
     workspaces:
       - name: source
       - name: basic-auth
@@ -63,37 +52,18 @@ spec:
             value: $(params.repo_url)
           - name: revision
             value: $(params.revision)
-      - name: build
-        params:
-          - name: IMAGE
-            value: $(params.image_name)
-          - name: TLSVERIFY
-            value: "false"
-          - name: PATH_CONTEXT
-            value: $(params.path_context)
-          - name: VERSION
-            value: $(params.version)
+      - name: maven-test
+        taskRef:
+          name: maven
         runAfter:
           - fetch-repository
-        taskRef:
-          kind: ClusterTask
-          name: s2i-java
-        workspaces:
-          - name: source
-            workspace: source
-      - name: deploy
         params:
-          - name: SCRIPT
-            value: oc rollout status deploy/$(params.app_name)
-        runAfter:
-          - build
-        taskRef:
-          kind: ClusterTask
-          name: openshift-client
+          - name: GOALS
+            value:
+              - test
         workspaces:
-          - name: workspace
+          - name: source
             workspace: source
-
   workspaces:
     - name: source
       volumeClaimTemplate:

pkg/cmd/tknpac/generate/templates/nodejs-template.yaml renamed to pkg/cmd/tknpac/generate/templates/nodejs.yaml

@@ -2,7 +2,7 @@
 apiVersion: tekton.dev/v1beta1
 kind: PipelineRun
 metadata:
-  name: nodejs-template
+  name: pipelinerun-nodejs
   annotations:
     # The event we are targeting as seen from the webhook payload
     # this can be an array too, i.e: [pull_request, push]
@@ -15,7 +15,6 @@ metadata:
     # with taskRef and it will automatically be embedded into our pipeline.
     pipelinesascode.tekton.dev/task: "git-clone"
 
-
     # Task for Nodejs
     pipelinesascode.tekton.dev/task-1: "[npm]"
 

pkg/cmd/tknpac/generate/templates/python-template.yaml renamed to pkg/cmd/tknpac/generate/templates/python.yaml

@@ -2,7 +2,7 @@
 apiVersion: tekton.dev/v1beta1
 kind: PipelineRun
 metadata:
-  name: python-template
+  name: pipelinerun-python
   annotations:
     # The event we are targeting as seen from the webhook payload
     # this can be an array too, i.e: [pull_request, push]
@@ -15,7 +15,6 @@ metadata:
     # with taskRef and it will automatically be embedded into our pipeline.
     pipelinesascode.tekton.dev/task: "git-clone"
 
-
     # Task for Python
     pipelinesascode.tekton.dev/task-1: "[pylint]"