marv/api/marv-mutations-schema.json at main · SecretSheppy/marv · GitHub

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
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Marv Mutations Schema",
    "$defs": {
        "UUID": {
            "type": "string",
            "description": "A UUID",
            "minLength": 36
        },
        "Pos": {
            "type": "object",
            "description": "A position within a source code file",
            "additionalProperties": false,
            "required": [
                "Line",
                "Char"
            ],
            "properties": {
                "Line": {
                    "type": "integer",
                    "description": "The source code line number (indexed from 0) that the position is describing"
                },
                "Char": {
                    "type": "integer",
                    "description": "The character number (indexed from 0) within the given source code line, that the position is describing"
                }
            }
        }
    },
    "type": "object",
    "description": "Map of source file paths to array of mutant regions (known in Marv as conflicts) found in the given file",
    "additionalProperties": {
        "type": "array",
        "description": "Array of mutant regions (known in Marv as conflicts)",
        "items": {
            "type": "object",
            "description": "A mutant region (known in Marv as a conflict region) which has a unique id, is bounded by start and end lines and contains an array of mutations that occur between those lines",
            "additionalProperties": false,
            "required": [
                "ID",
                "StartLine",
                "EndLine",
                "Mutations"
            ],
            "properties": {
                "ID": {
                    "$ref": "#/$defs/UUID"
                },
                "StartLine": {
                    "type": "integer",
                    "description": "The regions start line (indexed from 0 and inclusive)"
                },
                "EndLine": {
                    "type": "integer",
                    "description": "The regions end line (indexed from 0 and non-inclusive)"
                },
                "Mutations": {
                    "type": "array",
                    "description": "An array of mutations",
                    "items": {
                        "type": "object",
                        "description": "A mutation which has a unique id accompanied by the data required for Marv to display it inline with the original source code file",
                        "additionalProperties": false,
                        "required": [
                            "ID",
                            "Description",
                            "Operation",
                            "Start",
                            "End",
                            "Status",
                            "Replacement"
                        ],
                        "properties": {
                            "ID": {
                                "$ref": "#/$defs/UUID"
                            },
                            "FrameworkMutantID": {
                                "type": "string",
                                "description": "An optional field which contains the id assigned to the mutation by the mutation testing framework if one was created"
                            },
                            "Description": {
                                "type": "string",
                                "description": "A concise textual description of the mutation"
                            },
                            "Operation": {
                                "type": "string",
                                "description": "The mutation operator used to generate the mutation"
                            },
                            "Start": {
                                "$ref": "#/$defs/Pos"
                            },
                            "End": {
                                "$ref": "#/$defs/Pos"
                            },
                            "Status": {
                                "type": "string",
                                "description": "The mutations status after being run against the programs test suite",
                                "enum": [
                                    "KILLED",
                                    "SURVIVED",
                                    "CRASHED",
                                    "TIMEOUT",
                                    "NO_COVERAGE",
                                    "PENDING",
                                    "IGNORED"
                                ]
                            },
                            "Replacement": {
                                "type": "string",
                                "description": "The source code mutation"
                            }
                        }
                    }
                }
            }
        }
    }
}