change the apply API to InventoryInfo

Author: Liujingfang1

cmd/apply/cmdapply.go

@@ -111,7 +111,11 @@ func (r *ApplyRunner) RunE(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	inv, objs, err := inventory.SplitUnstructureds(objs)
+	inventoryClient, err := r.provider.InventoryClient()
+	if err != nil {
+		return err
+	}
+	inv, objs, err := inventory.SplitUnstructureds(inventoryClient.InvInfoFactoryFunc(), objs)
 	if err != nil {
 		return err
 	}

cmd/destroy/cmddestroy.go

@@ -64,7 +64,12 @@ func (r *DestroyRunner) RunE(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	inv, _, err := inventory.SplitUnstructureds(objs)
+	inventoryClient, err := r.provider.InventoryClient()
+	if err != nil {
+		return err
+	}
+
+	inv, _, err := inventory.SplitUnstructureds(inventoryClient.InvInfoFactoryFunc(), objs)
 	if err != nil {
 		return err
 	}

cmd/preview/cmdpreview.go

@@ -100,7 +100,12 @@ func (r *PreviewRunner) RunE(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	inv, objs, err := inventory.SplitUnstructureds(objs)
+	inventoryClient, err := r.provider.InventoryClient()
+	if err != nil {
+		return err
+	}
+
+	inv, objs, err := inventory.SplitUnstructureds(inventoryClient.InvInfoFactoryFunc(), objs)
 	if err != nil {
 		return err
 	}

cmd/status/cmdstatus.go

@@ -83,13 +83,13 @@ func (r *StatusRunner) runE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	// Find the inventory template among the manifests.
-	inv, _, err := inventory.SplitUnstructureds(objs)
+	invClient, err := r.provider.InventoryClient()
 	if err != nil {
 		return err
 	}
 
-	invClient, err := r.provider.InventoryClient()
+	// Find the inventory template among the manifests.
+	inv, _, err := inventory.SplitUnstructureds(invClient.InvInfoFactoryFunc(), objs)
 	if err != nil {
 		return err
 	}

pkg/apply/applier.go

@@ -88,7 +88,7 @@ func (a *Applier) Initialize() error {
 // calculates the set of objects to be pruned (pruneIds), and orders the
 // resources for the subsequent apply. Returns the sorted resources to
 // apply as well as the objects for the prune, or an error if one occurred.
-func (a *Applier) prepareObjects(localInv *unstructured.Unstructured, localObjs []*unstructured.Unstructured) (*ResourceObjects, error) {
+func (a *Applier) prepareObjects(localInv inventory.InventoryInfo, localObjs []*unstructured.Unstructured) (*ResourceObjects, error) {
 	if localInv == nil {
 		return nil, fmt.Errorf("the local inventory can't be nil")
 	}
@@ -125,7 +125,7 @@ func (a *Applier) prepareObjects(localInv *unstructured.Unstructured, localObjs
 // will be applied and the existing inventories used to determine
 // resources that should be pruned.
 type ResourceObjects struct {
-	LocalInv  *unstructured.Unstructured
+	LocalInv  inventory.InventoryInfo
 	Resources []*unstructured.Unstructured
 	PruneIds  []object.ObjMetadata
 }
@@ -138,7 +138,7 @@ func (r *ResourceObjects) ObjsForApply() []*unstructured.Unstructured {
 }
 
 // Inventory returns the unstructured representation of the inventory object.
-func (r *ResourceObjects) Inventory() *unstructured.Unstructured {
+func (r *ResourceObjects) Inventory() inventory.InventoryInfo {
 	return r.LocalInv
 }
 
@@ -172,7 +172,7 @@ func (r *ResourceObjects) AllIds() []object.ObjMetadata {
 // before all the given resources have been applied to the cluster. Any
 // cancellation or timeout will only affect how long we Wait for the
 // resources to become current.
-func (a *Applier) Run(ctx context.Context, inventory *unstructured.Unstructured, objects []*unstructured.Unstructured, options Options) <-chan event.Event {
+func (a *Applier) Run(ctx context.Context, invInfo inventory.InventoryInfo, objects []*unstructured.Unstructured, options Options) <-chan event.Event {
 	eventChannel := make(chan event.Event)
 	setDefaults(&options)
 	a.invClient.SetDryRunStrategy(options.DryRunStrategy) // client shared with prune, so sets dry-run for prune too.
@@ -182,7 +182,7 @@ func (a *Applier) Run(ctx context.Context, inventory *unstructured.Unstructured,
 		// This provides us with a slice of all the objects that will be
 		// applied to the cluster. This takes care of ordering resources
 		// and handling the inventory object.
-		resourceObjects, err := a.prepareObjects(inventory, objects)
+		resourceObjects, err := a.prepareObjects(invInfo, objects)
 		if err != nil {
 			handleError(eventChannel, err)
 			return
@@ -300,12 +300,11 @@ func handleError(eventChannel chan event.Event, err error) {
 // inventoryNamespaceInSet returns the the namespace the passed inventory
 // object will be applied to, or nil if this namespace object does not exist
 // in the passed slice "infos" or the inventory object is cluster-scoped.
-func inventoryNamespaceInSet(inv *unstructured.Unstructured, objs []*unstructured.Unstructured) *unstructured.Unstructured {
+func inventoryNamespaceInSet(inv inventory.InventoryInfo, objs []*unstructured.Unstructured) *unstructured.Unstructured {
 	if inv == nil {
 		return nil
 	}
-	invAcc, _ := meta.Accessor(inv)
-	invNamespace := invAcc.GetNamespace()
+	invNamespace := inv.Namespace()
 
 	for _, obj := range objs {
 		acc, _ := meta.Accessor(obj)

pkg/apply/applier_test.go

@@ -285,6 +285,8 @@ var inventoryObj = &unstructured.Unstructured{
 	},
 }
 
+var localInv = inventory.WrapInventoryInfoObj(inventoryObj)
+
 var obj1 = &unstructured.Unstructured{
 	Object: map[string]interface{}{
 		"apiVersion": "v1",
@@ -344,7 +346,7 @@ func TestInventoryNamespaceInSet(t *testing.T) {
 	inventoryNamespace := createNamespace(namespace)
 
 	tests := map[string]struct {
-		inv       *unstructured.Unstructured
+		inv       inventory.InventoryInfo
 		objects   []*unstructured.Unstructured
 		namespace *unstructured.Unstructured
 	}{
@@ -354,22 +356,22 @@ func TestInventoryNamespaceInSet(t *testing.T) {
 			namespace: nil,
 		},
 		"Inventory object, but no resources returns nil namespace": {
-			inv:       inventoryObj,
+			inv:       localInv,
 			objects:   []*unstructured.Unstructured{},
 			namespace: nil,
 		},
 		"Inventory object, resources with no namespace returns nil namespace": {
-			inv:       inventoryObj,
+			inv:       localInv,
 			objects:   []*unstructured.Unstructured{obj1, obj2},
 			namespace: nil,
 		},
 		"Inventory object, different namespace returns nil namespace": {
-			inv:       inventoryObj,
+			inv:       localInv,
 			objects:   []*unstructured.Unstructured{createNamespace("foo")},
 			namespace: nil,
 		},
 		"Inventory object, inventory namespace returns inventory namespace": {
-			inv:       inventoryObj,
+			inv:       localInv,
 			objects:   []*unstructured.Unstructured{obj1, inventoryNamespace, obj3},
 			namespace: inventoryNamespace,
 		},
@@ -388,13 +390,13 @@ func TestInventoryNamespaceInSet(t *testing.T) {
 func TestReadAndPrepareObjects(t *testing.T) {
 	testCases := map[string]struct {
 		// local inventory input into applier.prepareObjects
-		inventory *unstructured.Unstructured
+		inventory inventory.InventoryInfo
 		// locally read resources input into applier.prepareObjects
 		resources []*unstructured.Unstructured
 		// objects already stored in the cluster inventory
 		clusterObjs []*unstructured.Unstructured
 		// expected returned local inventory object
-		localInv *unstructured.Unstructured
+		localInv inventory.InventoryInfo
 		// expected returned local objects to apply (in order)
 		localObjs []*unstructured.Unstructured
 		// expected calculated prune objects
@@ -407,43 +409,43 @@ func TestReadAndPrepareObjects(t *testing.T) {
 			isError:   true,
 		},
 		"multiple inventory objects": {
-			inventory: inventoryObj,
+			inventory: localInv,
 			resources: []*unstructured.Unstructured{inventoryObj},
 			isError:   true,
 		},
 		"only inventory object": {
-			inventory: inventoryObj,
-			localInv:  inventoryObj,
+			inventory: localInv,
+			localInv:  localInv,
 			isError:   false,
 		},
 		"only inventory object, prune one object": {
-			inventory:   inventoryObj,
+			inventory:   localInv,
 			clusterObjs: []*unstructured.Unstructured{obj1},
-			localInv:    inventoryObj,
+			localInv:    localInv,
 			pruneObjs:   []*unstructured.Unstructured{obj1},
 			isError:     false,
 		},
 		"inventory object already at the beginning": {
-			inventory: inventoryObj,
+			inventory: localInv,
 			resources: []*unstructured.Unstructured{obj1, clusterScopedObj},
-			localInv:  inventoryObj,
+			localInv:  localInv,
 			localObjs: []*unstructured.Unstructured{obj1, clusterScopedObj},
 			isError:   false,
 		},
 		"inventory object already at the beginning, prune one": {
-			inventory:   inventoryObj,
+			inventory:   localInv,
 			resources:   []*unstructured.Unstructured{obj1, clusterScopedObj},
 			clusterObjs: []*unstructured.Unstructured{obj2},
-			localInv:    inventoryObj,
+			localInv:    localInv,
 			localObjs:   []*unstructured.Unstructured{obj1, clusterScopedObj},
 			pruneObjs:   []*unstructured.Unstructured{obj2},
 			isError:     false,
 		},
 		"inventory object not at the beginning": {
-			inventory:   inventoryObj,
+			inventory:   localInv,
 			resources:   []*unstructured.Unstructured{obj1, obj2, clusterScopedObj},
 			clusterObjs: []*unstructured.Unstructured{obj2},
-			localInv:    inventoryObj,
+			localInv:    localInv,
 			localObjs:   []*unstructured.Unstructured{obj1, obj2, clusterScopedObj},
 			pruneObjs:   []*unstructured.Unstructured{},
 			isError:     false,
@@ -468,8 +470,11 @@ func TestReadAndPrepareObjects(t *testing.T) {
 				return
 			}
 			// Validate the returned ResourceObjs
-			if tc.localInv.GetNamespace() != resourceObjs.LocalInv.GetNamespace() ||
-				tc.localInv.GetName() != resourceObjs.LocalInv.GetName() {
+			expected := tc.localInv
+			actual := resourceObjs.LocalInv
+			if expected.Namespace() != actual.Namespace() ||
+				expected.Name() != actual.Name() ||
+				expected.ID() != actual.ID() {
 				t.Errorf("expected local inventory (%v), got (%v)",
 					tc.localInv, resourceObjs.LocalInv)
 			}
@@ -536,7 +541,7 @@ func toIdentifier(t *testing.T, resourceInfo resourceInfo, namespace string) obj
 	}
 }
 
-func createObjs(resources []resourceInfo) (*unstructured.Unstructured, []*unstructured.Unstructured, error) {
+func createObjs(resources []resourceInfo) (inventory.InventoryInfo, []*unstructured.Unstructured, error) {
 	var objs []*unstructured.Unstructured
 	for _, ri := range resources {
 		u := &unstructured.Unstructured{}
@@ -546,7 +551,7 @@ func createObjs(resources []resourceInfo) (*unstructured.Unstructured, []*unstru
 		}
 		objs = append(objs, u)
 	}
-	return inventory.SplitUnstructureds(objs)
+	return inventory.SplitUnstructureds(inventory.WrapInventoryInfoObj, objs)
 }
 
 // The handler interface allows different testcases to provide

pkg/apply/destroyer.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/go-errors/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"sigs.k8s.io/cli-utils/pkg/apply/event"
 	"sigs.k8s.io/cli-utils/pkg/apply/prune"
@@ -59,7 +58,7 @@ func (d *Destroyer) Initialize() error {
 // Run performs the destroy step. Passes the inventory object. This
 // happens asynchronously on progress and any errors are reported
 // back on the event channel.
-func (d *Destroyer) Run(inv *unstructured.Unstructured) <-chan event.Event {
+func (d *Destroyer) Run(inv inventory.InventoryInfo) <-chan event.Event {
 	ch := make(chan event.Event)
 
 	go func() {

pkg/apply/prune/prune.go

@@ -13,6 +13,7 @@ package prune
 
 import (
 	"context"
+	"fmt"
 	"sort"
 	"strings"
 
@@ -82,10 +83,13 @@ type Options struct {
 // (retrieved from previous inventory objects) but omitted in
 // the current apply. Prune also delete all previous inventory
 // objects. Returns an error if there was a problem.
-func (po *PruneOptions) Prune(localInv *unstructured.Unstructured, localObjs []*unstructured.Unstructured, currentUIDs sets.String,
+func (po *PruneOptions) Prune(localInv inventory.InventoryInfo, localObjs []*unstructured.Unstructured, currentUIDs sets.String,
 	eventChannel chan<- event.Event, o Options) error {
-	invNamespace := strings.TrimSpace(strings.ToLower(localInv.GetNamespace()))
-	klog.V(4).Infof("prune local inventory object: %s/%s", invNamespace, localInv.GetName())
+	if localInv == nil {
+		return fmt.Errorf("the local inventory object can't be nil")
+	}
+	invNamespace := localInv.Namespace()
+	klog.V(4).Infof("prune local inventory object: %s/%s", invNamespace, localInv.Name())
 	// Create the set of namespaces for currently (locally) applied objects, including
 	// the namespace the inventory object lives in (if it's not cluster-scoped). When
 	// pruning, check this set of namespaces to ensure these namespaces are not deleted.
@@ -139,8 +143,8 @@ func (po *PruneOptions) Prune(localInv *unstructured.Unstructured, localObjs []*
 		// currently applied objects.
 		if !po.Destroy {
 			if clusterObj.GroupKind == object.CoreV1Namespace.GroupKind() &&
-				localNamespaces.Has(strings.ToLower(clusterObj.Name)) {
-				klog.V(7).Infof("skip pruning namespace: %s", clusterObj.Name)
+				clusterObj.Name == localInv.Namespace() {
+				klog.V(7).Infof("skip pruning inventory namespace: %s", obj)
 				eventChannel <- createPruneEvent(obj, event.PruneSkipped)
 				continue
 			}

pkg/apply/prune/prune_test.go

@@ -89,15 +89,18 @@ var role = &unstructured.Unstructured{
 
 // Returns a inventory object with the inventory set from
 // the passed "children".
-func createInventoryInfo(children ...*unstructured.Unstructured) *unstructured.Unstructured {
+func createInventoryInfo(children ...*unstructured.Unstructured) inventory.InventoryInfo {
 	inventoryObjCopy := inventoryObj.DeepCopy()
 	wrappedInv := inventory.WrapInventoryObj(inventoryObjCopy)
 	objs := object.UnstructuredsToObjMetas(children)
 	if err := wrappedInv.Store(objs); err != nil {
 		return nil
 	}
-	inventoryInfo, _ := wrappedInv.GetObject()
-	return inventoryInfo
+	obj, err := wrappedInv.GetObject()
+	if err != nil {
+		return nil
+	}
+	return inventory.WrapInventoryInfoObj(obj)
 }
 
 // preventDelete object contains the "on-remove:keep" lifecycle directive.

pkg/apply/solver/solver.go

@@ -30,6 +30,7 @@ import (
 	"sigs.k8s.io/cli-utils/pkg/apply/task"
 	"sigs.k8s.io/cli-utils/pkg/apply/taskrunner"
 	"sigs.k8s.io/cli-utils/pkg/common"
+	"sigs.k8s.io/cli-utils/pkg/inventory"
 	"sigs.k8s.io/cli-utils/pkg/object"
 )
 
@@ -51,7 +52,7 @@ type Options struct {
 
 type resourceObjects interface {
 	ObjsForApply() []*unstructured.Unstructured
-	Inventory() *unstructured.Unstructured
+	Inventory() inventory.InventoryInfo
 	IdsForApply() []object.ObjMetadata
 	IdsForPrune() []object.ObjMetadata
 }