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
104 lines
2.6 KiB
Go
104 lines
2.6 KiB
Go
/*l
|
|
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 (
|
|
getClusterLong = `
|
|
Display a specific cluster or all defined clusters if no name is provided.
|
|
|
|
Note that if a specific cluster's name is provided, the --cluster-type flag
|
|
must also be provided.
|
|
Valid values for the --cluster-type flag are [ephemeral|target].
|
|
`
|
|
|
|
getClusterExample = `
|
|
# List all clusters
|
|
airshipctl config get-cluster
|
|
|
|
# Display a specific cluster
|
|
airshipctl config get-cluster --cluster-type=ephemeral exampleCluster
|
|
`
|
|
)
|
|
|
|
// NewGetClusterCommand creates a command for viewing the cluster information
|
|
// defined in the airshipctl config file.
|
|
func NewGetClusterCommand(rootSettings *environment.AirshipCTLSettings) *cobra.Command {
|
|
o := &config.ClusterOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "get-cluster [NAME]",
|
|
Short: "Get cluster information from the airshipctl config",
|
|
Long: getClusterLong[1:],
|
|
Example: getClusterExample,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
airconfig := rootSettings.Config
|
|
if len(args) == 1 {
|
|
o.Name = args[0]
|
|
|
|
err := validate(o)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cluster, err := airconfig.GetCluster(o.Name, o.ClusterType)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fmt.Fprintln(cmd.OutOrStdout(), cluster.PrettyString())
|
|
return nil
|
|
}
|
|
|
|
clusters := airconfig.GetClusters()
|
|
if len(clusters) == 0 {
|
|
fmt.Fprintln(cmd.OutOrStdout(), "No clusters found in the configuration.")
|
|
}
|
|
for _, cluster := range clusters {
|
|
fmt.Fprintln(cmd.OutOrStdout(), cluster.PrettyString())
|
|
}
|
|
return nil
|
|
},
|
|
}
|
|
|
|
addGetClusterFlags(o, cmd)
|
|
return cmd
|
|
}
|
|
|
|
func addGetClusterFlags(o *config.ClusterOptions, cmd *cobra.Command) {
|
|
flags := cmd.Flags()
|
|
flags.StringVar(
|
|
&o.ClusterType,
|
|
"cluster-type",
|
|
"",
|
|
"type of the desired cluster")
|
|
}
|
|
|
|
func validate(o *config.ClusterOptions) error {
|
|
// Only an error if asking for a specific cluster
|
|
if len(o.Name) == 0 {
|
|
return nil
|
|
}
|
|
return config.ValidClusterType(o.ClusterType)
|
|
}
|