-
-
Notifications
You must be signed in to change notification settings - Fork 154
/
mutation-testing-report-schema.json
353 lines (353 loc) · 16 KB
/
mutation-testing-report-schema.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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://stryker-mutator.io/report.schema.json",
"title": "MutationTestResult",
"description": "Schema for a mutation testing report.",
"type": "object",
"required": ["schemaVersion", "thresholds", "files"],
"properties": {
"config": {
"description": "Free-format object that represents the configuration used to run mutation testing.",
"type": "object"
},
"schemaVersion": {
"type": "string",
"pattern": "^1(\\.\\d*)?$",
"description": "Major version of this report. Used for compatibility.",
"examples": ["1"]
},
"files": {
"type": "object",
"title": "FileResultDictionary",
"description": "All mutated files.",
"additionalProperties": {
"type": "object",
"title": "FileResult",
"description": "Mutated file, with the relative path of the file as the key.",
"required": ["language", "source", "mutants"],
"properties": {
"language": {
"description": "Programming language that is used. Used for code highlighting, see https://prismjs.com/#examples.",
"examples": ["javascript", "typescript", "cs", "scala", "java"],
"type": "string"
},
"mutants": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"title": "MutantResult",
"description": "Single mutation.",
"required": ["id", "mutatorName", "location", "status"],
"properties": {
"coveredBy": {
"type": "array",
"description": "The test ids that covered this mutant. If a mutation testing framework doesn't measure this information, it can simply be left out.",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "Description of the applied mutation.",
"examples": ["removed call to java/io/Writer::write"]
},
"duration": {
"type": "number",
"description": "The net time it took to test this mutant in milliseconds. This is the time measurement without overhead from the mutation testing framework."
},
"id": {
"type": "string",
"description": "Unique id, can be used to correlate this mutant across reports.",
"examples": ["321321"]
},
"killedBy": {
"type": "array",
"description": "The test ids that killed this mutant. It is a best practice to \"bail\" on first failing test, in which case you can fill this array with that one test.",
"items": {
"type": "string"
}
},
"location": {
"$ref": "#/definitions/location"
},
"mutatorName": {
"type": "string",
"description": "Category of the mutation.",
"examples": ["ConditionalExpression", "EqualityOperator", "LogicalOperator"]
},
"replacement": {
"type": "string",
"description": "Actual mutation that has been applied.",
"examples": ["-", "+", "&&", "||"]
},
"static": {
"type": "boolean",
"description": "A static mutant means that it was loaded once at during initialization, this makes it slow or even impossible to test, depending on the mutation testing framework."
},
"status": {
"type": "string",
"title": "MutantStatus",
"description": "Result of the mutation.",
"enum": ["Killed", "Survived", "NoCoverage", "CompileError", "RuntimeError", "Timeout", "Ignored"]
},
"statusReason": {
"type": "string",
"description": "The reason that this mutant has this status. In the case of a killed mutant, this should be filled with the failure message(s) of the failing tests. In case of an error mutant, this should be filled with the error message."
},
"testsCompleted": {
"type": "number",
"description": "The number of tests actually completed in order to test this mutant. Can differ from \"coveredBy\" because of bailing a mutant test run after first failing test."
}
}
}
},
"source": {
"description": "Full source code of the original file (without mutants), this is used to display exactly what was changed for each mutant.",
"examples": ["using System; using....."],
"type": "string"
}
}
}
},
"testFiles": {
"type": "object",
"title": "TestFileDefinitionDictionary",
"description": "Test file definitions by file path OR class name.",
"additionalProperties": {
"type": "object",
"title": "TestFile",
"description": "A file containing one or more tests",
"required": ["tests"],
"properties": {
"source": {
"description": "Full source code of the test file, this can be used to display in the report.",
"type": "string"
},
"tests": {
"type": "array",
"items": {
"type": "object",
"title": "TestDefinition",
"required": ["id", "name"],
"description": "A test in your test file.",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the test, used to correlate what test killed a mutant."
},
"name": {
"type": "string",
"description": "Name of the test, used to display the test."
},
"location": {
"$ref": "#/definitions/openEndLocation"
}
}
}
}
}
}
},
"thresholds": {
"type": "object",
"title": "Thresholds",
"description": "Thresholds for the status of the reported application.",
"required": ["high", "low"],
"properties": {
"high": {
"type": "integer",
"description": "Higher bound threshold.",
"minimum": 0,
"maximum": 100,
"examples": [80]
},
"low": {
"type": "integer",
"description": "Lower bound threshold.",
"minimum": 0,
"maximum": 100,
"examples": [60]
}
}
},
"projectRoot": {
"type": "string",
"description": "The optional location of the project root.",
"examples": ["C:\\Projects\\project-under-test", "/home/user/projects/project-under-test"]
},
"performance": {
"type": "object",
"title": "PerformanceStatistics",
"description": "The performance statistics per phase. Total time should be roughly equal to the sum of all these.",
"required": ["setup", "initialRun", "mutation"],
"properties": {
"setup": {
"type": "number",
"description": "Time it took to run the setup phase in milliseconds."
},
"initialRun": {
"type": "number",
"description": "Time it took to run the initial test phase (dry-run) in milliseconds."
},
"mutation": {
"type": "number",
"description": "Time it took to run the mutation test phase in milliseconds."
}
}
},
"framework": {
"type": "object",
"title": "FrameworkInformation",
"description": "Extra information about the framework used",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "Name of the framework used.",
"examples": ["Stryker", "Stryker4s", "Stryker.NET", "Infection PHP", "Pitest"]
},
"version": {
"type": "string",
"description": "Version of the framework."
},
"branding": {
"type": "object",
"title": "BrandingInformation",
"description": "Extra branding information about the framework used.",
"required": ["homepageUrl"],
"properties": {
"homepageUrl": {
"type": "string",
"format": "uri",
"description": "URL to the homepage of the framework."
},
"imageUrl": {
"type": "string",
"description": "URL to an image for the framework, can be a data URL."
}
}
},
"dependencies": {
"type": "object",
"title": "Dependencies",
"description": "Dependencies used by the framework. Key-value pair of dependencies and their versions.",
"additionalProperties": {
"type": "string"
}
}
}
},
"system": {
"type": "object",
"title": "SystemInformation",
"description": "Information about the system that performed mutation testing.",
"required": ["ci"],
"properties": {
"ci": {
"description": "Did mutation testing run in a Continuous Integration environment (pipeline)? Note that there is no way of knowing this for sure. It's done on a best-effort basis.",
"type": "boolean"
},
"os": {
"type": "object",
"title": "OSInformation",
"required": ["platform"],
"properties": {
"description": {
"type": "string",
"description": "Human-readable description of the OS",
"examples": ["Windows 10 Pro", "Debian Buster", "Ubuntu 20.04.1 LTS"]
},
"platform": {
"type": "string",
"description": "Platform identifier",
"examples": ["linux", "win32"]
},
"version": {
"type": "string",
"description": "Version of the OS or distribution",
"examples": ["10.0.19041"]
}
}
},
"cpu": {
"type": "object",
"title": "CpuInformation",
"required": ["logicalCores"],
"properties": {
"baseClock": {
"type": "number",
"description": "Clock speed in MHz"
},
"logicalCores": {
"type": "number"
},
"model": {
"type": "string",
"examples": ["Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz"]
}
}
},
"ram": {
"title": "RamInformation",
"type": "object",
"required": ["total"],
"properties": {
"total": {
"type": "number",
"description": "The total RAM of the system that performed mutation testing in MB."
}
}
}
}
}
},
"definitions": {
"position": {
"type": "object",
"title": "Position",
"description": "Position of a mutation. Both line and column start at one.",
"required": ["line", "column"],
"properties": {
"line": {
"type": "integer",
"minimum": 1,
"examples": [4]
},
"column": {
"type": "integer",
"minimum": 1,
"examples": [3]
}
}
},
"location": {
"type": "object",
"title": "Location",
"description": "A location with start and end. Start is inclusive, end is exclusive.",
"required": ["start", "end"],
"properties": {
"start": {
"$ref": "#/definitions/position"
},
"end": {
"$ref": "#/definitions/position"
}
}
},
"openEndLocation": {
"type": "object",
"title": "OpenEndLocation",
"description": "A location where \"end\" is not required. Start is inclusive, end is exclusive.",
"required": ["start"],
"properties": {
"start": {
"$ref": "#/definitions/position"
},
"end": {
"$ref": "#/definitions/position"
}
}
}
}
}