pipelinetask metadata

Adding metadata to TaskSpec in PipelineTask to allow specifying metadata. This metadata will be propogated to taskRun and then to the pods. ``` apiVersion: tekton.dev/v1beta1 kind: PipelineRun metadata: name: pipelinerun-with-taskspec-to-echo-greetings spec: pipelineSpec: tasks: - name: echo-greetings taskSpec: metadata: labels: [ …] steps: ... ``` Metadata is already supported as part of Tasks and Pipelines while respective CRDs are created. But was not possible to specify with embedded resources.
tektoncd · Jul 1, 2020 · b42df6a · b42df6a
1 parent 44f22a0
commit b42df6a
Show file tree

Hide file tree

Showing 12 changed files with 369 additions and 47 deletions.
diff --git a/examples/v1beta1/pipelineruns/pipelinerun-with-pipelinespec-and-taskspec.yaml b/examples/v1beta1/pipelineruns/pipelinerun-with-pipelinespec-and-taskspec.yaml
@@ -7,6 +7,9 @@ spec:
     tasks:
       - name: echo-good-morning
         taskSpec:
+          metadata:
+            labels:
+              app: "example"
           steps:
             - name: echo
               image: ubuntu

diff --git a/internal/builder/v1beta1/pipeline.go b/internal/builder/v1beta1/pipeline.go
@@ -179,7 +179,20 @@ func PipelineRunResult(name, value string) PipelineRunStatusOp {
 // PipelineTaskSpec sets the TaskSpec on a PipelineTask.
 func PipelineTaskSpec(spec *v1beta1.TaskSpec) PipelineTaskOp {
 	return func(pt *v1beta1.PipelineTask) {
-		pt.TaskSpec = spec
+		if pt.TaskSpec == nil {
+			pt.TaskSpec = &v1beta1.EmbeddedTask{}
+		}
+		pt.TaskSpec.TaskSpec = spec
+	}
+}
+
+// PipelineTaskMetadata sets the Metadata on a PipelineTask.
+func PipelineTaskMetadata(metadata metav1.ObjectMeta) PipelineTaskOp {
+	return func(pt *v1beta1.PipelineTask) {
+		if pt.TaskSpec == nil {
+			pt.TaskSpec = &v1beta1.EmbeddedTask{}
+		}
+		pt.TaskSpec.Metadata = metadata
 	}
 }
 

diff --git a/internal/builder/v1beta1/pipeline_test.go b/internal/builder/v1beta1/pipeline_test.go
@@ -137,13 +137,14 @@ func TestPipeline(t *testing.T) {
 				Timeout:  &metav1.Duration{Duration: 5 * time.Second},
 			}, {
 				Name: "foo",
-				TaskSpec: &v1beta1.TaskSpec{
-					Steps: []v1beta1.Step{{Container: corev1.Container{
-						Name:  "step",
-						Image: "myimage",
-					}}},
-				},
-			}},
+				TaskSpec: &v1beta1.EmbeddedTask{
+					TaskSpec: &v1beta1.TaskSpec{
+						Steps: []v1beta1.Step{{Container: corev1.Container{
+							Name:  "step",
+							Image: "myimage",
+						}}},
+					},
+				}}},
 			Workspaces: []v1beta1.PipelineWorkspaceDeclaration{{
 				Name: "workspace1",
 			}},
@@ -393,3 +394,57 @@ func TestPipelineRunWithPipelineSpec(t *testing.T) {
 		t.Fatalf("PipelineRun diff -want, +got: %s", diff)
 	}
 }
