Raw Schema (1.3)ΒΆ

For those versed in JSON-Schema we’d like to recommend reading the full schema directly. Note that this is the latest format schema, the full catalogue is included in the source distribution.

  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
{
    "description": "DashboadBundle object",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "format": {
            "description": "Document format identifier.",
            "type": "string",
            "enum": [
                "Dashboard Bundle Format 1.3"
            ]
        },
        "test_runs": {
            "description": "Array of TestRun objects",
            "type": "array",
            "optional": true,
            "items": {
                "description": "TestRun object",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "analyzer_assigned_uuid": {
                        "description": "UUID that was assigned by the log analyzer during processing",
                        "type": "string"
                    },
                    "analyzer_assigned_date": {
                        "description": "Time stamp in ISO 8601 format that was assigned by the log analyzer during processing. The exact format is YYYY-MM-DDThh:mm:ssZ",
                        "type": "string",
                        "format": "date-time"
                    },
                    "time_check_performed": {
                        "description": "Indicator on whether the log analyzer had accurate time information",
                        "type": "boolean"
                    },
                    "attributes": {
                        "description": "Container for additional attributes defined by the test and their values during this particular run",
                        "type": "object",
                        "optional": true,
                        "additionalProperties": {
                            "description": "Arbitrary properties that are defined by the test",
                            "type": "string"
                        }
                    },
                    "tags": {
                        "description": "An optional array of tags that are associated with this test run. Note that those are not version-control tags but arbitrary classifiers for test results",
                        "type": "array",
                        "optional": true,
                        "items": {
                            "description": "Tag name",
                            "type": "string"
                        }
                    },
                    "test_id": {
                        "description": "Test identifier. Must be a well-defined (in scope of the dashboard) name of the test",
                        "type": "string"
                    },
                    "test_results": {
                        "description": "Array of TestResult objects",
                        "type": "array",
                        "items": {
                            "description": "TestResult object",
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                                "test_case_id": {
                                    "description": "Identifier of the TestCase this test result came from",
                                    "type": "string",
                                    "optional": true
                                },
                                "result": {
                                    "description": "Status code of this test result",
                                    "type": "string",
                                    "enum": ["pass", "fail", "skip", "unknown"]
                                },
                                "message": {
                                    "description": "Message scrubbed from the log file",
                                    "type": "string",
                                    "optional": true
                                },
                                "measurement": {
                                    "description": "Numerical measurement associated with the test result",
                                    "type": "number",
                                    "optional": true,
                                    "requires": "test_case_id"
                                },
                                "units": {
                                    "description": "Units for measurement",
                                    "type": "string",
                                    "optional": true,
                                    "requires": "measurement"
                                },
                                "timestamp": {
                                    "description": "Date and time when the test was performed",
                                    "type": "string",
                                    "optional": true,
                                    "format": "date-time"
                                },
                                "duration": {
                                    "description": "Duration of the test case. Duration is stored in the following format '[DAYS]d [SECONDS]s [MICROSECONDS]us'",
                                    "type": "string",
                                    "optional": true
                                },
                                "log_filename": {
                                    "description": "Filename of the log file which this test result was scrubbed from",
                                    "type": "string",
                                    "optional": true
                                },
                                "log_lineno": {
                                    "description": "Precise location in the log file (line number)",
                                    "type": "integer",
                                    "optional": true,
                                    "requires": "log_filename"
                                },
                                "attributes": {
                                    "description": "Container for additional attributes defined by test result",
                                    "type": "object",
                                    "optional": true,
                                    "additionalProperties": {
                                        "description": "Arbitrary properties that are defined by the particular test result",
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    },
                    "attachments": {
                        "description": "Array of attachments",
                        "optional": true,
                        "type": "array",
                        "items": {
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                                "pathname": {
                                    "description": "Attachment pathname",
                                    "type": "string"
                                },
                                "mime_type": {
                                     "description": "Attachment MIME type",
                                     "type": "string"
                                },
                                "content": {
                                    "description": "Attachment content encoded as base64 string with standard encoding",
                                    "type": "string",
                                    "optional": true
                                },
                                "public_url": {
                                    "description": "Public URL of this attachment",
                                    "type": "string",
                                    "optional": true
                                }
                            }
                        }
                    },
                    "hardware_context": {
                        "description": "Description of the hardware context in which this test was running",
                        "type": "object",
                        "optional": true,
                        "additionalProperties": false,
                        "properties": {
                            "devices": {
                                "description": "Array of HardwareDevice objects",
                                "type": "array",
                                "items": {
                                    "description": "HardwareDevice object",
                                    "type": "object",
                                    "properties": {
                                        "device_type": {
                                            "type": "string",
                                            "description": "Device type"
                                        },
                                        "description": {
                                            "type": "string",
                                            "description": "Human readable description of the device"
                                        },
                                        "attributes": {
                                            "description": "Container for additional attributes defined by the device",
                                            "type": "object",
                                            "optional": true,
                                            "additionalProperties": {
                                                "description": "Arbitrary properties that are defined by the particular hardware device",
                                                "type": ["number", "string"]
                                            }
                                        }
                                    },
                                    "additionalProperties": false
                                }
                            }
                        }
                    },
                    "software_context": {
                        "description": "Description of the software context in which this test was running",
                        "type": "object",
                        "additionalProperties": false,
                        "optional": true,
                        "properties": {
                            "image": {
                                "description": "SoftwareImage object",
                                "type": "object",
                                "optional": true,
                                "additionalProperties": false,
                                "properties": {
                                    "name": {
                                        "description": "Name of the operating system image",
                                        "type": "string"
                                    }
                                }
                            },
                            "sources": {
                                "type": "array",
                                "optional": true,
                                "items": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "properties": {
                                        "project_name": {
                                            "type": "string"
                                        },
                                        "branch_vcs": {
                                            "type": "string",
                                            "enum": ["bzr", "git", "svn"]
                                        },
                                        "branch_url": {
                                            "type": "string"
                                        },
                                        "branch_revision": {
                                            "type": ["string", "integer"]
                                        },
                                        "commit_timestamp": {
                                            "type": "string",
                                            "format": "date-time",
                                            "optional": true
                                        }
                                    }
                                }
                            },
                            "packages": {
                                "description": "Array of SoftwarePackage objects",
                                "type": "array",
                                "optional": true,
                                "items": {
                                    "description": "SoftwarePackage object",
                                    "type": "object",
                                    "additionalProperties": false,
                                    "properties": {
                                        "name": {
                                            "description": "Package name",
                                            "type": "string"
                                        },
                                        "version": {
                                            "description": "Package version",
                                            "type": "string"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Project Versions

Previous topic

Schema Description (1.3)

Next topic

Example Bundles

This Page