events.go

/*
Copyright 2019 The Knative 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

import (
	"fmt"
	"strings"

	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"

	cloudevents "github.com/cloudevents/sdk-go"
	sourcesv1alpha1 "github.com/knative/eventing/pkg/apis/sources/v1alpha1"
)

func MakeAddEvent(source string, obj interface{}) (*cloudevents.Event, error) {
	if obj == nil {
		return nil, fmt.Errorf("resource can not be nil")
	}
	object := obj.(*unstructured.Unstructured)

	return makeEvent(source, sourcesv1alpha1.ApiServerSourceAddEventType, object, object)
}

func MakeUpdateEvent(source string, obj interface{}) (*cloudevents.Event, error) {
	if obj == nil {
		return nil, fmt.Errorf("resource can not be nil")
	}
	object := obj.(*unstructured.Unstructured)

	return makeEvent(source, sourcesv1alpha1.ApiServerSourceUpdateEventType, object, object)
}

func MakeDeleteEvent(source string, obj interface{}) (*cloudevents.Event, error) {
	if obj == nil {
		return nil, fmt.Errorf("resource can not be nil")
	}
	object := obj.(*unstructured.Unstructured)

	return makeEvent(source, sourcesv1alpha1.ApiServerSourceDeleteEventType, object, object)
}

func getRef(object *unstructured.Unstructured, asController bool) corev1.ObjectReference {
	if asController {
		if owner := metav1.GetControllerOf(object); owner != nil {
			return corev1.ObjectReference{
				APIVersion: owner.APIVersion,
				Kind:       owner.Kind,
				Name:       owner.Name,
				Namespace:  object.GetNamespace(),
			}
		}
	}
	return corev1.ObjectReference{
		APIVersion: object.GetAPIVersion(),
		Kind:       object.GetKind(),
		Name:       object.GetName(),
		Namespace:  object.GetNamespace(),
	}
}

func MakeAddRefEvent(source string, asController bool, obj interface{}) (*cloudevents.Event, error) {
	if obj == nil {
		return nil, fmt.Errorf("resource can not be nil")
	}
	object := obj.(*unstructured.Unstructured)
	return makeEvent(source, sourcesv1alpha1.ApiServerSourceAddRefEventType, object, getRef(object, asController))
}

func MakeUpdateRefEvent(source string, asController bool, obj interface{}) (*cloudevents.Event, error) {
	if obj == nil {
		return nil, fmt.Errorf("new resource can not be nil")
	}
	object := obj.(*unstructured.Unstructured)
	return makeEvent(source, sourcesv1alpha1.ApiServerSourceUpdateRefEventType, object, getRef(object, asController))
}

func MakeDeleteRefEvent(source string, asController bool, obj interface{}) (*cloudevents.Event, error) {
	if obj == nil {
		return nil, fmt.Errorf("resource can not be nil")
	}
	object := obj.(*unstructured.Unstructured)
	return makeEvent(source, sourcesv1alpha1.ApiServerSourceDeleteRefEventType, object, getRef(object, asController))
}

func makeEvent(source, eventType string, obj *unstructured.Unstructured, data interface{}) (*cloudevents.Event, error) {
	subject := createSelfLink(corev1.ObjectReference{
		APIVersion: obj.GetAPIVersion(),
		Kind:       obj.GetKind(),
		Name:       obj.GetName(),
		Namespace:  obj.GetNamespace(),
	})

	event := cloudevents.NewEvent()
	event.SetType(eventType)
	event.SetSource(source)
	event.SetSubject(subject)

	if err := event.SetData(data); err != nil {
		return nil, err
	}
	return &event, nil
}

// Creates a URI of the form found in object metadata selfLinks
// Format looks like: /apis/feeds.knative.dev/v1alpha1/namespaces/default/feeds/k8s-events-example
// KNOWN ISSUES:
// * ObjectReference.APIVersion has no version information (e.g. serving.knative.dev rather than serving.knative.dev/v1alpha1)
// * ObjectReference does not have enough information to create the pluaralized list type (e.g. "revisions" from kind: Revision)
//
// Track these issues at https://github.com/kubernetes/kubernetes/issues/66313
// We could possibly work around this by adding a lister for the resources referenced by these events.
func createSelfLink(o corev1.ObjectReference) string {
	collectionNameHack := strings.ToLower(o.Kind) + "s"
	versionNameHack := o.APIVersion

	// Core API types don't have a separate package name and only have a version string (e.g. /apis/v1/namespaces/default/pods/myPod)
	// To avoid weird looking strings like "v1/versionUnknown" we'll sniff for a "." in the version
	if strings.Contains(versionNameHack, ".") && !strings.Contains(versionNameHack, "/") {
		versionNameHack = versionNameHack + "/versionUnknown"
	}
	return fmt.Sprintf("/apis/%s/namespaces/%s/%s/%s", versionNameHack, o.Namespace, collectionNameHack, o.Name)
}