summaryrefslogtreecommitdiff
path: root/functional_tests/doc_tests/test_issue142/errorclass_failure.rst
blob: c4ce28780dd8648079a82633559cd1e333992a6e (plain)
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
Failure of Errorclasses
-----------------------

Errorclasses (skips, deprecations, etc.) define whether or not they
represent test failures.

    >>> import os
    >>> import sys
    >>> from nose.plugins.plugintest import run_buffered as run
    >>> from nose.plugins.skip import Skip
    >>> from nose.plugins.deprecated import Deprecated
    >>> support = os.path.join(os.path.dirname(__file__), 'support')
    >>> sys.path.insert(0, support)
    >>> from errorclass_failure_plugin import Todo, TodoPlugin, \
    ...                                       NonFailureTodoPlugin
    >>> todo_test = os.path.join(support, 'errorclass_failing_test.py')
    >>> misc_test = os.path.join(support, 'errorclass_tests.py')

nose.plugins.errorclass.ErrorClass has an argument ``isfailure``. With a
true isfailure, when the errorclass' exception is raised by a test,
tracebacks are printed.

    >>> run(argv=["nosetests", "-v", "--with-todo", todo_test],
    ...     plugins=[TodoPlugin()])  # doctest: +REPORT_NDIFF
    errorclass_failing_test.test_todo ... TODO: fix me
    errorclass_failing_test.test_2 ... ok
    <BLANKLINE>
    ======================================================================
    TODO: errorclass_failing_test.test_todo
    ----------------------------------------------------------------------
    Traceback (most recent call last):
    ...
    Todo: fix me
    <BLANKLINE>
    ----------------------------------------------------------------------
    Ran 2 tests in ...s
    <BLANKLINE>
    FAILED (TODO=1)


Also, ``--stop`` stops the test run.

    >>> run(argv=["nosetests", "-v", "--with-todo", "--stop", todo_test],
    ...     plugins=[TodoPlugin()])  # doctest: +REPORT_NDIFF
    errorclass_failing_test.test_todo ... TODO: fix me
    <BLANKLINE>
    ======================================================================
    TODO: errorclass_failing_test.test_todo
    ----------------------------------------------------------------------
    Traceback (most recent call last):
    ...
    Todo: fix me
    <BLANKLINE>
    ----------------------------------------------------------------------
    Ran 1 test in ...s
    <BLANKLINE>
    FAILED (TODO=1)


With a false .isfailure, errorclass exceptions raised by tests are
treated as "ignored errors."  For ignored errors, tracebacks are not
printed, and the test run does not stop.

    >>> run(argv=["nosetests", "-v", "--with-non-failure-todo", "--stop",
    ...           todo_test],
    ...     plugins=[NonFailureTodoPlugin()])  # doctest: +REPORT_NDIFF
    errorclass_failing_test.test_todo ... TODO: fix me
    errorclass_failing_test.test_2 ... ok
    <BLANKLINE>
    ----------------------------------------------------------------------
    Ran 2 tests in ...s
    <BLANKLINE>
    OK (TODO=1)


Exception detail strings of errorclass errors are always printed when
-v is in effect, regardless of whether the error is ignored.  Note
that exception detail strings may have more than one line.

    >>> run(argv=["nosetests", "-v", "--with-todo", misc_test],
    ...     plugins=[TodoPlugin(), Skip(), Deprecated()])
    ... # doctest: +REPORT_NDIFF
    errorclass_tests.test_todo ... TODO: fix me
    errorclass_tests.test_2 ... ok
    errorclass_tests.test_3 ... SKIP: skipety-skip
    errorclass_tests.test_4 ... SKIP
    errorclass_tests.test_5 ... DEPRECATED: spam
    eggs
    <BLANKLINE>
    spam
    errorclass_tests.test_6 ... DEPRECATED: spam
    <BLANKLINE>
    ======================================================================
    TODO: errorclass_tests.test_todo
    ----------------------------------------------------------------------
    Traceback (most recent call last):
    ...
    Todo: fix me
    <BLANKLINE>
    ----------------------------------------------------------------------
    Ran 6 tests in ...s
    <BLANKLINE>
    FAILED (DEPRECATED=2, SKIP=2, TODO=1)

Without -v, the exception detail strings are only displayed if the
error is not ignored (otherwise, there's no traceback).

    >>> run(argv=["nosetests", "--with-todo", misc_test],
    ...     plugins=[TodoPlugin(), Skip(), Deprecated()])
    ... # doctest: +REPORT_NDIFF
    T.SSDD
    ======================================================================
    TODO: errorclass_tests.test_todo
    ----------------------------------------------------------------------
    Traceback (most recent call last):
    ...
    Todo: fix me
    <BLANKLINE>
    ----------------------------------------------------------------------
    Ran 6 tests in ...s
    <BLANKLINE>
    FAILED (DEPRECATED=2, SKIP=2, TODO=1)

>>> sys.path.remove(support)