add apply/preview/destroy flag: inventory-policy

Author: Liujingfang1

cmd/apply/cmdapply.go

@@ -14,10 +14,10 @@ import (
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	"k8s.io/kubectl/pkg/util/i18n"
+	"sigs.k8s.io/cli-utils/cmd/flagutils"
 	"sigs.k8s.io/cli-utils/cmd/printers"
 	"sigs.k8s.io/cli-utils/pkg/apply"
 	"sigs.k8s.io/cli-utils/pkg/common"
-	"sigs.k8s.io/cli-utils/pkg/inventory"
 	"sigs.k8s.io/cli-utils/pkg/manifestreader"
 	"sigs.k8s.io/cli-utils/pkg/provider"
 )
@@ -55,6 +55,9 @@ func GetApplyRunner(provider provider.Provider, loader manifestreader.ManifestLo
 		"Background", "Propagation policy for pruning")
 	cmd.Flags().DurationVar(&r.pruneTimeout, "prune-timeout", time.Duration(0),
 		"Timeout threshold for waiting for all pruned resources to be deleted")
+	cmd.Flags().StringVar(&r.inventoryPolicy, "inventory-policy", "strict",
+		"It determines the behavior when the resources don't belong to current inventory. Available options "+
+			"\"strict\" and \"adopt\".")
 
 	r.Command = cmd
 	return r
@@ -80,13 +83,18 @@ type ApplyRunner struct {
 	noPrune                bool
 	prunePropagationPolicy string
 	pruneTimeout           time.Duration
+	inventoryPolicy        string
 }
 
 func (r *ApplyRunner) RunE(cmd *cobra.Command, args []string) error {
 	prunePropPolicy, err := convertPropagationPolicy(r.prunePropagationPolicy)
 	if err != nil {
 		return err
 	}
+	inventoryPolicy, err := flagutils.ConvertInventoryPolicy(r.inventoryPolicy)
+	if err != nil {
+		return err
+	}
 
 	// Only emit status events if we are waiting for status.
 	//TODO: This is not the right way to do this. There are situations where
@@ -133,7 +141,7 @@ func (r *ApplyRunner) RunE(cmd *cobra.Command, args []string) error {
 		DryRunStrategy:         common.DryRunNone,
 		PrunePropagationPolicy: prunePropPolicy,
 		PruneTimeout:           r.pruneTimeout,
-		InventoryPolicy:        inventory.AdoptIfNoInventory,
+		InventoryPolicy:        inventoryPolicy,
 	})
 
 	// The printer will print updates from the channel. It will block

cmd/destroy/cmddestroy.go

