velero/pkg/client/config.go

/*
Copyright 2021 the Velero contributors.

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 client

import (
	"encoding/json"
	"os"
	"path/filepath"
	"strconv"
	"strings"

	"github.com/cockroachdb/errors"
)

const (
	ConfigKeyNamespace     = "namespace"
	ConfigKeyNamespaceMode = "namespace-mode"
	ConfigKeyFeatures      = "features"
	ConfigKeyCACert        = "cacert"
	ConfigKeyColorized     = "colorized"

	// NamespaceModeAuto is the ConfigKeyNamespaceMode value that makes Velero resolve the
	// namespace for operational commands from the current kubeconfig context on every
	// invocation, instead of the static ConfigKeyNamespace value.
	NamespaceModeAuto = "auto"
)

// VeleroConfig is a map of strings to any for deserializing Velero client config options.
// The alias is a way to attach type-asserting convenience methods.
type VeleroConfig map[string]any

// LoadConfig loads the Velero client configuration file and returns it as a VeleroConfig. If the
// file does not exist, an empty map is returned.
func LoadConfig() (VeleroConfig, error) {
	fileName := configFileName()

	_, err := os.Stat(fileName)
	if os.IsNotExist(err) {
		// If the file isn't there, just return an empty map
		return VeleroConfig{}, nil
	}
	if err != nil {
		// For any other Stat() error, return it
		return nil, errors.WithStack(err)
	}

	configFile, err := os.Open(fileName)
	if err != nil {
		return nil, errors.WithStack(err)
	}
	defer configFile.Close()

	var config VeleroConfig
	if err := json.NewDecoder(configFile).Decode(&config); err != nil {
		return nil, errors.WithStack(err)
	}

	return config, nil
}

// SaveConfig saves the passed in config map to the Velero client configuration file.
func SaveConfig(config VeleroConfig) error {
	fileName := configFileName()

	// Try to make the directory in case it doesn't exist
	dir := filepath.Dir(fileName)
	if err := os.MkdirAll(dir, 0700); err != nil {
		return errors.WithStack(err)
	}

	configFile, err := os.OpenFile(fileName, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0600)
	if err != nil {
		return errors.WithStack(err)
	}
	defer configFile.Close()

	return json.NewEncoder(configFile).Encode(&config)
}

func (c VeleroConfig) Namespace() string {
	val, ok := c[ConfigKeyNamespace]
	if !ok {
		return ""
	}

	ns, ok := val.(string)
	if !ok {
		return ""
	}

	return ns
}

func (c VeleroConfig) NamespaceMode() string {
	val, ok := c[ConfigKeyNamespaceMode]
	if !ok {
		return ""
	}

	mode, ok := val.(string)
	if !ok {
		return ""
	}

	return mode
}

func (c VeleroConfig) Features() []string {
	val, ok := c[ConfigKeyFeatures]
	if !ok {
		return []string{}
	}

	features, ok := val.(string)
	if !ok {
		return []string{}
	}

	return strings.Split(features, ",")
}

func (c VeleroConfig) Colorized() bool {
	val, ok := c[ConfigKeyColorized]
	if !ok {
		return true
	}

	valString, ok := val.(string)
	if !ok {
		return true
	}

	colorized, err := strconv.ParseBool(valString)
	if err != nil {
		return true
	}

	return colorized
}

func (c VeleroConfig) CACertFile() string {
	val, ok := c[ConfigKeyCACert]
	if !ok {
		return ""
	}
	caCertFile, ok := val.(string)
	if !ok {
		return ""
	}

	return caCertFile
}

func configFileName() string {
	return filepath.Join(os.Getenv("HOME"), ".config", "velero", "config.json")
}