Skip to content

Commit

Permalink
WIP Sync the pipelinerun status from the informers
Browse files Browse the repository at this point in the history 
When we reconcile a pipelinerun, we should ensure that the
pipelinerun status is always in sync with the actual list of taskruns
that can be provided by the taskrun informer.

The only way to filter taskruns is by labels tekton.dev/pipelinerun.
In case an orphaned taskrun is found, we can use the other labels
on the taskrun to reconstruct the missing entry in the pipelinerun
status.
  • Loading branch information
@afrittoli
afrittoli committed May 7, 2020
1 parent 4280425 commit c0ef193
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 2 deletions.
29 changes: 29 additions & 0 deletions pkg/reconciler/pipelinerun/pipelinerun.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ import (
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/client-go/tools/cache"
"knative.dev/pkg/apis"
"knative.dev/pkg/configmap"
Expand Down Expand Up @@ -188,6 +189,14 @@ func (c *Reconciler) Reconcile(ctx context.Context, key string) error {
return err
}

// Make sure that the PipelineRun status is in sync with the actual TaskRuns
err = c.updatePipelineRunStatusFromInformer(pr)
if err != nil {
// This should not fail. Return the error so we can re-try later.
c.Logger.Errorf("Error while syncing the pipelinerun status: %v", err.Error())
return err
}

// Reconcile this copy of the pipelinerun and then write back any status or label
// updates regardless of whether the reconciliation errored out.
if err = c.reconcile(ctx, pr); err != nil {
Expand Down Expand Up @@ -930,3 +939,23 @@ func storePipelineSpec(ctx context.Context, pr *v1alpha1.PipelineRun, ps *v1alph
}
return nil
}

func (c *Reconciler) updatePipelineRunStatusFromInformer(pr *v1alpha1.PipelineRun) error {
pipelineRunLabels := getTaskrunLabels(pr, "")
taskRuns, err := c.taskRunLister.TaskRuns(pr.Namespace).List(labels.SelectorFromSet(pipelineRunLabels))
// taskRuns, err := c.taskRunLister.TaskRuns(pr.Namespace).List(labels.Everything())
if err != nil {
c.Logger.Errorf("Could not list TaskRuns %#v", err)
return err
}
for _, taskrun := range taskRuns {
if pr.Status.TaskRuns[taskrun.Name] == nil {
pr.Status.TaskRuns[taskrun.Name] = &v1alpha1.PipelineRunTaskRunStatus{
PipelineTaskName: taskrun.Labels[pipeline.GroupName+pipeline.PipelineTaskLabelKey],
Status: &taskrun.Status,
ConditionChecks: nil, // TBD handling ConditionChecks
}
}
}
return nil
}
151 changes: 149 additions & 2 deletions pkg/reconciler/pipelinerun/pipelinerun_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -816,8 +816,8 @@ func TestReconcileOnCompletedPipelineRun(t *testing.T) {
t.Fatalf("Expected client to have updated the TaskRun status for a completed PipelineRun, but it did not")
}

actual := clients.Pipeline.Actions()[1].(ktesting.UpdateAction).GetObject().(*v1alpha1.PipelineRun)
if actual == nil {
_, ok := clients.Pipeline.Actions()[1].(ktesting.UpdateAction).GetObject().(*v1alpha1.PipelineRun)
if !ok {
t.Errorf("Expected a PipelineRun to be updated, but it wasn't.")
}
t.Log(clients.Pipeline.Actions())
Expand Down Expand Up @@ -2185,3 +2185,150 @@ func Test_storePipelineSpec(t *testing.T) {
t.Fatalf("-want, +got: %v", d)
}
}

func TestReconcileOutOfSyncPipelineRun(t *testing.T) {
// It may happen that a PipelineRun creates one or more TaskRuns during reconcile
// but it fails to sync the update on the status back. This test verifies that
// the reconciler is able to coverge back to a consistent state with the orphaned
// TaskRuns back in the PipelineRun status.
// For more details, see https://github.com/tektoncd/pipeline/issues/2558
pipelineName := "test-pipeline"
pipelineRunName := "test-pipeline-run-out-of-sync"
taskRun1Name := "test-pipeline-run-out-of-sync-hello-world-1"
taskRun2Name := "test-pipeline-run-out-of-sync-hello-world-2"
prs := []*v1alpha1.PipelineRun{tb.PipelineRun(pipelineRunName,
tb.PipelineRunNamespace("foo"),
tb.PipelineRunSpec(pipelineName, tb.PipelineRunServiceAccountName("test-sa")),
tb.PipelineRunStatus(tb.PipelineRunStatusCondition(apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionUnknown,
Reason: "",
Message: "",
}),
tb.PipelineRunTaskRunsStatus(taskRun1Name, &v1alpha1.PipelineRunTaskRunStatus{
PipelineTaskName: "hello-world-1",
Status: &v1alpha1.TaskRunStatus{},
}),
),
)}
ps := []*v1alpha1.Pipeline{tb.Pipeline(pipelineName, tb.PipelineNamespace("foo"), tb.PipelineSpec(
tb.PipelineTask("hello-world-1", "hello-world"),
tb.PipelineTask("hello-world-2", "hello-world")))}
ts := []*v1alpha1.Task{tb.Task("hello-world", tb.TaskNamespace("foo"))}
trs := []*v1alpha1.TaskRun{
tb.TaskRun(taskRun1Name,
tb.TaskRunNamespace("foo"),
tb.TaskRunOwnerReference("PipelineRun", pipelineRunName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, pipelineName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, pipelineRunName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-1"),
tb.TaskRunSpec(tb.TaskRunTaskRef("hello-world")),
tb.TaskRunStatus(
tb.StatusCondition(apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionTrue,
}),
),
),
tb.TaskRun(taskRun2Name,
tb.TaskRunNamespace("foo"),
tb.TaskRunOwnerReference("PipelineRun", pipelineRunName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineLabelKey, pipelineName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineRunLabelKey, pipelineRunName),
tb.TaskRunLabel(pipeline.GroupName+pipeline.PipelineTaskLabelKey, "hello-world-2"),
tb.TaskRunSpec(tb.TaskRunTaskRef("hello-world")),
tb.TaskRunStatus(
tb.StatusCondition(apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionUnknown,
}),
),
),
}
d := test.Data{
PipelineRuns: prs,
Pipelines: ps,
Tasks: ts,
TaskRuns: trs,
}

