feat: test help() routing legacy or Cobra

Author: robertolopezlopez

cliv2/pkg/core/help_routing.go

@@ -19,12 +19,16 @@ func init() {
 	defaultCobraHelpFunc = (&cobra.Command{}).HelpFunc()
 }
 
-func legacyHelp() error {
+var runLegacyHelp = func() error {
 	args := utils.RemoveSimilar(os.Args[1:], "--")
 	args = append(args, "--help")
 	return defaultCmd(args)
 }
 
+func legacyHelp() error {
+	return runLegacyHelp()
+}
+
 func help(c *cobra.Command, _ []string) error {
 	helpProvided = true
 

cliv2/pkg/core/help_routing_test.go

@@ -0,0 +1,150 @@
+package core
+
+import (
+	"bytes"
+	"os"
+	"testing"
+
+	"github.com/snyk/go-application-framework/pkg/configuration"
+	"github.com/snyk/go-application-framework/pkg/workflow"
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_help_routing(t *testing.T) {
+	root := setupHelpRoutingRoot(t)
+
+	tests := map[string]struct {
+		argv       []string
+		command    func(t *testing.T, root *cobra.Command) (*cobra.Command, *bytes.Buffer)
+		wantLegacy bool
+		cobraOut   []string
+	}{
+		"top-level --help uses legacy readme": {
+			argv: []string{"snyk", "--help"},
+			command: func(_ *testing.T, root *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				return root, nil
+			},
+			wantLegacy: true,
+		},
+		"help subcommand uses legacy": {
+			argv: []string{"snyk", "help"},
+			command: func(_ *testing.T, _ *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				return helpSubcommand(), nil
+			},
+			wantLegacy: true,
+		},
+		"help test uses legacy user doc": {
+			argv: []string{"snyk", "help", "test"},
+			command: func(_ *testing.T, _ *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				return helpSubcommand(), nil
+			},
+			wantLegacy: true,
+		},
+		"documented test --help uses legacy": {
+			argv: []string{"snyk", "test", "--help"},
+			command: func(_ *testing.T, _ *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				return nil, nil
+			},
+			wantLegacy: true,
+		},
+		"undocumented secrets test --help uses cobra": {
+			argv: []string{"snyk", "secrets", "test", "--help"},
+			command: func(t *testing.T, root *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				cmd := findCommand(t, root, "secrets", "test")
+				buf := &bytes.Buffer{}
+				cmd.SetOut(buf)
+				return cmd, buf
+			},
+			cobraOut: []string{"Usage:"},
+		},
+		"unknown command --help falls back to legacy": {
+			argv: []string{"snyk", "rainmaker", "--help"},
+			command: func(_ *testing.T, _ *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				return nil, nil
+			},
+			wantLegacy: true,
+		},
+		"unknown flag on undocumented command uses cobra": {
+			argv: []string{"snyk", "secrets", "test", "--bad-flag"},
+			command: func(t *testing.T, root *cobra.Command) (*cobra.Command, *bytes.Buffer) {
+				cmd := findCommand(t, root, "secrets", "test")
+				buf := &bytes.Buffer{}
+				cmd.SetOut(buf)
+				return cmd, buf
+			},
+			cobraOut: []string{"Usage:"},
+		},
+	}
+
+	for name, tc := range tests {
+		t.Run(name, func(t *testing.T) {
+			defer cleanup()
+
+			oldArgs := append([]string{}, os.Args...)
+			oldLegacyHelp := runLegacyHelp
+			defer func() {
+				os.Args = oldArgs
+				runLegacyHelp = oldLegacyHelp
+				globalRootCommand = nil
+			}()
+
+			legacyCalled := false
+			runLegacyHelp = func() error {
+				legacyCalled = true
+				return nil
+			}
+
+			os.Args = tc.argv
+			cmd, buf := tc.command(t, root)
+
+			err := help(cmd, nil)
+			require.NoError(t, err)
+			assert.Equal(t, tc.wantLegacy, legacyCalled, "legacy help routing")
+			if tc.wantLegacy {
+				return
+			}
+			require.NotNil(t, buf)
+			for _, want := range tc.cobraOut {
+				assert.Contains(t, buf.String(), want)
+			}
+		})
+	}
+}
+
+func setupHelpRoutingRoot(t *testing.T) *cobra.Command {
+	t.Helper()
+
+	globalConfiguration = configuration.New()
+	globalEngine = workflow.NewWorkFlowEngine(globalConfiguration)
+
+	fn := func(invocation workflow.InvocationContext, input []workflow.Data) ([]workflow.Data, error) {
+		return []workflow.Data{}, nil
+	}
+
+	workflowConfig := workflow.ConfigurationOptionsFromFlagset(pflag.NewFlagSet("secrets-test", pflag.ContinueOnError))
+	workflowId := workflow.NewWorkflowIdentifier("secrets test")
+	_, err := globalEngine.Register(workflowId, workflowConfig, fn)
+	require.NoError(t, err)
+	require.NoError(t, globalEngine.Init())
+
+	rootCommand := prepareRootCommand()
+	globalRootCommand = rootCommand
+	createCommandsForWorkflows(rootCommand, globalEngine)
+
+	return rootCommand
+}
+
+func findCommand(t *testing.T, root *cobra.Command, path ...string) *cobra.Command {
+	t.Helper()
+
+	cmd, _, err := root.Find(path)
+	require.NoError(t, err)
+	return cmd
+}
+
+func helpSubcommand() *cobra.Command {
+	return &cobra.Command{Use: "help"}
+}