Merge pull request #20412 from soltysh/issue20097

Restore -v in set deploymenthook and status

Author: openshift-merge-robot

pkg/oc/cli/cli.go

@@ -8,8 +8,8 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/openshift/origin/pkg/oc/util/ocscheme"
 	"github.com/spf13/cobra"
+
 	kubecmd "k8s.io/kubernetes/pkg/kubectl/cmd"
 	ktemplates "k8s.io/kubernetes/pkg/kubectl/cmd/templates"
 	kcmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
@@ -68,6 +68,7 @@ import (
 	"github.com/openshift/origin/pkg/oc/cli/types"
 	"github.com/openshift/origin/pkg/oc/cli/version"
 	"github.com/openshift/origin/pkg/oc/cli/whoami"
+	"github.com/openshift/origin/pkg/oc/util/ocscheme"
 )
 
 const productName = `OpenShift`

pkg/oc/cli/set/deploymenthook.go

@@ -122,10 +122,12 @@ func NewCmdDeploymentHook(fullName string, f kcmdutil.Factory, streams genericcl
 	cmd.Flags().BoolVar(&o.Mid, "mid", o.Mid, "Set or remove a mid deployment hook")
 	cmd.Flags().BoolVar(&o.Post, "post", o.Post, "Set or remove a post deployment hook")
 	cmd.Flags().StringArrayVarP(&o.Environment, "environment", "e", o.Environment, "Environment variable to use in the deployment hook pod")
-	// FIXME: https://github.com/openshift/origin/issues/20097
-	// cmd.Flags().StringSliceVarP(&o.Volumes, "volumes", "v", o.Volumes, "Volumes from the pod template to use in the deployment hook pod")
+	// TODO: remove shorthand 'v' in 3.12
+	// this is done to trick pflag into allowing the duplicate registration.  The local value here wins
+	cmd.Flags().StringSliceVarP(&o.Volumes, "v", "v", o.Volumes, "Volumes from the pod template to use in the deployment hook pod")
+	cmd.Flags().MarkDeprecated("v", "Use --volumes instead.  Will be dropped in a future release")
+	cmd.Flags().MarkShorthandDeprecated("v", "Use --volumes instead.")
 	cmd.Flags().StringSliceVar(&o.Volumes, "volumes", o.Volumes, "Volumes from the pod template to use in the deployment hook pod")
-	cmd.Flags().MarkShorthandDeprecated("volumes", "Use --volumes instead.")
 	cmd.Flags().StringVar(&o.FailurePolicyStr, "failure-policy", o.FailurePolicyStr, "The failure policy for the deployment hook. Valid values are: abort,retry,ignore")
 	cmd.Flags().BoolVar(&o.Local, "local", o.Local, "If true, set deployment hook will NOT contact api-server but run locally.")
 

pkg/oc/cli/status/status.go

@@ -46,7 +46,7 @@ var (
 	  %[1]s -o dot | dot -T svg -o project.svg
 
 	  # See an overview of the current project including details for any identified issues.
-	  %[1]s -v`)
+	  %[1]s --sugest`)
 )
 
 // StatusOptions contains all the necessary options for the Openshift cli status command.
