class documentation

class SubunitReporterTests(ReporterInterfaceTests): (source)

View In Hierarchy

Tests for the subunit reporter.

This just tests that the subunit reporter implements the basic interface.

Method assertForwardsToSubunit Assert that 'methodName' on SubunitReporter forwards to the equivalent method on subunit.
Method removeMethod Remove 'methodName' from 'klass'.
Method setUp Undocumented
Method test_addErrorSendsSubunitAddError SubunitReporter.addError() sends the subunit 'addError' message.
Method test_addExpectedFailurePassedThrough Some versions of subunit have "addExpectedFailure". For these versions, when we call 'addExpectedFailure' on the test result, we pass the error and test through to the subunit client.
Method test_addFailureSendsSubunitAddFailure SubunitReporter.addFailure() sends the subunit 'addFailure' message.
Method test_addSkipSendsSubunitAddSkip Some versions of subunit have "addSkip". For these versions, when we call 'addSkip' on the test result, we pass the test and reason through to the subunit client.
Method test_addSuccessSendsSubunitAddSuccess SubunitReporter.addSuccess() sends the subunit 'addSuccess' message.
Method test_addUnexpectedSuccessSendsSubunitAddSuccess SubunitReporter.addFailure() sends the subunit 'addSuccess' message, since subunit doesn't model unexpected success.
Method test_doneDoesNothing The subunit reporter doesn't need to print out a summary -- the stream of results is everything. Thus, done() does nothing.
Method test_loadTimeErrors Load-time errors are reported like normal errors.
Method test_startTestSendsSubunitStartTest SubunitReporter.startTest() sends the subunit 'startTest' message.
Method test_stopTestSendsSubunitStopTest SubunitReporter.stopTest() sends the subunit 'stopTest' message.
Method test_subunitWithoutAddExpectedFailureInstalled Some versions of subunit don't have "addExpectedFailure". For these versions, we report expected failures as successes.
Method test_subunitWithoutAddSkipInstalled Some versions of subunit don't have "addSkip". For these versions, we report skips as successes.
Instance Variable publisher Undocumented
Instance Variable result Undocumented
Instance Variable stream Undocumented
Instance Variable test Undocumented

Inherited from ReporterInterfaceTests:

Method test_shouldStopInitiallyFalse shouldStop is False to begin with.
Method test_shouldStopTrueAfterStop shouldStop becomes True soon as someone calls stop().
Method test_wasSuccessfulFalseAfterErrors wasSuccessful() becomes False after errors have been reported.
Method test_wasSuccessfulFalseAfterFailures wasSuccessful() becomes False after failures have been reported.
Method test_wasSuccessfulInitiallyTrue wasSuccessful() is True when there have been no results reported.
Method test_wasSuccessfulTrueAfterSuccesses wasSuccessful() is True when there have been only successes, False otherwise.
Class Variable resultFactory A callable that returns a reporter to be tested. The callable must take the same parameters as reporter.Reporter.

Inherited from SynchronousTestCase (via ReporterInterfaceTests):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
Method __init__ Undocumented
Method addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
Method callDeprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method shortDescription Undocumented
Instance Variable failureException An exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable skip None or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
Instance Variable suppress None or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
Instance Variable todo None, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _passed Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via ReporterInterfaceTests, SynchronousTestCase):

Method assertAlmostEqual Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertApproximates Fail if first - second > tolerance
Method assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
Method assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertNotAlmostEqual Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
Method assertRaises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
Method assertWarns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def assertForwardsToSubunit(self, methodName, *args, **kwargs): (source)

Assert that 'methodName' on SubunitReporter forwards to the equivalent method on subunit.

Checks that the return value from subunit is returned from the SubunitReporter and that the reporter writes the same data to its stream as subunit does to its own.

Assumes that the method on subunit has the same name as the method on SubunitReporter.

def removeMethod(self, klass, methodName): (source)

Remove 'methodName' from 'klass'.

If 'klass' does not have a method named 'methodName', then 'removeMethod' succeeds silently.

If 'klass' does have a method named 'methodName', then it is removed using delattr. Also, methods of the same name are removed from all base classes of 'klass', thus removing the method entirely.

Parameters
klassThe class to remove the method from.
methodNameThe name of the method to remove.
def test_addErrorSendsSubunitAddError(self): (source)

SubunitReporter.addError() sends the subunit 'addError' message.

def test_addExpectedFailurePassedThrough(self): (source)

Some versions of subunit have "addExpectedFailure". For these versions, when we call 'addExpectedFailure' on the test result, we pass the error and test through to the subunit client.

def test_addFailureSendsSubunitAddFailure(self): (source)

SubunitReporter.addFailure() sends the subunit 'addFailure' message.

def test_addSkipSendsSubunitAddSkip(self): (source)

Some versions of subunit have "addSkip". For these versions, when we call 'addSkip' on the test result, we pass the test and reason through to the subunit client.

def test_addSuccessSendsSubunitAddSuccess(self): (source)

SubunitReporter.addSuccess() sends the subunit 'addSuccess' message.

def test_addUnexpectedSuccessSendsSubunitAddSuccess(self): (source)

SubunitReporter.addFailure() sends the subunit 'addSuccess' message, since subunit doesn't model unexpected success.

def test_doneDoesNothing(self): (source)

The subunit reporter doesn't need to print out a summary -- the stream of results is everything. Thus, done() does nothing.

def test_loadTimeErrors(self): (source)

Load-time errors are reported like normal errors.

def test_startTestSendsSubunitStartTest(self): (source)

SubunitReporter.startTest() sends the subunit 'startTest' message.

def test_stopTestSendsSubunitStopTest(self): (source)

SubunitReporter.stopTest() sends the subunit 'stopTest' message.

def test_subunitWithoutAddExpectedFailureInstalled(self): (source)

Some versions of subunit don't have "addExpectedFailure". For these versions, we report expected failures as successes.

def test_subunitWithoutAddSkipInstalled(self): (source)

Some versions of subunit don't have "addSkip". For these versions, we report skips as successes.