+
+func TestPipelineRunWithTaskSpec_TaskMetadata(t *testing.T) {
+	pipelineRun := tb.PipelineRun("pear", tb.PipelineRunNamespace("foo"),
+		tb.PipelineRunSpec("", tb.PipelineRunPipelineSpec(
+			tb.PipelineTask("a-task", "",
+				tb.PipelineTaskMetadata(metav1.ObjectMeta{
+					Name:        "a-task-name",
+					Labels:      map[string]string{"label": "labelvalue"},
+					Annotations: map[string]string{"annotation": "annotationvalue"}},
+				),
+				tb.PipelineTaskSpec(&v1beta1.TaskSpec{
+					Steps: []v1beta1.Step{{Container: corev1.Container{
+						Name:  "step",
+						Image: "myimage",
+					}}},
+				},
+				))),
+			tb.PipelineRunServiceAccountName("sa"),
+		))
+
+	expectedPipelineRun := &v1beta1.PipelineRun{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "pear",
+			Namespace: "foo",
+		},
+		Spec: v1beta1.PipelineRunSpec{
+			PipelineRef: nil,
+			PipelineSpec: &v1beta1.PipelineSpec{
+				Tasks: []v1beta1.PipelineTask{{
+					Name: "a-task",
+					TaskSpec: &v1beta1.EmbeddedTask{
+						Metadata: metav1.ObjectMeta{
+							Name:        "a-task-name",
+							Labels:      map[string]string{"label": "labelvalue"},
+							Annotations: map[string]string{"annotation": "annotationvalue"},
+						},
+						TaskSpec: &v1beta1.TaskSpec{
+							Steps: []v1beta1.Step{{Container: corev1.Container{
+								Name:  "step",
+								Image: "myimage",
+							}}},
+						},
+					},
+				}},
+			},
+			ServiceAccountName: "sa",
+			Timeout:            &metav1.Duration{Duration: 1 * time.Hour},
+		},
+	}
+
+	if diff := cmp.Diff(expectedPipelineRun, pipelineRun); diff != "" {
+		t.Fatalf("PipelineRun diff -want, +got: %s", diff)
+	}
+}
diff --git a/pkg/apis/pipeline/v1alpha1/pipeline_conversion.go b/pkg/apis/pipeline/v1alpha1/pipeline_conversion.go
@@ -21,6 +21,8 @@ import (
 	"context"
 	"fmt"
 
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
 	"knative.dev/pkg/apis"
 )