@@ -74,31 +74,29 @@ func NewStatusOptions(streams genericclioptions.IOStreams) *StatusOptions {
 // NewCmdStatus implements the OpenShift cli status command.
 // baseCLIName is the path from root cmd to the parent of this cmd.
 func NewCmdStatus(name, baseCLIName, fullName string, f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command {
-	opts := NewStatusOptions(streams)
-
+	o := NewStatusOptions(streams)
 	cmd := &cobra.Command{
-		Use:     fmt.Sprintf("%s [-o dot | -s ]", StatusRecommendedName),
+		Use:     fmt.Sprintf("%s [-o dot | --sugest ]", StatusRecommendedName),
 		Short:   "Show an overview of the current project",
 		Long:    fmt.Sprintf(statusLong, baseCLIName),
 		Example: fmt.Sprintf(statusExample, fullName),
 		Run: func(cmd *cobra.Command, args []string) {
-			err := opts.Complete(f, cmd, baseCLIName, args)
-			kcmdutil.CheckErr(err)
-
-			if err := opts.Validate(); err != nil {
-				kcmdutil.CheckErr(kcmdutil.UsageErrorf(cmd, err.Error()))
-			}
-
-			err = opts.RunStatus()
-			kcmdutil.CheckErr(err)
+			kcmdutil.CheckErr(o.Complete(f, cmd, baseCLIName, args))
+			kcmdutil.CheckErr(o.Validate())
+			kcmdutil.CheckErr(o.RunStatus())
 		},
 	}
-
-	cmd.Flags().StringVarP(&opts.outputFormat, "output", "o", opts.outputFormat, "Output format. One of: dot.")
-	cmd.Flags().BoolVar(&opts.suggest, "verbose", opts.suggest, "See details for resolving issues.")
+	cmd.Flags().StringVarP(&o.outputFormat, "output", "o", o.outputFormat, "Output format. One of: dot.")
+	// TODO: remove verbose in 3.12
+	// this is done to trick pflag into allowing the duplicate registration.  The local value here wins
+	cmd.Flags().BoolVarP(&o.suggest, "v", "v", o.suggest, "See details for resolving issues.")
+	cmd.Flags().MarkDeprecated("v", "Use --suggest instead.  Will be dropped in a future release")
+	cmd.Flags().MarkShorthandDeprecated("v", "Use --suggest instead.  Will be dropped in a future release")
+	cmd.Flags().BoolVar(&o.suggest, "verbose", o.suggest, "See details for resolving issues.")
+	cmd.Flags().MarkDeprecated("verbose", "Use --suggest instead.")
 	cmd.Flags().MarkHidden("verbose")
-	cmd.Flags().BoolVar(&opts.suggest, "suggest", opts.suggest, "See details for resolving issues.")
-	cmd.Flags().BoolVar(&opts.allNamespaces, "all-namespaces", false, "If true, display status for all namespaces (must have cluster admin)")
+	cmd.Flags().BoolVar(&o.suggest, "suggest", o.suggest, "See details for resolving issues.")
+	cmd.Flags().BoolVar(&o.allNamespaces, "all-namespaces", o.allNamespaces, "If true, display status for all namespaces (must have cluster admin)")
 
 	return cmd
 }

pkg/oc/lib/describe/projectstatus.go

@@ -518,7 +518,7 @@ func (d *ProjectStatusDescriber) Describe(namespace, name string) (string, error
 
 		switch {
 		case !d.Suggest && ((len(errorMarkers) > 0 && errorSuggestions > 0) || len(warningMarkers) > 0 || len(infoMarkers) > 0):
-			fmt.Fprintf(out, "%s identified, use '%s status -v' to see details.\n", markerString, d.CommandBaseName)
+			fmt.Fprintf(out, "%s identified, use '%s status --sugest' to see details.\n", markerString, d.CommandBaseName)
 
 		case (len(services) == 0) && (len(standaloneDCs) == 0) && (len(standaloneImages) == 0):
 			fmt.Fprintln(out, "You have no services, deployment configs, or build configs.")

pkg/router/template/configmanager/haproxy/client_test.go

@@ -2,6 +2,8 @@ package haproxy
 
 import (
 	"testing"
+
+	haproxytesting "github.com/openshift/origin/pkg/router/template/configmanager/haproxy/testing"
 )
 
 type infoEntry struct {
@@ -37,7 +39,7 @@ func TestNewClient(t *testing.T) {
 
 // TestClientRunCommand tests client command execution.
 func TestClientRunCommand(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -121,7 +123,7 @@ func TestClientRunInfoCommandConverter(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {
@@ -157,7 +159,7 @@ func TestClientRunBackendCommandConverter(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {
@@ -200,7 +202,7 @@ func TestClientRunMapCommandConverter(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {
@@ -243,7 +245,7 @@ func TestClientRunServerCommandConverter(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {
@@ -315,7 +317,7 @@ func TestClientExecute(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {
@@ -333,7 +335,7 @@ func TestClientExecute(t *testing.T) {
 
 // TestClientReset tests client state reset.
 func TestClientReset(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	client := NewClient(server.SocketFile(), 1)
@@ -375,7 +377,7 @@ func TestClientReset(t *testing.T) {
 
 // TestClientCommit tests client state commit.
 func TestClientCommit(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	client := NewClient(server.SocketFile(), 1)
@@ -439,7 +441,7 @@ func TestClientCommit(t *testing.T) {
 
 // TestClientBackends tests client backends.
 func TestClientBackends(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	client := NewClient(server.SocketFile(), 1)
@@ -501,7 +503,7 @@ func TestClientFindBackend(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {
@@ -527,7 +529,7 @@ func TestClientFindBackend(t *testing.T) {
 
 // TestClientMaps tests client haproxy maps.
 func TestClientMaps(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	client := NewClient(server.SocketFile(), 1)
@@ -584,7 +586,7 @@ func TestClientFindMap(t *testing.T) {
 		},
 	}
 
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	for _, tc := range testCases {

pkg/router/template/configmanager/haproxy/converter_test.go

@@ -4,6 +4,8 @@ import (
 	"bytes"
 	"fmt"
 	"testing"
+
+	haproxytesting "github.com/openshift/origin/pkg/router/template/configmanager/haproxy/testing"
 )
 
 // TestNewConverter tests a new converter.
@@ -352,35 +354,35 @@ func TestShowServerStateOutputConverter(t *testing.T) {
 	}{
 		{
 			name:            "show servers state",
-			commandOutput:   onePodAndOneDynamicServerBackendTemplate,
+			commandOutput:   haproxytesting.OnePodAndOneDynamicServerBackendTemplate,
 			header:          serversStateHeader,
 			converter:       stripVersionNumber,
 			failureExpected: false,
 		},
 		{
 			name:            "show servers state without a converter",
-			commandOutput:   onePodAndOneDynamicServerBackendTemplate,
+			commandOutput:   haproxytesting.OnePodAndOneDynamicServerBackendTemplate,
 			header:          serversStateHeader,
 			converter:       nil,
 			failureExpected: true,
 		},
 		{
 			name:            "show servers state without removing version number",
-			commandOutput:   onePodAndOneDynamicServerBackendTemplate,
+			commandOutput:   haproxytesting.OnePodAndOneDynamicServerBackendTemplate,
 			header:          serversStateHeader,
 			converter:       removeLeadingHashConverter,
 			failureExpected: true,
 		},
 		{
 			name:            "show servers state removing first line with version number",
-			commandOutput:   onePodAndOneDynamicServerBackendTemplate,
+			commandOutput:   haproxytesting.OnePodAndOneDynamicServerBackendTemplate,
 			header:          serversStateHeader,
 			converter:       removeFirstLineConverter,
 			failureExpected: false,
 		},
 		{
 			name:            "show servers state with error converter",
-			commandOutput:   onePodAndOneDynamicServerBackendTemplate,
+			commandOutput:   haproxytesting.OnePodAndOneDynamicServerBackendTemplate,
 			header:          serversStateHeader,
 			converter:       errorConverter,
 			failureExpected: true,

pkg/router/template/configmanager/haproxy/map_test.go

@@ -2,11 +2,13 @@ package haproxy
 
 import (
 	"testing"
+
+	haproxytesting "github.com/openshift/origin/pkg/router/template/configmanager/haproxy/testing"
 )
 
 // TestBuildHAProxyMaps tests haproxy maps.
 func TestBuildHAProxyMaps(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -56,7 +58,7 @@ func TestBuildHAProxyMaps(t *testing.T) {
 
 // TestNewHAProxyMap tests a new haproxy map.
 func TestNewHAProxyMap(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -91,7 +93,7 @@ func TestNewHAProxyMap(t *testing.T) {
 
 // TestHAProxyMapRefresh tests haproxy map refresh.
 func TestHAProxyMapRefresh(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -167,7 +169,7 @@ func TestHAProxyMapRefresh(t *testing.T) {
 
 // TestHAProxyMapCommit tests haproxy map commit.
 func TestHAProxyMapCommit(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -227,7 +229,7 @@ func TestHAProxyMapCommit(t *testing.T) {
 
 // TestHAProxyMapName tests haproxy map returns its name.
 func TestHAProxyMapName(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -303,7 +305,7 @@ func TestHAProxyMapName(t *testing.T) {
 
 // TestHAProxyMapFind tests finding an entry in a haproxy map.
 func TestHAProxyMapFind(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -441,7 +443,7 @@ func TestHAProxyMapFind(t *testing.T) {
 
 // TestHAProxyMapAdd tests adding an entry in a haproxy map.
 func TestHAProxyMapAdd(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -598,7 +600,7 @@ func TestHAProxyMapAdd(t *testing.T) {
 
 // TestHAProxyMapDelete tests deleting entries in a haproxy map.
 func TestHAProxyMapDelete(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {
@@ -720,7 +722,7 @@ func TestHAProxyMapDelete(t *testing.T) {
 
 // TestHAProxyMapDeleteEntry tests deleting an entry in a haproxy map.
 func TestHAProxyMapDeleteEntry(t *testing.T) {
-	server := startFakeServerForTest(t)
+	server := haproxytesting.StartFakeServerForTest(t)
 	defer server.Stop()
 
 	testCases := []struct {

pkg/router/template/configmanager/haproxy/fake_haproxy.go renamed to pkg/router/template/configmanager/haproxy/testing/haproxy.go

@@ -1,4 +1,4 @@
-package haproxy
+package testing
 
 import (
 	"bytes"
@@ -18,7 +18,7 @@ const (
 
 	serverName = "_dynamic-pod-1"
 
-	onePodAndOneDynamicServerBackendTemplate = `1
+	OnePodAndOneDynamicServerBackendTemplate = `1
 # be_id be_name srv_id srv_name srv_addr srv_op_state srv_admin_state srv_uweight srv_iweight srv_time_since_last_change srv_check_status srv_check_result srv_check_health srv_check_state srv_agent_state bk_f_forced_id srv_f_forced_id srv_fqdn srv_port
 9 %s 1 pod:test-1-l8x8w:test-service:172.17.0.3:1234 172.17.0.3 2 4 256 1 8117 6 3 4 6 0 0 0 - 1234
 9 %s 2 _dynamic-pod-1 172.4.0.4 2 4 256 1 8117 6 3 4 6 0 0 0 - 1234
@@ -50,7 +50,7 @@ func startFakeHAProxyServer(prefix string) (*fakeHAProxy, error) {
 	return server, nil
 }
 
-func startFakeServerForTest(t *testing.T) *fakeHAProxy {
+func StartFakeServerForTest(t *testing.T) *fakeHAProxy {
 	name := fmt.Sprintf("fake-haproxy-%s", t.Name())
 	server, err := startFakeHAProxyServer(name)
 	if err != nil {
@@ -356,7 +356,7 @@ func (p *fakeHAProxy) showServers(name string) string {
 
 	if name != p.backendName {
 		if _, ok := onePodAndOneDynamicServerBackends[name]; ok {
-			return fmt.Sprintf(onePodAndOneDynamicServerBackendTemplate, name, name)
+			return fmt.Sprintf(OnePodAndOneDynamicServerBackendTemplate, name, name)
 		}
 		if len(name) > 0 {
 			return fmt.Sprintf("Can't find backend.\n")