Merge pull request #316 from Liujingfang1/preprocess

add preprocess function in commands

Author: k8s-ci-robot

cmd/apply/cmdapply.go

@@ -18,6 +18,7 @@ import (
 	"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"
 )
@@ -70,11 +71,12 @@ func ApplyCommand(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cob
 }
 
 type ApplyRunner struct {
-	Command   *cobra.Command
-	ioStreams genericclioptions.IOStreams
-	Applier   *apply.Applier
-	provider  provider.Provider
-	loader    manifestreader.ManifestLoader
+	Command    *cobra.Command
+	PreProcess func(info inventory.InventoryInfo, strategy common.DryRunStrategy) (inventory.InventoryPolicy, error)
+	ioStreams  genericclioptions.IOStreams
+	Applier    *apply.Applier
+	provider   provider.Provider
+	loader     manifestreader.ManifestLoader
 
 	serverSideOptions      common.ServerSideOptions
 	output                 string
@@ -125,6 +127,13 @@ func (r *ApplyRunner) RunE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if r.PreProcess != nil {
+		inventoryPolicy, err = r.PreProcess(inv, common.DryRunNone)
+		if err != nil {
+			return err
+		}
+	}
+
 	// Run the applier. It will return a channel where we can receive updates
 	// to keep track of progress and any issues.
 	if err := r.Applier.Initialize(); err != nil {

cmd/destroy/cmddestroy.go

@@ -14,6 +14,8 @@ import (
 	"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"
 )
@@ -52,11 +54,12 @@ func DestroyCommand(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *c
 
 // DestroyRunner encapsulates data necessary to run the destroy command.
 type DestroyRunner struct {
-	Command   *cobra.Command
-	ioStreams genericclioptions.IOStreams
-	Destroyer *apply.Destroyer
-	provider  provider.Provider
-	loader    manifestreader.ManifestLoader
+	Command    *cobra.Command
+	PreProcess func(info inventory.InventoryInfo, strategy common.DryRunStrategy) (inventory.InventoryPolicy, error)
+	ioStreams  genericclioptions.IOStreams
+	Destroyer  *apply.Destroyer
+	provider   provider.Provider
+	loader     manifestreader.ManifestLoader
 
 	output          string
 	inventoryPolicy string
@@ -82,6 +85,13 @@ func (r *DestroyRunner) RunE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if r.PreProcess != nil {
+		inventoryPolicy, err = r.PreProcess(inv, r.Destroyer.DryRunStrategy)
+		if err != nil {
+			return err
+		}
+	}
+
 	// Run the destroyer. It will return a channel where we can receive updates
 	// to keep track of progress and any issues.
 	err = r.Destroyer.Initialize()

cmd/flagutils/utils_test.go

@@ -0,0 +1,48 @@
+// Copyright 2021 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package flagutils
+
+import (
+	"fmt"
+	"testing"
+
+	"sigs.k8s.io/cli-utils/pkg/inventory"
+)
+
+func TestConvertInventoryPolicy(t *testing.T) {
+	testcases := []struct {
+		value  string
+		policy inventory.InventoryPolicy
+		err    error
+	}{
+		{
+			value:  "strict",
+			policy: inventory.InventoryPolicyMustMatch,
+		},
+		{
+			value:  "adopt",
+			policy: inventory.AdoptIfNoInventory,
+		},
+		{
+			value: "random",
+			err:   fmt.Errorf("inventory policy must be one of strict, adopt"),
+		},
+	}
+	for _, tc := range testcases {
+		t.Run(tc.value, func(t *testing.T) {
+			policy, err := ConvertInventoryPolicy(tc.value)
+			if tc.err == nil {
+				if err != nil {
+					t.Errorf("unexpected error %v", err)
+				}
+				if policy != tc.policy {
+					t.Errorf("expected %v but got %v", policy, tc.policy)
+				}
+			}
+			if err == nil && tc.err != nil {
+				t.Errorf("expected an error, but not happened")
+			}
+		})
+	}
+}

cmd/preview/cmdpreview.go

@@ -12,11 +12,13 @@ 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"
 )
@@ -70,12 +72,13 @@ func PreviewCommand(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *c
 
 // PreviewRunner encapsulates data necessary to run the preview command.
 type PreviewRunner struct {
-	Command   *cobra.Command
-	ioStreams genericclioptions.IOStreams
-	Applier   *apply.Applier
-	Destroyer *apply.Destroyer
-	provider  provider.Provider
-	loader    manifestreader.ManifestLoader
+	Command    *cobra.Command
+	PreProcess func(info inventory.InventoryInfo, strategy common.DryRunStrategy) (inventory.InventoryPolicy, error)
+	ioStreams  genericclioptions.IOStreams
+	Applier    *apply.Applier
+	Destroyer  *apply.Destroyer
+	provider   provider.Provider
+	loader     manifestreader.ManifestLoader
 
 	serverSideOptions common.ServerSideOptions
 	output            string
@@ -114,6 +117,13 @@ func (r *PreviewRunner) RunE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if r.PreProcess != nil {
+		inventoryPolicy, err = r.PreProcess(inv, drs)
+		if err != nil {
+			return err
+		}
+	}
+
 	// if destroy flag is set in preview, transmit it to destroyer DryRunStrategy flag
 	// and pivot execution to destroy with dry-run
 	if !r.Destroyer.DryRunStrategy.ClientOrServerDryRun() {

pkg/inventory/fake-inventory-client.go

@@ -85,3 +85,7 @@ func (fic *FakeInventoryClient) ClearError() {
 func (fic *FakeInventoryClient) GetClusterInventoryInfo(inv InventoryInfo) (*unstructured.Unstructured, error) {
 	return nil, nil
 }
+
+func (fic *FakeInventoryClient) UpdateLabels(inv InventoryInfo, labels map[string]string) error {
+	return nil
+}

pkg/inventory/inventory-client.go

@@ -44,6 +44,8 @@ type InventoryClient interface {
 	ApplyInventoryNamespace(invNamespace *unstructured.Unstructured) error
 	// GetClusterInventoryInfo returns the cluster inventory object.
 	GetClusterInventoryInfo(inv InventoryInfo) (*unstructured.Unstructured, error)
+	// UpdateLabels updates the labels of the cluster inventory object if it exists.
+	UpdateLabels(InventoryInfo, map[string]string) error
 }
 
 // ClusterInventoryClient is a concrete implementation of the
@@ -270,6 +272,18 @@ func (cic *ClusterInventoryClient) GetClusterInventoryInfo(inv InventoryInfo) (*
 	return clusterInv, nil
 }
 
+func (cic *ClusterInventoryClient) UpdateLabels(inv InventoryInfo, labels map[string]string) error {
+	obj, err := cic.GetClusterInventoryInfo(inv)
+	if err != nil {
+		if apierrors.IsNotFound(err) {
+			return nil
+		}
+		return err
+	}
+	obj.SetLabels(labels)
+	return cic.applyInventoryObj(obj)
+}
+
 // mergeClusterInventory merges the inventory of multiple inventory objects
 // into one inventory object, and applies it. Deletes the remaining unnecessary
 // inventory objects. There should be only one inventory object stored in the