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
|
package praefect
import (
"bytes"
"context"
"errors"
"io"
"testing"
"github.com/stretchr/testify/assert"
"github.com/urfave/cli/v2"
"gitlab.com/gitlab-org/gitaly/v15/internal/praefect/config"
"gitlab.com/gitlab-org/gitaly/v15/internal/praefect/service"
)
func TestCheckSubcommand(t *testing.T) {
t.Parallel()
conf := config.Config{
ListenAddr: ":0",
VirtualStorages: []*config.VirtualStorage{
{
Name: "vs",
Nodes: []*config.Node{
{Address: "stub", Storage: "st"},
},
},
},
}
confPath := writeConfigToFile(t, conf)
testCases := []struct {
desc string
checks []service.CheckFunc
args []string
expectedQuietOutput string
expectedOutput string
expectedError error
}{
{
desc: "positional arguments",
args: []string{"positional-arg"},
expectedError: cli.Exit(unexpectedPositionalArgsError{Command: "check"}, 1),
},
{
desc: "all checks pass",
checks: []service.CheckFunc{
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 1",
Description: "checks a",
Run: func(ctx context.Context) error { return nil },
Severity: service.Fatal,
}
},
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 2",
Description: "checks b",
Run: func(ctx context.Context) error { return nil },
Severity: service.Fatal,
}
},
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 3",
Description: "checks c",
Run: func(ctx context.Context) error { return nil },
Severity: service.Fatal,
}
},
},
expectedOutput: `Checking check 1 - checks a [fatal]
Passed
Checking check 2 - checks b [fatal]
Passed
Checking check 3 - checks c [fatal]
Passed
All checks passed.
`,
expectedQuietOutput: `Checking check 1...Passed
Checking check 2...Passed
Checking check 3...Passed
All checks passed.
`,
expectedError: nil,
},
{
desc: "a fatal check fails",
checks: []service.CheckFunc{
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 1",
Description: "checks a",
Run: func(ctx context.Context) error { return nil },
Severity: service.Fatal,
}
},
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 2",
Description: "checks b",
Run: func(ctx context.Context) error { return errors.New("i failed") },
Severity: service.Fatal,
}
},
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 3",
Description: "checks c",
Run: func(ctx context.Context) error { return nil },
Severity: service.Fatal,
}
},
},
expectedOutput: `Checking check 1 - checks a [fatal]
Passed
Checking check 2 - checks b [fatal]
Failed (fatal) error: i failed
Checking check 3 - checks c [fatal]
Passed
1 check(s) failed, at least one was fatal.
`,
expectedQuietOutput: `Checking check 1...Passed
Checking check 2...Failed (fatal) error: i failed
Checking check 3...Passed
1 check(s) failed, at least one was fatal.
`,
expectedError: errFatalChecksFailed,
},
{
desc: "only warning checks fail",
checks: []service.CheckFunc{
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 1",
Description: "checks a",
Run: func(ctx context.Context) error { return nil },
Severity: service.Fatal,
}
},
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 2",
Description: "checks b",
Run: func(ctx context.Context) error { return errors.New("i failed but not too badly") },
Severity: service.Warning,
}
},
func(cfg config.Config, w io.Writer, quiet bool) *service.Check {
return &service.Check{
Name: "check 3",
Description: "checks c",
Run: func(ctx context.Context) error { return errors.New("i failed but not too badly") },
Severity: service.Warning,
}
},
},
expectedOutput: `Checking check 1 - checks a [fatal]
Passed
Checking check 2 - checks b [warning]
Failed (warning) error: i failed but not too badly
Checking check 3 - checks c [warning]
Failed (warning) error: i failed but not too badly
2 check(s) failed, but none are fatal.
`,
expectedQuietOutput: `Checking check 1...Passed
Checking check 2...Failed (warning) error: i failed but not too badly
Checking check 3...Failed (warning) error: i failed but not too badly
2 check(s) failed, but none are fatal.
`,
expectedError: nil,
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
var stdout bytes.Buffer
app := cli.App{
Writer: &stdout,
Commands: []*cli.Command{
newCheckCommand(tc.checks),
},
Flags: []cli.Flag{
&cli.StringFlag{
Name: "config",
Value: confPath,
},
},
}
t.Run("quiet", func(t *testing.T) {
stdout.Reset()
err := app.Run(append([]string{progname, "check", "-q"}, tc.args...))
assert.Equal(t, tc.expectedError, err)
if len(tc.args) == 0 {
assert.Equal(t, tc.expectedQuietOutput, stdout.String())
}
})
t.Run("normal", func(t *testing.T) {
stdout.Reset()
err := app.Run(append([]string{progname, "check"}, tc.args...))
assert.Equal(t, tc.expectedError, err)
if len(tc.args) == 0 {
assert.Equal(t, tc.expectedOutput, stdout.String())
}
})
})
}
}
|
