|
| 1 | +package cmd |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "os" |
| 6 | + "path/filepath" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/spf13/cobra" |
| 10 | + "github.com/spf13/pflag" |
| 11 | + "github.com/stretchr/testify/assert" |
| 12 | + "github.com/stretchr/testify/require" |
| 13 | + |
| 14 | + "github.com/smartcontractkit/testrig/internal/hooks" |
| 15 | +) |
| 16 | + |
| 17 | +func TestIsHelpRequest(t *testing.T) { |
| 18 | + t.Parallel() |
| 19 | + |
| 20 | + tests := []struct { |
| 21 | + name string |
| 22 | + args []string |
| 23 | + want bool |
| 24 | + }{ |
| 25 | + {name: "short help", args: []string{"-h"}, want: true}, |
| 26 | + {name: "long help", args: []string{"--help"}, want: true}, |
| 27 | + {name: "go test args", args: []string{"-v", "./..."}, want: false}, |
| 28 | + {name: "after separator", args: []string{"--", "-h", "./..."}, want: false}, |
| 29 | + } |
| 30 | + |
| 31 | + for _, tc := range tests { |
| 32 | + t.Run(tc.name, func(t *testing.T) { |
| 33 | + t.Parallel() |
| 34 | + assert.Equal(t, tc.want, isHelpRequest(tc.args)) |
| 35 | + }) |
| 36 | + } |
| 37 | +} |
| 38 | + |
| 39 | +func newRootArgsTestCmd(t *testing.T) *cobra.Command { |
| 40 | + t.Helper() |
| 41 | + cmd := &cobra.Command{Use: "testrig"} |
| 42 | + cmd.PersistentFlags().Bool("ai-output", false, "") |
| 43 | + hooks.RegisterPersistentFlags(cmd.PersistentFlags()) |
| 44 | + return cmd |
| 45 | +} |
| 46 | + |
| 47 | +func TestGoTestArgsFromRoot(t *testing.T) { |
| 48 | + t.Parallel() |
| 49 | + |
| 50 | + tests := []struct { |
| 51 | + name string |
| 52 | + args []string |
| 53 | + want []string |
| 54 | + wantGlobal string |
| 55 | + wantAIOut bool |
| 56 | + }{ |
| 57 | + { |
| 58 | + name: "go test verbose after persistent", |
| 59 | + args: []string{"--ai-output", "-v", "./pkg"}, |
| 60 | + want: []string{"-v", "./pkg"}, |
| 61 | + wantAIOut: true, |
| 62 | + }, |
| 63 | + { |
| 64 | + name: "go test count flag", |
| 65 | + args: []string{"-count=1", "./..."}, |
| 66 | + want: []string{"-count=1", "./..."}, |
| 67 | + }, |
| 68 | + { |
| 69 | + name: "go test run flag", |
| 70 | + args: []string{"-run", "^TestFoo$", "./pkg"}, |
| 71 | + want: []string{"-run", "^TestFoo$", "./pkg"}, |
| 72 | + }, |
| 73 | + { |
| 74 | + name: "global setup then go test flags", |
| 75 | + args: []string{"--global-setup", "docker compose up -d", "-run", "^TestFoo$", "./pkg"}, |
| 76 | + want: []string{"-run", "^TestFoo$", "./pkg"}, |
| 77 | + wantGlobal: "docker compose up -d", |
| 78 | + }, |
| 79 | + { |
| 80 | + name: "global setup equals form", |
| 81 | + args: []string{"--global-setup=docker compose up -d", "-v", "./..."}, |
| 82 | + want: []string{"-v", "./..."}, |
| 83 | + wantGlobal: "docker compose up -d", |
| 84 | + }, |
| 85 | + { |
| 86 | + name: "double dash forwards remainder including go test help", |
| 87 | + args: []string{"--ai-output", "--", "-h", "./pkg"}, |
| 88 | + want: []string{"--", "-h", "./pkg"}, |
| 89 | + wantAIOut: true, |
| 90 | + }, |
| 91 | + } |
| 92 | + |
| 93 | + for _, tc := range tests { |
| 94 | + t.Run(tc.name, func(t *testing.T) { |
| 95 | + t.Parallel() |
| 96 | + cmd := newRootArgsTestCmd(t) |
| 97 | + |
| 98 | + got, err := goTestArgsFromRoot(cmd, tc.args) |
| 99 | + require.NoError(t, err) |
| 100 | + assert.Equal(t, tc.want, got) |
| 101 | + |
| 102 | + if tc.wantAIOut { |
| 103 | + v, err := cmd.PersistentFlags().GetBool("ai-output") |
| 104 | + require.NoError(t, err) |
| 105 | + assert.True(t, v) |
| 106 | + } |
| 107 | + if tc.wantGlobal != "" { |
| 108 | + v, err := cmd.PersistentFlags().GetString("global-setup") |
| 109 | + require.NoError(t, err) |
| 110 | + assert.Equal(t, tc.wantGlobal, v) |
| 111 | + } |
| 112 | + }) |
| 113 | + } |
| 114 | +} |
| 115 | + |
| 116 | +func TestRunRootAfterParsingAppliesFlagsBeforeHooks(t *testing.T) { |
| 117 | + t.Parallel() |
| 118 | + |
| 119 | + dir := t.TempDir() |
| 120 | + marker := filepath.Join(dir, "setup") |
| 121 | + cmd := newRootArgsTestCmd(t) |
| 122 | + cmd.SetContext(context.Background()) |
| 123 | + |
| 124 | + err := runRootAfterParsing(cmd, []string{"--global-setup", touchCmd(marker)}, func([]string) error { |
| 125 | + return nil |
| 126 | + }) |
| 127 | + require.NoError(t, err) |
| 128 | + assert.FileExists(t, marker) |
| 129 | +} |
| 130 | + |
| 131 | +func TestRunRootAfterParsingHelpSkipsHooks(t *testing.T) { |
| 132 | + t.Parallel() |
| 133 | + |
| 134 | + dir := t.TempDir() |
| 135 | + marker := filepath.Join(dir, "setup") |
| 136 | + cmd := newRootArgsTestCmd(t) |
| 137 | + cmd.SetContext(context.Background()) |
| 138 | + |
| 139 | + err := runRootAfterParsing(cmd, []string{"--global-setup", touchCmd(marker), "-h"}, func([]string) error { |
| 140 | + return nil |
| 141 | + }) |
| 142 | + require.ErrorIs(t, err, pflag.ErrHelp) |
| 143 | + _, statErr := os.Stat(marker) |
| 144 | + assert.True(t, os.IsNotExist(statErr)) |
| 145 | +} |
0 commit comments