diff options
Diffstat (limited to 'lib/subunit/README')
| -rw-r--r-- | lib/subunit/README | 46 |
1 files changed, 25 insertions, 21 deletions
diff --git a/lib/subunit/README b/lib/subunit/README index 6ac258485f..4818a057bf 100644 --- a/lib/subunit/README +++ b/lib/subunit/README @@ -142,23 +142,26 @@ line orientated and consists of either directives and their parameters, or when outside a DETAILS region unexpected lines which are not interpreted by the parser - they should be forwarded unaltered. -test|testing|test:|testing: test label -success|success:|successful|successful: test label -success|success:|successful|successful: test label DETAILS -failure: test label -failure: test label DETAILS -error: test label -error: test label DETAILS -skip[:] test label -skip[:] test label DETAILS -xfail[:] test label -xfail[:] test label DETAILS +test|testing|test:|testing: test LABEL +success|success:|successful|successful: test LABEL +success|success:|successful|successful: test LABEL DETAILS +failure: test LABEL +failure: test LABEL DETAILS +error: test LABEL +error: test LABEL DETAILS +skip[:] test LABEL +skip[:] test LABEL DETAILS +xfail[:] test LABEL +xfail[:] test LABEL DETAILS +uxsuccess[:] test LABEL +uxsuccess[:] test LABEL DETAILS progress: [+|-]X progress: push progress: pop tags: [-]TAG ... time: YYYY-MM-DD HH:MM:SSZ +LABEL: UTF8* DETAILS ::= BRACKETED | MULTIPART BRACKETED ::= '[' CR UTF8-lines ']' CR MULTIPART ::= '[ multipart' CR PART* ']' CR @@ -200,13 +203,14 @@ directive for the most recently started test). The time directive acts as a clock event - it sets the time for all future events. The value should be a valid ISO8601 time. -The skip result is used to indicate a test that was found by the runner but not -fully executed due to some policy or dependency issue. This is represented in -python using the addSkip interface that testtools -(https://edge.launchpad.net/testtools) defines. When communicating with a non -skip aware test result, the test is reported as an error. -The xfail result is used to indicate a test that was expected to fail failing -in the expected manner. As this is a normal condition for such tests it is -represented as a successful test in Python. -In future, skip and xfail results will be represented semantically in Python, -but some discussion is underway on the right way to do this. +The skip, xfail and uxsuccess outcomes are not supported by all testing +environments. In Python the testttools (https://launchpad.net/testtools) +library is used to translate these automatically if an older Python version +that does not support them is in use. See the testtools documentation for the +translation policy. + +skip is used to indicate a test was discovered but not executed. xfail is used +to indicate a test that errored in some expected fashion (also know as "TODO" +tests in some frameworks). uxsuccess is used to indicate and unexpected success +where a test though to be failing actually passes. It is complementary to +xfail. |