|
| 1 | +package flags |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "io" |
| 6 | + "strings" |
| 7 | + "testing" |
| 8 | + "testing/fstest" |
| 9 | + |
| 10 | + "github.com/spf13/cobra" |
| 11 | + |
| 12 | + "github.com/stackitcloud/stackit-cli/internal/pkg/testparams" |
| 13 | + "github.com/stackitcloud/stackit-cli/internal/pkg/utils" |
| 14 | +) |
| 15 | + |
| 16 | +type testFile struct { |
| 17 | + path, content string |
| 18 | +} |
| 19 | + |
| 20 | +func TestSecretFlag(t *testing.T) { |
| 21 | + t.Parallel() |
| 22 | + tests := []struct { |
| 23 | + name string |
| 24 | + value string |
| 25 | + want *string |
| 26 | + file *testFile |
| 27 | + stdin string |
| 28 | + wantErr bool |
| 29 | + wantStdErr string |
| 30 | + }{ |
| 31 | + { |
| 32 | + name: "no value: prompts", |
| 33 | + value: "", |
| 34 | + want: utils.Ptr("from stdin"), |
| 35 | + stdin: "from stdin", |
| 36 | + }, |
| 37 | + { |
| 38 | + name: "a value: prints deprecation", |
| 39 | + value: "a value", |
| 40 | + want: utils.Ptr("a value"), |
| 41 | + wantStdErr: "Warning: Passing a secret value on the command line is insecure and deprecated. This usage will stop working October 2026.\n", |
| 42 | + }, |
| 43 | + { |
| 44 | + name: "from an existing file", |
| 45 | + value: "@some-file.txt", |
| 46 | + want: utils.Ptr("from file"), |
| 47 | + file: &testFile{ |
| 48 | + path: "some-file.txt", |
| 49 | + content: "from file", |
| 50 | + }, |
| 51 | + }, |
| 52 | + { |
| 53 | + name: "from a non-existing file", |
| 54 | + value: "@some-file-with-typo.txt", |
| 55 | + wantErr: true, |
| 56 | + file: &testFile{ |
| 57 | + path: "some-file.txt", |
| 58 | + content: "from file", |
| 59 | + }, |
| 60 | + }, |
| 61 | + { |
| 62 | + name: "from an existing double-quoted file", |
| 63 | + value: `@"some-file.txt"`, |
| 64 | + want: utils.Ptr("from file"), |
| 65 | + file: &testFile{ |
| 66 | + path: "some-file.txt", |
| 67 | + content: "from file", |
| 68 | + }, |
| 69 | + }, |
| 70 | + { |
| 71 | + name: "from an existing single-quoted file", |
| 72 | + value: "@'some-file.txt'", |
| 73 | + want: utils.Ptr("from file"), |
| 74 | + file: &testFile{ |
| 75 | + path: "some-file.txt", |
| 76 | + content: "from file", |
| 77 | + }, |
| 78 | + }, |
| 79 | + } |
| 80 | + |
| 81 | + for _, tt := range tests { |
| 82 | + t.Run(tt.name, func(t *testing.T) { |
| 83 | + t.Parallel() |
| 84 | + params := testparams.NewTestParams() |
| 85 | + if tt.file != nil { |
| 86 | + params.Fs = fstest.MapFS{ |
| 87 | + tt.file.path: &fstest.MapFile{ |
| 88 | + Data: []byte(tt.file.content), |
| 89 | + }, |
| 90 | + } |
| 91 | + } |
| 92 | + flag := SecretFlag("test", params.CmdParams) |
| 93 | + cmd := cobra.Command{} |
| 94 | + cmd.Flags().Var(flag, "test", flag.Usage()) |
| 95 | + if tt.stdin != "" { |
| 96 | + params.In.WriteString(tt.stdin) |
| 97 | + params.In.WriteString("\n") |
| 98 | + } |
| 99 | + |
| 100 | + if tt.value != "" { // emulate pflag only calling set when flag is specified on the command line |
| 101 | + err := cmd.Flags().Set("test", tt.value) |
| 102 | + if err != nil && !tt.wantErr { |
| 103 | + t.Fatalf("unexpected error: %v", err) |
| 104 | + } |
| 105 | + if err == nil && tt.wantErr { |
| 106 | + t.Fatalf("expected error, got none") |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + got := SecretFlagToStringPointer(params.Printer, &cmd, "test") |
| 111 | + |
| 112 | + if got != tt.want && *got != *tt.want { |
| 113 | + t.Fatalf("unexpected value: got %q, want %q", *got, *tt.want) |
| 114 | + } |
| 115 | + if tt.wantStdErr != "" { |
| 116 | + message, err := params.Err.ReadString('\n') |
| 117 | + if err != nil && err != io.EOF { |
| 118 | + t.Fatalf("reading stderr: %v", err) |
| 119 | + } |
| 120 | + if message != tt.wantStdErr { |
| 121 | + t.Fatalf("unexpected stderr: got %q, want %q", message, tt.wantStdErr) |
| 122 | + } |
| 123 | + } |
| 124 | + }) |
| 125 | + } |
| 126 | +} |
| 127 | + |
| 128 | +func TestSecretFlag_Usage(t *testing.T) { |
| 129 | + t.Parallel() |
| 130 | + tests := []struct { |
| 131 | + in string |
| 132 | + want string |
| 133 | + }{ |
| 134 | + { |
| 135 | + in: "password", |
| 136 | + want: "Password", |
| 137 | + }, |
| 138 | + { |
| 139 | + in: "Password", |
| 140 | + want: "Password", |
| 141 | + }, |
| 142 | + { |
| 143 | + in: "", |
| 144 | + want: "", |
| 145 | + }, |
| 146 | + { |
| 147 | + in: "secret-key", |
| 148 | + want: "Secret-Key", |
| 149 | + }, |
| 150 | + } |
| 151 | + for _, tt := range tests { |
| 152 | + t.Run(fmt.Sprintf("%q -> %q", tt.in, tt.want), func(t *testing.T) { |
| 153 | + t.Parallel() |
| 154 | + params := testparams.NewTestParams() |
| 155 | + flag := SecretFlag(tt.in, params.CmdParams) |
| 156 | + got := flag.Usage() |
| 157 | + if !strings.HasPrefix(got, tt.want) { |
| 158 | + t.Fatalf("unexpected usage: got %q, want %q", got, tt.want) |
| 159 | + } |
| 160 | + }) |
| 161 | + } |
| 162 | +} |
0 commit comments