Evgenii Stratonikov
17ec84151b
XDG base directory specification defines where various files should be looked by an application. Hopefully, this makes `frostfs-cli` more predictable and pleasant to work with. Luckily for us, golang already has everything we need in the stdlib. This commit also gets rid of `github.com/mitchellh/go-homedir` dependency. Close #532 Refs #1455 Signed-off-by: Evgenii Stratonikov <e.stratonikov@yadro.com>
139 lines
5 KiB
Go
139 lines
5 KiB
Go
package cmd
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/internal/common"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/internal/commonflags"
|
|
accountingCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/accounting"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/acl"
|
|
apemanager "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/ape_manager"
|
|
bearerCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/bearer"
|
|
containerCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/container"
|
|
controlCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/control"
|
|
netmapCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/netmap"
|
|
objectCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/object"
|
|
sessionCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/session"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/tree"
|
|
utilCli "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/modules/util"
|
|
commonCmd "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/internal/common"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/misc"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/pkg/util/config"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-node/pkg/util/gendoc"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/viper"
|
|
)
|
|
|
|
const (
|
|
envPrefix = "FROSTFS_CLI"
|
|
)
|
|
|
|
// Global scope flags.
|
|
var (
|
|
cfgFile string
|
|
cfgDir string
|
|
)
|
|
|
|
// rootCmd represents the base command when called without any subcommands.
|
|
var rootCmd = &cobra.Command{
|
|
Use: "frostfs-cli",
|
|
Short: "Command Line Tool to work with FrostFS",
|
|
Long: `FrostFS CLI provides all basic interactions with FrostFS and it's services.
|
|
|
|
It contains commands for interaction with FrostFS nodes using different versions
|
|
of frostfs-api and some useful utilities for compiling ACL rules from JSON
|
|
notation, managing container access through protocol gates, querying network map
|
|
and much more!`,
|
|
Run: entryPoint,
|
|
PersistentPreRun: func(cmd *cobra.Command, _ []string) {
|
|
common.StartClientCommandSpan(cmd)
|
|
},
|
|
PersistentPostRun: common.StopClientCommandSpan,
|
|
}
|
|
|
|
// 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() {
|
|
err := rootCmd.Execute()
|
|
commonCmd.ExitOnErr(rootCmd, "", err)
|
|
}
|
|
|
|
func init() {
|
|
cobra.OnInitialize(initConfig)
|
|
cobra.EnableTraverseRunHooks = true
|
|
|
|
// use stdout as default output for cmd.Print()
|
|
rootCmd.SetOut(os.Stdout)
|
|
|
|
// Here you will define your flags and configuration settings.
|
|
// Cobra supports persistent flags, which, if defined here,
|
|
// will be global for your application.
|
|
rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "Config file (default is $HOME/.config/frostfs-cli/config.yaml)")
|
|
rootCmd.PersistentFlags().StringVar(&cfgDir, "config-dir", "", "Config directory")
|
|
rootCmd.PersistentFlags().BoolP(commonflags.Verbose, commonflags.VerboseShorthand,
|
|
false, commonflags.VerboseUsage)
|
|
|
|
_ = viper.BindPFlag(commonflags.Verbose, rootCmd.PersistentFlags().Lookup(commonflags.Verbose))
|
|
|
|
// Cobra also supports local flags, which will only run
|
|
// when this action is called directly.
|
|
rootCmd.Flags().Bool("version", false, "Application version and FrostFS API compatibility")
|
|
|
|
rootCmd.AddCommand(acl.Cmd)
|
|
rootCmd.AddCommand(apemanager.Cmd)
|
|
rootCmd.AddCommand(bearerCli.Cmd)
|
|
rootCmd.AddCommand(sessionCli.Cmd)
|
|
rootCmd.AddCommand(accountingCli.Cmd)
|
|
rootCmd.AddCommand(controlCli.Cmd)
|
|
rootCmd.AddCommand(utilCli.Cmd)
|
|
rootCmd.AddCommand(netmapCli.Cmd)
|
|
rootCmd.AddCommand(objectCli.Cmd)
|
|
rootCmd.AddCommand(containerCli.Cmd)
|
|
rootCmd.AddCommand(tree.Cmd)
|
|
rootCmd.AddCommand(gendoc.Command(rootCmd, gendoc.Options{}))
|
|
}
|
|
|
|
func entryPoint(cmd *cobra.Command, _ []string) {
|
|
printVersion, _ := cmd.Flags().GetBool("version")
|
|
if printVersion {
|
|
cmd.Print(misc.BuildInfo("FrostFS CLI"))
|
|
|
|
return
|
|
}
|
|
|
|
_ = cmd.Usage()
|
|
}
|
|
|
|
// initConfig reads in config file and ENV variables if set.
|
|
func initConfig() {
|
|
if cfgFile != "" {
|
|
// Use config file from the flag.
|
|
viper.SetConfigFile(cfgFile)
|
|
} else {
|
|
// Find config directory.
|
|
configDir, err := os.UserConfigDir()
|
|
if err != nil {
|
|
common.PrintVerbose(rootCmd, "Get config dir: %s", err)
|
|
} else {
|
|
// Search config in `$XDG_CONFIG_HOME/frostfs-cli/` with name "config.yaml"
|
|
viper.AddConfigPath(filepath.Join(configDir, "frostfs-cli"))
|
|
viper.SetConfigName("config")
|
|
viper.SetConfigType("yaml")
|
|
}
|
|
}
|
|
|
|
viper.SetEnvPrefix(envPrefix)
|
|
viper.AutomaticEnv() // read in environment variables that match
|
|
|
|
// If a config file is found, read it in.
|
|
if err := viper.ReadInConfig(); err == nil {
|
|
common.PrintVerbose(rootCmd, "Using config file: %s", viper.ConfigFileUsed())
|
|
}
|
|
|
|
if cfgDir != "" {
|
|
if err := config.ReadConfigDir(viper.GetViper(), cfgDir); err != nil {
|
|
commonCmd.ExitOnErr(rootCmd, "failed to read config dir: %w", err)
|
|
}
|
|
}
|
|
}
|