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
|
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "The presets specify the generator and the build directory, and optionally a list of variables and other arguments to pass to CMake.",
"oneOf": [
{
"properties": {
"version": {
"const": 1,
"description": "A required integer representing the version of the JSON schema."
},
"cmakeMinimumRequired": { "$ref": "#/definitions/cmakeMinimumRequired"},
"vendor": { "$ref": "#/definitions/vendor" },
"configurePresets": { "$ref": "#/definitions/configurePresets"}
},
"additionalProperties": false
},
{
"properties": {
"version": {
"const": 2,
"description": "A required integer representing the version of the JSON schema."
},
"cmakeMinimumRequired": { "$ref": "#/definitions/cmakeMinimumRequired"},
"vendor": { "$ref": "#/definitions/vendor" },
"configurePresets": { "$ref": "#/definitions/configurePresets"},
"buildPresets": { "$ref": "#/definitions/buildPresets"},
"testPresets": { "$ref": "#/definitions/testPresets"}
},
"additionalProperties": false
}
],
"required": [
"version"
],
"definitions": {
"cmakeMinimumRequired": {
"type": "object",
"description": "An optional object representing the minimum version of CMake needed to build this project.",
"properties": {
"major": {
"type": "integer",
"description": "An optional integer representing the major version."
},
"minor": {
"type": "integer",
"description": "An optional integer representing the minor version."
},
"patch": {
"type": "integer",
"description": "An optional integer representing the patch version."
}
},
"additionalProperties": false
},
"vendor": {
"type": "object",
"description": "An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.",
"properties": {}
},
"configurePresets": {
"type": "array",
"description": "An optional array of configure preset objects.",
"items": {
"type": "object",
"description": "A configure preset object.",
"properties": {
"name": {
"type": "string",
"description": "A required string representing the machine-friendly name of the preset. This identifier is used in the --preset argument. There must not be two presets in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name.",
"minLength": 1
},
"hidden": {
"type": "boolean",
"description": "An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset= argument, will not show up in the CMake GUI, and does not have to have a valid generator or binaryDir, even from inheritance. Hidden presets are intended to be used as a base for other presets to inherit via the inherits field."
},
"inherits": {
"anyOf": [
{
"type": "string",
"description": "An optional string representing the name of the preset to inherit from.",
"minLength": 1
},
{
"type": "array",
"description": "An optional array of strings representing the names of presets to inherit from. The preset will inherit all of the fields from the inherits presets by default (except name, hidden, inherits, description, and displayName), but can override them as desired. If multiple inherits presets provide conflicting values for the same field, the earlier preset in the inherits list will be preferred. Presets in CMakePresets.json may not inherit from presets in CMakeUserPresets.json.",
"items": {
"type": "string",
"description": "An optional string representing the name of the preset to inherit from.",
"minLength": 1
}
}
]
},
"vendor": {
"type": "object",
"description": "An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field. If vendors use their own per-preset vendor field, they should implement inheritance in a sensible manner when appropriate.",
"properties": {}
},
"displayName": {
"type": "string",
"description": "An optional string with a human-friendly name of the preset."
},
"description": {
"type": "string",
"description": "An optional string with a human-friendly description of the preset."
},
"generator": {
"type": "string",
"description": "An optional string representing the generator to use for the preset. If generator is not specified, it must be inherited from the inherits preset (unless this preset is hidden). Note that for Visual Studio generators, unlike in the command line -G argument, you cannot include the platform name in the generator name. Use the architecture field instead."
},
"architecture": {
"anyOf": [
{
"type": "string",
"description": "An optional string representing the platform for generators that support it."
},
{
"type": "object",
"description": "An optional object representing the platform for generators that support it.",
"properties": {
"value": {
"type": "string",
"description": "An optional string representing the value."
},
"strategy": {
"type": "string",
"description": "An optional string telling CMake how to handle the field. Valid values are: \"set\" Set the respective value. This will result in an error for generators that do not support the respective field. \"external\" Do not set the value, even if the generator supports it. This is useful if, for example, a preset uses the Ninja generator, and an IDE knows how to set up the Visual C++ environment from the architecture and toolset fields. In that case, CMake will ignore the field, but the IDE can use them to set up the environment before invoking CMake.",
"enum": [
"set",
"external"
]
}
},
"additionalProperties": false
}
]
},
"toolset": {
"anyOf": [
{
"type": "string",
"description": "An optional string representing the toolset for generators that support it."
},
{
"type": "object",
"description": "An optional object representing the toolset for generators that support it.",
"properties": {
"value": {
"type": "string",
"description": "An optional string representing the value."
},
"strategy": {
"type": "string",
"description": "An optional string telling CMake how to handle the field. Valid values are: \"set\" Set the respective value. This will result in an error for generators that do not support the respective field. \"external\" Do not set the value, even if the generator supports it. This is useful if, for example, a preset uses the Ninja generator, and an IDE knows how to set up the Visual C++ environment from the architecture and toolset fields. In that case, CMake will ignore the field, but the IDE can use them to set up the environment before invoking CMake.",
"enum": [
"set",
"external"
]
}
},
"additionalProperties": false
}
]
},
"binaryDir": {
"type": "string",
"description": "An optional string representing the path to the output binary directory. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory. If binaryDir is not specified, it must be inherited from the inherits preset (unless this preset is hidden)."
},
"cmakeExecutable": {
"type": "string",
"description": "An optional string representing the path to the CMake executable to use for this preset. This is reserved for use by IDEs, and is not used by CMake itself. IDEs that use this field should expand any macros in it."
},
"cacheVariables": {
"type": "object",
"description": "An optional map of cache variables. The key is the variable name (which must not be an empty string). Cache variables are inherited through the inherits field, and the preset's variables will be the union of its own cacheVariables and the cacheVariables from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied.",
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "null",
"description": "Setting a variable to null causes it to not be set, even if a value was inherited from another preset."
},
{
"type": "boolean",
"description": "A boolean representing the value of the variable. Equivalent to \"TRUE\" or \"FALSE\"."
},
{
"type": "string",
"description": "A string representing the value of the variable (which supports macro expansion)."
},
{
"type": "object",
"description": "An object representing the type and value of the variable.",
"properties": {
"type": {
"type": "string",
"description": "An optional string representing the type of the variable. It should be BOOL, FILEPATH, PATH, STRING, or INTERNAL."
},
"value": {
"anyOf": [
{
"type": "boolean",
"description": "A required boolean representing the value of the variable. Equivalent to \"TRUE\" or \"FALSE\"."
},
{
"type": "string",
"description": "A required string representing the value of the variable. This field supports macro expansion."
}
]
}
},
"required": [
"value"
],
"additionalProperties": false
}
]
},
"propertyNames": {
"pattern": "^.+$"
}
},
"environment": {
"type": "object",
"description": "An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.",
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "null",
"description": "Setting a variable to null causes it to not be set, even if a value was inherited from another preset."
},
{
"type": "string",
"description": "A string representing the value of the variable."
}
]
},
"propertyNames": {
"pattern": "^.+$"
}
},
"warnings": {
"type": "object",
"description": "An optional object specifying warnings.",
"properties": {
"dev": {
"type": "boolean",
"description": "An optional boolean. Equivalent to passing -Wdev or -Wno-dev on the command line. This may not be set to false if errors.dev is set to true."
},
"deprecated": {
"type": "boolean",
"description": "An optional boolean. Equivalent to passing -Wdeprecated or -Wno-deprecated on the command line. This may not be set to false if errors.deprecated is set to true."
},
"uninitialized": {
"type": "boolean",
"description": "An optional boolean. Setting this to true is equivalent to passing --warn-uninitialized on the command line."
},
"unusedCli": {
"type": "boolean",
"description": "An optional boolean. Setting this to false is equivalent to passing --no-warn-unused-cli on the command line."
},
"systemVars": {
"type": "boolean",
"description": "An optional boolean. Setting this to true is equivalent to passing --check-system-vars on the command line."
}
},
"additionalProperties": false
},
"errors": {
"type": "object",
"description": "An optional object specifying errors.",
"properties": {
"dev": {
"type": "boolean",
"description": "An optional boolean. Equivalent to passing -Werror=dev or -Wno-error=dev on the command line. This may not be set to true if warnings.dev is set to false."
},
"deprecated": {
"type": "boolean",
"description": "An optional boolean. Equivalent to passing -Werror=deprecated or -Wno-error=deprecated on the command line. This may not be set to true if warnings.deprecated is set to false."
}
},
"additionalProperties": false
},
"debug": {
"type": "object",
"description": "An optional object specifying debug options.",
"properties": {
"output": {
"type": "boolean",
"description": "An optional boolean. Setting this to true is equivalent to passing --debug-output on the command line."
},
"tryCompile": {
"type": "boolean",
"description": "An optional boolean. Setting this to true is equivalent to passing --debug-trycompile on the command line."
},
"find": {
"type": "boolean",
"description": "An optional boolean. Setting this to true is equivalent to passing --debug-find on the command line."
}
},
"additionalProperties": false
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"buildPresets": {
"type": "array",
"description": "An optional array of build preset objects. Used to specify arguments to cmake --build. Available in version 2 and higher.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A required string representing the machine-friendly name of the preset. This identifier is used in the --preset argument. There must not be two presets (configure, build, or test) in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name.",
"minLength": 1
},
"hidden": {
"type": "boolean",
"description": "An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset argument, will not show up in the CMake GUI, and does not have to have a valid configurePreset, even from inheritance. Hidden presets are intended to be used as a base for other presets to inherit via the inherits field."
},
"inherits": {
"anyOf": [
{
"type": "string",
"description": "An optional string representing the name of the build preset to inherit from.",
"minLength": 1
},
{
"type": "array",
"description": "An optional array of strings representing the names of build presets to inherit from. The preset will inherit all of the fields from the inherits presets by default (except name, hidden, inherits, description, and displayName), but can override them as desired. If multiple inherits presets provide conflicting values for the same field, the earlier preset in the inherits list will be preferred. Presets in CMakePresets.json may not inherit from presets in CMakeUserPresets.json.",
"items": {
"type": "string",
"description": "An optional string representing the name of the preset to inherit from.",
"minLength": 1
}
}
]
},
"configurePreset": {
"type": "string",
"description": "An optional string specifying the name of a configure preset to associate with this build preset. If configurePreset is not specified, it must be inherited from the inherits preset (unless this preset is hidden). The build tree directory is inferred from the configure preset.",
"minLength": 1
},
"vendor": {
"type": "object",
"description": "An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field. If vendors use their own per-preset vendor field, they should implement inheritance in a sensible manner when appropriate.",
"properties": {}
},
"displayName": {
"type": "string",
"description": "An optional string with a human-friendly name of the preset."
},
"description": {
"type": "string",
"description": "An optional string with a human-friendly description of the preset."
},
"inheritConfigureEnvironment": {
"type": "boolean",
"description": "An optional boolean that defaults to true. If true, the environment variables from the associated configure preset are inherited after all inherited build preset environments, but before environment variables explicitly specified in this build preset."
},
"environment": {
"type": "object",
"description": "An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.",
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "null",
"description": "Setting a variable to null causes it to not be set, even if a value was inherited from another preset."
},
{
"type": "string",
"description": "A string representing the value of the variable."
}
]
},
"propertyNames": {
"pattern": "^.+$"
}
},
"jobs": {
"type": "integer",
"description": "An optional integer. Equivalent to passing --parallel or -j on the command line."
},
"targets": {
"anyOf": [
{
"type": "string",
"description": "An optional string. Equivalent to passing --target or -t on the command line. Vendors may ignore the targets property or hide build presets that explicitly specify targets."
},
{
"type": "array",
"description": "An optional array of strings. Equivalent to passing --target or -t on the command line. Vendors may ignore the targets property or hide build presets that explicitly specify targets.",
"items": {
"type": "string",
"description": "An optional string. Equivalent to passing --target or -t on the command line. Vendors may ignore the targets property or hide build presets that explicitly specify targets."
}
}
]
},
"configuration": {
"type": "string",
"description": "An optional string. Equivalent to passing --config on the command line."
},
"cleanFirst": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --clean-first on the command line."
},
"verbose": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --verbose on the command line."
},
"nativeToolOptions": {
"type": "array",
"description": "An optional array of strings. Equivalent to passing options after -- on the command line.",
"items": {
"type": "string",
"description": "An optional string representing an option to pass after -- on the command line."
}
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"testPresets": {
"type": "array",
"description": "An optional array of test preset objects. Used to specify arguments to ctest. Available in version 2 and higher.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A required string representing the machine-friendly name of the preset. This identifier is used in the --preset argument. There must not be two presets (configure, build, or test) in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name.",
"minLength": 1
},
"hidden": {
"type": "boolean",
"description": "An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset argument, will not show up in the CMake GUI, and does not have to have a valid configurePreset, even from inheritance. Hidden presets are intended to be used as a base for other presets to inherit via the inherits field."
},
"inherits": {
"anyOf": [
{
"type": "string",
"description": "An optional string representing the name of the test preset to inherit from.",
"minLength": 1
},
{
"type": "array",
"description": "An optional array of strings representing the names of test presets to inherit from. The preset will inherit all of the fields from the inherits presets by default (except name, hidden, inherits, description, and displayName), but can override them as desired. If multiple inherits presets provide conflicting values for the same field, the earlier preset in the inherits list will be preferred. Presets in CMakePresets.json may not inherit from presets in CMakeUserPresets.json.",
"items": {
"type": "string",
"description": "An optional string representing the name of the preset to inherit from.",
"minLength": 1
}
}
]
},
"configurePreset": {
"type": "string",
"description": "An optional string specifying the name of a configure preset to associate with this test preset. If configurePreset is not specified, it must be inherited from the inherits preset (unless this preset is hidden). The build tree directory is inferred from the configure preset.",
"minLength": 1
},
"vendor": {
"type": "object",
"description": "An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field. If vendors use their own per-preset vendor field, they should implement inheritance in a sensible manner when appropriate.",
"properties": {}
},
"displayName": {
"type": "string",
"description": "An optional string with a human-friendly name of the preset."
},
"description": {
"type": "string",
"description": "An optional string with a human-friendly description of the preset."
},
"inheritConfigureEnvironment": {
"type": "boolean",
"description": "An optional boolean that defaults to true. If true, the environment variables from the associated configure preset are inherited after all inherited test preset environments, but before environment variables explicitly specified in this test preset."
},
"environment": {
"type": "object",
"description": "An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.",
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "null",
"description": "Setting a variable to null causes it to not be set, even if a value was inherited from another preset."
},
{
"type": "string",
"description": "A string representing the value of the variable."
}
]
},
"propertyNames": {
"pattern": "^.+$"
}
},
"configuration": {
"type": "string",
"description": "An optional string. Equivalent to passing --build-config on the command line."
},
"overwriteConfigurationFile": {
"type": "array",
"description": "An optional array of configuration options to overwrite options specified in the CTest configuration file. Equivalent to passing ``--overwrite`` for each value in the array.",
"items": {
"type": "string",
"description": "An option written as a key-value pair in the form \"key=value\"."
}
},
"output": {
"type": "object",
"description": "An optional object specifying output options.",
"properties": {
"shortProgress": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --progress on the command line."
},
"verbosity": {
"type": "string",
"description": "An optional string specifying verbosity level. Valid values are \"default\" (equivalent to passing no verbosity flags on the command line), \"verbose\" (equivalent to passing --verbose on the command line), and \"extra\" (equivalent to passing --extra-verbose on the command line).",
"enum": [
"default", "verbose", "extra"
]
},
"debug": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --debug on the command line."
},
"outputOnFailure": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --output-on-failure on the command line."
},
"quiet": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --quiet on the command line."
},
"outputLogFile": {
"type": "string",
"description": "An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line."
},
"labelSummary": {
"type": "boolean",
"description": "An optional boolean. If false, equivalent to passing --no-label-summary on the command line."
},
"subprojectSummary": {
"type": "boolean",
"description": "An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line."
},
"maxPassedTestOutputSize": {
"type": "integer",
"description": "An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line."
},
"maxFailedTestOutputSize": {
"type": "integer",
"description": "An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line."
},
"maxTestNameWidth": {
"type": "integer",
"description": "An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line."
}
},
"additionalProperties": false
},
"filter": {
"type": "object",
"description": "An optional object specifying how to filter the tests to run.",
"properties": {
"include": {
"type": "object",
"description": "An optional object specifying which tests to include.",
"properties": {
"name": {
"type": "string",
"description": "An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line."
},
"label": {
"type": "string",
"description": "An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line."
},
"index": {
"anyOf": [
{
"type": "object",
"description": "An optional object specifying tests to include by test index.",
"properties": {
"start": {
"type": "integer",
"description": "An optional integer specifying a test index to start testing at."
},
"end": {
"type": "integer",
"description": "An optional integer specifying a test index to stop testing at."
},
"stride": {
"type": "integer",
"description": "An optional integer specifying the increment."
},
"specificTests": {
"type": "array",
"description": "An optional array of integers specifying specific test indices to run.",
"items": {
"type": "integer",
"description": "An integer specifying the test to run by index."
}
}
},
"additionalProperties": false
},
{
"type": "string",
"description": "An optional string specifying a file with the command line syntax for --tests-information."
}
]
},
"useUnion": {
"type": "boolean",
"description": "An optional boolean. Equivalent to passing --union on the command line."
}
},
"additionalProperties": false
},
"exclude": {
"type": "object",
"description": "An optional object specifying which tests to exclude.",
"properties": {
"name": {
"type": "string",
"description": "An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line."
},
"label": {
"type": "string",
"description": "An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line."
},
"fixtures": {
"type": "object",
"description": "An optional object specifying which fixtures to exclude from adding tests.",
"properties": {
"any": {
"type": "string",
"description": "An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to --fixture-exclude-any on the command line."
},
"setup": {
"type": "string",
"description": "An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to --fixture-exclude-setup on the command line."
},
"cleanup": {
"type": "string",
"description": "An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to --fixture-exclude-cleanup on the command line."
}
},
"additionalProperties": false
}
}
}
},
"additionalProperties": false
},
"execution": {
"type": "object",
"description": "An optional object specifying options for test execution.",
"properties": {
"stopOnFailure": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --stop-on-failure on the command line."
},
"enableFailover": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing -F on the command line."
},
"jobs": {
"type": "integer",
"description": "An optional integer. Equivalent to passing --parallel on the command line."
},
"resourceSpecFile": {
"type": "string",
"description": "An optional string. Equivalent to passing --resource-spec-file on the command line."
},
"testLoad": {
"type": "integer",
"description": "An optional integer. Equivalent to passing --test-load on the command line."
},
"showOnly": {
"type": "string",
"description": "An optional string. Equivalent to passing --show-only on the command line. Value must be \"human\" or \"json-v1\".",
"enum": [
"human", "json-v1"
]
},
"repeat": {
"type": "object",
"description": "An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.",
"properties": {
"mode": {
"type": "string",
"description": "A required string. Must be one of the following values: \"until-fail\", \"until-pass\", or \"after-timeout\".",
"enum": [
"until-fail", "until-pass", "after-timeout"
]
},
"count": {
"type": "integer",
"description": "A required integer."
}
},
"required": [
"mode", "count"
],
"additionalProperties": false
},
"interactiveDebugging": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --interactive-debug-mode 1 on the command line. If false, equivalent to passing --interactive-debug-mode 0 on the command line."
},
"scheduleRandom": {
"type": "boolean",
"description": "An optional boolean. If true, equivalent to passing --schedule-random on the command line."
},
"timeout": {
"type": "integer",
"description": "An optional integer. Equivalent to passing --timeout on the command line."
},
"noTestsAction": {
"type": "string",
"description": "An optional string specifying the behavior if no tests are found. Must be one of the following values: \"default\" (equivalent to not passing any value on the command line), \"error\" (equivalent to passing --no-tests=error on the command line), or \"ignore\" (equivalent to passing --no-tests-ignore on the command line).",
"enum": [
"default", "error", "ignore"
]
}
},
"additionalProperties": false
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
}
}
|