File: errs_test.go

package info (click to toggle)
golang-step-cli-utils 0.7.5%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 404 kB
  • sloc: makefile: 19
file content (361 lines) | stat: -rw-r--r-- 9,257 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
package errs

import (
	"errors"
	"flag"
	"io"
	"os"
	"strconv"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/urfave/cli"
)

func TestNewError(t *testing.T) {
	err := NewError("error was: %w", io.EOF)
	assert.EqualError(t, err, `error was: EOF`)
	assert.True(t, errors.Is(err, io.EOF))
}

func TestNewExitError(t *testing.T) {
	err := NewExitError(assert.AnError, 12)
	assert.EqualError(t, err, assert.AnError.Error())

	var ee *cli.ExitError
	require.True(t, errors.As(err, &ee))
	assert.Equal(t, 12, ee.ExitCode())
}

func TestInsecureCommand(t *testing.T) {
	const exp = `'app cmd' requires the '--insecure' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, InsecureCommand(ctx), exp)
}

func TestEqualArguments(t *testing.T) {
	const exp = `positional arguments <arg1> and <arg2> cannot be equal in 'app cmd [command options]'`

	ctx := newTestCLI(t)
	assert.EqualError(t, EqualArguments(ctx, "arg1", "arg2"), exp)
}

func TestMissingArguments(t *testing.T) {
	cases := []struct {
		args []string
		exp  string
	}{
		0: {
			exp: "missing positional arguments in 'app cmd [command options]'",
		},
		1: {
			args: []string{"arg1"},
			exp:  "missing positional argument <arg1> in 'app cmd [command options]'",
		},
		2: {
			args: []string{"arg1", "arg2"},
			exp:  "missing positional arguments <arg1> <arg2> in 'app cmd [command options]'",
		},
	}

	for caseIndex, kase := range cases {
		t.Run(strconv.Itoa(caseIndex), func(t *testing.T) {
			ctx := newTestCLI(t, kase.args...)
			assert.EqualError(t, MissingArguments(ctx, kase.args...), kase.exp)
		})
	}
}

func TestNumberOfArguments(t *testing.T) {
	ctx := newTestCLI(t, "arg1", "arg2")

	cases := map[int]string{
		0: "too many positional arguments were provided in 'app cmd [command options]'",
		1: "too many positional arguments were provided in 'app cmd [command options]'",
		2: "",
		3: "not enough positional arguments were provided in 'app cmd [command options]'",
	}

	for n := range cases {
		exp := cases[n]

		t.Run(strconv.Itoa(n), func(t *testing.T) {
			if exp == "" {
				assert.NoError(t, NumberOfArguments(ctx, n))
			} else {
				assert.EqualError(t, NumberOfArguments(ctx, n), exp)
			}
		})
	}
}

func TestMinMaxNumberOfArguments(t *testing.T) {
	ctx := newTestCLI(t, "arg1", "arg2")

	cases := []struct {
		min int
		max int
		exp string
	}{

		0: {0, 1, "too many positional arguments were provided in 'app cmd [command options]'"},
		1: {1, 3, ""},
		2: {3, 4, "not enough positional arguments were provided in 'app cmd [command options]'"},
	}

	for caseIndex := range cases {
		kase := cases[caseIndex]

		t.Run(strconv.Itoa(caseIndex), func(t *testing.T) {
			got := MinMaxNumberOfArguments(ctx, kase.min, kase.max)

			if kase.exp == "" {
				assert.NoError(t, got)
			} else {
				assert.EqualError(t, got, kase.exp)
			}
		})
	}
}

func TestInsecureArgument(t *testing.T) {
	const exp = `positional argument <arg> requires the '--insecure' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, InsecureArgument(ctx, "arg"), exp)
}

func TestFlagValueInsecure(t *testing.T) {
	const exp = `flag '--flag1 value2' requires the '--insecure' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, FlagValueInsecure(ctx, "flag1", "value2"), exp)
}

func TestInvalidFlagValue(t *testing.T) {
	ctx := newTestCLI(t)

	cases := []struct {
		value   string
		options string
		exp     string
	}{

		0: {
			exp: `missing value for flag '--myflag'`,
		},
		1: {
			value: "val2",
			exp:   `invalid value 'val2' for flag '--myflag'`,
		},
		2: {
			options: `'val3'`,
			exp:     `missing value for flag '--myflag'; options are 'val3'`,
		},
		3: {
			value:   "val2",
			options: `'val3', 'val4'`,
			exp:     `invalid value 'val2' for flag '--myflag'; options are 'val3', 'val4'`,
		},
	}

	for caseIndex := range cases {
		kase := cases[caseIndex]

		t.Run(strconv.Itoa(caseIndex), func(t *testing.T) {
			got := InvalidFlagValue(ctx, "myflag", kase.value, kase.options)

			assert.EqualError(t, got, kase.exp)
		})
	}
}

func TestIncompatibleFlag(t *testing.T) {
	const exp = `flag '--flag1' is incompatible with '--flag2'`

	ctx := newTestCLI(t)
	assert.EqualError(t, IncompatibleFlag(ctx, "flag1", "--flag2"), exp)
}

func TestIncompatibleFlagWithFlag(t *testing.T) {
	const exp = `flag '--flag1' is incompatible with '--flag2'`

	ctx := newTestCLI(t)
	assert.EqualError(t, IncompatibleFlagWithFlag(ctx, "flag1", "flag2"), exp)
}

func TestIncompatibleFlagValue(t *testing.T) {
	const exp = `flag '--flag1' is incompatible with flag '--with2 value3'`

	ctx := newTestCLI(t)
	assert.EqualError(t, IncompatibleFlagValue(ctx, "flag1", "with2", "value3"), exp)
}

func TestIncompatibleFlagValues(t *testing.T) {
	const exp = `flag '--flag1 value2' is incompatible with flag '--with2 value4'`

	ctx := newTestCLI(t)
	assert.EqualError(t, IncompatibleFlagValues(ctx, "flag1", "value2", "with2", "value4"), exp)
}

func TestIncompatibleFlagValueWithFlagValue(t *testing.T) {
	const exp = `flag '--flag1 value2' is incompatible with flag '--with2 value4'

  Option(s): --with2 opt`

	ctx := newTestCLI(t)
	assert.EqualError(t, IncompatibleFlagValueWithFlagValue(ctx, "flag1", "value2", "with2", "value4", "opt"), exp)
}

func TestRequiredFlag(t *testing.T) {
	const exp = `'app cmd' requires the '--f1' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredFlag(ctx, "f1"), exp)
}