@@ -11,6 +11,7 @@ import (
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	"k8s.io/kubectl/pkg/util/i18n"
+	"sigs.k8s.io/cli-utils/cmd/flagutils"
 	"sigs.k8s.io/cli-utils/cmd/printers"
 	"sigs.k8s.io/cli-utils/pkg/apply"
 	"sigs.k8s.io/cli-utils/pkg/manifestreader"
@@ -34,6 +35,9 @@ func GetDestroyRunner(provider provider.Provider, loader manifestreader.Manifest
 
 	cmd.Flags().StringVar(&r.output, "output", printers.DefaultPrinter(),
 		fmt.Sprintf("Output format, must be one of %s", strings.Join(printers.SupportedPrinters(), ",")))
+	cmd.Flags().StringVar(&r.inventoryPolicy, "inventory-policy", "strict",
+		"It determines the behavior when the resources don't belong to current inventory. Available options "+
+			"\"strict\" and \"adopt\".")
 
 	r.Command = cmd
 	return r
@@ -54,10 +58,16 @@ type DestroyRunner struct {
 	provider  provider.Provider
 	loader    manifestreader.ManifestLoader
 
-	output string
+	output          string
+	inventoryPolicy string
 }
 
 func (r *DestroyRunner) RunE(cmd *cobra.Command, args []string) error {
+	inventoryPolicy, err := flagutils.ConvertInventoryPolicy(r.inventoryPolicy)
+	if err != nil {
+		return err
+	}
+
 	// Retrieve the inventory object.
 	reader, err := r.loader.ManifestReader(cmd.InOrStdin(), args)
 	if err != nil {
@@ -78,7 +88,10 @@ func (r *DestroyRunner) RunE(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	ch := r.Destroyer.Run(inv)
+	option := &apply.DestroyerOption{
+		InventoryPolicy: inventoryPolicy,
+	}
+	ch := r.Destroyer.Run(inv, option)
 
 	// The printer will print updates from the channel. It will block
 	// until the channel is closed.

cmd/flagutils/utils.go

@@ -0,0 +1,22 @@
+// Copyright 2021 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package flagutils
+
+import (
+	"fmt"
+
+	"sigs.k8s.io/cli-utils/pkg/inventory"
+)
+
+func ConvertInventoryPolicy(policy string) (inventory.InventoryPolicy, error) {
+	switch policy {
+	case "strict":
+		return inventory.InventoryPolicyMustMatch, nil
+	case "adopt":
+		return inventory.AdoptIfNoInventory, nil
+	default:
+		return inventory.InventoryPolicyMustMatch, fmt.Errorf(
+			"inventory policy must be one of strict, adopt")
+	}
+}

cmd/preview/cmdpreview.go

@@ -12,11 +12,11 @@ import (
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	cmdutil "k8s.io/kubectl/pkg/cmd/util"
 	"k8s.io/kubectl/pkg/util/i18n"
+	"sigs.k8s.io/cli-utils/cmd/flagutils"
 	"sigs.k8s.io/cli-utils/cmd/printers"
 	"sigs.k8s.io/cli-utils/pkg/apply"
 	"sigs.k8s.io/cli-utils/pkg/apply/event"
 	"sigs.k8s.io/cli-utils/pkg/common"
-	"sigs.k8s.io/cli-utils/pkg/inventory"
 	"sigs.k8s.io/cli-utils/pkg/manifestreader"
 	"sigs.k8s.io/cli-utils/pkg/provider"
 )
@@ -53,6 +53,9 @@ func GetPreviewRunner(provider provider.Provider, loader manifestreader.Manifest
 	cmd.Flags().BoolVar(&previewDestroy, "destroy", previewDestroy, "If true, preview of destroy operations will be displayed.")
 	cmd.Flags().StringVar(&r.output, "output", printers.DefaultPrinter(),
 		fmt.Sprintf("Output format, must be one of %s", strings.Join(printers.SupportedPrinters(), ",")))
+	cmd.Flags().StringVar(&r.inventoryPolicy, "inventory-policy", "strict",
+		"It determines the behavior when the resources don't belong to current inventory. Available options "+
+			"\"strict\" and \"adopt\".")
 
 	r.Command = cmd
 	return r
@@ -76,6 +79,7 @@ type PreviewRunner struct {
 
 	serverSideOptions common.ServerSideOptions
 	output            string
+	inventoryPolicy   string
 }
 
 // RunE is the function run from the cobra command.
@@ -91,6 +95,11 @@ func (r *PreviewRunner) RunE(cmd *cobra.Command, args []string) error {
 		r.Destroyer.DryRunStrategy = drs
 	}
 
+	inventoryPolicy, err := flagutils.ConvertInventoryPolicy(r.inventoryPolicy)
+	if err != nil {
+		return err
+	}
+
 	reader, err := r.loader.ManifestReader(cmd.InOrStdin(), args)
 	if err != nil {
 		return err
@@ -128,14 +137,17 @@ func (r *PreviewRunner) RunE(cmd *cobra.Command, args []string) error {
 			NoPrune:           noPrune,
 			DryRunStrategy:    drs,
 			ServerSideOptions: r.serverSideOptions,
-			InventoryPolicy:   inventory.AdoptIfNoInventory,
+			InventoryPolicy:   inventoryPolicy,
 		})
 	} else {
 		err = r.Destroyer.Initialize()
 		if err != nil {
 			return err
 		}
-		ch = r.Destroyer.Run(inv)
+		option := &apply.DestroyerOption{
+			InventoryPolicy: inventoryPolicy,
+		}
+		ch = r.Destroyer.Run(inv, option)
 	}
 
 	// The printer will print updates from the channel. It will block

pkg/apply/destroyer.go

@@ -39,6 +39,10 @@ type Destroyer struct {
 	DryRunStrategy common.DryRunStrategy
 }
 
+type DestroyerOption struct {
+	InventoryPolicy inventory.InventoryPolicy
+}
+
 // Initialize sets up the Destroyer for actually doing an destroy against
 // a cluster. This involves validating command line inputs and configuring
 // clients for communicating with the cluster.
@@ -59,7 +63,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 inventory.InventoryInfo) <-chan event.Event {
+func (d *Destroyer) Run(inv inventory.InventoryInfo, option *DestroyerOption) <-chan event.Event {
 	ch := make(chan event.Event)
 
 	go func() {
@@ -75,6 +79,7 @@ func (d *Destroyer) Run(inv inventory.InventoryInfo) <-chan event.Event {
 		err := d.PruneOptions.Prune(inv, nil, sets.NewString(), taskContext, prune.Options{
 			DryRunStrategy:    d.DryRunStrategy,
 			PropagationPolicy: metav1.DeletePropagationBackground,
+			InventoryPolicy:   option.InventoryPolicy,
 		})
 		if err != nil {
 			ch <- event.Event{

pkg/inventory/fake-inventory-client.go

@@ -81,3 +81,7 @@ func (fic *FakeInventoryClient) SetError(err error) {
 func (fic *FakeInventoryClient) ClearError() {
 	fic.Err = nil
 }
+
+func (fic *FakeInventoryClient) GetClusterInventoryInfo(inv InventoryInfo) (*unstructured.Unstructured, error) {
+	return nil, nil
+}

pkg/inventory/inventory-client.go

@@ -42,6 +42,8 @@ type InventoryClient interface {
 	SetDryRunStrategy(drs common.DryRunStrategy)
 	// ApplyInventoryNamespace applies the Namespace that the inventory object should be in.
 	ApplyInventoryNamespace(invNamespace *unstructured.Unstructured) error
+	// GetClusterInventoryInfo returns the cluster inventory object.
+	GetClusterInventoryInfo(inv InventoryInfo) (*unstructured.Unstructured, error)
 }
 
 // ClusterInventoryClient is a concrete implementation of the
@@ -97,7 +99,7 @@ func NewInventoryClient(factory cmdutil.Factory,
 func (cic *ClusterInventoryClient) Merge(localInv InventoryInfo, objs []object.ObjMetadata) ([]object.ObjMetadata, error) {
 	pruneIds := []object.ObjMetadata{}
 	invObj := cic.invToUnstructuredFunc(localInv)
-	clusterInv, err := cic.getClusterInventoryInfo(invObj)
+	clusterInv, err := cic.GetClusterInventoryInfo(localInv)
 	if err != nil {
 		return pruneIds, err
 	}
@@ -164,7 +166,7 @@ func (cic *ClusterInventoryClient) Replace(localInv InventoryInfo, objs []object
 		klog.V(4).Infof("applied objects same as cluster inventory: do nothing")
 		return nil
 	}
-	clusterInv, err := cic.getClusterInventoryInfo(cic.invToUnstructuredFunc(localInv))
+	clusterInv, err := cic.GetClusterInventoryInfo(localInv)
 	if err != nil {
 		return err
 	}
@@ -202,8 +204,7 @@ func (cic *ClusterInventoryClient) DeleteInventoryObj(localInv InventoryInfo) er
 // an error if one occurred.
 func (cic *ClusterInventoryClient) GetClusterObjs(localInv InventoryInfo) ([]object.ObjMetadata, error) {
 	var objs []object.ObjMetadata
-	invObj := cic.invToUnstructuredFunc(localInv)
-	clusterInv, err := cic.getClusterInventoryInfo(invObj)
+	clusterInv, err := cic.GetClusterInventoryInfo(localInv)
 	if err != nil {
 		return objs, err
 	}
@@ -224,7 +225,8 @@ func (cic *ClusterInventoryClient) GetClusterObjs(localInv InventoryInfo) ([]obj
 //
 // TODO(seans3): Remove the special case code to merge multiple cluster inventory
 // objects once we've determined that this case is no longer possible.
-func (cic *ClusterInventoryClient) getClusterInventoryInfo(localInv *unstructured.Unstructured) (*unstructured.Unstructured, error) {
+func (cic *ClusterInventoryClient) GetClusterInventoryInfo(inv InventoryInfo) (*unstructured.Unstructured, error) {
+	localInv := cic.invToUnstructuredFunc(inv)
 	if localInv == nil {
 		return nil, fmt.Errorf("retrieving cluster inventory object with nil local inventory")
 	}

pkg/inventory/inventory-client_test.go

@@ -66,7 +66,7 @@ func TestGetClusterInventoryInfo(t *testing.T) {
 			if tc.inv != nil {
 				inv = storeObjsInInventory(tc.inv, tc.localObjs)
 			}
-			clusterInv, err := invClient.getClusterInventoryInfo(inv)
+			clusterInv, err := invClient.GetClusterInventoryInfo(WrapInventoryInfoObj(inv))
 			if tc.isError {
 				if err == nil {
 					t.Fatalf("expected error but received none")

test/e2e/apply_and_destroy_test.go

@@ -12,6 +12,7 @@ import (
 	"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/controller-runtime/pkg/client"
 )
 
@@ -57,7 +58,8 @@ func applyAndDestroyTest(c client.Client, invConfig InventoryConfig, inventoryNa
 	By("Destroy resources")
 	destroyer := invConfig.DestroyerFactoryFunc()
 
-	destroyerEvents := runCollectNoErr(destroyer.Run(inv))
+	option := &apply.DestroyerOption{InventoryPolicy: inventory.AdoptIfNoInventory}
+	destroyerEvents := runCollectNoErr(destroyer.Run(inv, option))
 	err = verifyEvents([]expEvent{
 		{
 			eventType: event.DeleteType,

test/e2e/continue_on_error_test.go

@@ -13,6 +13,7 @@ import (
 	"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/object"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
@@ -68,7 +69,8 @@ func continueOnErrorTest(_ client.Client, invConfig InventoryConfig, inventoryNa
 
 	By("destroy the resources")
 	destroyer := invConfig.DestroyerFactoryFunc()
-	destroyerEvents := runCollectNoErr(destroyer.Run(inv))
+	option := &apply.DestroyerOption{InventoryPolicy: inventory.AdoptIfNoInventory}
+	destroyerEvents := runCollectNoErr(destroyer.Run(inv, option))
 	err = verifyEvents([]expEvent{
 		{
 			eventType: event.DeleteType,