OLD | NEW |
1 JSON Reporter Protocol | 1 JSON Reporter Protocol |
2 ====================== | 2 ====================== |
3 | 3 |
4 The test runner supports a JSON reporter which provides a machine-readable | 4 The test runner supports a JSON reporter which provides a machine-readable |
5 representation of the test runner's progress. This reporter is intended for use | 5 representation of the test runner's progress. This reporter is intended for use |
6 by IDEs and other tools to present a custom view of the test runner's operation | 6 by IDEs and other tools to present a custom view of the test runner's operation |
7 without needing to parse output intended for humans. | 7 without needing to parse output intended for humans. |
8 | 8 |
9 Note that the test runner is highly asynchronous, and users of this protocol | 9 Note that the test runner is highly asynchronous, and users of this protocol |
10 shouldn't make assumptions about the ordering of events beyond what's explicitly | 10 shouldn't make assumptions about the ordering of events beyond what's explicitly |
(...skipping 304 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
315 String path; | 315 String path; |
316 } | 316 } |
317 ``` | 317 ``` |
318 | 318 |
319 A test suite corresponding to a loaded test file. The suite's ID is unique in | 319 A test suite corresponding to a loaded test file. The suite's ID is unique in |
320 the context of this test run. It's used elsewhere in the protocol to refer to | 320 the context of this test run. It's used elsewhere in the protocol to refer to |
321 this suite without including its full representation. | 321 this suite without including its full representation. |
322 | 322 |
323 A suite's platform is one of the platforms that can be passed to the | 323 A suite's platform is one of the platforms that can be passed to the |
324 `--platform` option, or `null` if there is no platform (for example if the file | 324 `--platform` option, or `null` if there is no platform (for example if the file |
325 doesn't exist at all). Its path is relative to the root of the current package. | 325 doesn't exist at all). Its path is either absolute or relative to the root of |
| 326 the current package. |
326 | 327 |
327 Suites don't include their own metadata. Instead, that metadata is present on | 328 Suites don't include their own metadata. Instead, that metadata is present on |
328 the root-level group. | 329 the root-level group. |
329 | 330 |
330 ### Group | 331 ### Group |
331 | 332 |
332 ``` | 333 ``` |
333 class Group { | 334 class Group { |
334 // An opaque ID for the group. | 335 // An opaque ID for the group. |
335 int id; | 336 int id; |
(...skipping 28 matching lines...) Expand all Loading... |
364 class Metadata { | 365 class Metadata { |
365 // Whether the test case will be skipped by the test runner. | 366 // Whether the test case will be skipped by the test runner. |
366 bool skip; | 367 bool skip; |
367 | 368 |
368 // The reason the test case is skipped, if the user provided it. | 369 // The reason the test case is skipped, if the user provided it. |
369 String? skipReason; | 370 String? skipReason; |
370 } | 371 } |
371 ``` | 372 ``` |
372 | 373 |
373 The metadata attached to a test by a user. | 374 The metadata attached to a test by a user. |
OLD | NEW |