porter/cli/cmd/config/config.go

package config

import (
	"context"
	"errors"
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/fatih/color"
	api "github.com/porter-dev/porter/api/client"
	"github.com/porter-dev/porter/cli/cmd/utils"
	"github.com/spf13/viper"
	"k8s.io/client-go/util/homedir"
)

var home = homedir.HomeDir()

// CLIConfig is the set of shared configuration options for the CLI commands.
// This config is used by viper: calling Set() function for any parameter will
// update the corresponding field in the viper config file.
type CLIConfig struct {
	// Driver can be either "docker" or "local", and represents which driver is
	// used to run an instance of the server.
	Driver string `yaml:"driver"`

	Host    string `yaml:"host"`
	Project uint   `yaml:"project"`
	Cluster uint   `yaml:"cluster"`

	Token string `yaml:"token"`

	Registry   uint   `yaml:"registry"`
	HelmRepo   uint   `yaml:"helm_repo"`
	Kubeconfig string `yaml:"kubeconfig"`
}

// FeatureFlags are any flags that are relevant to the feature set of the CLI. This should not include all feature flags, only those relevant to client-side CLI operations
type FeatureFlags struct {
	// ValidateApplyV2Enabled is a project-wide flag for checking if `porter apply` with porter.yaml is enabled
	ValidateApplyV2Enabled bool
}

// InitAndLoadConfig populates the config object with the following precedence rules:
// 1. flag
// 2. env
// 3. config
// 4. default
// Make sure to call overrideConfigWithFlags during runtime, to ensure that the flag values are considered
func InitAndLoadConfig() (CLIConfig, error) {
	var config CLIConfig

	porterDir, err := getOrCreatePorterDirectoryAndConfig()
	if err != nil {
		return config, fmt.Errorf("unable to get or create porter directory: %w", err)
	}
	viper.SetConfigName("porter")
	viper.SetConfigType("yaml")
	viper.AddConfigPath(porterDir)

	err = createAndLoadPorterYaml(porterDir)
	if err != nil {
		return config, fmt.Errorf("unable to load porter config: %w", err)
	}

	utils.DriverFlagSet.StringVar(
		&config.Driver,
		"driver",
		"local",
		"driver to use (local or docker)",
	)
	err = viper.BindPFlags(utils.DriverFlagSet)
	if err != nil {
		return config, err
	}

	utils.DefaultFlagSet.StringVar(
		&config.Host,
		"host",
		"https://dashboard.getporter.dev",
		"host URL of Porter instance",
	)

	utils.DefaultFlagSet.UintVar(
		&config.Project,
		"project",
		0,
		"project ID of Porter project",
	)

	utils.DefaultFlagSet.UintVar(
		&config.Cluster,
		"cluster",
		0,
		"cluster ID of Porter cluster",
	)

	utils.DefaultFlagSet.StringVar(
		&config.Token,
		"token",
		"",
		"token for Porter authentication",
	)

	err = viper.BindPFlags(utils.DefaultFlagSet)
	if err != nil {
		return config, err
	}

	utils.RegistryFlagSet.UintVar(
		&config.Registry,
		"registry",
		0,
		"registry ID of connected Porter registry",
	)

	err = viper.BindPFlags(utils.RegistryFlagSet)
	if err != nil {
		return config, err
	}

	utils.HelmRepoFlagSet.UintVar(
		&config.HelmRepo,
		"helmrepo",
		0,
		"helm repo ID of connected Porter Helm repository",
	)
	err = viper.BindPFlags(utils.HelmRepoFlagSet)
	if err != nil {
		return config, err
	}

	viper.SetEnvPrefix("PORTER")
	err = viper.BindEnv("host")
	if err != nil {
		return config, err
	}
	err = viper.BindEnv("project")
	if err != nil {
		return config, err
	}
	err = viper.BindEnv("cluster")
	if err != nil {
		return config, err
	}
	err = viper.BindEnv("token")
	if err != nil {
		return config, err
	}

	err = viper.Unmarshal(&config)
	if err != nil {
		return config, fmt.Errorf("unable to unmarshal porter config: %w", err)
	}

	return config, nil
}

// getOrCreatePorterDirectoryAndConfig checks that the .porter folder exists; create if not
func getOrCreatePorterDirectoryAndConfig() (string, error) {
	porterDir := filepath.Join(home, ".porter")

	_, err := os.Stat(porterDir)
	if err != nil {
		if !os.IsNotExist(err) {
			return "", fmt.Errorf("error reading porter directory: %w", err)
		}
		err = os.Mkdir(porterDir, 0o700)
		if err != nil {
			return "", fmt.Errorf("error creating porter directory: %w", err)
		}
	}
	return porterDir, nil
}

