-
-
Notifications
You must be signed in to change notification settings - Fork 1k
/
cmd_suites.go
325 lines (255 loc) · 7.71 KB
/
cmd_suites.go
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
package main
import (
"errors"
"fmt"
"io/ioutil"
"os"
"os/signal"
"sort"
"strings"
"syscall"
"time"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/authelia/authelia/internal/suites"
"github.com/authelia/authelia/internal/utils"
)
// ErrNotAvailableSuite error raised when suite is not available.
var ErrNotAvailableSuite = errors.New("unavailable suite")
// ErrNoRunningSuite error raised when no suite is running.
var ErrNoRunningSuite = errors.New("no running suite")
// runningSuiteFile name of the file containing the currently running suite.
var runningSuiteFile = ".suite"
var headless bool
var testPattern string
func init() {
SuitesTestCmd.Flags().BoolVar(&headless, "headless", false, "Run tests in headless mode")
SuitesTestCmd.Flags().StringVar(&testPattern, "test", "", "The single test to run")
}
// SuitesListCmd Command for listing the available suites.
var SuitesListCmd = &cobra.Command{
Use: "list",
Short: "List available suites.",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println(strings.Join(listSuites(), "\n"))
},
Args: cobra.ExactArgs(0),
}
// SuitesSetupCmd Command to setup a suite environment.
var SuitesSetupCmd = &cobra.Command{
Use: "setup [suite]",
Short: "Setup a Go suite environment. Suites can be listed using the list command.",
Run: func(cmd *cobra.Command, args []string) {
providedSuite := args[0]
runningSuite, err := getRunningSuite()
if err != nil {
log.Fatal(err)
}
if runningSuite != "" && runningSuite != providedSuite {
log.Fatal("A suite is already running")
}
if err := setupSuite(providedSuite); err != nil {
log.Fatal(err)
}
},
Args: cobra.ExactArgs(1),
}
// SuitesTeardownCmd Command for tearing down a suite environment.
var SuitesTeardownCmd = &cobra.Command{
Use: "teardown [suite]",
Short: "Teardown a Go suite environment. Suites can be listed using the list command.",
Run: func(cmd *cobra.Command, args []string) {
var suiteName string
if len(args) == 1 {
suiteName = args[0]
} else {
runningSuite, err := getRunningSuite()
if err != nil {
log.Fatal(err)
}
if runningSuite == "" {
log.Fatal(ErrNoRunningSuite)
}
suiteName = runningSuite
}
if err := teardownSuite(suiteName); err != nil {
log.Fatal(err)
}
},
Args: cobra.MaximumNArgs(1),
}
// SuitesTestCmd Command for testing a suite.
var SuitesTestCmd = &cobra.Command{
Use: "test [suite]",
Short: "Test a suite. Suites can be listed using the list command.",
Run: testSuite,
Args: cobra.MaximumNArgs(1),
}
func listSuites() []string {
suiteNames := make([]string, 0)
suiteNames = append(suiteNames, suites.GlobalRegistry.Suites()...)
sort.Strings(suiteNames)
return suiteNames
}
func checkSuiteAvailable(suite string) error {
suites := listSuites()
for _, s := range suites {
if s == suite {
return nil
}
}
return ErrNotAvailableSuite
}
func runSuiteSetupTeardown(command string, suite string) error {
selectedSuite := suite
err := checkSuiteAvailable(selectedSuite)
if err != nil {
if err == ErrNotAvailableSuite {
log.Fatal(errors.New("Suite named " + selectedSuite + " does not exist"))
}
log.Fatal(err)
}
s := suites.GlobalRegistry.Get(selectedSuite)
cmd := utils.CommandWithStdout("go", "run", "cmd/authelia-suites/main.go", command, selectedSuite)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Env = os.Environ()
return utils.RunCommandWithTimeout(cmd, s.SetUpTimeout)
}
func runOnSetupTimeout(suite string) error {
cmd := utils.CommandWithStdout("go", "run", "cmd/authelia-suites/main.go", "timeout", suite)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Env = os.Environ()
return utils.RunCommandWithTimeout(cmd, 15*time.Second)
}
func runOnError(suite string) error {
cmd := utils.CommandWithStdout("go", "run", "cmd/authelia-suites/main.go", "error", suite)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Env = os.Environ()
return utils.RunCommandWithTimeout(cmd, 15*time.Second)
}
func setupSuite(suiteName string) error {
log.Infof("Setup environment for suite %s...", suiteName)
signalChannel := make(chan os.Signal)
signal.Notify(signalChannel, os.Interrupt, syscall.SIGTERM)
interrupted := false
go func() {
<-signalChannel
interrupted = true
}()
if errSetup := runSuiteSetupTeardown("setup", suiteName); errSetup != nil || interrupted {
if errSetup == utils.ErrTimeoutReached {
runOnSetupTimeout(suiteName) //nolint:errcheck // TODO: Legacy code, consider refactoring time permitting.
}
teardownSuite(suiteName) //nolint:errcheck // TODO: Legacy code, consider refactoring time permitting.
return errSetup
}
return nil
}
func teardownSuite(suiteName string) error {
log.Infof("Tear down environment for suite %s...", suiteName)
return runSuiteSetupTeardown("teardown", suiteName)
}
func testSuite(cmd *cobra.Command, args []string) {
runningSuite, err := getRunningSuite()
if err != nil {
log.Fatal(err)
}
// If suite(s) are provided as argument.
if len(args) >= 1 {
suiteArg := args[0]
if runningSuite != "" && suiteArg != runningSuite {
log.Fatal(errors.New("Running suite (" + runningSuite + ") is different than suite(s) to be tested (" + suiteArg + "). Shutdown running suite and retry"))
}
if err := runMultipleSuitesTests(strings.Split(suiteArg, ","), runningSuite == ""); err != nil {
log.Fatal(err)
}
} else {
if runningSuite != "" {
fmt.Println("Running suite (" + runningSuite + ") detected. Run tests of that suite")
if err := runSuiteTests(runningSuite, false); err != nil {
log.Fatal(err)
}
} else {
fmt.Println("No suite provided therefore all suites will be tested")
if err := runAllSuites(); err != nil {
log.Fatal(err)
}
}
}
}
func getRunningSuite() (string, error) {
exist, err := utils.FileExists(runningSuiteFile)
if err != nil {
return "", err
}
if !exist {
return "", nil
}
b, err := ioutil.ReadFile(runningSuiteFile)
return string(b), err
}
func runSuiteTests(suiteName string, withEnv bool) error {
if withEnv {
if err := setupSuite(suiteName); err != nil {
return err
}
}
suite := suites.GlobalRegistry.Get(suiteName)
// Default value is 1 minute.
timeout := "60s"
if suite.TestTimeout > 0 {
timeout = fmt.Sprintf("%ds", int64(suite.TestTimeout/time.Second))
}
testCmdLine := fmt.Sprintf("go test -count=1 -v ./internal/suites -timeout %s ", timeout)
if testPattern != "" {
testCmdLine += fmt.Sprintf("-run '%s'", testPattern)
} else {
testCmdLine += fmt.Sprintf("-run '^(Test%sSuite)$'", suiteName)
}
log.Infof("Running tests of suite %s...", suiteName)
log.Debugf("Running tests with command: %s", testCmdLine)
cmd := utils.CommandWithStdout("bash", "-c", testCmdLine)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Env = os.Environ()
if headless {
cmd.Env = append(cmd.Env, "HEADLESS=y")
}
testErr := cmd.Run()
// If the tests failed, run the error hook.
if testErr != nil {
if err := runOnError(suiteName); err != nil {
// Do not return this error to return the test error instead
// and not skip the teardown phase.
log.Errorf("Error executing OnError callback: %v", err)
}
}
if withEnv {
if err := teardownSuite(suiteName); err != nil {
// Do not return this error to return the test error instead.
log.Errorf("Error running teardown: %v", err)
}
}
return testErr
}
func runMultipleSuitesTests(suiteNames []string, withEnv bool) error {
for _, suiteName := range suiteNames {
if err := runSuiteTests(suiteName, withEnv); err != nil {
return err
}
}
return nil
}
func runAllSuites() error {
log.Info("Start running all suites")
for _, s := range listSuites() {
if err := runSuiteTests(s, true); err != nil {
return err
}
}
log.Info("All suites passed successfully")
return nil
}