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
96 lines
2.4 KiB
Go
96 lines
2.4 KiB
Go
/*
|
|
Copyright 2014 The Kubernetes Authors.
|
|
|
|
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 config
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"opendev.org/airship/airshipctl/pkg/config"
|
|
"opendev.org/airship/airshipctl/pkg/environment"
|
|
)
|
|
|
|
const (
|
|
getContextLong = `
|
|
Display information about contexts such as associated manifests, users, and clusters.
|
|
`
|
|
|
|
getContextExample = `
|
|
# List all contexts
|
|
airshipctl config get-context
|
|
|
|
# Display the current context
|
|
airshipctl config get-context --current
|
|
|
|
# Display a specific context
|
|
airshipctl config get-context exampleContext
|
|
`
|
|
)
|
|
|
|
// NewGetContextCommand creates a command for viewing cluster information
|
|
// defined in the airshipctl config file.
|
|
func NewGetContextCommand(rootSettings *environment.AirshipCTLSettings) *cobra.Command {
|
|
o := &config.ContextOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "get-context [NAME]",
|
|
Short: "Get context information from the airshipctl config",
|
|
Long: getContextLong[1:],
|
|
Example: getContextExample,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
airconfig := rootSettings.Config
|
|
if len(args) == 1 {
|
|
o.Name = args[0]
|
|
}
|
|
if o.Name == "" && !o.CurrentContext {
|
|
contexts := airconfig.GetContexts()
|
|
if len(contexts) == 0 {
|
|
fmt.Fprintln(cmd.OutOrStdout(), "No Contexts found in the configuration.")
|
|
}
|
|
for _, context := range contexts {
|
|
fmt.Fprintln(cmd.OutOrStdout(), context.PrettyString())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
if o.CurrentContext {
|
|
o.Name = airconfig.CurrentContext
|
|
}
|
|
|
|
context, err := airconfig.GetContext(o.Name)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fmt.Fprintln(cmd.OutOrStdout(), context.PrettyString())
|
|
return nil
|
|
},
|
|
}
|
|
|
|
addGetContextFlags(o, cmd)
|
|
return cmd
|
|
}
|
|
|
|
func addGetContextFlags(o *config.ContextOptions, cmd *cobra.Command) {
|
|
flags := cmd.Flags()
|
|
|
|
flags.BoolVar(
|
|
&o.CurrentContext,
|
|
"current",
|
|
false,
|
|
"get the current context")
|
|
}
|