9ffc305392
This commit cleans up the command constructors in an attempt to make the codebase more uniform and approachable. This includes several refactors: * Removed the FlagConstants - this makes the help messages and examples significantly more readable without needed to compile and run airshipctl * Long help messages and examples are now constant * Short, Long, and Examples all begin with a capitol letter * Flag descriptions begin with a lowercase letter. This matches the flag description for the builtin "help" flag, making formatting uniform for all flags * Removed redundant unit tests on non-leaf commands This change also updates the documentation for the affected commands. Change-Id: I8b9dcbfd9846b3deaab06dec17f80643dae78de9
129 lines
3.8 KiB
Go
129 lines
3.8 KiB
Go
/*
|
|
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
|
|
|
|
https://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 environment
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"k8s.io/client-go/tools/clientcmd"
|
|
|
|
"opendev.org/airship/airshipctl/pkg/config"
|
|
"opendev.org/airship/airshipctl/pkg/log"
|
|
)
|
|
|
|
// AirshipCTLSettings is a container for all of the settings needed by airshipctl
|
|
type AirshipCTLSettings struct {
|
|
// Debug is used for verbose output
|
|
Debug bool
|
|
AirshipConfigPath string
|
|
KubeConfigPath string
|
|
Config *config.Config
|
|
}
|
|
|
|
// InitFlags adds the default settings flags to cmd
|
|
func (a *AirshipCTLSettings) InitFlags(cmd *cobra.Command) {
|
|
flags := cmd.PersistentFlags()
|
|
flags.BoolVar(
|
|
&a.Debug,
|
|
"debug",
|
|
false,
|
|
"enable verbose output")
|
|
|
|
defaultAirshipConfigDir := filepath.Join(HomeEnvVar, config.AirshipConfigDir)
|
|
|
|
defaultAirshipConfigPath := filepath.Join(defaultAirshipConfigDir, config.AirshipConfig)
|
|
flags.StringVar(
|
|
&a.AirshipConfigPath,
|
|
"airshipconf",
|
|
"",
|
|
`Path to file for airshipctl configuration. (default "`+defaultAirshipConfigPath+`")`)
|
|
|
|
defaultKubeConfigPath := filepath.Join(defaultAirshipConfigDir, config.AirshipKubeConfig)
|
|
flags.StringVar(
|
|
&a.KubeConfigPath,
|
|
clientcmd.RecommendedConfigPathFlag,
|
|
"",
|
|
`Path to kubeconfig associated with airshipctl configuration. (default "`+defaultKubeConfigPath+`")`)
|
|
}
|
|
|
|
// InitConfig - Initializes and loads Config it exists.
|
|
func (a *AirshipCTLSettings) InitConfig() {
|
|
a.Config = config.NewConfig()
|
|
|
|
a.initAirshipConfigPath()
|
|
a.initKubeConfigPath()
|
|
|
|
err := a.Config.LoadConfig(a.AirshipConfigPath, a.KubeConfigPath)
|
|
if err != nil {
|
|
// Should stop airshipctl
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
|
|
func (a *AirshipCTLSettings) initAirshipConfigPath() {
|
|
// The airshipConfigPath may already have been received as a command line argument
|
|
if a.AirshipConfigPath != "" {
|
|
return
|
|
}
|
|
|
|
// Otherwise, we can check if we got the path via ENVIRONMENT variable
|
|
a.AirshipConfigPath = os.Getenv(config.AirshipConfigEnv)
|
|
if a.AirshipConfigPath != "" {
|
|
return
|
|
}
|
|
|
|
// Otherwise, we'll try putting it in the home directory
|
|
homeDir := userHomeDir()
|
|
a.AirshipConfigPath = filepath.Join(homeDir, config.AirshipConfigDir, config.AirshipConfig)
|
|
}
|
|
|
|
func (a *AirshipCTLSettings) initKubeConfigPath() {
|
|
// NOTE(howell): This function will set the kubeConfigPath to the
|
|
// default location under the airship directory unless the user
|
|
// *explicitly* specifies a different location, either by setting the
|
|
// ENVIRONMENT variable or by passing a command line argument.
|
|
// This avoids messing up the user's kubeconfig if they didn't
|
|
// explicitly want airshipctl to use it.
|
|
|
|
// The kubeConfigPath may already have been received as a command line argument
|
|
if a.KubeConfigPath != "" {
|
|
return
|
|
}
|
|
|
|
// Otherwise, we can check if we got the path via ENVIRONMENT variable
|
|
a.KubeConfigPath = os.Getenv(config.AirshipKubeConfigEnv)
|
|
if a.KubeConfigPath != "" {
|
|
return
|
|
}
|
|
|
|
// Otherwise, we'll try putting it in the home directory
|
|
homeDir := userHomeDir()
|
|
a.KubeConfigPath = filepath.Join(homeDir, config.AirshipConfigDir, config.AirshipKubeConfig)
|
|
}
|
|
|
|
// userHomeDir is a utility function that wraps os.UserHomeDir and returns no
|
|
// errors. If the user has no home directory, the returned value will be the
|
|
// empty string
|
|
func userHomeDir() string {
|
|
homeDir, err := os.UserHomeDir()
|
|
if err != nil {
|
|
homeDir = ""
|
|
}
|
|
return homeDir
|
|
}
|