testAssets, cancel := getPipelineRunController(t, d)
defer cancel()
c := testAssets.Controller
clients := testAssets.Clients

if err := c.Reconciler.Reconcile(context.Background(), "foo/"+pipelineRunName); err != nil {
t.Fatalf("Error reconciling: %s", err)
}

// if len(clients.Pipeline.Actions()) != 2 {
// t.Fatalf("Expected client to have updated the TaskRun status for a completed PipelineRun, but it did not")
// }

_, ok := clients.Pipeline.Actions()[1].(ktesting.UpdateAction).GetObject().(*v1alpha1.PipelineRun)
if !ok {
t.Errorf("Expected a PipelineRun to be updated, but it wasn't.")
}
t.Log(clients.Pipeline.Actions())
actions := clients.Pipeline.Actions()
pipelineUpdates := 0
for _, action := range actions {
if action != nil {
switch {
case action.Matches("create", "taskruns"):
t.Fatalf("Expected client to not have created a TaskRun, but it did")
case action.Matches("update", "pipelineruns"):
pipelineUpdates++
default:
continue
}
}
}
if pipelineUpdates != 2 {
// If only the pipelinerun status changed, we expect one update
t.Fatalf("Expected client to have updated the pipelinerun once, but it did %d times", pipelineUpdates)
}

// Check that the PipelineRun was reconciled correctly
reconciledRun, err := clients.Pipeline.TektonV1alpha1().PipelineRuns("foo").Get(pipelineRunName, metav1.GetOptions{})
if err != nil {
t.Fatalf("Somehow had error getting completed reconciled run out of fake client: %s", err)
}

// This PipelineRun should still be running and the status should reflect that
if !reconciledRun.Status.GetCondition(apis.ConditionSucceeded).IsUnknown() {
t.Errorf("Expected PipelineRun status to be running, but was %v", reconciledRun.Status.GetCondition(apis.ConditionSucceeded))
}

expectedTaskRunsStatus := make(map[string]*v1alpha1.PipelineRunTaskRunStatus)
expectedTaskRunsStatus[taskRun1Name] = &v1alpha1.PipelineRunTaskRunStatus{
PipelineTaskName: "hello-world-1",
Status: &v1alpha1.TaskRunStatus{
Status: duckv1beta1.Status{
Conditions: []apis.Condition{
{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionTrue,
},
},
},
},
}
expectedTaskRunsStatus[taskRun2Name] = &v1alpha1.PipelineRunTaskRunStatus{
PipelineTaskName: "hello-world-2",
Status: &v1alpha1.TaskRunStatus{
Status: duckv1beta1.Status{
Conditions: []apis.Condition{
{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionUnknown,
},
},
},
},
}

if d := cmp.Diff(reconciledRun.Status.TaskRuns, expectedTaskRunsStatus); d != "" {
t.Fatalf("Expected PipelineRun status to match TaskRun(s) status, but got a mismatch: %s", d)
}
}

0 comments on commit c0ef193

Please sign in to comment.