list.go

/*******************************************************************************
*
* Copyright 2019 SAP SE
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You should have received a copy of the License along with this
* program. If not, you may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*******************************************************************************/

package cmd

import (
	"fmt"
	"github.com/pkg/errors"
	"path/filepath"

	log "github.com/sirupsen/logrus"

	"github.com/gosuri/uitable"
	"github.com/spf13/cobra"
	"github.com/uniknow/helm-outdated/pkg/helm"

	"helm.sh/helm/v3/pkg/cli"
)

var listLongUsage = `
Helm plugin to manage outdated dependencies of a Helm chart.

Examples:
  $ helm outdated list
  $ helm outdated list <chartPath>
`

type listCmd struct {
	//     settings
	maxColumnWidth             uint
	chartPath                  string
	failOnOutdatedDependencies bool
	dependencyFilter           *helm.Filter
}

func newListOutdatedDependenciesCmd() *cobra.Command {
	l := &listCmd{
		dependencyFilter: &helm.Filter{},
		maxColumnWidth:   60,
	}

	cmd := &cobra.Command{
		Use:          "list",
		Long:         listLongUsage,
		SilenceUsage: true,
		RunE: func(cmd *cobra.Command, args []string) error {
			path := "."
			if len(args) > 0 {
				path = args[0]
			}

			path, err := filepath.Abs(path)
			if err != nil {
				return err
			}
			l.chartPath = path

			if debug, err := cmd.Flags().GetBool("debug"); err == nil {
				if debug == true {
					log.SetLevel(log.DebugLevel)
				} else {
					log.SetLevel(log.InfoLevel)
				}
			}

			if maxColumnWidth, err := cmd.Flags().GetUint("max-column-width"); err == nil {
				l.maxColumnWidth = maxColumnWidth
			}

			if repositories, err := cmd.Flags().GetStringSlice("repositories"); err == nil {
				l.dependencyFilter.Repositories = repositories
			}

			if deps, err := cmd.Flags().GetStringSlice("dependencies"); err == nil {
				l.dependencyFilter.DependencyNames = deps
			}

			return l.list()
		},
	}

	addCommonFlags(cmd)
	cmd.Flags().BoolVarP(&l.failOnOutdatedDependencies, "fail-on-outdated-dependencies", "", false, "Fail if any dependency is outdated. (exit code 1)")

	return cmd
}

func (l *listCmd) list() error {
	outdatedDeps, err := helm.ListOutdatedDependencies(l.chartPath, cli.New(), l.dependencyFilter)
	if err != nil {
		return err
	}

	fmt.Println(l.formatResults(outdatedDeps))

	if l.failOnOutdatedDependencies && len(outdatedDeps) > 0 {
		return errors.New("dependencies are outdated")
	}

	return nil
}

func (l *listCmd) formatResults(results []*helm.Result) string {
	if len(results) == 0 {
		return "All charts up to date."
	}
	table := uitable.New()
	table.MaxColWidth = l.maxColumnWidth
	table.AddRow("The following dependencies are outdated:")
	table.AddRow("ALIAS", "VERSION", "LATEST_VERSION", "REPOSITORY")
	for _, r := range results {
		name := r.Alias
		if name == "" {
			name = r.Name
		}
		table.AddRow(name, r.Version, r.LatestVersion, r.Repository)
	}
	return table.String()
}