Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

adding label memberOf to identify a taskRun in the pipeline #4121

Merged
merged 1 commit into from
Aug 5, 2021
Merged

adding label memberOf to identify a taskRun in the pipeline #4121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/labels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ Tekton automatically adds labels to Tekton entities as described in the followin
<td>No propagation.</td>
<td>Name of the <code>TaskRun</code> that created the <code>Pod</code>.</td>
</tr>
<tr>
<td><code>tekton.dev/memberOf</code></td>
<td><code>TaskRuns</code> that are created automatically during the execution of a <code>PipelineRun</code>.</td>
<td><code>TaskRuns, Pods</code></td>
<td><code>tasks</code> or <code>finally</code> depending on the <code>PipelineTask</code>'s membership in the <code>Pipeline</code>.</td>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice 👍 maps to the field names in the pipeline.

</tr>
<tr>
<td><code>app.kubernetes.io/instance</code>, <code>app.kubernetes.io/component</code></td>
<td><code>Pods</code>, <code>StatefulSets</code> (Affinity Assistant)</td>
Expand Down
4 changes: 4 additions & 0 deletions pkg/apis/pipeline/register.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ const (

// RunKey is used as the label identifier for a Run
RunKey = "/run"

// MemberOfLabelKey is used as the label identifier for a PipelineTask
// Set to Tasks/Finally depending on the position of the PipelineTask
MemberOfLabelKey = "/memberOf"
)

