~azzar1/unity/add-show-desktop-key

304 by dilshan_a
Added documentation of output of TestSuite.
1
The output of running a problem suite is a next dictionary that can easily be converted into json:
2
3
--------
4
problem
5
--------
6
Normal case:
7
problem = {
8
	name: name of problem <string>
9
	cases: test case results <list(case)>
309 by dilshan_a
Added a passed key to return value of problem suite.
10
	passed: <bool>
304 by dilshan_a
Added documentation of output of TestSuite.
11
}
12
13
Critical error occured (Syntax, Indentation, FunctionNotFound):
14
problem = {
15
	name: name of problem <string>
16
	critical_error: details of error <exception_data>
309 by dilshan_a
Added a passed key to return value of problem suite.
17
	passed: False <bool>
304 by dilshan_a
Added documentation of output of TestSuite.
18
}
19
20
----
21
case
22
----
23
Normal:
24
case = {
25
	name: name of test case <string>
26
	parts: test part results <list(part)>
27
	passed: all parts passed <bool>
28
}
29
30
Exception occured:
31
case = {
32
	name: name of test case <string>
33
	exception: details of exception <exception_data>
34
	passed: False <bool>
35
}
36
37
----
38
part
39
----
40
Part passed:
41
part = {
42
	description: <string>
43
	passed: True <bool>
44
}
45
46
Part failed:
47
part = {
48
	description: <string>
49
	passed: False <bool>
50
	error_message: <string>
51
}
52
53
--------------
54
exception_data
55
--------------
56
exception_data = {
57
	name: class name of exception <string>
58
	detail: extra info <string>
59
	critical: does exception prevent all tests from being run <bool>
60
}