Migrate PipelineResource in there own package… 📦

This is mainly done to separate the `PipelineResource` from the rest
of the API *and* remove the dependency cycle that we get by keeping
`PipelineResource` in alpha.

This update the code generation to generate a different set of clients,
informers, clientsets, … for `resource`, although it is exposed in the
same apiGroup.

Signed-off-by: Vincent Demeester <[email protected]>

Author: vdemeester

.golangci.yml

@@ -4,6 +4,7 @@ run:
   skip-dirs:
   - vendor
   - pkg/client/clientset/(.*)/fake
+  - pkg/client/resource/clientset/(.*)/fake
   timeout: 5m
 linters-settings:
   errcheck:

cmd/webhook/main.go

@@ -98,12 +98,12 @@ func main() {
 	}
 	resourceHandlers := map[schema.GroupVersionKind]webhook.GenericCRD{
 		v1alpha1.SchemeGroupVersion.WithKind("Pipeline"):         &v1alpha1.Pipeline{},
-		v1alpha1.SchemeGroupVersion.WithKind("PipelineResource"): &v1alpha1.PipelineResource{},
 		v1alpha1.SchemeGroupVersion.WithKind("Task"):             &v1alpha1.Task{},
 		v1alpha1.SchemeGroupVersion.WithKind("ClusterTask"):      &v1alpha1.ClusterTask{},
 		v1alpha1.SchemeGroupVersion.WithKind("TaskRun"):          &v1alpha1.TaskRun{},
 		v1alpha1.SchemeGroupVersion.WithKind("PipelineRun"):      &v1alpha1.PipelineRun{},
 		v1alpha1.SchemeGroupVersion.WithKind("Condition"):        &v1alpha1.Condition{},
+		v1alpha1.SchemeGroupVersion.WithKind("PipelineResource"): &v1alpha1.PipelineResource{},
 	}
 
 	resourceAdmissionController := webhook.NewResourceAdmissionController(resourceHandlers, options, true)

hack/update-codegen.sh

@@ -20,11 +20,16 @@ set -o pipefail
 
 source $(dirname $0)/../vendor/github.com/tektoncd/plumbing/scripts/library.sh
 
+OLDGOFLAGS="${GOFLAGS:-}"
+GOFLAGS="-mod=vendor"
 # generate the code with:
 # --output-base    because this script should also be able to run inside the vendor dir of
 #                  k8s.io/kubernetes. The output-base is needed for the generators to output into the vendor dir
 #                  instead of the $GOPATH directly. For normal projects this can be dropped.
-
+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
 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,v1alpha2" \
@@ -37,10 +42,15 @@ ${GOPATH}/bin/deepcopy-gen \
   -i github.com/tektoncd/pipeline/pkg/apis/config
 
 # Knative Injection
+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
 bash ${REPO_ROOT_DIR}/hack/generate-knative.sh "injection" \
   github.com/tektoncd/pipeline/pkg/client github.com/tektoncd/pipeline/pkg/apis \
   "pipeline:v1alpha1,v1alpha2" \
   --go-header-file ${REPO_ROOT_DIR}/hack/boilerplate/boilerplate.go.txt
+GOFLAGS="${OLDGOFLAGS}"
 
 # Make sure our dependencies are up-to-date
 ${REPO_ROOT_DIR}/hack/update-deps.sh

pkg/apis/pipeline/v1alpha1/param_types.go