var (
Expand Down
4 changes: 4 additions & 0 deletions pkg/apis/pipeline/v1beta1/pipeline_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ import (
const (
// PipelineTasksAggregateStatus is a param representing aggregate status of all dag pipelineTasks
PipelineTasksAggregateStatus = "tasks.status"
// PipelineTasks is a value representing a task is a member of "tasks" section of the pipeline
PipelineTasks = "tasks"
// PipelineFinallyTasks is a value representing a task is a member of "finally" section of the pipeline
PipelineFinallyTasks = "finally"
)

// +genclient
Expand Down
16 changes: 16 additions & 0 deletions pkg/reconciler/pipelinerun/pipelinerun.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,6 +907,22 @@ func getTaskrunLabels(pr *v1beta1.PipelineRun, pipelineTaskName string, includeP
if pipelineTaskName != "" {
labels[pipeline.GroupName+pipeline.PipelineTaskLabelKey] = pipelineTaskName
}
if pr.Status.PipelineSpec != nil {
// check if a task is part of the "tasks" section, add a label to identify it during the runtime
for _, f := range pr.Status.PipelineSpec.Tasks {
if pipelineTaskName == f.Name {
labels[pipeline.GroupName+pipeline.MemberOfLabelKey] = v1beta1.PipelineTasks
break
}
}
// check if a task is part of the "finally" section, add a label to identify it during the runtime
for _, f := range pr.Status.PipelineSpec.Finally {
if pipelineTaskName == f.Name {
labels[pipeline.GroupName+pipeline.MemberOfLabelKey] = v1beta1.PipelineFinallyTasks
break
}
}
}
return labels
}

Expand Down
46 changes: 34 additions & 12 deletions pkg/reconciler/pipelinerun/pipelinerun_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,7 @@ func TestReconcile(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-success"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "unit-test-1"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(
tb.TaskRunTaskRef("unit-test-task"),
tb.TaskRunServiceAccountName("test-sa"),
Expand Down Expand Up @@ -512,9 +513,10 @@ func TestReconcile_CustomTask(t *testing.T) {
BlockOwnerDeletion: &trueb,
}},
Labels: map[string]string{
"tekton.dev/pipeline": pipelineRunName,
"tekton.dev/pipelineRun": pipelineRunName,
"tekton.dev/pipelineTask": pipelineTaskName,
"tekton.dev/pipeline": pipelineRunName,
"tekton.dev/pipelineRun": pipelineRunName,
"tekton.dev/pipelineTask": pipelineTaskName,
pipeline.GroupName + pipeline.MemberOfLabelKey: v1beta1.PipelineTasks,
},
Annotations: map[string]string{},
},
Expand Down Expand Up @@ -571,9 +573,10 @@ func TestReconcile_CustomTask(t *testing.T) {
BlockOwnerDeletion: &trueb,
}},
Labels: map[string]string{
"tekton.dev/pipeline": pipelineRunName,
"tekton.dev/pipelineRun": pipelineRunName,
"tekton.dev/pipelineTask": pipelineTaskName,
"tekton.dev/pipeline": pipelineRunName,
"tekton.dev/pipelineRun": pipelineRunName,
"tekton.dev/pipelineTask": pipelineTaskName,
pipeline.GroupName + pipeline.MemberOfLabelKey: v1beta1.PipelineTasks,
},
Annotations: map[string]string{},
},
Expand Down Expand Up @@ -640,9 +643,10 @@ func TestReconcile_CustomTask(t *testing.T) {
BlockOwnerDeletion: &trueb,
}},
Labels: map[string]string{
"tekton.dev/pipeline": pipelineRunName,
"tekton.dev/pipelineRun": pipelineRunName,
"tekton.dev/pipelineTask": pipelineTaskName,
"tekton.dev/pipeline": pipelineRunName,
"tekton.dev/pipelineRun": pipelineRunName,
"tekton.dev/pipelineTask": pipelineTaskName,
pipeline.GroupName + pipeline.MemberOfLabelKey: v1beta1.PipelineTasks,
},
Annotations: map[string]string{
"pipeline.tekton.dev/affinity-assistant": getAffinityAssistantName("pipelinews", pipelineRunName),
Expand Down Expand Up @@ -774,6 +778,7 @@ func TestReconcile_PipelineSpecTaskSpec(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-success"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "unit-test-task-spec"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(tb.TaskRunTaskSpec(tb.Step("myimage", tb.StepName("mystep"))),
tb.TaskRunServiceAccountName(config.DefaultServiceAccountValue)),
)
Expand Down Expand Up @@ -2458,6 +2463,7 @@ func TestReconcilePropagateLabels(t *testing.T) {
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-1"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-with-labels"),
tb.TaskRunLabel("PipelineRunLabel", "PipelineRunValue"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(
tb.TaskRunTaskRef("hello-world"),
tb.TaskRunServiceAccountName("test-sa"),
Expand Down Expand Up @@ -2528,6 +2534,7 @@ func TestReconcileWithDifferentServiceAccounts(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-different-service-accs"),
tb.TaskRunLabel("tekton.dev/pipelineTask", "hello-world-0"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
),
tb.TaskRun(taskRunNames[1],
tb.TaskRunNamespace("foo"),
Expand All @@ -2542,6 +2549,7 @@ func TestReconcileWithDifferentServiceAccounts(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-different-service-accs"),
tb.TaskRunLabel("tekton.dev/pipelineTask", "hello-world-1"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
),
}
for i := range ps[0].Spec.Tasks {
Expand Down Expand Up @@ -2739,6 +2747,7 @@ func TestReconcilePropagateAnnotations(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-1"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-with-annotations"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunAnnotation("PipelineRunAnnotation", "PipelineRunValue"),
tb.TaskRunSpec(
tb.TaskRunTaskRef("hello-world"),
Expand Down Expand Up @@ -3002,6 +3011,7 @@ func TestReconcileAndPropagateCustomPipelineTaskRunSpec(t *testing.T) {
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, "test-pipeline"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-1"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, "test-pipeline-run"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunAnnotation("PipelineRunAnnotation", "PipelineRunValue"),
tb.TaskRunSpec(
tb.TaskRunTaskRef("hello-world"),
Expand Down Expand Up @@ -3212,6 +3222,7 @@ func TestReconcileWithFailingConditionChecks(t *testing.T) {
tb.TaskRunOwnerReference("kind", "name"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, "test-pipeline-run-with-conditions"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, "test-pipeline"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(tb.TaskRunTaskRef("hello-world")),
tb.TaskRunStatus(tb.StatusCondition(apis.Condition{
Type: apis.ConditionSucceeded,
Expand Down Expand Up @@ -3267,6 +3278,7 @@ func TestReconcileWithFailingConditionChecks(t *testing.T) {
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, "test-pipeline"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "task-3"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, "test-pipeline-run-with-conditions"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunAnnotation("PipelineRunAnnotation", "PipelineRunValue"),
tb.TaskRunSpec(
tb.TaskRunTaskRef("hello-world"),
Expand All @@ -3289,6 +3301,7 @@ func makeExpectedTr(condName, ccName string, labels, annotations map[string]stri
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, "test-pipeline"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-1"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, "test-pipeline-run"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunLabel(pipeline.GroupName+pipeline.ConditionCheckKey, ccName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.ConditionNameKey, condName),
tb.TaskRunLabels(labels),
Expand Down Expand Up @@ -3378,6 +3391,7 @@ func TestReconcileWithWhenExpressionsWithParameters(t *testing.T) {
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, "test-pipeline"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-1"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, "test-pipeline-run"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunAnnotation("PipelineRunAnnotation", "PipelineRunValue"),
tb.TaskRunSpec(
tb.TaskRunTaskRef("hello-world-1"),
Expand Down Expand Up @@ -3507,6 +3521,7 @@ func TestReconcileWithWhenExpressionsWithTaskResults(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-different-service-accs"),
tb.TaskRunLabel("tekton.dev/pipelineTask", "b-task"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(
tb.TaskRunTaskRef("b-task"),
tb.TaskRunServiceAccountName("test-sa-0"),
Expand Down Expand Up @@ -3921,6 +3936,7 @@ func TestReconcileWithTaskResults(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-different-service-accs"),
tb.TaskRunLabel("tekton.dev/pipelineTask", "b-task"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(
tb.TaskRunTaskRef("b-task"),
tb.TaskRunServiceAccountName("test-sa-0"),
Expand Down Expand Up @@ -3997,6 +4013,7 @@ func TestReconcileWithTaskResultsEmbeddedNoneStarted(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", "test-pipeline-run-different-service-accs"),
tb.TaskRunLabel("tekton.dev/pipelineRun", "test-pipeline-run-different-service-accs"),
tb.TaskRunLabel("tekton.dev/pipelineTask", "a-task"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunSpec(
tb.TaskRunTaskRef("a-task", tb.TaskRefKind(v1beta1.NamespacedTaskKind)),
tb.TaskRunServiceAccountName("test-sa-0"),
Expand Down Expand Up @@ -5534,6 +5551,7 @@ func TestReconciler_ReconcileKind_PipelineTaskContext(t *testing.T) {
tb.TaskRunLabel("tekton.dev/pipeline", pipelineName),
tb.TaskRunLabel("tekton.dev/pipelineRun", pipelineRunName),
tb.TaskRunLabel("tekton.dev/pipelineTask", "finaltask"),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineFinallyTasks),
tb.TaskRunSpec(
tb.TaskRunTaskRef("finaltask"),
tb.TaskRunServiceAccountName("test-sa"),
Expand Down Expand Up @@ -5764,9 +5782,10 @@ func TestReconcileWithTaskResultsInFinalTasks(t *testing.T) {
BlockOwnerDeletion: &trueb,
}},
Labels: map[string]string{
"tekton.dev/pipeline": "test-pipeline",
"tekton.dev/pipelineRun": "test-pipeline-run-final-task-results",
"tekton.dev/pipelineTask": "final-task-1",
"tekton.dev/pipeline": "test-pipeline",
"tekton.dev/pipelineRun": "test-pipeline-run-final-task-results",
"tekton.dev/pipelineTask": "final-task-1",
pipeline.GroupName + pipeline.MemberOfLabelKey: v1beta1.PipelineFinallyTasks,
},
Annotations: map[string]string{},
},
Expand Down Expand Up @@ -5953,6 +5972,7 @@ func TestReconcile_RemotePipelineRef(t *testing.T) {
"tekton.dev/pipeline": "test-pipeline",
"tekton.dev/pipelineRun": "test-pipeline-run-success",
pipeline.GroupName + pipeline.PipelineTaskLabelKey: "unit-test-1",
pipeline.GroupName + pipeline.MemberOfLabelKey: v1beta1.PipelineTasks,
},
OwnerReferences: []metav1.OwnerReference{{
APIVersion: "tekton.dev/v1beta1",
Expand Down Expand Up @@ -6060,6 +6080,7 @@ func TestReconcile_OptionalWorkspacesOmitted(t *testing.T) {
"tekton.dev/pipeline": "test-pipeline-run-success",
"tekton.dev/pipelineRun": "test-pipeline-run-success",
pipeline.GroupName + pipeline.PipelineTaskLabelKey: "unit-test-1",
pipeline.GroupName + pipeline.MemberOfLabelKey: v1beta1.PipelineTasks,
},
OwnerReferences: []metav1.OwnerReference{{
APIVersion: "tekton.dev/v1beta1",
Expand Down Expand Up @@ -6263,6 +6284,7 @@ func getTaskRunWithTaskSpec(tr, pr, p, t string, labels, annotations map[string]
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, p),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, pr),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, t),
tb.TaskRunLabel(pipeline.GroupName+pipeline.MemberOfLabelKey, v1beta1.PipelineTasks),
tb.TaskRunLabels(labels),
tb.TaskRunAnnotations(annotations),
tb.TaskRunSpec(tb.TaskRunTaskSpec(tb.Step("myimage", tb.StepName("mystep"))),
Expand Down