func TestRequiredWithFlag(t *testing.T) {
	const exp = `flag '--f1' requires the '--f2' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredWithFlag(ctx, "f1", "f2"), exp)
}

func TestRequiredWithFlagValue(t *testing.T) {
	const exp = `'--f1 v1' requires the '--f2' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredWithFlagValue(ctx, "f1", "v1", "f2"), exp)
}

func TestRequiredWithProvisionerTypeFlag(t *testing.T) {
	const exp = `provisioner type 'p1' requires the '--f1' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredWithProvisionerTypeFlag(ctx, "p1", "f1"), exp)
}

func TestRequiredInsecureFlag(t *testing.T) {
	const exp = `flag '--f1' requires the '--insecure' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredInsecureFlag(ctx, "f1"), exp)
}

func TestRequiredSubtleFlag(t *testing.T) {
	const exp = `flag '--f1' requires the '--subtle' flag`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredSubtleFlag(ctx, "f1"), exp)
}

func TestRequiredUnlessInsecureFlag(t *testing.T) {
	const exp = `flag '--f1' is required unless the '--insecure' flag is provided`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredUnlessInsecureFlag(ctx, "f1"), exp)
}

func TestRequiredUnlessSubtleFlag(t *testing.T) {
	const exp = `flag '--f1' is required unless the '--subtle' flag is provided`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredUnlessSubtleFlag(ctx, "f1"), exp)
}

func TestRequiredOrFlag(t *testing.T) {
	const exp = `one of flag --f1 or --f2 or --f3 is required`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredOrFlag(ctx, "f1", "f2", "f3"), exp)
}

func TestRequiredWithOrFlag(t *testing.T) {
	const exp = `one of flag --f1 or --f2 or --f3 is required with flag --f4`

	ctx := newTestCLI(t)
	assert.EqualError(t, RequiredWithOrFlag(ctx, "f4", "f1", "f2", "f3"), exp)
}

func TestMinSizeFlag(t *testing.T) {
	const exp = `flag '--f1' must be greater than or equal to 10`

	ctx := newTestCLI(t)
	assert.EqualError(t, MinSizeFlag(ctx, "f1", "10"), exp)
}

func TestMinSizeInsecureFlag(t *testing.T) {
	const exp = `flag '--f1' requires at least 10 unless '--insecure' flag is provided`

	ctx := newTestCLI(t)
	assert.EqualError(t, MinSizeInsecureFlag(ctx, "f1", "10"), exp)
}

func TestMutuallyExclusiveFlags(t *testing.T) {
	const exp = `flag '--f1' and flag '--f2' are mutually exclusive`

	ctx := newTestCLI(t)
	assert.EqualError(t, MutuallyExclusiveFlags(ctx, "f1", "f2"), exp)
}

func TestUnsupportedFlag(t *testing.T) {
	const exp = `flag '--f1' is not yet supported`

	ctx := newTestCLI(t)
	assert.EqualError(t, UnsupportedFlag(ctx, "f1"), exp)
}

func TestFileError(t *testing.T) {
	tests := []struct {
		err      error
		expected string
	}{
		{
			err:      os.NewSyscallError("open", errors.New("out of file descriptors")),
			expected: "open failed: out of file descriptors",
		},
		{
			err: func() error {
				_, err := os.ReadFile("im-fairly-certain-this-file-doesnt-exist")
				require.Error(t, err)
				return err
			}(),
			expected: "open im-fairly-certain-this-file-doesnt-exist failed",
		},
		{
			err: func() error {
				err := os.Link("im-fairly-certain-this-file-doesnt-exist", "neither-does-this")
				require.Error(t, err)
				return err
			}(),
			expected: "link im-fairly-certain-this-file-doesnt-exist neither-does-this failed",
		},
	}
	for _, tt := range tests {
		err := FileError(tt.err, "myfile")
		require.Error(t, err)
		require.Contains(t, err.Error(), tt.expected)
	}
}

func newTestCLI(t *testing.T, args ...string) *cli.Context {
	t.Helper()

	fs := flag.NewFlagSet("cmd", flag.ContinueOnError)
	require.NoError(t, fs.Parse(args))

	app := cli.NewApp()
	app.Name = "app"
	app.HelpName = "app"
	app.Writer = io.Discard
	app.ErrWriter = io.Discard

	ctx := cli.NewContext(app, fs, nil)
	ctx.Command = cli.Command{
		Name: "cmd",
	}

	return ctx
}