// createAndLoadPorterYaml loads a porter.yaml config into Viper if it exists, or creates the file if it does not
func createAndLoadPorterYaml(porterDir string) error {
	err := viper.ReadInConfig()
	if err != nil {
		_, ok := err.(viper.ConfigFileNotFoundError)
		if !ok {
			return fmt.Errorf("unknown error reading ~/.porter/porter.yaml config: %w", err)
		}

		err := os.WriteFile(filepath.Join(porterDir, "porter.yaml"), []byte{}, 0o644) //nolint:gosec // do not want to change program logic. Should be addressed later
		if err != nil {
			return fmt.Errorf("unable to create ~/.porter/porter.yaml config: %w", err)
		}
	}
	return nil
}

func (c *CLIConfig) SetDriver(driver string) error {
	viper.Set("driver", driver)
	color.New(color.FgGreen).Printf("Set the current driver as %s\n", driver)
	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	c.Driver = driver

	return nil
}

func (c *CLIConfig) SetHost(host string) error {
	// a trailing / can lead to errors with the api server
	host = strings.TrimRight(host, "/")

	viper.Set("host", host)

	// let us clear the project ID, cluster ID, and token when we reset a host
	viper.Set("project", 0)
	viper.Set("cluster", 0)
	viper.Set("token", "")

	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	color.New(color.FgGreen).Printf("Set the current host as %s\n", host)

	c.Host = host
	c.Project = 0
	c.Cluster = 0
	c.Token = ""

	return nil
}

// SetProject sets a project for all API commands
func (c *CLIConfig) SetProject(ctx context.Context, apiClient api.Client, projectID uint) error {
	viper.Set("project", projectID)

	color.New(color.FgGreen).Printf("Set the current project as %d\n", projectID)

	if c.Kubeconfig != "" || viper.IsSet("kubeconfig") {
		color.New(color.FgYellow).Println("Please change local kubeconfig if needed")
	}

	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	c.Project = projectID

	resp, err := apiClient.ListProjectClusters(ctx, projectID)
	if err == nil {
		clusters := *resp
		if len(clusters) == 1 {
			_ = c.SetCluster(clusters[0].ID)
		}
	}

	return nil
}

func (c *CLIConfig) SetCluster(clusterID uint) error {
	viper.Set("cluster", clusterID)

	color.New(color.FgGreen).Printf("Set the current cluster as %d\n", clusterID)

	if c.Kubeconfig != "" || viper.IsSet("kubeconfig") {
		color.New(color.FgYellow).Println("Please change local kubeconfig if needed")
	}

	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	c.Cluster = clusterID

	return nil
}

func (c *CLIConfig) SetToken(token string) error {
	viper.Set("token", token)
	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	c.Token = token

	return nil
}

func (c *CLIConfig) SetRegistry(registryID uint) error {
	viper.Set("registry", registryID)
	color.New(color.FgGreen).Printf("Set the current registry as %d\n", registryID)
	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	c.Registry = registryID

	return nil
}

func (c *CLIConfig) SetHelmRepo(helmRepoID uint) error {
	viper.Set("helm_repo", helmRepoID)
	color.New(color.FgGreen).Printf("Set the current Helm repo as %d\n", helmRepoID)
	err := viper.WriteConfig()
	if err != nil {
		return err
	}

	c.HelmRepo = helmRepoID

	return nil
}

func (c *CLIConfig) SetKubeconfig(kubeconfig string) error {
	path, err := filepath.Abs(kubeconfig)
	if err != nil {
		return err
	}

	if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) {
		return fmt.Errorf("%s does not exist", path)
	}

	viper.Set("kubeconfig", path)
	color.New(color.FgGreen).Printf("Set the path to kubeconfig as %s\n", path)
	err = viper.WriteConfig()

	if err != nil {
		return err
	}

	c.Kubeconfig = kubeconfig

	return nil
}

// ValidateCLIEnvironment checks that all required variables are present for running the CLI
func (c *CLIConfig) ValidateCLIEnvironment() error {
	if c.Token == "" {
		return fmt.Errorf("no auth token present, please run 'porter auth login' to authenticate")
	}

	if c.Project == 0 {
		return fmt.Errorf("no project selected, please run 'porter config set-project' to select a project")
	}

	if c.Cluster == 0 {
		return fmt.Errorf("no cluster selected, please run 'porter config set-cluster' to select a cluster")
	}

	return nil
}