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 83 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
94 String protocolVersion; | 94 String protocolVersion; |
95 | 95 |
96 // The version of the test runner being used. | 96 // The version of the test runner being used. |
97 String runnerVersion; | 97 String runnerVersion; |
98 } | 98 } |
99 ``` | 99 ``` |
100 | 100 |
101 A single start event is emitted before any other events. It indicates that the | 101 A single start event is emitted before any other events. It indicates that the |
102 test runner has started running. | 102 test runner has started running. |
103 | 103 |
104 ### SuiteCountEvent | |
alexander.doroshko
2016/01/29 11:51:05
mismatch with the class name AllSuitesEvent
| |
105 | |
106 ``` | |
107 class AllSuitesEvent { | |
108 String type = "allSuites"; | |
109 | |
110 /// The total number of suites that will be loaded. | |
111 int count; | |
112 } | |
113 ``` | |
114 | |
115 A single suite count event is emitted once the test runner knows the total | |
116 number of suites that will be loaded over the course of the test run. Because | |
117 this is determined asynchronously, its position relative to other events (except | |
118 `StartEvent`) is not guaranteed. | |
119 | |
104 ### SuiteEvent | 120 ### SuiteEvent |
105 | 121 |
106 ``` | 122 ``` |
107 class SuiteEvent extends Event { | 123 class SuiteEvent extends Event { |
108 String type = "suite"; | 124 String type = "suite"; |
109 | 125 |
110 /// Metadata about the suite. | 126 /// Metadata about the suite. |
111 Suite suite; | 127 Suite suite; |
112 } | 128 } |
113 ``` | 129 ``` |
(...skipping 208 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
322 String? name; | 338 String? name; |
323 | 339 |
324 // The ID of the suite containing this group. | 340 // The ID of the suite containing this group. |
325 int suiteID; | 341 int suiteID; |
326 | 342 |
327 // The ID of the group's parent group, unless it's the root group. | 343 // The ID of the group's parent group, unless it's the root group. |
328 int? parentID; | 344 int? parentID; |
329 | 345 |
330 // The group's metadata, including metadata from any containing groups. | 346 // The group's metadata, including metadata from any containing groups. |
331 Metadata metadata; | 347 Metadata metadata; |
348 | |
349 // The number of tests (recursively) within this group. | |
350 int testCount; | |
332 } | 351 } |
333 ``` | 352 ``` |
334 | 353 |
335 A group containing test cases. The group's ID is unique in the context of this | 354 A group containing test cases. The group's ID is unique in the context of this |
336 test run. It's used elsewhere in the protocol to refer to this group without | 355 test run. It's used elsewhere in the protocol to refer to this group without |
337 including its full representation. | 356 including its full representation. |
338 | 357 |
339 The implicit group at the root of each test suite has `null` `name` and | 358 The implicit group at the root of each test suite has `null` `name` and |
340 `parentID` attributes. | 359 `parentID` attributes. |
341 | 360 |
342 ### Metadata | 361 ### Metadata |
343 | 362 |
344 ``` | 363 ``` |
345 class Metadata { | 364 class Metadata { |
346 // Whether the test case will be skipped by the test runner. | 365 // Whether the test case will be skipped by the test runner. |
347 bool skip; | 366 bool skip; |
348 | 367 |
349 // The reason the test case is skipped, if the user provided it. | 368 // The reason the test case is skipped, if the user provided it. |
350 String? skipReason; | 369 String? skipReason; |
351 } | 370 } |
352 ``` | 371 ``` |
353 | 372 |
354 The metadata attached to a test by a user. | 373 The metadata attached to a test by a user. |
OLD | NEW |