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
144 lines
4.1 KiB
Go
144 lines
4.1 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_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
kubeconfig "k8s.io/client-go/tools/clientcmd/api"
|
|
|
|
cmd "opendev.org/airship/airshipctl/cmd/config"
|
|
"opendev.org/airship/airshipctl/pkg/config"
|
|
"opendev.org/airship/airshipctl/pkg/environment"
|
|
"opendev.org/airship/airshipctl/testutil"
|
|
)
|
|
|
|
const (
|
|
ephemeralFlag = "--cluster-type=ephemeral"
|
|
targetFlag = "--cluster-type=target"
|
|
|
|
fooCluster = "clusterFoo"
|
|
barCluster = "clusterBar"
|
|
bazCluster = "clusterBaz"
|
|
missingCluster = "clusterMissing"
|
|
)
|
|
|
|
func TestGetClusterCmd(t *testing.T) {
|
|
settings := &environment.AirshipCTLSettings{
|
|
Config: &config.Config{
|
|
Clusters: map[string]*config.ClusterPurpose{
|
|
fooCluster: {
|
|
ClusterTypes: map[string]*config.Cluster{
|
|
config.Ephemeral: getNamedTestCluster(fooCluster, config.Ephemeral),
|
|
config.Target: getNamedTestCluster(fooCluster, config.Target),
|
|
},
|
|
},
|
|
barCluster: {
|
|
ClusterTypes: map[string]*config.Cluster{
|
|
config.Ephemeral: getNamedTestCluster(barCluster, config.Ephemeral),
|
|
config.Target: getNamedTestCluster(barCluster, config.Target),
|
|
},
|
|
},
|
|
bazCluster: {
|
|
ClusterTypes: map[string]*config.Cluster{
|
|
config.Ephemeral: getNamedTestCluster(bazCluster, config.Ephemeral),
|
|
config.Target: getNamedTestCluster(bazCluster, config.Target),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
cmdTests := []*testutil.CmdTest{
|
|
{
|
|
Name: "get-ephemeral",
|
|
CmdLine: fmt.Sprintf("%s %s", ephemeralFlag, fooCluster),
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
},
|
|
{
|
|
Name: "get-target",
|
|
CmdLine: fmt.Sprintf("%s %s", targetFlag, fooCluster),
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
},
|
|
|
|
// FIXME(howell): "airshipctl config get-cluster foo bar" will
|
|
// print *all* clusters, regardless of whether they are
|
|
// specified on the command line
|
|
// In this case, the bazCluster should not be included in the
|
|
// output, yet it is
|
|
{
|
|
Name: "get-multiple-ephemeral",
|
|
CmdLine: fmt.Sprintf("%s %s %s", ephemeralFlag, fooCluster, barCluster),
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
},
|
|
{
|
|
Name: "get-multiple-target",
|
|
CmdLine: fmt.Sprintf("%s %s %s", targetFlag, fooCluster, barCluster),
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
},
|
|
|
|
// FIXME(howell): "airshipctl config get-cluster
|
|
// --cluster-type=ephemeral" will print *all* clusters,
|
|
// regardless of whether they are ephemeral or target
|
|
{
|
|
Name: "get-all-ephemeral",
|
|
CmdLine: ephemeralFlag,
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
},
|
|
{
|
|
Name: "get-all-target",
|
|
CmdLine: targetFlag,
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
},
|
|
{
|
|
Name: "missing",
|
|
CmdLine: fmt.Sprintf("%s %s", targetFlag, missingCluster),
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
Error: fmt.Errorf("cluster clustermissing information was not " +
|
|
"found in the configuration"),
|
|
},
|
|
}
|
|
|
|
for _, tt := range cmdTests {
|
|
testutil.RunTest(t, tt)
|
|
}
|
|
}
|
|
|
|
func TestNoClustersGetClusterCmd(t *testing.T) {
|
|
settings := &environment.AirshipCTLSettings{Config: new(config.Config)}
|
|
cmdTest := &testutil.CmdTest{
|
|
Name: "no-clusters",
|
|
CmdLine: "",
|
|
Cmd: cmd.NewGetClusterCommand(settings),
|
|
}
|
|
testutil.RunTest(t, cmdTest)
|
|
}
|
|
|
|
func getNamedTestCluster(clusterName, clusterType string) *config.Cluster {
|
|
kCluster := &kubeconfig.Cluster{
|
|
LocationOfOrigin: "",
|
|
InsecureSkipTLSVerify: true,
|
|
Server: "",
|
|
}
|
|
|
|
newCluster := &config.Cluster{NameInKubeconf: fmt.Sprintf("%s_%s", clusterName, clusterType)}
|
|
newCluster.SetKubeCluster(kCluster)
|
|
|
|
return newCluster
|
|
}
|