Move events to a common package

Move both events.go and the cloudevents module under a new module reconciler.events. We want to the controllers to be able to emit both kubernetes events and cloudevents, so this change is in preparation to creating a common event interface to be used by controllers. Partially addresses tektoncd#2082
afrittoli · May 20, 2020 · 20983fb · 20983fb
1 parent 6e24131
commit 20983fb
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 10 deletions.
diff --git a/...rces/cloudevent/cloud_event_controller.go → ...ents/cloudevent/cloud_event_controller.go b/...rces/cloudevent/cloud_event_controller.go → ...ents/cloudevent/cloud_event_controller.go
diff --git a/...cloudevent/cloud_event_controller_test.go → ...cloudevent/cloud_event_controller_test.go b/...cloudevent/cloud_event_controller_test.go → ...cloudevent/cloud_event_controller_test.go
diff --git a/...askrun/resources/cloudevent/cloudevent.go → ...econciler/events/cloudevent/cloudevent.go b/...askrun/resources/cloudevent/cloudevent.go → ...econciler/events/cloudevent/cloudevent.go
diff --git a/...n/resources/cloudevent/cloudevent_test.go → ...iler/events/cloudevent/cloudevent_test.go b/...n/resources/cloudevent/cloudevent_test.go → ...iler/events/cloudevent/cloudevent_test.go
diff --git a/.../resources/cloudevent/cloudeventclient.go → ...ler/events/cloudevent/cloudeventclient.go b/.../resources/cloudevent/cloudeventclient.go → ...ler/events/cloudevent/cloudeventclient.go
diff --git a/...urces/cloudevent/cloudeventsfakeclient.go → ...vents/cloudevent/cloudeventsfakeclient.go b/...urces/cloudevent/cloudeventsfakeclient.go → ...vents/cloudevent/cloudeventsfakeclient.go
diff --git a/pkg/reconciler/events/doc.go b/pkg/reconciler/events/doc.go
@@ -0,0 +1,21 @@
+/*
+Copyright 2020 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 events defines the interface and different implementations for events
+//
+// Tekton uses events to notify about changes in Condition of resources, like a
+// TaskRun is starting, a PipelineRun failed to run or could not be validated.
+package events
diff --git a/pkg/reconciler/event.go → pkg/reconciler/events/event.go b/pkg/reconciler/event.go → pkg/reconciler/events/event.go
@@ -13,7 +13,7 @@ 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 reconciler
+package events
 
 import (
 	corev1 "k8s.io/api/core/v1"

diff --git a/pkg/reconciler/event_test.go → pkg/reconciler/events/event_test.go b/pkg/reconciler/event_test.go → pkg/reconciler/events/event_test.go
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package reconciler
+package events
 
 import (
 	"errors"

diff --git a/pkg/reconciler/pipelinerun/pipelinerun.go b/pkg/reconciler/pipelinerun/pipelinerun.go
@@ -36,6 +36,7 @@ import (
 	resourcelisters "github.com/tektoncd/pipeline/pkg/client/resource/listers/resource/v1alpha1"
 	"github.com/tektoncd/pipeline/pkg/contexts"
 	"github.com/tektoncd/pipeline/pkg/reconciler"
+	"github.com/tektoncd/pipeline/pkg/reconciler/events"
 	"github.com/tektoncd/pipeline/pkg/reconciler/pipeline/dag"
 	"github.com/tektoncd/pipeline/pkg/reconciler/pipelinerun/resources"
 	"github.com/tektoncd/pipeline/pkg/reconciler/taskrun"
@@ -196,7 +197,7 @@ func (c *Reconciler) Reconcile(ctx context.Context, key string) error {
 		before := pr.Status.GetCondition(apis.ConditionSucceeded)
 		merr = multierror.Append(merr, cancelPipelineRun(c.Logger, pr, c.PipelineClientSet))
 		after := pr.Status.GetCondition(apis.ConditionSucceeded)
-		reconciler.EmitEvent(c.Recorder, before, after, pr)
+		events.EmitEvent(c.Recorder, before, after, pr)
 	default:
 		if err := c.tracker.Track(pr.GetTaskRunRef(), pr); err != nil {
 			c.Logger.Errorf("Failed to create tracker for TaskRuns for PipelineRun %s: %v", pr.Name, err)
@@ -605,7 +606,7 @@ func (c *Reconciler) reconcile(ctx context.Context, pr *v1beta1.PipelineRun) err
 	before := pr.Status.GetCondition(apis.ConditionSucceeded)
 	after := resources.GetPipelineConditionStatus(pr, pipelineState, c.Logger, d)
 	pr.Status.SetCondition(after)
-	reconciler.EmitEvent(c.Recorder, before, after, pr)
+	events.EmitEvent(c.Recorder, before, after, pr)
 
 	pr.Status.TaskRuns = getTaskRunsStatus(pr, pipelineState)
 	c.Logger.Infof("PipelineRun %s status is being set to %s", pr.Name, pr.Status.GetCondition(apis.ConditionSucceeded))

diff --git a/pkg/reconciler/taskrun/controller.go b/pkg/reconciler/taskrun/controller.go
@@ -29,7 +29,7 @@ import (
 	resourceinformer "github.com/tektoncd/pipeline/pkg/client/resource/injection/informers/resource/v1alpha1/pipelineresource"
 	"github.com/tektoncd/pipeline/pkg/pod"
 	"github.com/tektoncd/pipeline/pkg/reconciler"
-	cloudeventclient "github.com/tektoncd/pipeline/pkg/reconciler/taskrun/resources/cloudevent"
+	cloudeventclient "github.com/tektoncd/pipeline/pkg/reconciler/events/cloudevent"
 	"github.com/tektoncd/pipeline/pkg/reconciler/volumeclaim"
 	"k8s.io/client-go/tools/cache"
 	kubeclient "knative.dev/pkg/client/injection/kube/client"

diff --git a/pkg/reconciler/taskrun/taskrun.go b/pkg/reconciler/taskrun/taskrun.go
@@ -34,8 +34,9 @@ import (
 	"github.com/tektoncd/pipeline/pkg/contexts"
 	podconvert "github.com/tektoncd/pipeline/pkg/pod"
 	"github.com/tektoncd/pipeline/pkg/reconciler"
+	"github.com/tektoncd/pipeline/pkg/reconciler/events"
+	"github.com/tektoncd/pipeline/pkg/reconciler/events/cloudevent"
 	"github.com/tektoncd/pipeline/pkg/reconciler/taskrun/resources"
-	"github.com/tektoncd/pipeline/pkg/reconciler/taskrun/resources/cloudevent"
 	"github.com/tektoncd/pipeline/pkg/reconciler/volumeclaim"
 	"github.com/tektoncd/pipeline/pkg/termination"
 	"github.com/tektoncd/pipeline/pkg/workspace"
@@ -116,7 +117,7 @@ func (c *Reconciler) Reconcile(ctx context.Context, key string) error {
 		// We also want to send the "Started" event as soon as possible for anyone who may be waiting
 		// on the event to perform user facing initialisations, such has reset a CI check status
 		afterCondition := tr.Status.GetCondition(apis.ConditionSucceeded)
-		reconciler.EmitEvent(c.Recorder, nil, afterCondition, tr)
+		events.EmitEvent(c.Recorder, nil, afterCondition, tr)
 	}
 
 	// If the TaskRun is complete, run some post run fixtures when applicable
@@ -209,9 +210,9 @@ func (c *Reconciler) Reconcile(ctx context.Context, key string) error {
 
 func (c *Reconciler) finishReconcileUpdateEmitEvents(tr, original *v1beta1.TaskRun, beforeCondition *apis.Condition, previousError error) error {
 	afterCondition := tr.Status.GetCondition(apis.ConditionSucceeded)
-	reconciler.EmitEvent(c.Recorder, beforeCondition, afterCondition, tr)
+	events.EmitEvent(c.Recorder, beforeCondition, afterCondition, tr)
 	err := c.updateStatusLabelsAndAnnotations(tr, original)
-	reconciler.EmitErrorEvent(c.Recorder, err, tr)
+	events.EmitErrorEvent(c.Recorder, err, tr)
 	return multierror.Append(previousError, err).ErrorOrNil()
 }
 

diff --git a/pkg/reconciler/taskrun/taskrun_test.go b/pkg/reconciler/taskrun/taskrun_test.go
@@ -32,7 +32,7 @@ import (
 	resourcev1alpha1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
 	podconvert "github.com/tektoncd/pipeline/pkg/pod"
-	"github.com/tektoncd/pipeline/pkg/reconciler/taskrun/resources/cloudevent"
+	"github.com/tektoncd/pipeline/pkg/reconciler/events/cloudevent"
 	ttesting "github.com/tektoncd/pipeline/pkg/reconciler/testing"
 	"github.com/tektoncd/pipeline/pkg/system"
 	test "github.com/tektoncd/pipeline/test"