|
| 1 | +package cli_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "os" |
| 5 | + "testing" |
| 6 | + |
| 7 | + "github.com/kanopy-platform/go-library/cli" |
| 8 | + "github.com/spf13/cobra" |
| 9 | + "github.com/stretchr/testify/assert" |
| 10 | +) |
| 11 | + |
| 12 | +type testCLI struct { |
| 13 | + String string |
| 14 | + Int int |
| 15 | + SubString string `split_words:"true"` |
| 16 | + OverrideFlagRoot string `split_words:"true"` |
| 17 | + OverrideFlagSub string `split_words:"true"` |
| 18 | +} |
| 19 | + |
| 20 | +func (c *testCLI) RootCmd() *cobra.Command { |
| 21 | + emptyRun := func(_ *cobra.Command, _ []string) {} |
| 22 | + |
| 23 | + root := &cobra.Command{ |
| 24 | + Use: "root", |
| 25 | + Run: emptyRun, |
| 26 | + PersistentPreRunE: func(cmd *cobra.Command, _ []string) error { |
| 27 | + return cli.EnvconfigProcessWithPflags("APP", cmd.Flags(), c) |
| 28 | + }, |
| 29 | + } |
| 30 | + |
| 31 | + root.PersistentFlags().StringVar(&c.String, "string", "default", "") |
| 32 | + root.PersistentFlags().IntVar(&c.Int, "int", 1, "") |
| 33 | + root.PersistentFlags().StringVar(&c.OverrideFlagRoot, "override", "root", "") |
| 34 | + |
| 35 | + sub := &cobra.Command{Use: "sub", Run: emptyRun} |
| 36 | + sub.Flags().StringVar(&c.SubString, "substring", "default", "") |
| 37 | + sub.PersistentFlags().StringVar(&c.OverrideFlagSub, "override", "sub", "") |
| 38 | + |
| 39 | + root.AddCommand(sub) |
| 40 | + |
| 41 | + return root |
| 42 | +} |
| 43 | + |
| 44 | +// checks that the correct order of precedence is adhered to: flag > env > default |
| 45 | +func TestPrecedence(t *testing.T) { |
| 46 | + tests := []struct { |
| 47 | + desc string |
| 48 | + env map[string]string |
| 49 | + args []string |
| 50 | + want testCLI |
| 51 | + }{ |
| 52 | + { |
| 53 | + desc: "test root defaults", |
| 54 | + want: testCLI{ |
| 55 | + String: "default", |
| 56 | + Int: 1, |
| 57 | + SubString: "default", |
| 58 | + OverrideFlagRoot: "root", |
| 59 | + OverrideFlagSub: "sub", |
| 60 | + }, |
| 61 | + }, |
| 62 | + { |
| 63 | + desc: "test root override", |
| 64 | + args: []string{"--override=flag"}, |
| 65 | + want: testCLI{ |
| 66 | + String: "default", |
| 67 | + Int: 1, |
| 68 | + SubString: "default", |
| 69 | + OverrideFlagRoot: "flag", |
| 70 | + OverrideFlagSub: "sub", |
| 71 | + }, |
| 72 | + }, |
| 73 | + { |
| 74 | + desc: "test sub defaults", |
| 75 | + args: []string{"sub"}, |
| 76 | + want: testCLI{ |
| 77 | + String: "default", |
| 78 | + Int: 1, |
| 79 | + SubString: "default", |
| 80 | + OverrideFlagRoot: "root", |
| 81 | + OverrideFlagSub: "sub", |
| 82 | + }, |
| 83 | + }, |
| 84 | + { |
| 85 | + desc: "test sub env", |
| 86 | + args: []string{"sub"}, |
| 87 | + env: map[string]string{ |
| 88 | + "APP_STRING": "env", |
| 89 | + "APP_INT": "2", |
| 90 | + "APP_SUB_STRING": "env", |
| 91 | + "APP_OVERRIDE_FLAG_SUB": "env", |
| 92 | + }, |
| 93 | + want: testCLI{ |
| 94 | + String: "env", |
| 95 | + Int: 2, |
| 96 | + SubString: "env", |
| 97 | + OverrideFlagRoot: "root", |
| 98 | + OverrideFlagSub: "env", |
| 99 | + }, |
| 100 | + }, |
| 101 | + { |
| 102 | + desc: "test sub flags", |
| 103 | + args: []string{ |
| 104 | + "sub", |
| 105 | + "--string=flag", |
| 106 | + "--int=3", |
| 107 | + "--substring=flag", |
| 108 | + "--override=flag", |
| 109 | + }, |
| 110 | + want: testCLI{ |
| 111 | + String: "flag", |
| 112 | + Int: 3, |
| 113 | + SubString: "flag", |
| 114 | + OverrideFlagRoot: "root", |
| 115 | + OverrideFlagSub: "flag", |
| 116 | + }, |
| 117 | + }, |
| 118 | + { |
| 119 | + desc: "test sub flags > env", |
| 120 | + env: map[string]string{ |
| 121 | + "APP_STRING": "env", |
| 122 | + "APP_INT": "2", |
| 123 | + "APP_SUB_STRING": "env", |
| 124 | + "APP_OVERRIDE_FLAG_ROOT": "env", |
| 125 | + "APP_OVERRIDE_FLAG_SUB": "env", |
| 126 | + }, |
| 127 | + args: []string{ |
| 128 | + "sub", |
| 129 | + "--string=flag", |
| 130 | + "--int=3", |
| 131 | + "--substring=flag", |
| 132 | + "--override=flag", |
| 133 | + }, |
| 134 | + want: testCLI{ |
| 135 | + String: "flag", |
| 136 | + Int: 3, |
| 137 | + SubString: "flag", |
| 138 | + OverrideFlagRoot: "env", |
| 139 | + OverrideFlagSub: "flag", |
| 140 | + }, |
| 141 | + }, |
| 142 | + } |
| 143 | + |
| 144 | + for _, test := range tests { |
| 145 | + for k, v := range test.env { |
| 146 | + assert.NoError(t, os.Setenv(k, v)) |
| 147 | + } |
| 148 | + |
| 149 | + cli := &testCLI{} |
| 150 | + cmd := cli.RootCmd() |
| 151 | + cmd.SetArgs(test.args) |
| 152 | + assert.NoError(t, cmd.Execute()) |
| 153 | + |
| 154 | + assert.Equal(t, test.want, *cli, test.desc) |
| 155 | + |
| 156 | + for k := range test.env { |
| 157 | + assert.NoError(t, os.Unsetenv(k)) |
| 158 | + } |
| 159 | + } |
| 160 | +} |
0 commit comments