cli/errors_test.go at main · bjaus/cli · GitHub

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
package cli_test

import (
	"errors"
	"testing"

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

func TestExit(t *testing.T) {
	t.Parallel()

	tests := map[string]struct {
		message  string
		code     int
		wantMsg  string
		wantCode int
	}{
		"non-zero exit": {
			message:  "something failed",
			code:     42,
			wantMsg:  "something failed",
			wantCode: 42,
		},
		"zero exit": {
			message:  "ok",
			code:     0,
			wantMsg:  "ok",
			wantCode: 0,
		},
		"exit code 1": {
			message:  "generic error",
			code:     1,
			wantMsg:  "generic error",
			wantCode: 1,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			t.Parallel()

			err := cli.Exit(tt.message, tt.code)
			require.Error(t, err)
			assert.Equal(t, tt.wantMsg, err.Error())

			var ec cli.ExitCoder
			require.ErrorAs(t, err, &ec)
			assert.Equal(t, tt.wantCode, ec.ExitCode())
		})
	}
}

func TestExitf(t *testing.T) {
	t.Parallel()

	err := cli.Exitf(2, "port %d in use", 8080)
	require.Error(t, err)
	assert.Equal(t, "port 8080 in use", err.Error())

	var ec cli.ExitCoder
	require.ErrorAs(t, err, &ec)
	assert.Equal(t, 2, ec.ExitCode())
}

func TestExitCoder_ErrorsAs(t *testing.T) {
	t.Parallel()

	err := cli.Exit("inner", 3)
	wrapped := errors.New("outer: " + err.Error())

	// Direct ExitCoder extraction works.
	var ec cli.ExitCoder
	require.ErrorAs(t, err, &ec)
	assert.Equal(t, 3, ec.ExitCode())

	// Plain wrapped error does not satisfy ExitCoder.
	assert.False(t, errors.As(wrapped, &ec))
}

func TestHelpSignals(t *testing.T) {
	t.Parallel()

	tests := []struct {
		name     string
		signal   error
		wantMsg  string
		wantCode int
	}{
		{
			name:     "ShowHelp exits 0",
			signal:   cli.ShowHelp,
			wantMsg:  "show help",
			wantCode: 0,
		},
		{
			name:     "ErrShowHelp exits 1",
			signal:   cli.ErrShowHelp,
			wantMsg:  "show help",
			wantCode: 1,
		},
		{
			name:     "ShowUsage exits 0",
			signal:   cli.ShowUsage,
			wantMsg:  "show usage",
			wantCode: 0,
		},
		{
			name:     "ErrShowUsage exits 1",
			signal:   cli.ErrShowUsage,
			wantMsg:  "show usage",
			wantCode: 1,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()

			assert.Equal(t, tt.wantMsg, tt.signal.Error())

			var ec cli.ExitCoder
			require.ErrorAs(t, tt.signal, &ec)
			assert.Equal(t, tt.wantCode, ec.ExitCode())
		})
	}
}