@@ -25,10 +25,6 @@ import (
 // or PipelineRun.
 type ParamSpec = v1alpha2.ParamSpec
 
-// ResourceParam declares a string value to use for the parameter called Name, and is used in
-// the specific context of PipelineResources.
-type ResourceParam = v1alpha2.ResourceParam
-
 // Param declares an ArrayOrString to use for the parameter called name.
 type Param = v1alpha2.Param
 

pkg/apis/pipeline/v1alpha1/pipeline_resource_types.go

@@ -0,0 +1,78 @@
+/*
+Copyright 2019 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 v1alpha1
+
+import (
+	resource "github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1"
+)
+
+// PipelineResourceType represents the type of endpoint the pipelineResource is, so that the
+// controller will know this pipelineResource should be fetched and optionally what
+// additional metatdata should be provided for it.
+type PipelineResourceType = resource.PipelineResourceType
+
+var (
+	AllowedOutputResources = resource.AllowedOutputResources
+)
+
+const (
+	// PipelineResourceTypeGit indicates that this source is a GitHub repo.
+	PipelineResourceTypeGit PipelineResourceType = resource.PipelineResourceTypeGit
+
+	// PipelineResourceTypeStorage indicates that this source is a storage blob resource.
+	PipelineResourceTypeStorage PipelineResourceType = resource.PipelineResourceTypeStorage
+
+	// PipelineResourceTypeImage indicates that this source is a docker Image.
+	PipelineResourceTypeImage PipelineResourceType = resource.PipelineResourceTypeImage
+
+	// PipelineResourceTypeCluster indicates that this source is a k8s cluster Image.
+	PipelineResourceTypeCluster PipelineResourceType = resource.PipelineResourceTypeCluster
+
+	// PipelineResourceTypePullRequest indicates that this source is a SCM Pull Request.
+	PipelineResourceTypePullRequest PipelineResourceType = resource.PipelineResourceTypePullRequest
+
+	// PipelineResourceTypeCloudEvent indicates that this source is a cloud event URI
+	PipelineResourceTypeCloudEvent PipelineResourceType = resource.PipelineResourceTypeCloudEvent
+)
+
+// AllResourceTypes can be used for validation to check if a provided Resource type is one of the known types.
+var AllResourceTypes = resource.AllResourceTypes
+
+// PipelineResource describes a resource that is an input to or output from a
+// Task.
+//
+type PipelineResource = resource.PipelineResource
+
+// PipelineResourceSpec defines  an individual resources used in the pipeline.
+type PipelineResourceSpec = resource.PipelineResourceSpec
+
+// SecretParam indicates which secret can be used to populate a field of the resource
+type SecretParam = resource.SecretParam
+
+// ResourceParam declares a string value to use for the parameter called Name, and is used in
+// the specific context of PipelineResources.
+type ResourceParam = resource.ResourceParam
+
+// ResourceDeclaration defines an input or output PipelineResource declared as a requirement
+// by another type such as a Task or Condition. The Name field will be used to refer to these
+// PipelineResources within the type's definition, and when provided as an Input, the Name will be the
+// path to the volume mounted containing this PipelineResource as an input (e.g.
+// an input Resource named `workspace` will be mounted at `/workspace`).
+type ResourceDeclaration = resource.ResourceDeclaration
+
+// PipelineResourceList contains a list of PipelineResources
+type PipelineResourceList = resource.PipelineResourceList

pkg/apis/pipeline/v1alpha1/resource_types.go

@@ -22,41 +22,8 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha2"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// PipelineResourceType represents the type of endpoint the pipelineResource is, so that the
-// controller will know this pipelineResource should be fetched and optionally what
-// additional metatdata should be provided for it.
-type PipelineResourceType = v1alpha2.PipelineResourceType
-
-var (
-	AllowedOutputResources = v1alpha2.AllowedOutputResources
-)
-
-const (
-	// PipelineResourceTypeGit indicates that this source is a GitHub repo.
-	PipelineResourceTypeGit PipelineResourceType = v1alpha2.PipelineResourceTypeGit
-
-	// PipelineResourceTypeStorage indicates that this source is a storage blob resource.
-	PipelineResourceTypeStorage PipelineResourceType = v1alpha2.PipelineResourceTypeStorage
-
-	// PipelineResourceTypeImage indicates that this source is a docker Image.
-	PipelineResourceTypeImage PipelineResourceType = v1alpha2.PipelineResourceTypeImage
-
-	// PipelineResourceTypeCluster indicates that this source is a k8s cluster Image.
-	PipelineResourceTypeCluster PipelineResourceType = v1alpha2.PipelineResourceTypeCluster
-
-	// PipelineResourceTypePullRequest indicates that this source is a SCM Pull Request.
-	PipelineResourceTypePullRequest PipelineResourceType = v1alpha2.PipelineResourceTypePullRequest
-
-	// PipelineResourceTypeCloudEvent indicates that this source is a cloud event URI
-	PipelineResourceTypeCloudEvent PipelineResourceType = v1alpha2.PipelineResourceTypeCloudEvent
-)
-
-// AllResourceTypes can be used for validation to check if a provided Resource type is one of the known types.
-var AllResourceTypes = v1alpha2.AllResourceTypes
-
 // PipelineResourceInterface interface to be implemented by different PipelineResource types
 type PipelineResourceInterface interface {
 	// GetName returns the name of this PipelineResource instance.
@@ -132,51 +99,6 @@ func ApplyTaskModifier(ts *TaskSpec, tm TaskModifier) error {
 	return nil
 }
 
-// SecretParam indicates which secret can be used to populate a field of the resource
-type SecretParam struct {
-	FieldName  string `json:"fieldName"`
-	SecretKey  string `json:"secretKey"`
-	SecretName string `json:"secretName"`
-}
-
-// PipelineResourceSpec defines  an individual resources used in the pipeline.
-type PipelineResourceSpec struct {
-	Type   PipelineResourceType `json:"type"`
-	Params []ResourceParam      `json:"params"`
-	// Secrets to fetch to populate some of resource fields
-	// +optional
-	SecretParams []SecretParam `json:"secrets,omitempty"`
-}
-
-// +genclient
-// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-// +genclient:noStatus
-
-// PipelineResource describes a resource that is an input to or output from a
-// Task.
-//
-// +k8s:openapi-gen=true
-type PipelineResource struct {
-	metav1.TypeMeta `json:",inline"`
-	// +optional
-	metav1.ObjectMeta `json:"metadata,omitempty"`
-
-	// Spec holds the desired state of the PipelineResource from the client
-	Spec PipelineResourceSpec `json:"spec,omitempty"`
-
-	// Status is deprecated.
-	// It usually is used to communicate the observed state of the PipelineResource from
-	// the controller, but was unused as there is no controller for PipelineResource.
-	// +optional
-	Status *PipelineResourceStatus `json:"status,omitempty"`
-}
-
-// PipelineResourceStatus does not contain anything because PipelineResources on their own
-// do not have a status
-// Deprecated
-type PipelineResourceStatus struct {
-}
-
 // PipelineResourceBinding connects a reference to an instance of a PipelineResource
 // with a PipelineResource dependency that the Pipeline has declared
 type PipelineResourceBinding struct {
@@ -203,23 +125,6 @@ type PipelineResourceResult struct {
 	ResourceRef PipelineResourceRef `json:"resourceRef,omitempty"`
 }
 
-// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-
-// PipelineResourceList contains a list of PipelineResources
-type PipelineResourceList struct {
-	metav1.TypeMeta `json:",inline"`
-	// +optional
-	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []PipelineResource `json:"items"`
-}
-
-// ResourceDeclaration defines an input or output PipelineResource declared as a requirement
-// by another type such as a Task or Condition. The Name field will be used to refer to these
-// PipelineResources within the type's definition, and when provided as an Input, the Name will be the
-// path to the volume mounted containing this PipelineResource as an input (e.g.
-// an input Resource named `workspace` will be mounted at `/workspace`).
-type ResourceDeclaration = v1alpha2.ResourceDeclaration
-
 // ResourceFromType returns an instance of the correct PipelineResource object type which can be
 // used to add input and output containers as well as volumes to a TaskRun's pod in order to realize
 // a PipelineResource in a pod.

pkg/apis/pipeline/v1alpha1/storage_resource.go

@@ -21,18 +21,19 @@ import (
 	"strings"
 
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline"
+	resource "github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1"
 	corev1 "k8s.io/api/core/v1"
 )
 
 type PipelineResourceStorageType string
 
 const (
 	// PipelineResourceTypeGCS is the subtype for the GCSResources, which is backed by a GCS blob/directory.
-	PipelineResourceTypeGCS PipelineResourceType = "gcs"
+	PipelineResourceTypeGCS PipelineResourceType = resource.PipelineResourceTypeGCS
 
 	// PipelineResourceTypeBuildGCS is the subtype for the BuildGCSResources, which is simialr to the GCSResource but
 	// with additional functionality that was added to be compatible with knative build.
-	PipelineResourceTypeBuildGCS PipelineResourceType = "build-gcs"
+	PipelineResourceTypeBuildGCS PipelineResourceType = resource.PipelineResourceTypeBuildGCS
 )
 
 // PipelineStorageResourceInterface is the interface for subtypes of the storage type.

pkg/apis/pipeline/v1alpha1/task_types.go

@@ -109,7 +109,9 @@ type Inputs struct {
 // the Task definition, and when provided as an Input, the Name will be the
 // path to the volume mounted containing this Resource as an input (e.g.
 // an input Resource named `workspace` will be mounted at `/workspace`).
-type TaskResource = v1alpha2.TaskResource
+type TaskResource struct {
+	ResourceDeclaration `json:",inline"`
+}
 
 // Outputs allow a task to declare what data the Build/Task will be producing,
 // i.e. results such as logs and artifacts such as images.