/
common.go
530 lines (495 loc) · 18.9 KB
/
common.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
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
package common
import (
"encoding/json"
"fmt"
"io/ioutil"
"os"
"strconv"
"strings"
"time"
"github.com/go-resty/resty"
"github.com/mholt/archiver/v3"
"github.com/urfave/cli"
)
type testCasesCounter struct {
NotRunning int `json:"not-running,omitempty"`
Running int `json:"running,omitempty"`
Succeeded int `json:"succeeded,omitempty"`
Failed int `json:"failed,omitempty"`
Aborted int `json:"aborted,omitempty"`
Unresolved int `json:"unresolved,omitempty"`
Total int `json:"total"`
}
type taskInterval struct {
StartedAt string `json:"started_at"`
FinishedAt string `json:"finished_at"`
DurationSeconds *float64 `json:"duration_seconds"`
}
// BatchRun stands for a batch run executed on the server
type BatchRun struct {
OrganizationName string `json:"organization_name"`
ProjectName string `json:"project_name"`
BatchRunNumber int `json:"batch_run_number"`
TestSettingName string `json:"test_setting_name"`
Status string `json:"status"`
StatusNumber int `json:"status_number"`
taskInterval
TestCases struct {
testCasesCounter
Details []struct {
PatternName *string `json:"pattern_name"`
IncludedLabels []string `json:"included_labels"`
ExcludedLabels []string `json:"excluded_labels"`
Results []TestCaseResult `json:"results"`
} `json:"details"`
} `json:"test_cases"`
Url string `json:"url"`
}
type TestCaseResult struct {
Order int `json:"order"`
TestCase struct {
Number int `json:"number"`
Name string `json:"name"`
Url string `json:"url"`
} `json:"test_case"`
Status string `json:"status"`
taskInterval
DataPatterns []DataPattern `json:"data_patterns"`
}
type DataPattern struct {
DataIndex int `json:"data_index"`
Status string `json:"status"`
StartedAt string `json:"started_at"`
FinishedAt string `json:"finished_at"`
}
// BatchRuns stands for a group of batch runs executed on the server
type BatchRuns struct {
OrganizationName string `json:"organization_name"`
ProjectName string `json:"project_name"`
BatchRuns []BatchRunSummary `json:"batch_runs"`
}
type BatchRunSummary struct {
BatchRunNumber int `json:"batch_run_number"`
TestSettingName string `json:"test_setting_name"`
Status string `json:"status"`
StatusNumber int `json:"status_number"`
taskInterval
TestCases struct {
testCasesCounter
} `json:"test_cases"`
Url string `json:"url"`
}
// UploadFile stands for a file to be uploaded to the server
type UploadFile struct {
FileNo int `json:"file_no"`
}
func zipAppDir(dirPath string) string {
zipPath := dirPath + ".zip"
if err := os.RemoveAll(zipPath); err != nil {
panic(err)
}
if err := archiver.Archive([]string{dirPath}, zipPath); err != nil {
panic(err)
}
return zipPath
}
func createBaseRequest(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string) *resty.Request {
client := resty.New()
return client.
SetHostURL(urlBase+"/api/v1.0").R().
SetHeader("Authorization", "Token "+string(apiToken)).
SetHeaders(httpHeadersMap).
SetPathParams(map[string]string{
"organization": organization,
"project": project,
})
}
func handleError(resp *resty.Response) *cli.ExitError {
if resp.StatusCode() != 200 {
return cli.NewExitError(fmt.Sprintf("%s: %s", resp.Status(), resp.String()), 1)
} else {
return nil
}
}
// UploadApp uploads app/ipa/apk file to the server
func UploadApp(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, appPath string) (int, *cli.ExitError) {
stat, err := os.Stat(appPath)
if err != nil {
return 0, cli.NewExitError(fmt.Sprintf("%s does not exist", appPath), 1)
}
var actualPath string
if stat.Mode().IsDir() {
if strings.HasSuffix(appPath, ".app") {
actualPath = zipAppDir(appPath)
} else {
return 0, cli.NewExitError(fmt.Sprintf("%s is not file but direcoty.", appPath), 1)
}
} else {
actualPath = appPath
}
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetFile("file", actualPath).
SetResult(UploadFile{}).
Post("/{organization}/{project}/upload-file/")
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return 0, exitErr
}
return res.Result().(*UploadFile).FileNo, nil
}
func mergeTestSettingsNumberToSetting(testSettingsMap map[string]interface{}, hasTestSettings bool, testSettingsNumber int) string {
testSettingsMap["test_settings_number"] = testSettingsNumber
if !hasTestSettings {
// convert {\"model\":\"Nexus 5X\"} to {\"test_settings\":[{\"model\":\"Nexus 5X\"}]}
// so that it can be treated with test_settings_number
miscSettings := make(map[string]interface{})
keysToDelete := []string{}
for k, v := range testSettingsMap {
if k != "test_settings_number" && k != "concurrency" && k != "test_settings_name" {
miscSettings[k] = v
keysToDelete = append(keysToDelete, k)
}
}
for k := range keysToDelete {
delete(testSettingsMap, keysToDelete[k])
}
if len(miscSettings) > 0 {
settingsArray := [...]map[string]interface{}{miscSettings}
testSettingsMap["test_settings"] = settingsArray
}
}
settingBytes, _ := json.Marshal(testSettingsMap)
return string(settingBytes)
}
// StartBatchRun starts a batch run or a cross batch run on the server
func StartBatchRun(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, testSettingsNumber int, setting string) (*BatchRun, *cli.ExitError) {
var testSettings interface{}
isCrossBatchRunSetting := (testSettingsNumber != 0)
if setting == "" {
setting = "{\"test_settings_number\":" + strconv.Itoa(testSettingsNumber) + "}"
} else {
err := json.Unmarshal([]byte(setting), &testSettings)
if err == nil {
testSettingsMap, ok := testSettings.(map[string]interface{})
if ok {
_, hasTestSettings := testSettingsMap["test_settings"]
testSettingsNumberInJSON, hasTestSettingsNumber := testSettingsMap["test_settings_number"]
if testSettingsNumber != 0 {
if hasTestSettingsNumber && testSettingsNumber != testSettingsNumberInJSON {
return nil, cli.NewExitError("--test_settings_number and --setting have different number", 1)
}
setting = mergeTestSettingsNumberToSetting(testSettingsMap, hasTestSettings, testSettingsNumber)
}
isCrossBatchRunSetting = isCrossBatchRunSetting || hasTestSettings || hasTestSettingsNumber
}
}
}
if isCrossBatchRunSetting {
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetHeader("Content-Type", "application/json").
SetBody(setting).
SetResult(BatchRun{}).
Post("/{organization}/{project}/cross-batch-run/")
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return nil, exitErr
}
return res.Result().(*BatchRun), nil
} else { // normal batch run
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetHeader("Content-Type", "application/json").
SetBody(setting).
SetResult(BatchRun{}).
Post("/{organization}/{project}/batch-run/")
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return nil, exitErr
}
return res.Result().(*BatchRun), nil
}
}
// GetBatchRun retrieves status and number of test cases executed of a specified batch run
func GetBatchRun(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, batchRunNumber int) (*BatchRun, *cli.ExitError) {
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetPathParams(map[string]string{
"batch_run_number": strconv.Itoa(batchRunNumber),
}).
SetResult(BatchRun{}).
Get("/{organization}/{project}/batch-run/{batch_run_number}/")
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return nil, exitErr
}
return res.Result().(*BatchRun), nil
}
func getBatchRuns(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, count int, maxBatchRunNumber int, minBatchRunNumber int) (*resty.Response, error) {
req := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetQueryParam("count", strconv.Itoa(count)).
SetResult(BatchRuns{})
// Optional filtering parameters.
if maxBatchRunNumber > 0 {
req.SetQueryParam("max_batch_run_number", strconv.Itoa(maxBatchRunNumber))
}
if minBatchRunNumber > 0 {
req.SetQueryParam("min_batch_run_number", strconv.Itoa(minBatchRunNumber))
}
return req.Get("/{organization}/{project}/batch-runs/")
}
func GetBatchRuns(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, count int, maxBatchRunNumber int, minBatchRunNumber int) (*BatchRuns, *cli.ExitError) {
res, err := getBatchRuns(urlBase, apiToken, organization, project, httpHeadersMap, count, maxBatchRunNumber, minBatchRunNumber)
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return nil, exitErr
}
return res.Result().(*BatchRuns), nil
}
func LatestBatchRunNo(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string) (int, *cli.ExitError) {
res, err := getBatchRuns(urlBase, apiToken, organization, project, httpHeadersMap, 1, 0, 0)
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return 0, exitErr
}
batchRuns := res.Result().(*BatchRuns).BatchRuns
if len(batchRuns) == 0 {
return 0, cli.NewExitError("no batch run exists in this project", 1)
}
return batchRuns[0].BatchRunNumber, nil
}
// DeleteApp deletes app/ipa/apk file on the server
func DeleteApp(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, appFileNumber int) *cli.ExitError {
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetBody(fmt.Sprintf("{\"app_file_number\":%d}", appFileNumber)).
Delete("/{organization}/{project}/delete-file/")
if err != nil {
panic(err)
}
if exitErr := handleError(res); exitErr != nil {
return exitErr
}
return nil
}
func PrepareScreenshots(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, batchRunNumber int, fileIndexType string, fileNameBodyType string, downloadType string, maskDynamicallyChangedArea bool) int {
var maskDynamicallyChangedAreaStr string
if maskDynamicallyChangedArea {
maskDynamicallyChangedAreaStr = "true"
} else {
maskDynamicallyChangedAreaStr = "false"
}
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetPathParams(map[string]string{
"batch_run_number": strconv.Itoa(batchRunNumber),
}).
SetQueryParam("file_index_type", fileIndexType).
SetQueryParam("file_name_body_type", fileNameBodyType).
SetQueryParam("download_type", downloadType).
SetQueryParam("mask_dynamically_changed_area", maskDynamicallyChangedAreaStr).
SetResult(map[string]int{}).
Post("/{organization}/{project}/batch-runs/{batch_run_number}/screenshots/")
if err != nil {
panic(err)
}
responseJson := res.Result().(*map[string]int)
return (*responseJson)["batch_task_id"]
}
func GetBatchTaskStatus(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, batchTaskId int) string {
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetPathParams(map[string]string{
"batch_task_id": strconv.Itoa(batchTaskId),
}).
SetResult(map[string]string{}).
Get("/{organization}/{project}/batch-task/{batch_task_id}/")
if err != nil {
panic(err)
}
responseJson := res.Result().(*map[string]string)
return (*responseJson)["status"]
}
func DownloadPreparedScreenshots(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string, batchTaskId int, downloadPath string) error {
res, err := createBaseRequest(urlBase, apiToken, organization, project, httpHeadersMap).
SetPathParams(map[string]string{
"batch_task_id": strconv.Itoa(batchTaskId),
}).
SetResult(map[string]string{}).
SetOutput(downloadPath).
Get("/{organization}/{project}/screenshots/{batch_task_id}/")
if err != nil {
panic(err)
}
if res.StatusCode() != 200 {
// response body is included not in res but in downloadPath file,
responseText, err := ioutil.ReadFile(downloadPath)
if err != nil {
panic(err)
}
// remove downloadPath since it contains not zip contents but just error information
err = os.Remove(downloadPath)
if err != nil {
panic(err)
}
return cli.NewExitError(fmt.Sprintf("%s: %s", res.Status(), responseText), 1)
}
return nil
}
func GetScreenshots(urlBase string, apiToken string, organization string, project string, httpHeadersMap map[string]string,
batchRunNumber int, downloadPath string, fileIndexType string, fileNameBodyType string, downloadType string,
maskDynamicallyChangedArea bool, waitLimit int, printResult bool) error {
batchTaskId := PrepareScreenshots(urlBase, apiToken, organization, project, httpHeadersMap, batchRunNumber, fileIndexType, fileNameBodyType, downloadType, maskDynamicallyChangedArea)
printMessage(printResult, "Preparing screenshots download.. \n")
interval := 5
passedSeconds := 0
actualWaitLimit := waitLimit
defaultTimeout := 300
if waitLimit == -1 {
actualWaitLimit = defaultTimeout
}
for {
status := GetBatchTaskStatus(urlBase, apiToken, organization, project, httpHeadersMap, batchTaskId)
if status == "succeeded" {
printMessage(printResult, "\nDone.\n")
break
} else if status == "running" {
printMessage(printResult, ".")
} else {
return cli.NewExitError("\nScreenshots download failed unexpectedly", 1)
}
if passedSeconds > 60 {
interval = 10
}
if passedSeconds > 120 {
interval = 30
}
if passedSeconds >= actualWaitLimit {
errorMessage := fmt.Sprintf("\nReached timeout of %d seconds while waiting for screenshots download.", actualWaitLimit)
if waitLimit == -1 {
errorMessage += fmt.Sprintf(" Default timeout is %d seconds. If it's not enough, please specify a longer value by --wait_limit or -w option.", defaultTimeout)
}
return cli.NewExitError(errorMessage, 1)
}
time.Sleep(time.Duration(interval) * time.Second)
passedSeconds += interval
}
return DownloadPreparedScreenshots(urlBase, apiToken, organization, project, httpHeadersMap, batchTaskId, downloadPath)
}
func printMessage(printResult bool, format string, args ...interface{}) {
if printResult {
fmt.Printf(format, args...)
}
}
// ExecuteBatchRun starts batch run(s) and wait for its completion with showing progress
func ExecuteBatchRun(urlBase string, apiToken string, organization string, project string,
httpHeadersMap map[string]string, testSettingsNumber int, setting string,
waitForResult bool, waitLimit int, printResult bool) (*BatchRun /*on which magicpod bitrise step depends */, bool, bool, *cli.ExitError) {
// send batch run start request
batchRun, exitErr := StartBatchRun(urlBase, apiToken, organization, project, httpHeadersMap, testSettingsNumber, setting)
if exitErr != nil {
return nil, false, false, exitErr
}
printMessage(printResult, "test result page:\n")
printMessage(printResult, "%s\n", batchRun.Url)
// finish before the test finish
if !waitForResult {
return batchRun, false, false, nil
}
return WaitForBatchRunResult(urlBase, apiToken, organization, project, httpHeadersMap, batchRun, waitLimit, printResult)
}
func WaitForBatchRunResult(urlBase string, apiToken string, organization string, project string,
httpHeadersMap map[string]string, batchRun *BatchRun,
waitLimit int, printResult bool) (*BatchRun /*on which magicpod bitrise step depends */, bool, bool, *cli.ExitError) {
crossBatchRunTotalTestCount := batchRun.TestCases.Total
const initRetryInterval = 10 // retry more frequently at first
const retryInterval = 60
var limitSeconds int
if waitLimit == 0 {
limitSeconds = crossBatchRunTotalTestCount * 10 * 60 // wait up to test count x 10 minutes by default
} else {
limitSeconds = waitLimit
}
passedSeconds := 0
existsErr := false
existsUnresolved := false
printMessage(printResult, "\n#%d wait until %d tests to be finished.. \n", batchRun.BatchRunNumber, batchRun.TestCases.Total)
prevFinished := 0
for {
batchRunUnderProgress, exitErr := GetBatchRun(urlBase, apiToken, organization, project, httpHeadersMap, batchRun.BatchRunNumber)
if exitErr != nil {
if printResult {
fmt.Print(exitErr)
}
existsErr = true
break // give up the wait here
}
finished := batchRunUnderProgress.TestCases.Succeeded + batchRunUnderProgress.TestCases.Failed + batchRunUnderProgress.TestCases.Aborted + batchRunUnderProgress.TestCases.Unresolved
printMessage(printResult, ".") // show progress to prevent "long time no output" error on CircleCI etc
// output progress
if finished != prevFinished {
notSuccessfulCount := ""
if batchRunUnderProgress.TestCases.Failed > 0 {
notSuccessfulCount = fmt.Sprintf("%d failed", batchRunUnderProgress.TestCases.Failed)
}
if batchRunUnderProgress.TestCases.Unresolved > 0 {
if notSuccessfulCount != "" {
notSuccessfulCount += ", "
}
notSuccessfulCount += fmt.Sprintf("%d unresolved", batchRunUnderProgress.TestCases.Unresolved)
}
if notSuccessfulCount != "" {
notSuccessfulCount = fmt.Sprintf(" (%s)", notSuccessfulCount)
}
printMessage(printResult, "%d/%d finished%s\n", finished, batchRun.TestCases.Total, notSuccessfulCount)
prevFinished = finished
}
if batchRunUnderProgress.Status != "running" {
if batchRunUnderProgress.TestCases.Unresolved > 0 {
existsUnresolved = true
}
if batchRunUnderProgress.Status == "succeeded" {
printMessage(printResult, "batch run succeeded\n")
break
} else if batchRunUnderProgress.Status == "failed" {
if batchRunUnderProgress.TestCases.Failed > 0 {
unresolved := ""
if existsUnresolved {
unresolved = fmt.Sprintf(", %d unresolved", batchRunUnderProgress.TestCases.Unresolved)
}
printMessage(printResult, "batch run failed (%d failed%s)\n", batchRunUnderProgress.TestCases.Failed, unresolved)
} else {
printMessage(printResult, "batch run failed\n")
}
existsErr = true
break
} else if batchRunUnderProgress.Status == "unresolved" {
printMessage(printResult, "batch run unresolved (%d unresolved)\n", batchRunUnderProgress.TestCases.Unresolved)
break
} else if batchRunUnderProgress.Status == "aborted" {
printMessage(printResult, "batch run aborted\n")
existsErr = true
break
} else {
panic(batchRunUnderProgress.Status)
}
}
if passedSeconds > limitSeconds {
return batchRun, existsErr, existsUnresolved, cli.NewExitError("batch run never finished", 1)
}
if passedSeconds < 120 {
time.Sleep(initRetryInterval * time.Second)
passedSeconds += initRetryInterval
} else {
time.Sleep(retryInterval * time.Second)
passedSeconds += retryInterval
}
}
return batchRun, existsErr, existsUnresolved, nil
}