class IReporter(zi.Interface): (source)
Known implementations: twisted.plugins.twisted_trial._Reporter
, twisted.trial._dist.distreporter.DistReporter
, twisted.trial.reporter._ExitWrapper
, twisted.trial.reporter.Reporter
, twisted.trial.reporter.SubunitReporter
, twisted.trial.reporter.TestResult
, twisted.trial.reporter.TestResultDecorator
, twisted.trial.reporter.UncleanWarningsReporterWrapper
I report results from a run of a test suite.
Attribute | shouldStop |
A boolean indicating that this reporter would like the test run to stop. |
Attribute | testsRun |
The number of tests that seem to have been run according to this reporter. |
Method | startTest |
Report the beginning of a run of a single test method. |
Method | stopTest |
Report the status of a single test method |
Method | addSuccess |
Record that test passed. |
Method | addError |
Record that a test has raised an unexpected exception. |
Method | addFailure |
Record that a test has failed with the given failure. |
Method | addExpectedFailure |
Record that the given test failed, and was expected to do so. |
Method | addUnexpectedSuccess |
Record that the given test failed, and was expected to do so. |
Method | addSkip |
Record that a test has been skipped for the given reason. |
Method | wasSuccessful |
Return a boolean indicating whether all test results that were reported to this reporter were successful or not. |
Method | done |
Called when the test run is complete. |
Report the beginning of a run of a single test method.
Parameters | method | an object that is adaptable to ITestMethod |
Record that a test has raised an unexpected exception.
Parameters | test | The test that has raised an error. |
error | The error that the test raised. It will either be a three-tuple in the style of sys.exc_info() or a Failure object. |
Record that a test has failed with the given failure.
Parameters | test | The test that has failed. |
failure | The failure that the test failed with. It will either be a three-tuple in the style of sys.exc_info() or a Failure object. |
Record that the given test failed, and was expected to do so.
In Twisted 15.5 and prior, todo
was a mandatory parameter.
Parameters | test | The test which this is about. (type: unittest.TestCase ) |
failure | The error which this test failed with. (type: failure.Failure ) | |
todo | The reason for the test's TODO status. If None , a generic reason is used. (type: unittest.Todo ) |
Record that the given test failed, and was expected to do so.
In Twisted 15.5 and prior, todo
was a mandatory parameter.
Parameters | test | The test which this is about. (type: unittest.TestCase ) |
todo | The reason for the test's TODO status. If None , a generic reason is used. (type: unittest.Todo ) |
Record that a test has been skipped for the given reason.
Parameters | test | The test that has been skipped. |
reason | An object that the test case has specified as the reason for skipping the test. |