Add almost-empty v1 package

This commit adds a package for v1 and updates the hack directory to generate code and OpenAPI spec for v1. The v1 package is left as minimal as possible; however, the code does not build and pass tests without at least one generated client. Therefore, a Task type is added with only a Description field, with the rest of the Task spec to be added in a future commit.
tektoncd · Jul 11, 2022 · 25b8965 · 25b8965
1 parent 9dacb49
commit 25b8965
Show file tree

Hide file tree

Showing 37 changed files with 2,946 additions and 33 deletions.
diff --git a/hack/spec-gen/main.go b/hack/spec-gen/main.go
@@ -18,28 +18,39 @@ package main
 
 import (
 	"encoding/json"
+	"flag"
 	"fmt"
-	"os"
 	"strings"
 
-	tekton "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
+	tektonv1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
+	tektonv1beta1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
 
 	"k8s.io/klog"
 	"k8s.io/kube-openapi/pkg/common"
 	spec "k8s.io/kube-openapi/pkg/validation/spec"
 )
 
 func main() {
-	if len(os.Args) <= 1 {
-		klog.Fatal("Supply a version")
-	}
-	version := os.Args[1]
+	pipelinesVersion := flag.String("version", "v0.17.2", "Tekton Pipelines software version")
+	apiVersion := flag.String("apiVersion", "v1beta1", "API version")
+	flag.Parse()
+	version := *pipelinesVersion
 	if !strings.HasPrefix(version, "v") {
 		version = "v" + version
 	}
-	oAPIDefs := tekton.GetOpenAPIDefinitions(func(name string) spec.Ref {
-		return spec.MustCreateRef("#/definitions/" + common.EscapeJsonPointer(swaggify(name)))
-	})
+	var oAPIDefs map[string]common.OpenAPIDefinition
+	switch *apiVersion {
+	case "v1beta1":
+		oAPIDefs = tektonv1beta1.GetOpenAPIDefinitions(func(name string) spec.Ref {
+			return spec.MustCreateRef("#/definitions/" + common.EscapeJsonPointer(swaggify(name)))
+		})
+	case "v1":
+		oAPIDefs = tektonv1.GetOpenAPIDefinitions(func(name string) spec.Ref {
+			return spec.MustCreateRef("#/definitions/" + common.EscapeJsonPointer(swaggify(name)))
+		})
+	default:
+		panic(fmt.Sprintf("Unsupported API version: %s", *apiVersion))
+	}
 	defs := spec.Definitions{}
 	for defName, val := range oAPIDefs {
 		defs[swaggify(defName)] = val.Schema

diff --git a/hack/update-codegen.sh b/hack/update-codegen.sh
@@ -40,10 +40,10 @@ bash ${REPO_ROOT_DIR}/hack/generate-groups.sh "deepcopy,client,informer,lister"
   github.com/tektoncd/pipeline/pkg/client/resource github.com/tektoncd/pipeline/pkg/apis \
   "resource:v1alpha1" \
   --go-header-file ${REPO_ROOT_DIR}/hack/boilerplate/boilerplate.go.txt
-# This generates deepcopy,client,informer and lister for the pipeline package (v1alpha1 and v1beta1)
+# This generates deepcopy,client,informer and lister for the pipeline package (v1alpha1, v1beta1, and v1)
 bash ${REPO_ROOT_DIR}/hack/generate-groups.sh "deepcopy,client,informer,lister" \
   github.com/tektoncd/pipeline/pkg/client github.com/tektoncd/pipeline/pkg/apis \
-  "pipeline:v1alpha1,v1beta1" \
+  "pipeline:v1alpha1,v1beta1,v1" \
   --go-header-file ${REPO_ROOT_DIR}/hack/boilerplate/boilerplate.go.txt
 
 # Depends on generate-groups.sh to install bin/deepcopy-gen
@@ -74,10 +74,10 @@ bash ${REPO_ROOT_DIR}/hack/generate-knative.sh "injection" \
   github.com/tektoncd/pipeline/pkg/client/resource github.com/tektoncd/pipeline/pkg/apis \
   "resource:v1alpha1" \
   --go-header-file ${REPO_ROOT_DIR}/hack/boilerplate/boilerplate.go.txt
-# This generates the knative inject packages for the pipeline package (v1alpha1, v1beta1).
+# This generates the knative inject packages for the pipeline package (v1alpha1, v1beta1, v1).
 bash ${REPO_ROOT_DIR}/hack/generate-knative.sh "injection" \
   github.com/tektoncd/pipeline/pkg/client github.com/tektoncd/pipeline/pkg/apis \
-  "pipeline:v1alpha1,v1beta1" \
+  "pipeline:v1alpha1,v1beta1,v1" \
   --go-header-file ${REPO_ROOT_DIR}/hack/boilerplate/boilerplate.go.txt
 GOFLAGS="${OLDGOFLAGS}"
 

diff --git a/hack/update-openapigen.sh b/hack/update-openapigen.sh
@@ -34,22 +34,31 @@ mkdir -p "${TMP_DIFFROOT}"
 
 trap cleanup EXIT
 
-echo "Generating OpenAPI specification ..."
-go run k8s.io/kube-openapi/cmd/openapi-gen \
-    --input-dirs ./pkg/apis/pipeline/v1beta1,./pkg/apis/pipeline/pod,./pkg/apis/resource/v1alpha1,knative.dev/pkg/apis,knative.dev/pkg/apis/duck/v1beta1 \
-    --output-package ./pkg/apis/pipeline/v1beta1 -o ./ \
-    --go-header-file hack/boilerplate/boilerplate.go.txt \
-    -r "${TMP_DIFFROOT}/api-report"
-
-violations=$(diff --changed-group-format='%>' --unchanged-group-format='' <(sort "hack/ignored-openapi-violations.list") <(sort "${TMP_DIFFROOT}/api-report") || echo "")
-if [ -n "${violations}" ]; then
-  echo ""
-  echo "New API rule violations found which are not present in hack/ignored-openapi-violations.list. Please fix these violations:"
-  echo ""
-  echo "${violations}"
-  echo ""
-  exit 1
-fi
-
-echo "Generating swagger file ..."
-go run hack/spec-gen/main.go v0.17.2 > pkg/apis/pipeline/v1beta1/swagger.json
+for APIVERSION in "v1beta1" "v1"
+do
+  input_dirs=./pkg/apis/pipeline/${APIVERSION},./pkg/apis/pipeline/pod,knative.dev/pkg/apis,knative.dev/pkg/apis/duck/v1beta1
+  if [ ${APIVERSION} = "v1beta1" ]
+  then
+    input_dirs=${input_dirs},./pkg/apis/resource/v1alpha1
+  fi
+
+  echo "Generating OpenAPI specification for ${APIVERSION} ..."
+  go run k8s.io/kube-openapi/cmd/openapi-gen \
+      --input-dirs ${input_dirs} \
+      --output-package ./pkg/apis/pipeline/${APIVERSION} -o ./ \
+      --go-header-file hack/boilerplate/boilerplate.go.txt \
+      -r "${TMP_DIFFROOT}/api-report"
+
+  violations=$(diff --changed-group-format='%>' --unchanged-group-format='' <(sort "hack/ignored-openapi-violations.list") <(sort "${TMP_DIFFROOT}/api-report") || echo "")
+  if [ -n "${violations}" ]; then
+    echo ""
+    echo "New API rule violations found which are not present in hack/ignored-openapi-violations.list. Please fix these violations:"
+    echo ""
+    echo "${violations}"
+    echo ""
+    exit 1
+  fi
+
+  echo "Generating swagger file for ${APIVERSION} ..."
+  go run hack/spec-gen/main.go -apiVersion=${APIVERSION} > pkg/apis/pipeline/${APIVERSION}/swagger.json
+done
diff --git a/pkg/apis/pipeline/v1/doc.go b/pkg/apis/pipeline/v1/doc.go
@@ -0,0 +1,23 @@
+/*
+Copyright 2022 The Tekton Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package v1 contains API Schema definitions for the pipeline v1 API group
+// +k8s:openapi-gen=true
+// +k8s:deepcopy-gen=package,register
+// +k8s:conversion-gen=github.com/tektoncd/pipeline/pkg/apis/pipeline
+// +k8s:defaulter-gen=TypeMeta
+// +groupName=tekton.dev
+package v1