airshipctl/cmd/config/get_cluster.go
jezogwza b2af034e57 airshipctl config (replace 686508)
This implementation creates named references between an airship
config file , and a user specified or system  default kubeconfig file

airshipconfig location can be specified via an envirnment variable
or via
--airshipconf string   Path to file for airshipctl configuration.
                       (default ".airship/config")

kubeconfig has to be explicitly stated using the argument below
--kubeconfig string    Path to kubeconfig associated with airshipctl
                       configuration. (default ".airship/kubeconfig")

if the argument is not specified a default empty kubeconfig will be
used using the default ".airship/kubeconfig"

All subcommands exposed via airshipctl config will update airship
config and airship related kubeconfig
when appropriate.

This patchset adds :

- Config Struct (type)
- config cmd and pkg
- get_cluster : List a specific name cluster or
                List all clusters if no name is provided.
- set-cluster : Create or Modify an existing cluster.

Review comment fixes as of Pathset 19
- Moved core functionality from cmd to pkg
- Encapsulate cmd needs in pck in nw files cmds, cmds_types and cmds_test .
  Expectation is that other functions will need func an structs there.
- added test for GetCluster
- Added GetCluster method to config object to be used by get_cluster command
- Change ClusterNames func as per review suggestion
- Change TestEmpty Cluster to avoid pointing to non test kubecnfig by default
- Change constant AirshipConfigFilePath to AirshipConfigDir
- Renamed config_utils to utils
- Added config cmd output tests
- Changes to settings_test.go to clean after itself.
- Created new pkg/config/testdata/GoldenString for struct data comparison values to avoid confusion
- Fix small get_cluster no name issue when empty config
- Fix issue when reconciling a cluster info that only exists in airship config and not in kubeconfig

Increased coverage to: SUCCESS: Test coverage is at 84.2%,
Started to move all testdata to a single place under pkg/config for now.

Change-Id: I7aae1f15afaebc99407f7fabccecf86ab0923bc3
2019-11-05 15:42:42 +00:00

118 lines
3.2 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"
"io"
"github.com/spf13/cobra"
"opendev.org/airship/airshipctl/pkg/config"
"opendev.org/airship/airshipctl/pkg/environment"
"opendev.org/airship/airshipctl/pkg/log"
)
var (
getClusterLong = (`
Gets a specific cluster or all defined clusters if no name is provided`)
getClusterExample = fmt.Sprintf(`
# List all the clusters airshipctl knows about
airshipctl config get-cluster
# Display a specific cluster
airshipctl config get-cluster e2e --%v=ephemeral`, config.FlagClusterType)
)
// NewCmdConfigGetCluster returns a Command instance for 'config -Cluster' sub command
func NewCmdConfigGetCluster(rootSettings *environment.AirshipCTLSettings) *cobra.Command {
theCluster := &config.ClusterOptions{}
getclustercmd := &cobra.Command{
Use: "get-cluster NAME",
Short: "Display a specific cluster",
Long: getClusterLong,
Example: getClusterExample,
Run: func(cmd *cobra.Command, args []string) {
if len(args) == 1 {
theCluster.Name = args[0]
}
err := runGetCluster(theCluster, cmd.OutOrStdout(), rootSettings)
if err != nil {
log.Fatal(err)
}
},
}
gcInitFlags(theCluster, getclustercmd)
return getclustercmd
}
func gcInitFlags(o *config.ClusterOptions, getclustercmd *cobra.Command) {
getclustercmd.Flags().StringVar(&o.ClusterType, config.FlagClusterType, "",
config.FlagClusterType+" for the cluster entry in airshipctl config")
}
// runGetCluster performs the execution of 'config get-cluster' sub command
func runGetCluster(o *config.ClusterOptions, out io.Writer, rootSettings *environment.AirshipCTLSettings) error {
err := validate(o)
if err != nil {
return err
}
if o.Name == "" {
return getClusters(out, rootSettings)
}
return getCluster(o.Name, o.ClusterType, out, rootSettings)
}
func getCluster(cName, cType string,
out io.Writer, rootSettings *environment.AirshipCTLSettings) error {
airconfig := rootSettings.Config()
cluster, err := airconfig.GetCluster(cName, cType)
if err != nil {
return err
}
fmt.Fprintf(out, "%s", cluster.PrettyString())
return nil
}
func getClusters(out io.Writer, rootSettings *environment.AirshipCTLSettings) error {
airconfig := rootSettings.Config()
clusters, err := airconfig.GetClusters()
if err != nil {
return err
}
if clusters == nil {
fmt.Fprint(out, "No clusters found in the configuration.\n")
}
for _, cluster := range clusters {
fmt.Fprintf(out, "%s", cluster.PrettyString())
}
return nil
}
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)
}