forked from SchemaStore/schemastore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
boyka-config.json
847 lines (847 loc) · 31.3 KB
/
boyka-config.json
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/boyka-config.json",
"additionalProperties": true,
"definitions": {
"caps": {
"type": "object",
"description": "Capabilities object where you can add any capability based on the Cloud platform supported or Grid supported capabilities",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"args": {
"type": "object",
"description": "Arguments object where you can add any arguments",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"ApplicationType": {
"description": "Type of Mobile Application",
"enum": ["HYBRID", "NATIVE", "WEB"],
"type": "string"
},
"AutomationType": {
"description": "Target Appium Driver",
"enum": ["UI_AUTOMATOR", "XCUI"],
"type": "string"
},
"Browser": {
"description": "Target Web Browser",
"enum": ["CHROME", "EDGE", "FIREFOX", "NONE", "REMOTE", "SAFARI"],
"type": "string"
},
"DeviceType": {
"description": "Type of Target Device",
"enum": ["CLOUD", "VIRTUAL"],
"type": "string"
},
"LogLevel": {
"description": "Log level used to capture the Appium server logging",
"enum": [
"DEBUG",
"DEBUG_DEBUG",
"DEBUG_ERROR",
"DEBUG_INFO",
"DEBUG_WARN",
"ERROR",
"ERROR_DEBUG",
"ERROR_ERROR",
"ERROR_INFO",
"ERROR_WARN",
"INFO",
"INFO_DEBUG",
"INFO_ERROR",
"INFO_INFO",
"INFO_WARN",
"WARN",
"WARN_DEBUG",
"WARN_ERROR",
"WARN_INFO",
"WARN_WARN"
],
"type": "string"
},
"OS": {
"description": "Target Mobile OS",
"enum": ["ANDROID", "IOS"],
"type": "string"
},
"PageLoadStrategy": {
"description": "Page Load strategy for Web application",
"enum": ["NONE", "EAGER", "NORMAL"],
"type": "string"
},
"Protocol": {
"description": "Protocol for Target server",
"enum": ["HTTP", "HTTPS"],
"type": "string"
},
"Speed": {
"description": "Swiping speed for Mobile devices",
"default": "NORMAL",
"enum": ["FAST", "NORMAL", "SLOW"],
"type": "string"
},
"TargetProviders": {
"description": "Target Cloud providers",
"enum": [
"BROWSER_STACK",
"LAMBDA_TEST_MOBILE",
"LAMBDA_TEST_WEB",
"LOCAL"
],
"type": "string"
},
"VideoQuality": {
"description": "Video recording quality",
"enum": ["LOW", "MEDIUM", "HIGH", "PHOTO"],
"type": "string"
},
"WindowResizeType": {
"description": "Window resize type for Web Browser",
"enum": ["CUSTOM", "FULL_SCREEN", "MAXIMIZED", "MINIMIZED", "NORMAL"],
"type": "string"
}
},
"properties": {
"api": {
"description": "Collection of API configurations",
"additionalProperties": {
"description": "API Configuration properties",
"properties": {
"base_path": {
"description": "Base path of the API endpoint",
"type": "string"
},
"base_uri": {
"description": "Base URI of the API endpoint",
"type": "string"
},
"connection_timeout": {
"description": "API request connection timeout (in seconds)",
"type": "number"
},
"logging": {
"description": "Logging related settings",
"properties": {
"enable": {
"description": "If false, logging of API request and response will not be captured, default is set to true",
"type": "boolean"
},
"request": {
"description": "Log API request related details",
"type": "boolean"
},
"response": {
"description": "Log API response related details",
"type": "boolean"
}
},
"type": "object"
},
"port": {
"description": "Port number of API endpoint",
"type": "number"
},
"read_timeout": {
"description": "API request read timeout (in seconds)",
"type": "number"
},
"schema_path": {
"description": "API response schema files parent directory path",
"type": "string"
},
"validate_ssl": {
"description": "If set to false, SSL handshake validation will be skipped, set to true by default",
"type": "boolean"
},
"verify_host_name": {
"description": "If set to false, Host name verification will be skipped, set to true by default",
"type": "boolean"
},
"write_timeout": {
"description": "API request write timeout (in seconds)",
"type": "number"
}
},
"required": ["base_uri"],
"type": "object"
},
"type": "object"
},
"listeners_package": {
"description": "Package name where all the Boyka listener implementations are placed",
"type": "string"
},
"ui": {
"description": "UI Configurations for Web and Mobile",
"properties": {
"delay": {
"description": "UI interaction delay settings",
"properties": {
"before_click": {
"description": "Delay before clicking on an element (in ms)",
"type": "number"
},
"before_mouse_move": {
"description": "Delay before moving of mouse (in ms)",
"type": "number"
},
"before_swipe": {
"description": "Delay before swiping on the device screen or inside an element (in ms)",
"type": "number"
},
"before_tap": {
"description": "Delay before tapping on an element (in ms)",
"type": "number"
},
"before_typing": {
"description": "Delay before typing any text in an element (in ms)",
"type": "number"
}
},
"type": "object"
},
"logging": {
"description": "UI logging related settings",
"properties": {
"enable": {
"description": "If true, any log files generated by Selenium or Appium would be saved",
"default": true,
"type": "boolean"
},
"exclude_logs": {
"description": "List of type of logs which you want to exclude from",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Path where the logs should be saved",
"type": "string"
}
},
"type": "object"
},
"mobile": {
"description": "Mobile related settings",
"additionalProperties": {
"properties": {
"device": {
"description": "Mobile device related settings",
"properties": {
"accept_alerts": {
"description": "Automatically accepts alerts",
"type": "boolean"
},
"adb_timeout": {
"description": "ADB timeout (in ms)",
"type": "number"
},
"application": {
"description": "Application related settings",
"properties": {
"base_url": {
"description": "Base URL of Web application which will be used to automatically navigate it to",
"type": "string"
},
"browser": {
"$ref": "#/definitions/Browser"
},
"bundle_id": {
"description": "iOS Bundle ID",
"type": "string"
},
"chrome_driver_port": {
"description": "Chrome driver port",
"type": "number"
},
"external": {
"description": "Set to true, if the application path is not under `src/test/resources`",
"default": false,
"type": "boolean"
},
"install_timeout": {
"description": "Timeout for waiting until Application is installed on the device",
"type": "number"
},
"path": {
"description": "Path of the application under `src/test/resources` if `external` property is set to false, or Application URL for Cloud platform",
"type": "string"
},
"type": {
"$ref": "#/definitions/ApplicationType"
},
"wait_activity": {
"description": "Activity name to wait until it is loaded",
"type": "string"
},
"wait_timeout": {
"description": "Wait timeout to wait until a package or activity is loaded",
"type": "number"
}
},
"type": "object"
},
"capabilities": {
"$ref": "#/definitions/caps"
},
"clear_files": {
"description": "Set to true to clean up any cached files before starting the test session",
"type": "boolean"
},
"clear_logs": {
"description": "Set to true to clean up any old logs from the device before starting the test session",
"type": "boolean"
},
"full_reset": {
"description": "Set to true to perform full reset of the target device. This will not delete any important files, it will only clear any files or logs which was created by earlier test executions",
"type": "boolean"
},
"ignore_unimportant_views": {
"description": "Set to true to reduce the element hierarchies to only those elements which are visible to the user",
"type": "boolean"
},
"name": {
"description": "Target Device name",
"type": "string"
},
"no_reset": {
"description": "Set to true to avoid Appium to reset previous test executions files or logs",
"type": "boolean"
},
"os": {
"$ref": "#/definitions/OS"
},
"server_install_timeout": {
"description": "Timeout to wait until Appium server application is installed on the device",
"type": "number"
},
"server_launch_timeout": {
"description": "Timeout to wait until Appium server application is launched on the device",
"type": "number"
},
"swipe": {
"description": "Swipe related settings",
"properties": {
"distance": {
"description": "Distance of finger which will be moved from the starting position to the ending position",
"maximum": 100,
"minimum": 1,
"type": "number"
},
"max_swipe_until_found": {
"description": "Maximum number of swipes till the element is visible",
"minimum": 1,
"maximum": 100,
"type": "number"
},
"speed": {
"$ref": "#/definitions/Speed"
}
},
"type": "object"
},
"system_port": {
"description": "Android System port number",
"type": "number"
},
"type": {
"$ref": "#/definitions/DeviceType"
},
"typing_speed": {
"description": "Typing speed while entering the text in the input element. Only for iOS",
"default": 60,
"type": "number"
},
"unique_id": {
"description": "Device unique ID",
"type": "string"
},
"version": {
"description": "Device OS version",
"type": "string"
},
"video": {
"description": "Video recording related settings",
"properties": {
"android": {
"description": "Android video recording related settings",
"properties": {
"bit_rate": {
"description": "Bit rate of the video, higher value results in better quality of video. Value will be internally multiplied by 1000000",
"default": 4,
"minimum": 1,
"maximum": 25,
"type": "number"
}
},
"type": "object"
},
"enabled": {
"description": "Set it to true to enable video recording of the test",
"type": "boolean"
},
"ios": {
"description": "iOS video recording related settings",
"properties": {
"codec": {
"description": "Codec type of the video. The type should be one of the result for the command `ffmpeg -codecs`",
"default": "mpeg4",
"type": "string"
},
"fps": {
"description": "Frames per second",
"default": 10,
"minimum": 1,
"maximum": 60,
"type": "number"
},
"quality": {
"$ref": "#/definitions/VideoQuality"
}
},
"type": "object"
},
"path": {
"description": "Path where the video to be saved",
"default": "./videos",
"type": "string"
},
"prefix": {
"description": "Prefix of the video file name",
"default": "VID",
"type": "string"
},
"size": {
"description": "Video resolution size",
"type": "string"
},
"time_limit": {
"description": "Time limit of the video (in seconds)",
"minimum": 10,
"maximum": 1800,
"type": "number"
}
},
"type": "object"
},
"virtual_device": {
"description": "Virtual device related settings",
"properties": {
"connect_keyboard": {
"description": "Set to true if you want to connect hardware device. Only for iOS devices",
"default": true,
"type": "boolean"
},
"headless": {
"description": "Set to true if you want to run the test in headless mode",
"default": false,
"type": "boolean"
},
"launch_timeout": {
"description": "Virtual device launch timeout (in seconds)",
"default": 120,
"type": "number"
},
"name": {
"description": "Name of the virtual device",
"type": "string"
},
"ready_timeout": {
"description": "AVD ready timeout. Only for Android",
"default": 60,
"type": "number"
}
},
"type": "object"
},
"wda": {
"description": "iOS WebDriverAgent related settings",
"properties": {
"connection_timeout": {
"description": "WDA connection timeout (in seconds)",
"default": 60,
"minimum": 1,
"maximum": 900,
"type": "number"
},
"launch_timeout": {
"description": "WDA launch timeout (in seconds)",
"default": 60,
"minimum": 1,
"maximum": 900,
"type": "number"
},
"local_port": {
"description": "Port on which WDA is running",
"type": "number"
},
"signing_id": {
"description": "XCode signing ID",
"type": "string"
},
"startup_retries": {
"description": "WDA startup retries",
"default": 2,
"minimum": 1,
"maximum": 10,
"type": "number"
},
"startup_retry_interval": {
"description": "WDA startup retry interval",
"default": 10,
"minimum": 1,
"maximum": 300,
"type": "number"
},
"team_id": {
"description": "XCode Team or Organization ID",
"type": "string"
},
"update_bundle_id": {
"description": "Bundle ID to update WDA before building and launching it",
"type": "string"
},
"use_new": {
"description": "Set to true, to use new WDA on every run",
"default": false,
"type": "boolean"
},
"use_prebuilt": {
"description": "Set to true, if you want to use the existing prebuilt WDA instance",
"default": false,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"description": "Appium server related settings",
"properties": {
"allow_cors": {
"description": "Set to true to allow cors",
"type": "boolean"
},
"allow_insecure": {
"description": "Set list of insecure features which you want to enable",
"items": {
"type": "string"
},
"type": "array"
},
"appium_path": {
"description": "Appium executable path",
"type": "string"
},
"base_path": {
"description": "Appium server's base path, example `/wd/hub`",
"type": "string"
},
"callback_address": {
"description": "Callback IP address",
"type": "string"
},
"callback_port": {
"description": "Callback Port number",
"type": "number"
},
"config_path": {
"description": "Appium config path",
"type": "string"
},
"deny_insecure": {
"description": "List of insecure features which you want to deny",
"items": {
"type": "string"
},
"type": "array"
},
"driver": {
"$ref": "#/definitions/AutomationType"
},
"external": {
"description": "Set to true, if you have Appium server already running",
"default": false,
"type": "boolean"
},
"external_config": {
"description": "Set to true, if the Appium config file is not there in the projects root directory",
"default": false,
"type": "boolean"
},
"host": {
"description": "Appium server's IP address",
"type": "string"
},
"keep_alive_timeout": {
"description": "Timeout to keep the Appium server running",
"type": "number"
},
"logging": {
"description": "Appium server's logging related settings",
"properties": {
"debug_spacing": {
"description": "Adds extra spaces to logs for ease to view",
"default": false,
"type": "boolean"
},
"level": {
"$ref": "#/definitions/LogLevel"
},
"local_timezone": {
"description": "Set to true to use local timezone",
"default": false,
"type": "boolean"
},
"timestamp": {
"description": "Set to true to display timestamps in the logs",
"type": "boolean"
}
},
"type": "object"
},
"node_path": {
"description": "Node JS executable path",
"type": "string"
},
"other_args": {
"$ref": "#/definitions/args"
},
"password": {
"description": "Your password for Cloud platform",
"type": "string"
},
"plugins": {
"description": "List of Appium plugin names which you want to activate",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port on which Appium Server will run",
"type": "number"
},
"protocol": {
"$ref": "#/definitions/Protocol"
},
"relaxed_security": {
"description": "Set to true, to allow relaxed security",
"default": false,
"type": "boolean"
},
"session_override": {
"description": "Set to true, to allow overriding the Appium session",
"type": "boolean"
},
"strict_capabilities": {
"description": "Set to true, to enforce strict capabilities",
"type": "boolean"
},
"target": {
"$ref": "#/definitions/TargetProviders"
},
"timeout": {
"description": "Appium server timeout (in seconds)",
"default": 30,
"minimum": 1,
"maximum": 900,
"type": "number"
},
"user_name": {
"description": "Your username of the Cloud platform",
"type": "string"
},
"webhook": {
"description": "Webhook URL to which you want to send the Appium server logs to",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "object"
},
"screenshot": {
"description": "UI screenshot related settings",
"properties": {
"enabled": {
"description": "Set to true to enable screenshots",
"default": false,
"type": "boolean"
},
"extension": {
"description": "Screenshot file extension",
"default": "png",
"type": "string"
},
"path": {
"description": "Path where the screenshots will be saved",
"default": "./screenshots",
"type": "string"
},
"prefix": {
"description": "Prefix of the screenshot file name",
"default": "SCR",
"type": "string"
}
},
"type": "object"
},
"timeout": {
"description": "UI timeout related settings",
"properties": {
"explicit_wait": {
"description": "Explicit wait for the element to wait for a particular condition to succeed (in seconds)",
"default": 10,
"maximum": 900,
"type": "number"
},
"highlight_delay": {
"description": "Delay while Highlighting the element (in ms)",
"default": 100,
"maximum": 90000,
"type": "number"
},
"implicit_wait": {
"description": "Implicit wait for Appium to find the element (in seconds)",
"default": 1,
"maximum": 300,
"type": "number"
},
"page_load_timeout": {
"description": "Page load timeout (in seconds)",
"default": 30,
"maximum": 300,
"type": "number"
},
"script_timeout": {
"description": "Script load timeout (in seconds)",
"default": 10,
"maximum": 300,
"type": "number"
}
},
"type": "object"
},
"web": {
"description": "Web related settings",
"additionalProperties": {
"properties": {
"base_url": {
"description": "Base URL to which you want to navigate automatically when the Web session is started",
"type": "string"
},
"browser": {
"$ref": "#/definitions/Browser"
},
"browser_options": {
"description": "List of Browser driver options",
"items": {
"type": "string"
},
"type": "array"
},
"capabilities": {
"$ref": "#/definitions/caps"
},
"custom_size": {
"description": "Custom size when Resize is set as `CUSTOM`",
"properties": {
"height": {
"description": "Height of the Browser window",
"type": "number"
},
"width": {
"description": "Width of the Browser window",
"type": "number"
}
},
"type": "object"
},
"headless": {
"description": "Set to true if you want to run the test in headless mode",
"default": true,
"type": "boolean"
},
"highlight": {
"description": "Set to true if you want to see the element interactions being highlighted",
"default": false,
"type": "boolean"
},
"host": {
"description": "Host IP address, if not provided, Target Host will be used",
"type": "string"
},
"page_load_strategy": {
"$ref": "#/definitions/PageLoadStrategy"
},
"password": {
"description": "Your cloud platform password",
"type": "string"
},
"platform": {
"description": "Platform on which the Web browser will be launched",
"type": "string"
},
"port": {
"description": "Port number on which Selenium WebDriver will start the session",
"type": "number"
},
"protocol": {
"$ref": "#/definitions/Protocol"
},
"resize": {
"$ref": "#/definitions/WindowResizeType"
},
"target": {
"$ref": "#/definitions/TargetProviders"
},
"user_name": {
"description": "Your cloud platform user name or key",
"type": "string"
},
"version": {
"description": "Platform version on which the Browser will be launched",
"type": "string"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}