dapr cli list components configuration add namespace flag (#787)

* dapr cli list components configuration add namespace flag

Signed-off-by: meijin <[email protected]>

* fix unit test err

Signed-off-by: meijin <[email protected]>

* add usage example

Signed-off-by: meijin <[email protected]>

* change some annotation

Signed-off-by: meijin <[email protected]>

* fix typo and adjust help guide

Signed-off-by: meijin <[email protected]>

* default all ns and -name shorthand to -N

Signed-off-by: meijin <[email protected]>

* adjust e2e test for output warning msg

Signed-off-by: meijin <[email protected]>

* adjust e2e test for output warning msg

Signed-off-by: meijin <[email protected]>

* adjust e2e test for output warning msg

Signed-off-by: meijin <[email protected]>

* add get all ns components e2e tests

Signed-off-by: meijin <[email protected]>

* add e2e test log

Signed-off-by: meijin <[email protected]>

* add test ns for e2e test

Signed-off-by: meijin <[email protected]>

* in k8s mode -n flag for --name short

Signed-off-by: meijin <[email protected]>

Co-authored-by: Mukundan Sundararajan <[email protected]>

Author: marviniter

cmd/components.go

@@ -20,6 +20,8 @@ import (
 
 	"github.com/dapr/cli/pkg/kubernetes"
 	"github.com/dapr/cli/pkg/print"
+
+	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 var (
@@ -32,7 +34,17 @@ var ComponentsCmd = &cobra.Command{
 	Short: "List all Dapr components. Supported platforms: Kubernetes",
 	Run: func(cmd *cobra.Command, args []string) {
 		if kubernetesMode {
-			err := kubernetes.PrintComponents(componentsName, componentsOutputFormat)
+			print.WarningStatusEvent(os.Stdout, "In future releases, this command will only query the \"default\" namespace by default. Please use the -n (namespace) flag, for specific namespace, or -A (all-namespaces) flag for all namespaces.")
+			if allNamespaces {
+				resourceNamespace = meta_v1.NamespaceAll
+			} else if resourceNamespace == "" {
+				resourceNamespace = meta_v1.NamespaceAll
+				print.WarningStatusEvent(os.Stdout, "From next release(or after 2 releases), behavior can be changed to query only \"default\" namespace.")
+			}
+			if componentsName != "" {
+				print.WarningStatusEvent(os.Stdout, "From next release(or after 2 releases), behavior can be changed to treat it as \"namespace\".")
+			}
+			err := kubernetes.PrintComponents(componentsName, resourceNamespace, componentsOutputFormat)
 			if err != nil {
 				print.FailureStatusEvent(os.Stderr, err.Error())
 				os.Exit(1)
@@ -43,13 +55,24 @@ var ComponentsCmd = &cobra.Command{
 		kubernetes.CheckForCertExpiry()
 	},
 	Example: `
-# List Kubernetes components
+# List all namespace Dapr components in Kubernetes mode
 dapr components -k
+
+# List define namespace Dapr components in Kubernetes mode
+dapr components -k --namespace default
+
+# Print define name Dapr components in Kubernetes mode
+dapr components -k -n target
+
+# List all namespaces Dapr components in Kubernetes mode
+dapr components -k --all-namespaces
 `,
 }
 
 func init() {
+	ComponentsCmd.Flags().BoolVarP(&allNamespaces, "all-namespaces", "A", false, "If true, list all Dapr components in all namespaces")
 	ComponentsCmd.Flags().StringVarP(&componentsName, "name", "n", "", "The components name to be printed (optional)")
+	ComponentsCmd.Flags().StringVarP(&resourceNamespace, "namespace", "", "", "List all namespace components in a Kubernetes cluster")
 	ComponentsCmd.Flags().StringVarP(&componentsOutputFormat, "output", "o", "list", "Output format (options: json or yaml or list)")
 	ComponentsCmd.Flags().BoolVarP(&kubernetesMode, "kubernetes", "k", false, "List all Dapr components in a Kubernetes cluster")
 	ComponentsCmd.Flags().BoolP("help", "h", false, "Print this help message")

cmd/configurations.go

@@ -20,6 +20,8 @@ import (
 
 	"github.com/dapr/cli/pkg/kubernetes"
 	"github.com/dapr/cli/pkg/print"
+
+	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 var (
@@ -32,7 +34,17 @@ var ConfigurationsCmd = &cobra.Command{
 	Short: "List all Dapr configurations. Supported platforms: Kubernetes",
 	Run: func(cmd *cobra.Command, args []string) {
 		if kubernetesMode {
-			err := kubernetes.PrintConfigurations(configurationName, configurationOutputFormat)
+			print.WarningStatusEvent(os.Stdout, "In future releases, this command will only query the \"default\" namespace by default. Please use the -n (namespace) flag, for specific namespace, or -A (all-namespaces) flag for all namespaces.")
+			if allNamespaces {
+				resourceNamespace = meta_v1.NamespaceAll
+			} else if resourceNamespace == "" {
+				resourceNamespace = meta_v1.NamespaceAll
+				print.WarningStatusEvent(os.Stdout, "From next release(or after 2 releases), behavior can be changed to query only \"default\" namespace.")
+			}
+			if configurationName != "" {
+				print.WarningStatusEvent(os.Stdout, "From next release(or after 2 releases), behavior can be changed to treat it as \"namespace\".")
+			}
+			err := kubernetes.PrintConfigurations(configurationName, resourceNamespace, configurationOutputFormat)
 			if err != nil {
 				print.FailureStatusEvent(os.Stderr, err.Error())
 				os.Exit(1)
@@ -43,13 +55,24 @@ var ConfigurationsCmd = &cobra.Command{
 		kubernetes.CheckForCertExpiry()
 	},
 	Example: `
-# List Kubernetes Dapr configurations
+# List all namespace Dapr configurations in Kubernetes mode
 dapr configurations -k
+
+# List define namespace Dapr configurations in Kubernetes mode
+dapr configurations -k --namespace default
+
+# Print define name Dapr configurations in Kubernetes mode
+dapr configurations -k -n target
+
+# List all namespaces Dapr configurations in Kubernetes mode
+dapr configurations -k --all-namespaces
 `,
 }
 
 func init() {
+	ConfigurationsCmd.Flags().BoolVarP(&allNamespaces, "all-namespaces", "A", false, "If true, list all Dapr configurations in all namespaces")
 	ConfigurationsCmd.Flags().StringVarP(&configurationName, "name", "n", "", "The configuration name to be printed (optional)")
+	ConfigurationsCmd.Flags().StringVarP(&resourceNamespace, "namespace", "", "", "List Define namespace configurations in a Kubernetes cluster")
 	ConfigurationsCmd.Flags().StringVarP(&configurationOutputFormat, "output", "o", "list", "Output format (options: json or yaml or list)")
 	ConfigurationsCmd.Flags().BoolVarP(&kubernetesMode, "kubernetes", "k", false, "List all Dapr configurations in a Kubernetes cluster")
 	ConfigurationsCmd.Flags().BoolP("help", "h", false, "Print this help message")

cmd/init.go

@@ -26,17 +26,19 @@ import (
 )
 
 var (
-	kubernetesMode   bool
-	wait             bool
-	timeout          uint
-	slimMode         bool
-	runtimeVersion   string
-	dashboardVersion string
-	initNamespace    string
-	enableMTLS       bool
-	enableHA         bool
-	values           []string
-	fromDir          string
+	kubernetesMode    bool
+	wait              bool
+	timeout           uint
+	slimMode          bool
+	runtimeVersion    string
+	dashboardVersion  string
+	allNamespaces     bool
+	initNamespace     string
+	resourceNamespace string
+	enableMTLS        bool
+	enableHA          bool
+	values            []string
+	fromDir           string
 )
 
 var InitCmd = &cobra.Command{

cmd/list.go

@@ -24,6 +24,8 @@ import (
 	"github.com/dapr/cli/pkg/print"
 	"github.com/dapr/cli/pkg/standalone"
 	"github.com/dapr/cli/utils"
+
+	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 var outputFormat string
@@ -59,8 +61,14 @@ var ListCmd = &cobra.Command{
 # List Dapr instances in self-hosted mode
 dapr list
 
-# List Dapr instances in Kubernetes mode
+# List all namespace Dapr instances in Kubernetes mode
 dapr list -k
+
+# List define namespace Dapr instances in Kubernetes mode
+dapr list -k --namespace default
+
+# List all namespaces Dapr instances in Kubernetes mode
+dapr list -k --all-namespaces
 `,
 	PreRun: func(cmd *cobra.Command, args []string) {
 		if outputFormat != "" && outputFormat != "json" && outputFormat != "yaml" && outputFormat != "table" {
@@ -70,7 +78,15 @@ dapr list -k
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 		if kubernetesMode {
-			list, err := kubernetes.List()
+			print.WarningStatusEvent(os.Stdout, "In future releases, this command will only query the \"default\" namespace by default. Please use the -n (namespace) flag, for specific namespace, or -A (all-namespaces) flag for all namespaces.")
+			if allNamespaces {
+				resourceNamespace = meta_v1.NamespaceAll
+			} else if resourceNamespace == "" {
+				resourceNamespace = meta_v1.NamespaceAll
+				print.WarningStatusEvent(os.Stdout, "From next release(or after 2 releases), behavior can be changed to query only \"default\" namespace.")
+			}
+
+			list, err := kubernetes.List(resourceNamespace)
 			if err != nil {
 				print.FailureStatusEvent(os.Stderr, err.Error())
 				os.Exit(1)
@@ -95,7 +111,9 @@ dapr list -k
 }
 
 func init() {
+	ListCmd.Flags().BoolVarP(&allNamespaces, "all-namespaces", "A", false, "If true, list all Dapr pods in all namespaces")
 	ListCmd.Flags().BoolVarP(&kubernetesMode, "kubernetes", "k", false, "List all Dapr pods in a Kubernetes cluster")
+	ListCmd.Flags().StringVarP(&resourceNamespace, "namespace", "", "", "List define namespace pod in a Kubernetes cluster")
 	ListCmd.Flags().StringVarP(&outputFormat, "output", "o", "", "The output format of the list. Valid values are: json, yaml, or table (default)")
 	ListCmd.Flags().BoolP("help", "h", false, "Print this help message")
 	RootCmd.AddCommand(ListCmd)

pkg/kubernetes/components.go

@@ -16,6 +16,7 @@ package kubernetes
 import (
 	"io"
 	"os"
+	"sort"
 	"strings"
 
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -28,23 +29,24 @@ import (
 
 // ComponentsOutput represent a Dapr component.
 type ComponentsOutput struct {
-	Name    string `csv:"Name"`
-	Type    string `csv:"Type"`
-	Version string `csv:"VERSION"`
-	Scopes  string `csv:"SCOPES"`
-	Created string `csv:"CREATED"`
-	Age     string `csv:"AGE"`
+	Namespace string `csv:"Namespace"`
+	Name      string `csv:"Name"`
+	Type      string `csv:"Type"`
+	Version   string `csv:"VERSION"`
+	Scopes    string `csv:"SCOPES"`
+	Created   string `csv:"CREATED"`
+	Age       string `csv:"AGE"`
 }
 
 // PrintComponents prints all Dapr components.
-func PrintComponents(name, outputFormat string) error {
+func PrintComponents(name, namespace, outputFormat string) error {
 	return writeComponents(os.Stdout, func() (*v1alpha1.ComponentList, error) {
 		client, err := DaprClient()
 		if err != nil {
 			return nil, err
 		}
 
-		list, err := client.ComponentsV1alpha1().Components(meta_v1.NamespaceAll).List(meta_v1.ListOptions{})
+		list, err := client.ComponentsV1alpha1().Components(namespace).List(meta_v1.ListOptions{})
 		// This means that the Dapr Components CRD is not installed and
 		// therefore no component items exist.
 		if apierrors.IsNotFound(err) {
@@ -76,8 +78,9 @@ func writeComponents(writer io.Writer, getConfigFunc func() (*v1alpha1.Component
 		if name == "" || strings.EqualFold(confName, name) {
 			filtered = append(filtered, c)
 			filteredSpecs = append(filteredSpecs, configurationDetailedOutput{
-				Name: confName,
-				Spec: c.Spec,
+				Name:      confName,
+				Namespace: c.GetNamespace(),
+				Spec:      c.Spec,
 			})
 		}
 	}
@@ -86,21 +89,30 @@ func writeComponents(writer io.Writer, getConfigFunc func() (*v1alpha1.Component
 		return printComponentList(writer, filtered)
 	}
 
+	// filteredSpecs sort by namespace.
+	sort.Slice(filteredSpecs, func(i, j int) bool {
+		return filteredSpecs[i].Namespace > filteredSpecs[j].Namespace
+	})
 	return utils.PrintDetail(writer, outputFormat, filteredSpecs)
 }
 
 func printComponentList(writer io.Writer, list []v1alpha1.Component) error {
 	co := []ComponentsOutput{}
 	for _, c := range list {
 		co = append(co, ComponentsOutput{
-			Name:    c.GetName(),
-			Type:    c.Spec.Type,
-			Created: c.CreationTimestamp.Format("2006-01-02 15:04.05"),
-			Age:     age.GetAge(c.CreationTimestamp.Time),
-			Version: c.Spec.Version,
-			Scopes:  strings.Join(c.Scopes, ","),
+			Name:      c.GetName(),
+			Namespace: c.GetNamespace(),
+			Type:      c.Spec.Type,
+			Created:   c.CreationTimestamp.Format("2006-01-02 15:04.05"),
+			Age:       age.GetAge(c.CreationTimestamp.Time),
+			Version:   c.Spec.Version,
+			Scopes:    strings.Join(c.Scopes, ","),
 		})
 	}
 
+	// co sort by namespace.
+	sort.Slice(co, func(i, j int) bool {
+		return co[i].Namespace > co[j].Namespace
+	})
 	return utils.MarshalAndWriteTable(writer, co)
 }

pkg/kubernetes/components_test.go

@@ -40,13 +40,14 @@ func TestComponents(t *testing.T) {
 			name:           "List one config",
 			configName:     "",
 			outputFormat:   "",
-			expectedOutput: "  NAME       TYPE         VERSION  SCOPES  CREATED              AGE  \n  appConfig  state.redis  v1               " + formattedNow + "  0s   \n",
+			expectedOutput: "  NAMESPACE  NAME       TYPE         VERSION  SCOPES  CREATED              AGE  \n  default    appConfig  state.redis  v1               " + formattedNow + "  0s   \n",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
 				{
 					ObjectMeta: meta_v1.ObjectMeta{
 						Name:              "appConfig",
+						Namespace:         "default",
 						CreationTimestamp: now,
 					},
 					Spec: v1alpha1.ComponentSpec{
@@ -69,13 +70,14 @@ func TestComponents(t *testing.T) {
 			name:           "Filters out daprsystem",
 			configName:     "",
 			outputFormat:   "",
-			expectedOutput: "  NAME       TYPE         VERSION  SCOPES  CREATED              AGE  \n  appConfig  state.redis  v1               " + formattedNow + "  0s   \n",
+			expectedOutput: "  NAMESPACE  NAME       TYPE         VERSION  SCOPES  CREATED              AGE  \n  default    appConfig  state.redis  v1               " + formattedNow + "  0s   \n",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
 				{
 					ObjectMeta: meta_v1.ObjectMeta{
 						Name:              "appConfig",
+						Namespace:         "default",
 						CreationTimestamp: now,
 					},
 					Spec: v1alpha1.ComponentSpec{
@@ -96,13 +98,14 @@ func TestComponents(t *testing.T) {
 			name:           "Name does match",
 			configName:     "appConfig",
 			outputFormat:   "list",
-			expectedOutput: "  NAME       TYPE         VERSION  SCOPES  CREATED              AGE  \n  appConfig  state.redis  v1               " + formattedNow + "  0s   \n",
+			expectedOutput: "  NAMESPACE  NAME       TYPE         VERSION  SCOPES  CREATED              AGE  \n  default    appConfig  state.redis  v1               " + formattedNow + "  0s   \n",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
 				{
 					ObjectMeta: meta_v1.ObjectMeta{
 						Name:              "appConfig",
+						Namespace:         "default",
 						CreationTimestamp: now,
 					},
 					Spec: v1alpha1.ComponentSpec{
@@ -116,7 +119,7 @@ func TestComponents(t *testing.T) {
 			name:           "Name does not match",
 			configName:     "appConfig",
 			outputFormat:   "list",
-			expectedOutput: "  NAME  TYPE  VERSION  SCOPES  CREATED  AGE  \n",
+			expectedOutput: "  NAMESPACE  NAME  TYPE  VERSION  SCOPES  CREATED  AGE  \n",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
@@ -136,7 +139,7 @@ func TestComponents(t *testing.T) {
 			name:           "Yaml one config",
 			configName:     "",
 			outputFormat:   "yaml",
-			expectedOutput: "name: appConfig\nspec:\n  type: state.redis\n  version: v1\n  ignoreerrors: false\n  metadata: []\n  inittimeout: \"\"\n",
+			expectedOutput: "name: appConfig\nnamespace: \"\"\nspec:\n  type: state.redis\n  version: v1\n  ignoreerrors: false\n  metadata: []\n  inittimeout: \"\"\n",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
@@ -156,7 +159,7 @@ func TestComponents(t *testing.T) {
 			name:           "Yaml two configs",
 			configName:     "",
 			outputFormat:   "yaml",
-			expectedOutput: "- name: appConfig1\n  spec:\n    type: state.redis\n    version: v1\n    ignoreerrors: false\n    metadata: []\n    inittimeout: \"\"\n- name: appConfig2\n  spec:\n    type: state.redis\n    version: v1\n    ignoreerrors: false\n    metadata: []\n    inittimeout: \"\"\n",
+			expectedOutput: "- name: appConfig1\n  namespace: \"\"\n  spec:\n    type: state.redis\n    version: v1\n    ignoreerrors: false\n    metadata: []\n    inittimeout: \"\"\n- name: appConfig2\n  namespace: \"\"\n  spec:\n    type: state.redis\n    version: v1\n    ignoreerrors: false\n    metadata: []\n    inittimeout: \"\"\n",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
@@ -186,7 +189,7 @@ func TestComponents(t *testing.T) {
 			name:           "Json one config",
 			configName:     "",
 			outputFormat:   "json",
-			expectedOutput: "{\n  \"name\": \"appConfig\",\n  \"spec\": {\n    \"type\": \"state.redis\",\n    \"version\": \"v1\",\n    \"ignoreErrors\": false,\n    \"metadata\": null,\n    \"initTimeout\": \"\"\n  }\n}",
+			expectedOutput: "{\n  \"name\": \"appConfig\",\n  \"namespace\": \"\",\n  \"spec\": {\n    \"type\": \"state.redis\",\n    \"version\": \"v1\",\n    \"ignoreErrors\": false,\n    \"metadata\": null,\n    \"initTimeout\": \"\"\n  }\n}",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{
@@ -206,7 +209,7 @@ func TestComponents(t *testing.T) {
 			name:           "Json two configs",
 			configName:     "",
 			outputFormat:   "json",
-			expectedOutput: "[\n  {\n    \"name\": \"appConfig1\",\n    \"spec\": {\n      \"type\": \"state.redis\",\n      \"version\": \"v1\",\n      \"ignoreErrors\": false,\n      \"metadata\": null,\n      \"initTimeout\": \"\"\n    }\n  },\n  {\n    \"name\": \"appConfig2\",\n    \"spec\": {\n      \"type\": \"state.redis\",\n      \"version\": \"v1\",\n      \"ignoreErrors\": false,\n      \"metadata\": null,\n      \"initTimeout\": \"\"\n    }\n  }\n]",
+			expectedOutput: "[\n  {\n    \"name\": \"appConfig1\",\n    \"namespace\": \"\",\n    \"spec\": {\n      \"type\": \"state.redis\",\n      \"version\": \"v1\",\n      \"ignoreErrors\": false,\n      \"metadata\": null,\n      \"initTimeout\": \"\"\n    }\n  },\n  {\n    \"name\": \"appConfig2\",\n    \"namespace\": \"\",\n    \"spec\": {\n      \"type\": \"state.redis\",\n      \"version\": \"v1\",\n      \"ignoreErrors\": false,\n      \"metadata\": null,\n      \"initTimeout\": \"\"\n    }\n  }\n]",
 			errString:      "",
 			errorExpected:  false,
 			k8sConfig: []v1alpha1.Component{