@@ -61,8 +63,8 @@ func (source *PipelineTask) ConvertTo(ctx context.Context, sink *v1beta1.Pipelin
 	sink.Name = source.Name
 	sink.TaskRef = source.TaskRef
 	if source.TaskSpec != nil {
-		sink.TaskSpec = &v1beta1.TaskSpec{}
-		if err := source.TaskSpec.ConvertTo(ctx, sink.TaskSpec); err != nil {
+		sink.TaskSpec = &v1beta1.EmbeddedTask{v1.ObjectMeta{}, &v1beta1.TaskSpec{}}
+		if err := source.TaskSpec.ConvertTo(ctx, sink.TaskSpec.TaskSpec); err != nil {
 			return err
 		}
 	}
@@ -112,7 +114,7 @@ func (sink *PipelineTask) ConvertFrom(ctx context.Context, source v1beta1.Pipeli
 	sink.TaskRef = source.TaskRef
 	if source.TaskSpec != nil {
 		sink.TaskSpec = &TaskSpec{}
-		if err := sink.TaskSpec.ConvertFrom(ctx, source.TaskSpec); err != nil {
+		if err := sink.TaskSpec.ConvertFrom(ctx, source.TaskSpec.TaskSpec); err != nil {
 			return err
 		}
 	}

diff --git a/pkg/apis/pipeline/v1beta1/pipeline_defaults_test.go b/pkg/apis/pipeline/v1beta1/pipeline_defaults_test.go
@@ -20,6 +20,8 @@ import (
 	"context"
 	"testing"
 
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
 	"github.com/tektoncd/pipeline/test/diff"
 
 	"github.com/google/go-cmp/cmp"
@@ -85,41 +87,53 @@ func TestPipelineSpec_SetDefaults(t *testing.T) {
 		desc: "pipeline task with taskSpec - default param type must be " + string(v1beta1.ParamTypeString),
 		ps: &v1beta1.PipelineSpec{
 			Tasks: []v1beta1.PipelineTask{{
-				Name: "foo", TaskSpec: &v1beta1.TaskSpec{
-					Params: []v1beta1.ParamSpec{{
-						Name: "string-param",
-					}},
+				Name: "foo", TaskSpec: &v1beta1.EmbeddedTask{
+					Metadata: v1.ObjectMeta{},
+					TaskSpec: &v1beta1.TaskSpec{
+						Params: []v1beta1.ParamSpec{{
+							Name: "string-param",
+						}},
+					},
 				},
 			}},
 		},
 		want: &v1beta1.PipelineSpec{
 			Tasks: []v1beta1.PipelineTask{{
-				Name: "foo", TaskSpec: &v1beta1.TaskSpec{
-					Params: []v1beta1.ParamSpec{{
-						Name: "string-param",
-						Type: v1beta1.ParamTypeString,
-					}},
+				Name: "foo", TaskSpec: &v1beta1.EmbeddedTask{
+					Metadata: v1.ObjectMeta{},
+					TaskSpec: &v1beta1.TaskSpec{
+						Params: []v1beta1.ParamSpec{{
+							Name: "string-param",
+							Type: v1beta1.ParamTypeString,
+						}},
+					},
 				},
 			}},
 		},
 	}, {
 		desc: "final pipeline task with taskSpec - default param type must be " + string(v1beta1.ParamTypeString),
 		ps: &v1beta1.PipelineSpec{
 			Finally: []v1beta1.PipelineTask{{
-				Name: "foo", TaskSpec: &v1beta1.TaskSpec{
-					Params: []v1beta1.ParamSpec{{
-						Name: "string-param",
-					}},
+				Name: "foo", TaskSpec: &v1beta1.EmbeddedTask{
+					Metadata: v1.ObjectMeta{},
+					TaskSpec: &v1beta1.TaskSpec{
+						Params: []v1beta1.ParamSpec{{
+							Name: "string-param",
+						}},
+					},
 				},
 			}},
 		},
 		want: &v1beta1.PipelineSpec{
 			Finally: []v1beta1.PipelineTask{{
-				Name: "foo", TaskSpec: &v1beta1.TaskSpec{
-					Params: []v1beta1.ParamSpec{{
-						Name: "string-param",
-						Type: v1beta1.ParamTypeString,
-					}},
+				Name: "foo", TaskSpec: &v1beta1.EmbeddedTask{
+					Metadata: v1.ObjectMeta{},
+					TaskSpec: &v1beta1.TaskSpec{
+						Params: []v1beta1.ParamSpec{{
+							Name: "string-param",
+							Type: v1beta1.ParamTypeString,
+						}},
+					},
 				},
 			}},
 		},

diff --git a/pkg/apis/pipeline/v1beta1/pipeline_types.go b/pkg/apis/pipeline/v1beta1/pipeline_types.go
@@ -17,8 +17,10 @@ limitations under the License.
 package v1beta1
 
 import (
+	"github.com/tektoncd/pipeline/pkg/apis/validate"
 	"github.com/tektoncd/pipeline/pkg/reconciler/pipeline/dag"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"knative.dev/pkg/apis"
 )
 
 // +genclient
@@ -90,6 +92,15 @@ type PipelineResult struct {
 	Value string `json:"value"`
 }
 
+type EmbeddedTask struct {
+	// +optional
+	Metadata metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// TaskSpec is a specification of a task
+	// +optional
+	*TaskSpec `json:",inline,omitempty"`
+}
+
 // PipelineTask defines a task in a Pipeline, passing inputs from both
 // Params and from the output of previous tasks.
 type PipelineTask struct {
@@ -104,7 +115,7 @@ type PipelineTask struct {
 
 	// TaskSpec is a specification of a task
 	// +optional
-	TaskSpec *TaskSpec `json:"taskSpec,omitempty"`
+	TaskSpec *EmbeddedTask `json:"taskSpec,inline,omitempty"`
 
 	// Conditions is a list of conditions that need to be true for the task to run
 	// +optional
@@ -139,6 +150,19 @@ type PipelineTask struct {
 	Timeout *metav1.Duration `json:"timeout,omitempty"`
 }
 
+func (pt *PipelineTask) TaskSpecMetadata() metav1.ObjectMeta {
+	return pt.TaskSpec.Metadata
+}
+
+func (pt *PipelineTask) ValidateTaskSpecMetadata() *apis.FieldError {
+	if pt.TaskSpec != nil {
+		if err := validate.ObjectMetadata(pt.TaskSpec.Metadata.GetObjectMeta()); err != nil {
+			return err.ViaField("[tasks|finally].taskSpec.metadata")
+		}
+	}
+	return nil
+}
+
 func (pt PipelineTask) HashKey() string {
 	return pt.Name
 }

diff --git a/pkg/apis/pipeline/v1beta1/pipeline_validation.go b/pkg/apis/pipeline/v1beta1/pipeline_validation.go
@@ -251,6 +251,9 @@ func validatePipelineTaskName(ctx context.Context, prefix string, i int, t Pipel
 		if err := t.TaskSpec.Validate(ctx); err != nil {
 			return err
 		}
+		if err := t.ValidateTaskSpecMetadata(); err != nil {
+			return err
+		}
 	}
 	if t.TaskRef != nil && t.TaskRef.Name != "" {
 		// Task names are appended to the container name, which must exist and