github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/cli/cmd/cluster/list.go

/*
Copyright (C) 2022-2023 ApeCloud Co., Ltd

This file is part of KubeBlocks project

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package cluster

import (
	"fmt"

	"github.com/spf13/cobra"
	"k8s.io/cli-runtime/pkg/genericiooptions"
	"k8s.io/client-go/dynamic"
	"k8s.io/client-go/kubernetes"
	cmdutil "k8s.io/kubectl/pkg/cmd/util"
	"k8s.io/kubectl/pkg/util/templates"

	"github.com/1aal/kubeblocks/pkg/cli/cluster"
	"github.com/1aal/kubeblocks/pkg/cli/list"
	"github.com/1aal/kubeblocks/pkg/cli/printer"
	"github.com/1aal/kubeblocks/pkg/cli/types"
	"github.com/1aal/kubeblocks/pkg/cli/util"
)

var (
	listExample = templates.Examples(`
		# list all clusters
		kbcli cluster list

		# list a single cluster with specified name
		kbcli cluster list mycluster

		# list a single cluster in YAML output format
		kbcli cluster list mycluster -o yaml

		# list a single cluster in JSON output format
		kbcli cluster list mycluster -o json

		# list a single cluster in wide output format
		kbcli cluster list mycluster -o wide`)

	listInstancesExample = templates.Examples(`
		# list all instances of all clusters in current namespace
		kbcli cluster list-instances

		# list all instances of a specified cluster
		kbcli cluster list-instances mycluster`)

	listComponentsExample = templates.Examples(`
		# list all components of all clusters in current namespace
		kbcli cluster list-components

		# list all components of a specified cluster
		kbcli cluster list-components mycluster`)

	listEventsExample = templates.Examples(`
		# list all events of all clusters in current namespace
		kbcli cluster list-events

		# list all events of a specified cluster
		kbcli cluster list-events mycluster`)
)

func NewListCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command {
	o := list.NewListOptions(f, streams, types.ClusterGVR())
	cmd := &cobra.Command{
		Use:               "list [NAME]",
		Short:             "List clusters.",
		Example:           listExample,
		Aliases:           []string{"ls"},
		ValidArgsFunction: util.ResourceNameCompletionFunc(f, o.GVR),
		Run: func(cmd *cobra.Command, args []string) {
			o.Names = args
			if o.Format == printer.Wide {
				util.CheckErr(run(o, cluster.PrintWide))
			} else {
				util.CheckErr(run(o, cluster.PrintClusters))
			}
		},
	}
	o.AddFlags(cmd)
	return cmd
}

func NewListInstancesCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command {
	o := list.NewListOptions(f, streams, types.ClusterGVR())
	cmd := &cobra.Command{
		Use:               "list-instances",
		Short:             "List cluster instances.",
		Example:           listInstancesExample,
		Aliases:           []string{"ls-instances"},
		ValidArgsFunction: util.ResourceNameCompletionFunc(f, o.GVR),
		Run: func(cmd *cobra.Command, args []string) {
			o.Names = args
			util.CheckErr(run(o, cluster.PrintInstances))
		},
	}
	cmd.Flags().BoolVarP(&o.AllNamespaces, "all-namespaces", "A", o.AllNamespaces, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.")
	cmd.Flags().StringVarP(&o.LabelSelector, "selector", "l", o.LabelSelector, "Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.")
	return cmd
}

func NewListComponentsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command {
	o := list.NewListOptions(f, streams, types.ClusterGVR())
	cmd := &cobra.Command{
		Use:               "list-components",
		Short:             "List cluster components.",
		Example:           listComponentsExample,
		Aliases:           []string{"ls-components"},
		ValidArgsFunction: util.ResourceNameCompletionFunc(f, o.GVR),
		Run: func(cmd *cobra.Command, args []string) {
			o.Names = args
			util.CheckErr(run(o, cluster.PrintComponents))
		},
	}
	cmd.Flags().BoolVarP(&o.AllNamespaces, "all-namespaces", "A", o.AllNamespaces, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.")
	cmd.Flags().StringVarP(&o.LabelSelector, "selector", "l", o.LabelSelector, "Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.")
	return cmd
}

func NewListEventsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command {
	o := list.NewListOptions(f, streams, types.ClusterGVR())
	cmd := &cobra.Command{
		Use:               "list-events",
		Short:             "List cluster events.",
		Example:           listEventsExample,
		Aliases:           []string{"ls-events"},
		ValidArgsFunction: util.ResourceNameCompletionFunc(f, o.GVR),
		Run: func(cmd *cobra.Command, args []string) {
			o.Names = args
			util.CheckErr(run(o, cluster.PrintEvents))
		},
	}
	cmd.Flags().BoolVarP(&o.AllNamespaces, "all-namespaces", "A", o.AllNamespaces, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.")
	cmd.Flags().StringVarP(&o.LabelSelector, "selector", "l", o.LabelSelector, "Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.")
	return cmd
}

func run(o *list.ListOptions, printType cluster.PrintType) error {
	// if format is JSON or YAML, use default printer to output the result.
	if o.Format == printer.JSON || o.Format == printer.YAML {
		_, err := o.Run()
		return err
	}

	// get and output the result
	o.Print = false
	r, err := o.Run()
	if err != nil {
		return err
	}

	infos, err := r.Infos()
	if err != nil {
		return err
	}

	if len(infos) == 0 {
		fmt.Fprintln(o.IOStreams.Out, "No cluster found")
		return nil
	}

	dynamic, err := o.Factory.DynamicClient()
	if err != nil {
		return err
	}

	client, err := o.Factory.KubernetesClientSet()
	if err != nil {
		return err
	}

	opt := &cluster.PrinterOptions{
		ShowLabels: o.ShowLabels,
	}

	p := cluster.NewPrinter(o.IOStreams.Out, printType, opt)
	for _, info := range infos {
		if err = addRow(dynamic, client, info.Namespace, info.Name, p); err != nil {
			return err
		}
	}
	p.Print()
	return nil
}

func addRow(dynamic dynamic.Interface, client *kubernetes.Clientset,
	namespace string, name string, printer *cluster.Printer) error {
	getter := &cluster.ObjectsGetter{
		Name:       name,
		Namespace:  namespace,
		Client:     client,
		Dynamic:    dynamic,
		GetOptions: printer.GetterOptions(),
	}

	clusterObjs, err := getter.Get()
	if err != nil {
		return err
	}

	printer.AddRow(clusterObjs)
	return nil
}