root.go

/*
Copyright © 2023 FairwindsOps, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
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"
	"os"
	"strings"

	tea "github.com/charmbracelet/bubbletea"
	"github.com/spf13/cobra"
	"github.com/spf13/pflag"
	"github.com/spf13/viper"
	"go.uber.org/zap"

	"github.com/fairwindsops/bif"
)

var (
	version       string
	versionCommit string
	cfgFile       string
	insightsURL   string
	debug         bool

	// interactive enables the interactive pager
	interactive bool

	bifClient bif.Client
)

func init() {
	cobra.OnInitialize(initConfig)

	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.bif.yaml)")
	rootCmd.PersistentFlags().BoolVar(&debug, "debug", false, "If true, debug logging will be enabled")

	findCmd.PersistentFlags().StringVarP(&bifClient.Token, "insights-oss-token", "t", "", "Your Fairwinds OSS Token")
	findCmd.PersistentFlags().StringVar(&bifClient.APIURL, "bif-url", "https://bif-server-6biex2p5nq-uc.a.run.app", "The URL of the BIF server.")
	findCmd.PersistentFlags().StringVarP(&bifClient.OutputFormat, "output", "o", "table", fmt.Sprintf("The output format to use. Must be one of %v", bif.OutputFormats))
	findCmd.PersistentFlags().BoolVar(&bifClient.ColorizeOutput, "color", true, "If true, table output will be colorized")
	findCmd.PersistentFlags().StringSliceVarP(&bifClient.ImageLayers, "image-layers", "l", nil, "A list of image layers to send. Mutually exclusive with --image")
	findCmd.PersistentFlags().StringVarP(&bifClient.Image, "image", "i", "", "An image reference in the form of <repository>:<tag>. Must be a publicly-available image. Mutually exclusive with --image-layers")
	findCmd.PersistentFlags().StringVar(&bifClient.SortBy, "sort-by", "Severity", fmt.Sprintf("What to sort the table output by. Must be one of %v", bif.SortColumns))
	findCmd.PersistentFlags().StringVar(&bifClient.SortOrder, "sort-order", "desc", fmt.Sprintf("Sort order for table output. Must be one of %v", bif.SortOrder))
	findCmd.PersistentFlags().BoolVar(&interactive, "interactive", false, "If true, uses the interactive pager")

	requestTokenCmd.PersistentFlags().StringVar(&insightsURL, "insights-url", "https://insights.fairwinds.com", "The Insights API URL")

	rootCmd.AddCommand(findCmd)
	rootCmd.AddCommand(requestTokenCmd)
}

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
	Use:   "bif",
	Short: "The Fairwinds Base Image Finder (BIF) Client",
	Long:  ``,
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		logConfig := &zap.Config{
			Encoding:         "json",
			EncoderConfig:    encoderConfig,
			OutputPaths:      []string{"stderr"},
			ErrorOutputPaths: []string{"stderr"},
			Level:            zap.NewAtomicLevelAt(zap.InfoLevel),
		}

		if debug {
			logConfig.Level = zap.NewAtomicLevelAt(zap.DebugLevel)
		}
		logger, err := logConfig.Build(zap.AddStacktrace(zap.DPanicLevel))
		if err != nil {
			fmt.Fprintln(os.Stderr, "Failed to initialize logger.")
			os.Exit(1)
		}
		bifClient.Logger = logger.Sugar()
	},
	RunE: func(cmd *cobra.Command, args []string) error {
		return fmt.Errorf("You must specify a sub-command.")
	},
}

var findCmd = &cobra.Command{
	Use:   "find [ --image-layers | --image ]",
	Short: "Given either an image or a list of layers, finds the base image and any known vulnerabilities",
	PreRunE: func(cmd *cobra.Command, args []string) error {
		if bifClient.Token == "" {
			return fmt.Errorf("You must supply a token via the --insights-oss-token flag.")
		}
		return bifClient.ValidateOptions()
	},
	Run: func(cmd *cobra.Command, args []string) {
		output, err := bifClient.GetBaseImageOutput()
		if err != nil {
			fmt.Fprintln(os.Stderr, "error getting base image:", err.Error())
			os.Exit(1)
		}

		if interactive {
			p := tea.NewProgram(
				model{content: string(output)},
				tea.WithAltScreen(),       // use the full size of the terminal in its "alternate screen buffer"
				tea.WithMouseCellMotion(), // turn on mouse support so we can track the mouse wheel
			)

			if _, err := p.Run(); err != nil {
				bifClient.Logger.Fatalf("could not run program", "error", err)
				os.Exit(1)
			}
		} else {
			fmt.Println(output)
		}
	},
}

var requestTokenCmd = &cobra.Command{
	Use:   "request-token",
	Short: "Requests an API token for BIF",
	Run: func(cmd *cobra.Command, args []string) {
		if err := requestInsightsOSSToken(); err != nil {
			fmt.Println("error requesting token: " + err.Error())
			os.Exit(1)
		}
	},
}

// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute(VERSION, COMMIT string) {
	version = VERSION
	versionCommit = COMMIT

	err := rootCmd.Execute()
	if err != nil {
		os.Exit(1)
	}
}

// initConfig reads in config file and ENV variables if set.
func initConfig() {
	if cfgFile != "" {
		viper.SetConfigFile(cfgFile)
	} else {
		home, err := os.UserHomeDir()
		cobra.CheckErr(err)

		viper.AddConfigPath(home)
		viper.SetConfigType("yaml")
		viper.SetConfigName(".bif")
	}

	if err := viper.ReadInConfig(); err == nil {
		fmt.Fprintln(os.Stderr, "Using config file:", viper.ConfigFileUsed())
	}

	bindFlags(rootCmd, viper.GetViper())
	bindFlags(findCmd, viper.GetViper())
	bindFlags(requestTokenCmd, viper.GetViper())
}

// bindFlags binds the flags to the viper config, as well as to environment variables
func bindFlags(cmd *cobra.Command, v *viper.Viper) {
	cmd.Flags().VisitAll(func(f *pflag.Flag) {
		envVar := strings.ToUpper(strings.ReplaceAll(f.Name, "-", "_"))
		err := v.BindEnv(f.Name, envVar)
		if err != nil {
			fmt.Printf("error parsing flag %s\n", f.Name)
			os.Exit(1)
		}

		if !f.Changed && v.IsSet(f.Name) {
			val := v.Get(f.Name)
			err := cmd.Flags().Set(f.Name, fmt.Sprintf("%v", val))
			if err != nil {
				fmt.Printf("error parsing flag %s\n", f.Name)
				os.Exit(1)
			}
		}
	})
}