func/cmd/list.go

package cmd

import (
	"encoding/json"
	"encoding/xml"
	"errors"
	"fmt"
	"io"
	"os"
	"text/tabwriter"

	"github.com/ory/viper"
	"github.com/spf13/cobra"
	"gopkg.in/yaml.v2"

	fn "knative.dev/kn-plugin-func"
	"knative.dev/kn-plugin-func/knative"
)

func init() {
	root.AddCommand(NewListCmd(newListClient))
}

func newListClient(cfg listConfig) (*fn.Client, error) {
	// TODO(lkingland): does an empty namespace mean all namespaces
	// or the default namespace as defined in user's config?
	lister, err := knative.NewLister(cfg.Namespace)
	if err != nil {
		return nil, err
	}

	lister.Verbose = cfg.Verbose

	return fn.New(
		fn.WithLister(lister),
		fn.WithVerbose(cfg.Verbose),
	), nil
}

type listClientFn func(listConfig) (*fn.Client, error)

func NewListCmd(clientFn listClientFn) *cobra.Command {
	cmd := &cobra.Command{
		Use:   "list",
		Short: "List functions",
		Long: `List functions

Lists all deployed functions in a given namespace.
`,
		Example: `
# List all functions in the current namespace with human readable output
kn func list

# List all functions in the 'test' namespace with yaml output
kn func list --namespace test --output yaml

# List all functions in all namespaces with JSON output
kn func list --all-namespaces --output json
`,
		SuggestFor: []string{"ls", "lsit"},
		PreRunE:    bindEnv("namespace", "output"),
	}

	cmd.Flags().BoolP("all-namespaces", "A", false, "List functions in all namespaces. If set, the --namespace flag is ignored.")
	cmd.Flags().StringP("output", "o", "human", "Output format (human|plain|json|xml|yaml) (Env: $FUNC_OUTPUT)")
	setNamespaceFlag(cmd)

	if err := cmd.RegisterFlagCompletionFunc("output", CompleteOutputFormatList); err != nil {
		fmt.Println("internal: error while calling RegisterFlagCompletionFunc: ", err)
	}

	cmd.RunE = func(cmd *cobra.Command, args []string) error {
		return runList(cmd, args, clientFn)
	}

	return cmd
}

func runList(cmd *cobra.Command, _ []string, clientFn listClientFn) (err error) {
	config := newListConfig()

	if err := config.Validate(); err != nil {
		return err
	}

	client, err := clientFn(config)
	if err != nil {
		return err
	}

	items, err := client.List(cmd.Context())
	if err != nil {
		return
	}

	if len(items) == 0 {
		// TODO(lkingland): this isn't particularly script friendly.  Suggest this
		// prints bo only on --verbose.  Possible future tweak, as I don't want to
		// make functional changes during a refactor.
		if config.Namespace != "" && !config.AllNamespaces {
			fmt.Printf("No functions found in '%v' namespace\n", config.Namespace)
		} else {
			fmt.Println("No functions found")
		}
		return
	}

	write(os.Stdout, listItems(items), config.Output)

	return
}

// CLI Configuration (parameters)
// ------------------------------

type listConfig struct {
	Namespace     string
	Output        string
	AllNamespaces bool
	Verbose       bool
}

func newListConfig() listConfig {
	return listConfig{
		Namespace:     viper.GetString("namespace"),
		Output:        viper.GetString("output"),
		AllNamespaces: viper.GetBool("all-namespaces"),
		Verbose:       viper.GetBool("verbose"),
	}
}

func (c listConfig) Validate() error {
	if c.Namespace != "" && c.AllNamespaces {
		return errors.New("Both --namespace and --all-namespaces specified.")
	}
	return nil
}

// Output Formatting (serializers)
// -------------------------------

type listItems []fn.ListItem

func (items listItems) Human(w io.Writer) error {
	return items.Plain(w)
}

func (items listItems) Plain(w io.Writer) error {

	// minwidth, tabwidth, padding, padchar, flags
	tabWriter := tabwriter.NewWriter(w, 0, 8, 2, ' ', 0)
	defer tabWriter.Flush()

	fmt.Fprintf(tabWriter, "%s\t%s\t%s\t%s\t%s\n", "NAME", "NAMESPACE", "RUNTIME", "URL", "READY")
	for _, item := range items {
		fmt.Fprintf(tabWriter, "%s\t%s\t%s\t%s\t%s\n", item.Name, item.Namespace, item.Runtime, item.URL, item.Ready)
	}
	return nil
}

func (items listItems) JSON(w io.Writer) error {
	return json.NewEncoder(w).Encode(items)
}

func (items listItems) XML(w io.Writer) error {
	return xml.NewEncoder(w).Encode(items)
}

func (items listItems) YAML(w io.Writer) error {
	return yaml.NewEncoder(w).Encode(items)
}

func (items listItems) URL(w io.Writer) error {
	for _, item := range items {
		fmt.Fprintf(w, "%s\n", item.URL)
	}
	return nil
}