Add e2e-tests for applying crd and cr at the same time

Author: mortent

test/e2e/apply_and_destroy_test.go

@@ -67,16 +67,8 @@ func applyAndDestroyTest(c client.Client, inventoryName, namespaceName string) {
 
 	By("Destroy resources")
 	destroyer := newDestroyer()
-	err = destroyer.Initialize()
-	Expect(err).NotTo(HaveOccurred())
 
-	destroyCh := destroyer.Run(inv)
-
-	var destroyerEvents []event.Event
-	for e := range destroyCh {
-		Expect(e.Type).NotTo(Equal(event.ErrorType))
-		destroyerEvents = append(destroyerEvents, e)
-	}
+	destroyerEvents := runCollectNoErr(destroyer.Run(inv))
 	err = verifyEvents([]expEvent{
 		{
 			eventType: event.DeleteType,

test/e2e/common_test.go

@@ -14,6 +14,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/cli-utils/pkg/apply/event"
 	"sigs.k8s.io/cli-utils/pkg/common"
+	"sigs.k8s.io/cli-utils/pkg/kstatus/status"
 	"sigs.k8s.io/cli-utils/pkg/object"
 )
 
@@ -100,7 +101,10 @@ func updateReplicas(u *unstructured.Unstructured, replicas int) *unstructured.Un
 type expEvent struct {
 	eventType event.Type
 
-	applyEvent *expApplyEvent
+	applyEvent  *expApplyEvent
+	statusEvent *expStatusEvent
+	pruneEvent  *expPruneEvent
+	deleteEvent *expDeleteEvent
 }
 
 type expApplyEvent struct {
@@ -110,6 +114,27 @@ type expApplyEvent struct {
 	error          error
 }
 
+type expStatusEvent struct {
+	statusEventType event.StatusEventType
+	identifier      object.ObjMetadata
+	status          status.Status
+	error           error
+}
+
+type expPruneEvent struct {
+	pruneEventType event.PruneEventType
+	operation      event.PruneEventOperation
+	identifier     object.ObjMetadata
+	error          error
+}
+
+type expDeleteEvent struct {
+	deleteEventType event.DeleteEventType
+	operation       event.DeleteEventOperation
+	identifier      object.ObjMetadata
+	error           error
+}
+
 func verifyEvents(expEvents []expEvent, events []event.Event) error {
 	expEventIndex := 0
 	for i := range events {
@@ -127,6 +152,10 @@ func verifyEvents(expEvents []expEvent, events []event.Event) error {
 
 var nilIdentifier = object.ObjMetadata{}
 
+// nolint:gocyclo
+// TODO(mortent): This function is pretty complex and with quite a bit of
+// duplication. We should see if there is a better way to provide a flexible
+// way to verify that we go the expected events.
 func isMatch(ee expEvent, e event.Event) bool {
 	if ee.eventType != e.Type {
 		return false
@@ -136,6 +165,7 @@ func isMatch(ee expEvent, e event.Event) bool {
 	switch e.Type {
 	case event.ApplyType:
 		aee := ee.applyEvent
+		// If no more information is specified, we consider it a match.
 		if aee == nil {
 			return true
 		}
@@ -146,13 +176,13 @@ func isMatch(ee expEvent, e event.Event) bool {
 		}
 
 		if aee.applyEventType == event.ApplyEventResourceUpdate {
-			if aee.operation != ae.Operation {
-				return false
+			if aee.identifier != nilIdentifier {
+				if aee.identifier != ae.Identifier {
+					return false
+				}
 			}
-		}
 
-		if aee.identifier != nilIdentifier {
-			if aee.identifier != ae.Identifier {
+			if aee.operation != ae.Operation {
 				return false
 			}
 		}
@@ -161,6 +191,90 @@ func isMatch(ee expEvent, e event.Event) bool {
 			return ae.Error != nil
 		}
 		return ae.Error == nil
+
+	case event.StatusType:
+		see := ee.statusEvent
+		if see == nil {
+			return true
+		}
+		se := e.StatusEvent
+
+		if see.statusEventType != se.Type {
+			return false
+		}
+
+		if see.statusEventType == event.StatusEventResourceUpdate {
+			if see.identifier != nilIdentifier {
+				if see.identifier != se.Resource.Identifier {
+					return false
+				}
+			}
+
+			if see.status != se.Resource.Status {
+				return false
+			}
+
+			if see.error != nil {
+				return se.Resource.Error != nil
+			}
+			return se.Resource.Error == nil
+		}
+
+	case event.PruneType:
+		pee := ee.pruneEvent
+		if pee == nil {
+			return true
+		}
+		pe := e.PruneEvent
+
+		if pee.pruneEventType != pe.Type {
+			return false
+		}
+
+		if pee.pruneEventType == event.PruneEventResourceUpdate {
+			if pee.identifier != nilIdentifier {
+				if pee.identifier != pe.Identifier {
+					return false
+				}
+			}
+
+			if pee.operation != pe.Operation {
+				return false
+			}
+		}
+
+		if pee.error != nil {
+			return pe.Error != nil
+		}
+		return pe.Error == nil
+
+	case event.DeleteType:
+		dee := ee.deleteEvent
+		if dee == nil {
+			return true
+		}
+		de := e.DeleteEvent
+
+		if dee.deleteEventType != de.Type {
+			return false
+		}
+
+		if dee.deleteEventType == event.DeleteEventResourceUpdate {
+			if dee.identifier != nilIdentifier {
+				if dee.identifier != de.Identifier {
+					return false
+				}
+			}
+
+			if dee.operation != de.Operation {
+				return false
+			}
+		}
+
+		if dee.error != nil {
+			return de.Error != nil
+		}
+		return de.Error == nil
 	}
 	return true
 }

test/e2e/crd_test.go

@@ -0,0 +1,176 @@
+// Copyright 2020 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package e2e
+
+import (
+	"context"
+	"strings"
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"sigs.k8s.io/cli-utils/pkg/apply"
+	"sigs.k8s.io/cli-utils/pkg/apply/event"
+	"sigs.k8s.io/cli-utils/pkg/inventory"
+	"sigs.k8s.io/cli-utils/pkg/kstatus/status"
+	"sigs.k8s.io/cli-utils/pkg/object"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/kustomize/kyaml/yaml"
+)
+
+func crdTest(_ client.Client, inventoryName, namespaceName string) {
+	By("apply a set of resources that includes both a crd and a cr")
+	applier := newApplier()
+
+	inv := inventory.WrapInventoryInfoObj(cmInventoryManifest(inventoryName, namespaceName, "test"))
+
+	resources := []*unstructured.Unstructured{
+		deploymentManifest(namespaceName),
+		manifestToUnstructured(cr),
+		manifestToUnstructured(crd),
+	}
+
+	ch := applier.Run(context.TODO(), inv, resources, apply.Options{
+		ReconcileTimeout: 2 * time.Minute,
+		EmitStatusEvents: true,
+	})
+
+	var applierEvents []event.Event
+	for e := range ch {
+		Expect(e.Type).NotTo(Equal(event.ErrorType))
+		applierEvents = append(applierEvents, e)
+	}
+	err := verifyEvents([]expEvent{
+		{
+			eventType: event.ApplyType,
+			applyEvent: &expApplyEvent{
+				applyEventType: event.ApplyEventResourceUpdate,
+				operation:      event.Created,
+				identifier:     object.UnstructuredToObjMeta(manifestToUnstructured(crd)),
+				error:          nil,
+			},
+		},
+		{
+			eventType: event.StatusType,
+			statusEvent: &expStatusEvent{
+				statusEventType: event.StatusEventResourceUpdate,
+				identifier:      object.UnstructuredToObjMeta(manifestToUnstructured(crd)),
+				status:          status.CurrentStatus,
+				error:           nil,
+			},
+		},
+		{
+			eventType: event.ApplyType,
+			applyEvent: &expApplyEvent{
+				applyEventType: event.ApplyEventResourceUpdate,
+				operation:      event.Created,
+			},
+		},
+		{
+			eventType: event.ApplyType,
+			applyEvent: &expApplyEvent{
+				applyEventType: event.ApplyEventResourceUpdate,
+				operation:      event.Created,
+			},
+		},
+	}, applierEvents)
+	Expect(err).ToNot(HaveOccurred())
+
+	By("destroy the resources, including the crd")
+	destroyer := newDestroyer()
+	destroyerEvents := runCollectNoErr(destroyer.Run(inv))
+	err = verifyEvents([]expEvent{
+		{
+			eventType: event.DeleteType,
+			deleteEvent: &expDeleteEvent{
+				deleteEventType: event.DeleteEventResourceUpdate,
+				operation:       event.Deleted,
+				error:           nil,
+			},
+		},
+		{
+			eventType: event.DeleteType,
+			deleteEvent: &expDeleteEvent{
+				deleteEventType: event.DeleteEventResourceUpdate,
+				operation:       event.Deleted,
+				error:           nil,
+			},
+		},
+		{
+			eventType: event.DeleteType,
+			deleteEvent: &expDeleteEvent{
+				deleteEventType: event.DeleteEventResourceUpdate,
+				operation:       event.Deleted,
+				// TODO(mortent): The identifier isn't populated in the Delete
+				// events. This should be fixed.
+				// identifier: object.UnstructuredToObjMeta(manifestToUnstructured(crd)),
+				error: nil,
+			},
+		},
+	}, destroyerEvents)
+	Expect(err).ToNot(HaveOccurred())
+}
+
+var crd = []byte(strings.TrimSpace(`
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: examples.cli-utils.example.io
+spec:
+  conversion:
+    strategy: None
+  group: cli-utils.example.io
+  names:
+    kind: Example
+    listKind: ExampleList
+    plural: examples
+    singular: example
+  scope: Cluster
+  versions:
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        description: Example for cli-utils e2e tests
+        properties:
+          apiVersion:
+            type: string
+          kind:
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: Example for cli-utils e2e tests
+            properties:
+              replicas:
+                description: Number of replicas 
+                type: integer
+            required:
+            - replicas
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources: {}
+`))
+
+var cr = []byte(strings.TrimSpace(`
+apiVersion: cli-utils.example.io/v1alpha1
+kind: Example
+metadata:
+  name: example-cr
+spec:
+  replicas: 4
+`))
+
+func manifestToUnstructured(manifest []byte) *unstructured.Unstructured {
+	u := make(map[string]interface{})
+	err := yaml.Unmarshal(manifest, &u)
+	if err != nil {
+		panic(err)
+	}
+	return &unstructured.Unstructured{
+		Object: u,
+	}
+}