17.12
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
if __name__ == '__main__':
|
||||
from pkg_resources import load_entry_point
|
||||
import sys
|
||||
|
||||
sys.exit(
|
||||
load_entry_point('Twisted', 'console_scripts', 'trial')()
|
||||
)
|
||||
@@ -0,0 +1,405 @@
|
||||
# -*- test-case-name: twisted.trial.test -*-
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
Things likely to be used by writers of unit tests.
|
||||
|
||||
Maintainer: Jonathan Lange
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import
|
||||
|
||||
import inspect
|
||||
import warnings
|
||||
|
||||
from zope.interface import implementer
|
||||
|
||||
# We can't import reactor at module-level because this code runs before trial
|
||||
# installs a user-specified reactor, installing the default reactor and
|
||||
# breaking reactor installation. See also #6047.
|
||||
from twisted.internet import defer, utils
|
||||
from twisted.python import failure
|
||||
|
||||
from twisted.trial import itrial, util
|
||||
from twisted.trial._synctest import (
|
||||
FailTest, SkipTest, SynchronousTestCase)
|
||||
|
||||
_wait_is_running = []
|
||||
|
||||
@implementer(itrial.ITestCase)
|
||||
class TestCase(SynchronousTestCase):
|
||||
"""
|
||||
A unit test. The atom of the unit testing universe.
|
||||
|
||||
This class extends L{SynchronousTestCase} which extends C{unittest.TestCase}
|
||||
from the standard library. The main feature is the ability to return
|
||||
C{Deferred}s from tests and fixture methods and to have the suite wait for
|
||||
those C{Deferred}s to fire. Also provides new assertions such as
|
||||
L{assertFailure}.
|
||||
|
||||
@ivar timeout: A real number of seconds. If set, the test will
|
||||
raise an error if it takes longer than C{timeout} seconds.
|
||||
If not set, util.DEFAULT_TIMEOUT_DURATION is used.
|
||||
"""
|
||||
|
||||
def __init__(self, methodName='runTest'):
|
||||
"""
|
||||
Construct an asynchronous test case for C{methodName}.
|
||||
|
||||
@param methodName: The name of a method on C{self}. This method should
|
||||
be a unit test. That is, it should be a short method that calls some of
|
||||
the assert* methods. If C{methodName} is unspecified,
|
||||
L{SynchronousTestCase.runTest} will be used as the test method. This is
|
||||
mostly useful for testing Trial.
|
||||
"""
|
||||
super(TestCase, self).__init__(methodName)
|
||||
|
||||
|
||||
def assertFailure(self, deferred, *expectedFailures):
|
||||
"""
|
||||
Fail if C{deferred} does not errback with one of C{expectedFailures}.
|
||||
Returns the original Deferred with callbacks added. You will need
|
||||
to return this Deferred from your test case.
|
||||
"""
|
||||
def _cb(ignore):
|
||||
raise self.failureException(
|
||||
"did not catch an error, instead got %r" % (ignore,))
|
||||
|
||||
def _eb(failure):
|
||||
if failure.check(*expectedFailures):
|
||||
return failure.value
|
||||
else:
|
||||
output = ('\nExpected: %r\nGot:\n%s'
|
||||
% (expectedFailures, str(failure)))
|
||||
raise self.failureException(output)
|
||||
return deferred.addCallbacks(_cb, _eb)
|
||||
failUnlessFailure = assertFailure
|
||||
|
||||
|
||||
def _run(self, methodName, result):
|
||||
from twisted.internet import reactor
|
||||
timeout = self.getTimeout()
|
||||
def onTimeout(d):
|
||||
e = defer.TimeoutError("%r (%s) still running at %s secs"
|
||||
% (self, methodName, timeout))
|
||||
f = failure.Failure(e)
|
||||
# try to errback the deferred that the test returns (for no gorram
|
||||
# reason) (see issue1005 and test_errorPropagation in
|
||||
# test_deferred)
|
||||
try:
|
||||
d.errback(f)
|
||||
except defer.AlreadyCalledError:
|
||||
# if the deferred has been called already but the *back chain
|
||||
# is still unfinished, crash the reactor and report timeout
|
||||
# error ourself.
|
||||
reactor.crash()
|
||||
self._timedOut = True # see self._wait
|
||||
todo = self.getTodo()
|
||||
if todo is not None and todo.expected(f):
|
||||
result.addExpectedFailure(self, f, todo)
|
||||
else:
|
||||
result.addError(self, f)
|
||||
onTimeout = utils.suppressWarnings(
|
||||
onTimeout, util.suppress(category=DeprecationWarning))
|
||||
method = getattr(self, methodName)
|
||||
if inspect.isgeneratorfunction(method):
|
||||
exc = TypeError(
|
||||
'%r is a generator function and therefore will never run' % (
|
||||
method,))
|
||||
return defer.fail(exc)
|
||||
d = defer.maybeDeferred(
|
||||
utils.runWithWarningsSuppressed, self._getSuppress(), method)
|
||||
call = reactor.callLater(timeout, onTimeout, d)
|
||||
d.addBoth(lambda x : call.active() and call.cancel() or x)
|
||||
return d
|
||||
|
||||
|
||||
def __call__(self, *args, **kwargs):
|
||||
return self.run(*args, **kwargs)
|
||||
|
||||
|
||||
def deferSetUp(self, ignored, result):
|
||||
d = self._run('setUp', result)
|
||||
d.addCallbacks(self.deferTestMethod, self._ebDeferSetUp,
|
||||
callbackArgs=(result,),
|
||||
errbackArgs=(result,))
|
||||
return d
|
||||
|
||||
|
||||
def _ebDeferSetUp(self, failure, result):
|
||||
if failure.check(SkipTest):
|
||||
result.addSkip(self, self._getSkipReason(self.setUp, failure.value))
|
||||
else:
|
||||
result.addError(self, failure)
|
||||
if failure.check(KeyboardInterrupt):
|
||||
result.stop()
|
||||
return self.deferRunCleanups(None, result)
|
||||
|
||||
|
||||
def deferTestMethod(self, ignored, result):
|
||||
d = self._run(self._testMethodName, result)
|
||||
d.addCallbacks(self._cbDeferTestMethod, self._ebDeferTestMethod,
|
||||
callbackArgs=(result,),
|
||||
errbackArgs=(result,))
|
||||
d.addBoth(self.deferRunCleanups, result)
|
||||
d.addBoth(self.deferTearDown, result)
|
||||
return d
|
||||
|
||||
|
||||
def _cbDeferTestMethod(self, ignored, result):
|
||||
if self.getTodo() is not None:
|
||||
result.addUnexpectedSuccess(self, self.getTodo())
|
||||
else:
|
||||
self._passed = True
|
||||
return ignored
|
||||
|
||||
|
||||
def _ebDeferTestMethod(self, f, result):
|
||||
todo = self.getTodo()
|
||||
if todo is not None and todo.expected(f):
|
||||
result.addExpectedFailure(self, f, todo)
|
||||
elif f.check(self.failureException, FailTest):
|
||||
result.addFailure(self, f)
|
||||
elif f.check(KeyboardInterrupt):
|
||||
result.addError(self, f)
|
||||
result.stop()
|
||||
elif f.check(SkipTest):
|
||||
result.addSkip(
|
||||
self,
|
||||
self._getSkipReason(getattr(self, self._testMethodName), f.value))
|
||||
else:
|
||||
result.addError(self, f)
|
||||
|
||||
|
||||
def deferTearDown(self, ignored, result):
|
||||
d = self._run('tearDown', result)
|
||||
d.addErrback(self._ebDeferTearDown, result)
|
||||
return d
|
||||
|
||||
|
||||
def _ebDeferTearDown(self, failure, result):
|
||||
result.addError(self, failure)
|
||||
if failure.check(KeyboardInterrupt):
|
||||
result.stop()
|
||||
self._passed = False
|
||||
|
||||
|
||||
def deferRunCleanups(self, ignored, result):
|
||||
"""
|
||||
Run any scheduled cleanups and report errors (if any to the result
|
||||
object.
|
||||
"""
|
||||
d = self._runCleanups()
|
||||
d.addCallback(self._cbDeferRunCleanups, result)
|
||||
return d
|
||||
|
||||
|
||||
def _cbDeferRunCleanups(self, cleanupResults, result):
|
||||
for flag, testFailure in cleanupResults:
|
||||
if flag == defer.FAILURE:
|
||||
result.addError(self, testFailure)
|
||||
if testFailure.check(KeyboardInterrupt):
|
||||
result.stop()
|
||||
self._passed = False
|
||||
|
||||
|
||||
def _cleanUp(self, result):
|
||||
try:
|
||||
clean = util._Janitor(self, result).postCaseCleanup()
|
||||
if not clean:
|
||||
self._passed = False
|
||||
except:
|
||||
result.addError(self, failure.Failure())
|
||||
self._passed = False
|
||||
for error in self._observer.getErrors():
|
||||
result.addError(self, error)
|
||||
self._passed = False
|
||||
self.flushLoggedErrors()
|
||||
self._removeObserver()
|
||||
if self._passed:
|
||||
result.addSuccess(self)
|
||||
|
||||
|
||||
def _classCleanUp(self, result):
|
||||
try:
|
||||
util._Janitor(self, result).postClassCleanup()
|
||||
except:
|
||||
result.addError(self, failure.Failure())
|
||||
|
||||
|
||||
def _makeReactorMethod(self, name):
|
||||
"""
|
||||
Create a method which wraps the reactor method C{name}. The new
|
||||
method issues a deprecation warning and calls the original.
|
||||
"""
|
||||
def _(*a, **kw):
|
||||
warnings.warn("reactor.%s cannot be used inside unit tests. "
|
||||
"In the future, using %s will fail the test and may "
|
||||
"crash or hang the test run."
|
||||
% (name, name),
|
||||
stacklevel=2, category=DeprecationWarning)
|
||||
return self._reactorMethods[name](*a, **kw)
|
||||
return _
|
||||
|
||||
|
||||
def _deprecateReactor(self, reactor):
|
||||
"""
|
||||
Deprecate C{iterate}, C{crash} and C{stop} on C{reactor}. That is,
|
||||
each method is wrapped in a function that issues a deprecation
|
||||
warning, then calls the original.
|
||||
|
||||
@param reactor: The Twisted reactor.
|
||||
"""
|
||||
self._reactorMethods = {}
|
||||
for name in ['crash', 'iterate', 'stop']:
|
||||
self._reactorMethods[name] = getattr(reactor, name)
|
||||
setattr(reactor, name, self._makeReactorMethod(name))
|
||||
|
||||
|
||||
def _undeprecateReactor(self, reactor):
|
||||
"""
|
||||
Restore the deprecated reactor methods. Undoes what
|
||||
L{_deprecateReactor} did.
|
||||
|
||||
@param reactor: The Twisted reactor.
|
||||
"""
|
||||
for name, method in self._reactorMethods.items():
|
||||
setattr(reactor, name, method)
|
||||
self._reactorMethods = {}
|
||||
|
||||
|
||||
def _runCleanups(self):
|
||||
"""
|
||||
Run the cleanups added with L{addCleanup} in order.
|
||||
|
||||
@return: A C{Deferred} that fires when all cleanups are run.
|
||||
"""
|
||||
def _makeFunction(f, args, kwargs):
|
||||
return lambda: f(*args, **kwargs)
|
||||
callables = []
|
||||
while len(self._cleanups) > 0:
|
||||
f, args, kwargs = self._cleanups.pop()
|
||||
callables.append(_makeFunction(f, args, kwargs))
|
||||
return util._runSequentially(callables)
|
||||
|
||||
|
||||
def _runFixturesAndTest(self, result):
|
||||
"""
|
||||
Really run C{setUp}, the test method, and C{tearDown}. Any of these may
|
||||
return L{defer.Deferred}s. After they complete, do some reactor cleanup.
|
||||
|
||||
@param result: A L{TestResult} object.
|
||||
"""
|
||||
from twisted.internet import reactor
|
||||
self._deprecateReactor(reactor)
|
||||
self._timedOut = False
|
||||
try:
|
||||
d = self.deferSetUp(None, result)
|
||||
try:
|
||||
self._wait(d)
|
||||
finally:
|
||||
self._cleanUp(result)
|
||||
self._classCleanUp(result)
|
||||
finally:
|
||||
self._undeprecateReactor(reactor)
|
||||
|
||||
|
||||
def addCleanup(self, f, *args, **kwargs):
|
||||
"""
|
||||
Extend the base cleanup feature with support for cleanup functions which
|
||||
return Deferreds.
|
||||
|
||||
If the function C{f} returns a Deferred, C{TestCase} will wait until the
|
||||
Deferred has fired before proceeding to the next function.
|
||||
"""
|
||||
return super(TestCase, self).addCleanup(f, *args, **kwargs)
|
||||
|
||||
|
||||
def getSuppress(self):
|
||||
return self._getSuppress()
|
||||
|
||||
|
||||
def getTimeout(self):
|
||||
"""
|
||||
Returns the timeout value set on this test. Checks on the instance
|
||||
first, then the class, then the module, then packages. As soon as it
|
||||
finds something with a C{timeout} attribute, returns that. Returns
|
||||
L{util.DEFAULT_TIMEOUT_DURATION} if it cannot find anything. See
|
||||
L{TestCase} docstring for more details.
|
||||
"""
|
||||
timeout = util.acquireAttribute(self._parents, 'timeout',
|
||||
util.DEFAULT_TIMEOUT_DURATION)
|
||||
try:
|
||||
return float(timeout)
|
||||
except (ValueError, TypeError):
|
||||
# XXX -- this is here because sometimes people will have methods
|
||||
# called 'timeout', or set timeout to 'orange', or something
|
||||
# Particularly, test_news.NewsTestCase and ReactorCoreTestCase
|
||||
# both do this.
|
||||
warnings.warn("'timeout' attribute needs to be a number.",
|
||||
category=DeprecationWarning)
|
||||
return util.DEFAULT_TIMEOUT_DURATION
|
||||
|
||||
|
||||
def _wait(self, d, running=_wait_is_running):
|
||||
"""Take a Deferred that only ever callbacks. Block until it happens.
|
||||
"""
|
||||
if running:
|
||||
raise RuntimeError("_wait is not reentrant")
|
||||
|
||||
from twisted.internet import reactor
|
||||
results = []
|
||||
def append(any):
|
||||
if results is not None:
|
||||
results.append(any)
|
||||
def crash(ign):
|
||||
if results is not None:
|
||||
reactor.crash()
|
||||
crash = utils.suppressWarnings(
|
||||
crash, util.suppress(message=r'reactor\.crash cannot be used.*',
|
||||
category=DeprecationWarning))
|
||||
def stop():
|
||||
reactor.crash()
|
||||
stop = utils.suppressWarnings(
|
||||
stop, util.suppress(message=r'reactor\.crash cannot be used.*',
|
||||
category=DeprecationWarning))
|
||||
|
||||
running.append(None)
|
||||
try:
|
||||
d.addBoth(append)
|
||||
if results:
|
||||
# d might have already been fired, in which case append is
|
||||
# called synchronously. Avoid any reactor stuff.
|
||||
return
|
||||
d.addBoth(crash)
|
||||
reactor.stop = stop
|
||||
try:
|
||||
reactor.run()
|
||||
finally:
|
||||
del reactor.stop
|
||||
|
||||
# If the reactor was crashed elsewhere due to a timeout, hopefully
|
||||
# that crasher also reported an error. Just return.
|
||||
# _timedOut is most likely to be set when d has fired but hasn't
|
||||
# completed its callback chain (see self._run)
|
||||
if results or self._timedOut: #defined in run() and _run()
|
||||
return
|
||||
|
||||
# If the timeout didn't happen, and we didn't get a result or
|
||||
# a failure, then the user probably aborted the test, so let's
|
||||
# just raise KeyboardInterrupt.
|
||||
|
||||
# FIXME: imagine this:
|
||||
# web/test/test_webclient.py:
|
||||
# exc = self.assertRaises(error.Error, wait, method(url))
|
||||
#
|
||||
# wait() will raise KeyboardInterrupt, and assertRaises will
|
||||
# swallow it. Therefore, wait() raising KeyboardInterrupt is
|
||||
# insufficient to stop trial. A suggested solution is to have
|
||||
# this code set a "stop trial" flag, or otherwise notify trial
|
||||
# that it should really try to stop as soon as possible.
|
||||
raise KeyboardInterrupt()
|
||||
finally:
|
||||
results = None
|
||||
running.pop()
|
||||
@@ -0,0 +1,47 @@
|
||||
# -*- test-case-name: twisted.trial._dist.test -*-
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
This package implements the distributed Trial test runner:
|
||||
|
||||
- The L{twisted.trial._dist.disttrial} module implements a test runner which
|
||||
runs in a manager process and can launch additional worker processes in
|
||||
which to run tests and gather up results from all of them.
|
||||
|
||||
- The L{twisted.trial._dist.options} module defines command line options used
|
||||
to configure the distributed test runner.
|
||||
|
||||
- The L{twisted.trial._dist.managercommands} module defines AMP commands
|
||||
which are sent from worker processes back to the manager process to report
|
||||
the results of tests.
|
||||
|
||||
- The L{twisted.trial._dist.workercommands} module defines AMP commands which
|
||||
are sent from the manager process to the worker processes to control the
|
||||
execution of tests there.
|
||||
|
||||
- The L{twisted.trial._dist.distreporter} module defines a proxy for
|
||||
L{twisted.trial.itrial.IReporter} which enforces the typical requirement
|
||||
that results be passed to a reporter for only one test at a time, allowing
|
||||
any reporter to be used with despite disttrial's simultaneously running
|
||||
tests.
|
||||
|
||||
- The L{twisted.trial._dist.workerreporter} module implements a
|
||||
L{twisted.trial.itrial.IReporter} which is used by worker processes and
|
||||
reports results back to the manager process using AMP commands.
|
||||
|
||||
- The L{twisted.trial._dist.workertrial} module is a runnable script which is
|
||||
the main point for worker processes.
|
||||
|
||||
- The L{twisted.trial._dist.worker} process defines the manager's AMP
|
||||
protocol for accepting results from worker processes and a process protocol
|
||||
for use running workers as local child processes (as opposed to
|
||||
distributing them to another host).
|
||||
|
||||
@since: 12.3
|
||||
"""
|
||||
|
||||
# File descriptors numbers used to set up pipes with the worker.
|
||||
_WORKER_AMP_STDIN = 3
|
||||
|
||||
_WORKER_AMP_STDOUT = 4
|
||||
@@ -0,0 +1,470 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
Test for distributed trial worker side.
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
from zope.interface.verify import verifyObject
|
||||
|
||||
from twisted.trial.reporter import TestResult
|
||||
from twisted.trial.unittest import TestCase
|
||||
from twisted.trial._dist.worker import (
|
||||
LocalWorker, LocalWorkerAMP, LocalWorkerTransport, WorkerProtocol)
|
||||
from twisted.trial._dist import managercommands, workercommands
|
||||
|
||||
from twisted.scripts import trial
|
||||
from twisted.test.proto_helpers import StringTransport
|
||||
|
||||
from twisted.internet.interfaces import ITransport, IAddress
|
||||
from twisted.internet.defer import fail, succeed
|
||||
from twisted.internet.main import CONNECTION_DONE
|
||||
from twisted.internet.error import ConnectionDone
|
||||
from twisted.python.reflect import fullyQualifiedName
|
||||
from twisted.python.failure import Failure
|
||||
from twisted.protocols.amp import AMP
|
||||
from twisted.python.compat import NativeStringIO
|
||||
from io import BytesIO
|
||||
|
||||
|
||||
class FakeAMP(AMP):
|
||||
"""
|
||||
A fake amp protocol.
|
||||
"""
|
||||
|
||||
|
||||
|
||||
class WorkerProtocolTests(TestCase):
|
||||
"""
|
||||
Tests for L{WorkerProtocol}.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
"""
|
||||
Set up a transport, a result stream and a protocol instance.
|
||||
"""
|
||||
self.serverTransport = StringTransport()
|
||||
self.clientTransport = StringTransport()
|
||||
self.server = WorkerProtocol()
|
||||
self.server.makeConnection(self.serverTransport)
|
||||
self.client = FakeAMP()
|
||||
self.client.makeConnection(self.clientTransport)
|
||||
|
||||
|
||||
def test_run(self):
|
||||
"""
|
||||
Calling the L{workercommands.Run} command on the client returns a
|
||||
response with C{success} sets to C{True}.
|
||||
"""
|
||||
d = self.client.callRemote(workercommands.Run, testCase="doesntexist")
|
||||
|
||||
def check(result):
|
||||
self.assertTrue(result['success'])
|
||||
|
||||
d.addCallback(check)
|
||||
self.server.dataReceived(self.clientTransport.value())
|
||||
self.clientTransport.clear()
|
||||
self.client.dataReceived(self.serverTransport.value())
|
||||
self.serverTransport.clear()
|
||||
return d
|
||||
|
||||
|
||||
def test_start(self):
|
||||
"""
|
||||
The C{start} command changes the current path.
|
||||
"""
|
||||
curdir = os.path.realpath(os.path.curdir)
|
||||
self.addCleanup(os.chdir, curdir)
|
||||
self.server.start('..')
|
||||
self.assertNotEqual(os.path.realpath(os.path.curdir), curdir)
|
||||
|
||||
|
||||
|
||||
class LocalWorkerAMPTests(TestCase):
|
||||
"""
|
||||
Test case for distributed trial's manager-side local worker AMP protocol
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.managerTransport = StringTransport()
|
||||
self.managerAMP = LocalWorkerAMP()
|
||||
self.managerAMP.makeConnection(self.managerTransport)
|
||||
self.result = TestResult()
|
||||
self.workerTransport = StringTransport()
|
||||
self.worker = AMP()
|
||||
self.worker.makeConnection(self.workerTransport)
|
||||
|
||||
config = trial.Options()
|
||||
self.testName = "twisted.doesnexist"
|
||||
config['tests'].append(self.testName)
|
||||
self.testCase = trial._getSuite(config)._tests.pop()
|
||||
|
||||
self.managerAMP.run(self.testCase, self.result)
|
||||
self.managerTransport.clear()
|
||||
|
||||
|
||||
def pumpTransports(self):
|
||||
"""
|
||||
Sends data from C{self.workerTransport} to C{self.managerAMP}, and then
|
||||
data from C{self.managerTransport} back to C{self.worker}.
|
||||
"""
|
||||
self.managerAMP.dataReceived(self.workerTransport.value())
|
||||
self.workerTransport.clear()
|
||||
self.worker.dataReceived(self.managerTransport.value())
|
||||
|
||||
|
||||
def test_runSuccess(self):
|
||||
"""
|
||||
Run a test, and succeed.
|
||||
"""
|
||||
results = []
|
||||
|
||||
d = self.worker.callRemote(managercommands.AddSuccess,
|
||||
testName=self.testName)
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_runExpectedFailure(self):
|
||||
"""
|
||||
Run a test, and fail expectedly.
|
||||
"""
|
||||
results = []
|
||||
|
||||
d = self.worker.callRemote(managercommands.AddExpectedFailure,
|
||||
testName=self.testName, error='error',
|
||||
todo='todoReason')
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual(self.testCase, self.result.expectedFailures[0][0])
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_runError(self):
|
||||
"""
|
||||
Run a test, and encounter an error.
|
||||
"""
|
||||
results = []
|
||||
errorClass = fullyQualifiedName(ValueError)
|
||||
d = self.worker.callRemote(managercommands.AddError,
|
||||
testName=self.testName, error='error',
|
||||
errorClass=errorClass,
|
||||
frames=[])
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual(self.testCase, self.result.errors[0][0])
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_runErrorWithFrames(self):
|
||||
"""
|
||||
L{LocalWorkerAMP._buildFailure} recreates the C{Failure.frames} from
|
||||
the C{frames} argument passed to C{AddError}.
|
||||
"""
|
||||
results = []
|
||||
errorClass = fullyQualifiedName(ValueError)
|
||||
d = self.worker.callRemote(managercommands.AddError,
|
||||
testName=self.testName, error='error',
|
||||
errorClass=errorClass,
|
||||
frames=["file.py", "invalid code", "3"])
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual(self.testCase, self.result.errors[0][0])
|
||||
self.assertEqual(
|
||||
[('file.py', 'invalid code', 3, [], [])],
|
||||
self.result.errors[0][1].frames)
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_runFailure(self):
|
||||
"""
|
||||
Run a test, and fail.
|
||||
"""
|
||||
results = []
|
||||
failClass = fullyQualifiedName(RuntimeError)
|
||||
d = self.worker.callRemote(managercommands.AddFailure,
|
||||
testName=self.testName, fail='fail',
|
||||
failClass=failClass,
|
||||
frames=[])
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual(self.testCase, self.result.failures[0][0])
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_runSkip(self):
|
||||
"""
|
||||
Run a test, but skip it.
|
||||
"""
|
||||
results = []
|
||||
|
||||
d = self.worker.callRemote(managercommands.AddSkip,
|
||||
testName=self.testName, reason='reason')
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual(self.testCase, self.result.skips[0][0])
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_runUnexpectedSuccesses(self):
|
||||
"""
|
||||
Run a test, and succeed unexpectedly.
|
||||
"""
|
||||
results = []
|
||||
|
||||
d = self.worker.callRemote(managercommands.AddUnexpectedSuccess,
|
||||
testName=self.testName,
|
||||
todo='todo')
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual(self.testCase, self.result.unexpectedSuccesses[0][0])
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_testWrite(self):
|
||||
"""
|
||||
L{LocalWorkerAMP.testWrite} writes the data received to its test
|
||||
stream.
|
||||
"""
|
||||
results = []
|
||||
stream = NativeStringIO()
|
||||
self.managerAMP.setTestStream(stream)
|
||||
|
||||
command = managercommands.TestWrite
|
||||
d = self.worker.callRemote(command,
|
||||
out="Some output")
|
||||
d.addCallback(lambda result: results.append(result['success']))
|
||||
self.pumpTransports()
|
||||
|
||||
self.assertEqual("Some output\n", stream.getvalue())
|
||||
self.assertTrue(results)
|
||||
|
||||
|
||||
def test_stopAfterRun(self):
|
||||
"""
|
||||
L{LocalWorkerAMP.run} calls C{stopTest} on its test result once the
|
||||
C{Run} commands has succeeded.
|
||||
"""
|
||||
result = object()
|
||||
stopped = []
|
||||
|
||||
def fakeCallRemote(command, testCase):
|
||||
return succeed(result)
|
||||
|
||||
self.managerAMP.callRemote = fakeCallRemote
|
||||
|
||||
class StopTestResult(TestResult):
|
||||
|
||||
def stopTest(self, test):
|
||||
stopped.append(test)
|
||||
|
||||
|
||||
d = self.managerAMP.run(self.testCase, StopTestResult())
|
||||
self.assertEqual([self.testCase], stopped)
|
||||
return d.addCallback(self.assertIdentical, result)
|
||||
|
||||
|
||||
|
||||
class FakeAMProtocol(AMP):
|
||||
"""
|
||||
A fake implementation of L{AMP} for testing.
|
||||
"""
|
||||
id = 0
|
||||
dataString = b""
|
||||
|
||||
def dataReceived(self, data):
|
||||
self.dataString += data
|
||||
|
||||
|
||||
def setTestStream(self, stream):
|
||||
self.testStream = stream
|
||||
|
||||
|
||||
|
||||
class FakeTransport(object):
|
||||
"""
|
||||
A fake process transport implementation for testing.
|
||||
"""
|
||||
dataString = b""
|
||||
calls = 0
|
||||
|
||||
def writeToChild(self, fd, data):
|
||||
self.dataString += data
|
||||
|
||||
|
||||
def loseConnection(self):
|
||||
self.calls += 1
|
||||
|
||||
|
||||
|
||||
class LocalWorkerTests(TestCase):
|
||||
"""
|
||||
Tests for L{LocalWorker} and L{LocalWorkerTransport}.
|
||||
"""
|
||||
|
||||
def tidyLocalWorker(self, *args, **kwargs):
|
||||
"""
|
||||
Create a L{LocalWorker}, connect it to a transport, and ensure
|
||||
its log files are closed.
|
||||
|
||||
@param args: See L{LocalWorker}
|
||||
|
||||
@param kwargs: See L{LocalWorker}
|
||||
|
||||
@return: a L{LocalWorker} instance
|
||||
"""
|
||||
worker = LocalWorker(*args, **kwargs)
|
||||
worker.makeConnection(FakeTransport())
|
||||
self.addCleanup(worker._testLog.close)
|
||||
self.addCleanup(worker._outLog.close)
|
||||
self.addCleanup(worker._errLog.close)
|
||||
return worker
|
||||
|
||||
|
||||
def test_childDataReceived(self):
|
||||
"""
|
||||
L{LocalWorker.childDataReceived} forwards the received data to linked
|
||||
L{AMP} protocol if the right file descriptor, otherwise forwards to
|
||||
C{ProcessProtocol.childDataReceived}.
|
||||
"""
|
||||
localWorker = self.tidyLocalWorker(FakeAMProtocol(), '.', 'test.log')
|
||||
localWorker._outLog = BytesIO()
|
||||
localWorker.childDataReceived(4, b"foo")
|
||||
localWorker.childDataReceived(1, b"bar")
|
||||
self.assertEqual(b"foo", localWorker._ampProtocol.dataString)
|
||||
self.assertEqual(b"bar", localWorker._outLog.getvalue())
|
||||
|
||||
|
||||
def test_outReceived(self):
|
||||
"""
|
||||
L{LocalWorker.outReceived} logs the output into its C{_outLog} log
|
||||
file.
|
||||
"""
|
||||
localWorker = self.tidyLocalWorker(FakeAMProtocol(), '.', 'test.log')
|
||||
localWorker._outLog = BytesIO()
|
||||
data = b"The quick brown fox jumps over the lazy dog"
|
||||
localWorker.outReceived(data)
|
||||
self.assertEqual(data, localWorker._outLog.getvalue())
|
||||
|
||||
|
||||
def test_errReceived(self):
|
||||
"""
|
||||
L{LocalWorker.errReceived} logs the errors into its C{_errLog} log
|
||||
file.
|
||||
"""
|
||||
localWorker = self.tidyLocalWorker(FakeAMProtocol(), '.', 'test.log')
|
||||
localWorker._errLog = BytesIO()
|
||||
data = b"The quick brown fox jumps over the lazy dog"
|
||||
localWorker.errReceived(data)
|
||||
self.assertEqual(data, localWorker._errLog.getvalue())
|
||||
|
||||
|
||||
def test_write(self):
|
||||
"""
|
||||
L{LocalWorkerTransport.write} forwards the written data to the given
|
||||
transport.
|
||||
"""
|
||||
transport = FakeTransport()
|
||||
localTransport = LocalWorkerTransport(transport)
|
||||
data = b"The quick brown fox jumps over the lazy dog"
|
||||
localTransport.write(data)
|
||||
self.assertEqual(data, transport.dataString)
|
||||
|
||||
|
||||
def test_writeSequence(self):
|
||||
"""
|
||||
L{LocalWorkerTransport.writeSequence} forwards the written data to the
|
||||
given transport.
|
||||
"""
|
||||
transport = FakeTransport()
|
||||
localTransport = LocalWorkerTransport(transport)
|
||||
data = (b"The quick ", b"brown fox jumps ", b"over the lazy dog")
|
||||
localTransport.writeSequence(data)
|
||||
self.assertEqual(b"".join(data), transport.dataString)
|
||||
|
||||
|
||||
def test_loseConnection(self):
|
||||
"""
|
||||
L{LocalWorkerTransport.loseConnection} forwards the call to the given
|
||||
transport.
|
||||
"""
|
||||
transport = FakeTransport()
|
||||
localTransport = LocalWorkerTransport(transport)
|
||||
localTransport.loseConnection()
|
||||
|
||||
self.assertEqual(transport.calls, 1)
|
||||
|
||||
|
||||
def test_connectionLost(self):
|
||||
"""
|
||||
L{LocalWorker.connectionLost} closes the log streams.
|
||||
"""
|
||||
|
||||
localWorker = self.tidyLocalWorker(FakeAMProtocol(), '.', 'test.log')
|
||||
localWorker.connectionLost(None)
|
||||
self.assertTrue(localWorker._outLog.closed)
|
||||
self.assertTrue(localWorker._errLog.closed)
|
||||
self.assertTrue(localWorker._testLog.closed)
|
||||
|
||||
|
||||
def test_processEnded(self):
|
||||
"""
|
||||
L{LocalWorker.processEnded} calls C{connectionLost} on itself and on
|
||||
the L{AMP} protocol.
|
||||
"""
|
||||
|
||||
transport = FakeTransport()
|
||||
protocol = FakeAMProtocol()
|
||||
localWorker = LocalWorker(protocol, '.', 'test.log')
|
||||
localWorker.makeConnection(transport)
|
||||
localWorker.processEnded(Failure(CONNECTION_DONE))
|
||||
self.assertTrue(localWorker._outLog.closed)
|
||||
self.assertTrue(localWorker._errLog.closed)
|
||||
self.assertTrue(localWorker._testLog.closed)
|
||||
self.assertIdentical(None, protocol.transport)
|
||||
return self.assertFailure(localWorker.endDeferred, ConnectionDone)
|
||||
|
||||
|
||||
def test_addresses(self):
|
||||
"""
|
||||
L{LocalWorkerTransport.getPeer} and L{LocalWorkerTransport.getHost}
|
||||
return L{IAddress} objects.
|
||||
"""
|
||||
localTransport = LocalWorkerTransport(None)
|
||||
self.assertTrue(verifyObject(IAddress, localTransport.getPeer()))
|
||||
self.assertTrue(verifyObject(IAddress, localTransport.getHost()))
|
||||
|
||||
|
||||
def test_transport(self):
|
||||
"""
|
||||
L{LocalWorkerTransport} implements L{ITransport} to be able to be used
|
||||
by L{AMP}.
|
||||
"""
|
||||
localTransport = LocalWorkerTransport(None)
|
||||
self.assertTrue(verifyObject(ITransport, localTransport))
|
||||
|
||||
|
||||
def test_startError(self):
|
||||
"""
|
||||
L{LocalWorker} swallows the exceptions returned by the L{AMP} protocol
|
||||
start method, as it generates unnecessary errors.
|
||||
"""
|
||||
|
||||
def failCallRemote(command, directory):
|
||||
return fail(RuntimeError("oops"))
|
||||
|
||||
protocol = FakeAMProtocol()
|
||||
protocol.callRemote = failCallRemote
|
||||
self.tidyLocalWorker(protocol, '.', 'test.log')
|
||||
|
||||
self.assertEqual([], self.flushLoggedErrors(RuntimeError))
|
||||
@@ -0,0 +1,167 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
Tests for L{twisted.trial._dist.workerreporter}.
|
||||
"""
|
||||
|
||||
from twisted.python.compat import _PY3
|
||||
from twisted.python.failure import Failure
|
||||
from twisted.trial.unittest import TestCase, Todo
|
||||
from twisted.trial._dist.workerreporter import WorkerReporter
|
||||
from twisted.trial._dist import managercommands
|
||||
|
||||
|
||||
class FakeAMProtocol(object):
|
||||
"""
|
||||
A fake C{AMP} implementations to track C{callRemote} calls.
|
||||
"""
|
||||
id = 0
|
||||
lastCall = None
|
||||
|
||||
def callRemote(self, command, **kwargs):
|
||||
self.lastCall = command
|
||||
self.lastArgs = kwargs
|
||||
|
||||
|
||||
|
||||
class WorkerReporterTests(TestCase):
|
||||
"""
|
||||
Tests for L{WorkerReporter}.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.fakeAMProtocol = FakeAMProtocol()
|
||||
self.workerReporter = WorkerReporter(self.fakeAMProtocol)
|
||||
self.test = TestCase()
|
||||
|
||||
|
||||
def test_addSuccess(self):
|
||||
"""
|
||||
L{WorkerReporter.addSuccess} sends a L{managercommands.AddSuccess}
|
||||
command.
|
||||
"""
|
||||
self.workerReporter.addSuccess(self.test)
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddSuccess)
|
||||
|
||||
|
||||
def test_addError(self):
|
||||
"""
|
||||
L{WorkerReporter.addError} sends a L{managercommands.AddError} command.
|
||||
"""
|
||||
self.workerReporter.addError(self.test, Failure(RuntimeError('error')))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddError)
|
||||
|
||||
|
||||
def test_addErrorTuple(self):
|
||||
"""
|
||||
Adding an error using L{WorkerReporter.addError} as a
|
||||
C{sys.exc_info}-style tuple sends an L{managercommands.AddError}
|
||||
command.
|
||||
"""
|
||||
self.workerReporter.addError(
|
||||
self.test, (RuntimeError, RuntimeError('error'), None))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddError)
|
||||
|
||||
|
||||
def test_addFailure(self):
|
||||
"""
|
||||
L{WorkerReporter.addFailure} sends a L{managercommands.AddFailure}
|
||||
command.
|
||||
"""
|
||||
self.workerReporter.addFailure(self.test,
|
||||
Failure(RuntimeError('fail')))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddFailure)
|
||||
|
||||
|
||||
def test_addFailureTuple(self):
|
||||
"""
|
||||
Adding a failure using L{WorkerReporter.addFailure} as a
|
||||
C{sys.exc_info}-style tuple sends an L{managercommands.AddFailure}
|
||||
message.
|
||||
"""
|
||||
self.workerReporter.addFailure(
|
||||
self.test, (RuntimeError, RuntimeError('fail'), None))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddFailure)
|
||||
|
||||
|
||||
def test_addFailureNonASCII(self):
|
||||
"""
|
||||
L{WorkerReporter.addFailure} sends a L{managercommands.AddFailure}
|
||||
message when called with a L{Failure}, even if it includes encoded
|
||||
non-ASCII content.
|
||||
"""
|
||||
content = u"\N{SNOWMAN}".encode("utf-8")
|
||||
exception = RuntimeError(content)
|
||||
failure = Failure(exception)
|
||||
self.workerReporter.addFailure(self.test, failure)
|
||||
self.assertEqual(
|
||||
self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddFailure,
|
||||
)
|
||||
self.assertEqual(
|
||||
content,
|
||||
self.fakeAMProtocol.lastArgs["fail"],
|
||||
)
|
||||
if _PY3:
|
||||
test_addFailureNonASCII.skip = (
|
||||
"Exceptions only convert to unicode on Python 3"
|
||||
)
|
||||
|
||||
|
||||
def test_addSkip(self):
|
||||
"""
|
||||
L{WorkerReporter.addSkip} sends a L{managercommands.AddSkip} command.
|
||||
"""
|
||||
self.workerReporter.addSkip(self.test, 'reason')
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddSkip)
|
||||
|
||||
|
||||
def test_addExpectedFailure(self):
|
||||
"""
|
||||
L{WorkerReporter.addExpectedFailure} sends a
|
||||
L{managercommands.AddExpectedFailure} command.
|
||||
protocol.
|
||||
"""
|
||||
self.workerReporter.addExpectedFailure(
|
||||
self.test, Failure(RuntimeError('error')), Todo('todo'))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddExpectedFailure)
|
||||
|
||||
|
||||
def test_addExpectedFailureNoTodo(self):
|
||||
"""
|
||||
L{WorkerReporter.addExpectedFailure} sends a
|
||||
L{managercommands.AddExpectedFailure} command.
|
||||
protocol.
|
||||
"""
|
||||
self.workerReporter.addExpectedFailure(
|
||||
self.test, Failure(RuntimeError('error')))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddExpectedFailure)
|
||||
|
||||
|
||||
def test_addUnexpectedSuccess(self):
|
||||
"""
|
||||
L{WorkerReporter.addUnexpectedSuccess} sends a
|
||||
L{managercommands.AddUnexpectedSuccess} command.
|
||||
"""
|
||||
self.workerReporter.addUnexpectedSuccess(self.test, Todo('todo'))
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddUnexpectedSuccess)
|
||||
|
||||
|
||||
def test_addUnexpectedSuccessNoTodo(self):
|
||||
"""
|
||||
L{WorkerReporter.addUnexpectedSuccess} sends a
|
||||
L{managercommands.AddUnexpectedSuccess} command.
|
||||
"""
|
||||
self.workerReporter.addUnexpectedSuccess(self.test)
|
||||
self.assertEqual(self.fakeAMProtocol.lastCall,
|
||||
managercommands.AddUnexpectedSuccess)
|
||||
@@ -0,0 +1,184 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
Tests for L{twisted.trial._dist.workertrial}.
|
||||
"""
|
||||
|
||||
import errno
|
||||
import sys
|
||||
import os
|
||||
|
||||
from io import BytesIO
|
||||
|
||||
from twisted.protocols.amp import AMP
|
||||
from twisted.test.proto_helpers import StringTransport
|
||||
from twisted.trial.unittest import TestCase
|
||||
from twisted.trial._dist.workertrial import WorkerLogObserver, main, _setupPath
|
||||
from twisted.trial._dist import (
|
||||
workertrial, _WORKER_AMP_STDIN, _WORKER_AMP_STDOUT, workercommands,
|
||||
managercommands)
|
||||
|
||||
|
||||
|
||||
class FakeAMP(AMP):
|
||||
"""
|
||||
A fake amp protocol.
|
||||
"""
|
||||
|
||||
|
||||
|
||||
class WorkerLogObserverTests(TestCase):
|
||||
"""
|
||||
Tests for L{WorkerLogObserver}.
|
||||
"""
|
||||
|
||||
def test_emit(self):
|
||||
"""
|
||||
L{WorkerLogObserver} forwards data to L{managercommands.TestWrite}.
|
||||
"""
|
||||
calls = []
|
||||
|
||||
class FakeClient(object):
|
||||
|
||||
def callRemote(self, method, **kwargs):
|
||||
calls.append((method, kwargs))
|
||||
|
||||
observer = WorkerLogObserver(FakeClient())
|
||||
observer.emit({'message': ['Some log']})
|
||||
self.assertEqual(
|
||||
calls, [(managercommands.TestWrite, {'out': 'Some log'})])
|
||||
|
||||
|
||||
|
||||
class MainTests(TestCase):
|
||||
"""
|
||||
Tests for L{main}.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.readStream = BytesIO()
|
||||
self.writeStream = BytesIO()
|
||||
self.patch(workertrial, 'startLoggingWithObserver',
|
||||
self.startLoggingWithObserver)
|
||||
self.addCleanup(setattr, sys, "argv", sys.argv)
|
||||
sys.argv = ["trial"]
|
||||
|
||||
|
||||
def fdopen(self, fd, mode=None):
|
||||
"""
|
||||
Fake C{os.fdopen} implementation which returns C{self.readStream} for
|
||||
the stdin fd and C{self.writeStream} for the stdout fd.
|
||||
"""
|
||||
if fd == _WORKER_AMP_STDIN:
|
||||
self.assertIdentical('rb', mode)
|
||||
return self.readStream
|
||||
elif fd == _WORKER_AMP_STDOUT:
|
||||
self.assertEqual('wb', mode)
|
||||
return self.writeStream
|
||||
else:
|
||||
raise AssertionError("Unexpected fd %r" % (fd,))
|
||||
|
||||
|
||||
def startLoggingWithObserver(self, emit, setStdout):
|
||||
"""
|
||||
Override C{startLoggingWithObserver} for not starting logging.
|
||||
"""
|
||||
self.assertFalse(setStdout)
|
||||
|
||||
|
||||
def test_empty(self):
|
||||
"""
|
||||
If no data is ever written, L{main} exits without writing data out.
|
||||
"""
|
||||
main(self.fdopen)
|
||||
self.assertEqual(b'', self.writeStream.getvalue())
|
||||
|
||||
|
||||
def test_forwardCommand(self):
|
||||
"""
|
||||
L{main} forwards data from its input stream to a L{WorkerProtocol}
|
||||
instance which writes data to the output stream.
|
||||
"""
|
||||
client = FakeAMP()
|
||||
clientTransport = StringTransport()
|
||||
client.makeConnection(clientTransport)
|
||||
client.callRemote(workercommands.Run, testCase="doesntexist")
|
||||
self.readStream = clientTransport.io
|
||||
self.readStream.seek(0, 0)
|
||||
main(self.fdopen)
|
||||
self.assertIn(
|
||||
b"No module named 'doesntexist'", self.writeStream.getvalue())
|
||||
|
||||
|
||||
def test_readInterrupted(self):
|
||||
"""
|
||||
If reading the input stream fails with a C{IOError} with errno
|
||||
C{EINTR}, L{main} ignores it and continues reading.
|
||||
"""
|
||||
excInfos = []
|
||||
|
||||
class FakeStream(object):
|
||||
count = 0
|
||||
|
||||
def read(oself, size):
|
||||
oself.count += 1
|
||||
if oself.count == 1:
|
||||
raise IOError(errno.EINTR)
|
||||
else:
|
||||
excInfos.append(sys.exc_info())
|
||||
return b''
|
||||
|
||||
self.readStream = FakeStream()
|
||||
main(self.fdopen)
|
||||
self.assertEqual(b'', self.writeStream.getvalue())
|
||||
self.assertEqual([(None, None, None)], excInfos)
|
||||
|
||||
|
||||
def test_otherReadError(self):
|
||||
"""
|
||||
L{main} only ignores C{IOError} with C{EINTR} errno: otherwise, the
|
||||
error pops out.
|
||||
"""
|
||||
|
||||
class FakeStream(object):
|
||||
count = 0
|
||||
|
||||
def read(oself, size):
|
||||
oself.count += 1
|
||||
if oself.count == 1:
|
||||
raise IOError("Something else")
|
||||
return ''
|
||||
|
||||
self.readStream = FakeStream()
|
||||
self.assertRaises(IOError, main, self.fdopen)
|
||||
|
||||
|
||||
|
||||
class SetupPathTests(TestCase):
|
||||
"""
|
||||
Tests for L{_setupPath} C{sys.path} manipulation.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.addCleanup(setattr, sys, "path", sys.path[:])
|
||||
|
||||
|
||||
def test_overridePath(self):
|
||||
"""
|
||||
L{_setupPath} overrides C{sys.path} if B{TRIAL_PYTHONPATH} is specified
|
||||
in the environment.
|
||||
"""
|
||||
environ = {"TRIAL_PYTHONPATH": os.pathsep.join(["foo", "bar"])}
|
||||
_setupPath(environ)
|
||||
self.assertEqual(["foo", "bar"], sys.path)
|
||||
|
||||
|
||||
def test_noVariable(self):
|
||||
"""
|
||||
L{_setupPath} doesn't change C{sys.path} if B{TRIAL_PYTHONPATH} is not
|
||||
present in the environment.
|
||||
"""
|
||||
originalPath = sys.path[:]
|
||||
_setupPath({})
|
||||
self.assertEqual(originalPath, sys.path)
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,21 @@
|
||||
# Copyright (c) 2006 Twisted Matrix Laboratories. See LICENSE for details
|
||||
|
||||
"""
|
||||
Mock test module that contains a C{testSuite} method. L{runner.TestLoader}
|
||||
should load the tests from the C{testSuite}, not from the C{Foo} C{TestCase}.
|
||||
|
||||
See L{twisted.trial.test.test_loader.LoaderTest.test_loadModuleWith_testSuite}.
|
||||
"""
|
||||
|
||||
|
||||
from twisted.trial import unittest, runner
|
||||
|
||||
class Foo(unittest.SynchronousTestCase):
|
||||
def test_foo(self):
|
||||
pass
|
||||
|
||||
|
||||
def testSuite():
|
||||
ts = runner.TestSuite()
|
||||
ts.name = "MyCustomSuite"
|
||||
return ts
|
||||
@@ -0,0 +1,196 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
#
|
||||
|
||||
"""
|
||||
Classes and functions used by L{twisted.trial.test.test_util}
|
||||
and L{twisted.trial.test.test_loader}.
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
from twisted.python.compat import _PY3
|
||||
from twisted.trial import unittest
|
||||
|
||||
if _PY3:
|
||||
# Python 3 has some funny import caching, which we don't want.
|
||||
# invalidate_caches clears it out for us.
|
||||
from importlib import invalidate_caches as invalidateImportCaches
|
||||
else:
|
||||
def invalidateImportCaches():
|
||||
"""
|
||||
On python 2, import caches don't need to be invalidated.
|
||||
"""
|
||||
|
||||
testModule = """
|
||||
from twisted.trial import unittest
|
||||
|
||||
class FooTest(unittest.SynchronousTestCase):
|
||||
def testFoo(self):
|
||||
pass
|
||||
"""
|
||||
|
||||
dosModule = testModule.replace('\n', '\r\n')
|
||||
|
||||
|
||||
testSample = """
|
||||
'''This module is used by test_loader to test the Trial test loading
|
||||
functionality. Do NOT change the number of tests in this module.
|
||||
Do NOT change the names the tests in this module.
|
||||
'''
|
||||
|
||||
import unittest as pyunit
|
||||
from twisted.trial import unittest
|
||||
|
||||
class FooTest(unittest.SynchronousTestCase):
|
||||
def test_foo(self):
|
||||
pass
|
||||
|
||||
def test_bar(self):
|
||||
pass
|
||||
|
||||
|
||||
class PyunitTest(pyunit.TestCase):
|
||||
def test_foo(self):
|
||||
pass
|
||||
|
||||
def test_bar(self):
|
||||
pass
|
||||
|
||||
|
||||
class NotATest(object):
|
||||
def test_foo(self):
|
||||
pass
|
||||
|
||||
|
||||
class AlphabetTest(unittest.SynchronousTestCase):
|
||||
def test_a(self):
|
||||
pass
|
||||
|
||||
def test_b(self):
|
||||
pass
|
||||
|
||||
def test_c(self):
|
||||
pass
|
||||
"""
|
||||
|
||||
testInheritanceSample = """
|
||||
'''This module is used by test_loader to test the Trial test loading
|
||||
functionality. Do NOT change the number of tests in this module.
|
||||
Do NOT change the names the tests in this module.
|
||||
'''
|
||||
|
||||
from twisted.trial import unittest
|
||||
|
||||
class X(object):
|
||||
|
||||
def test_foo(self):
|
||||
pass
|
||||
|
||||
class A(unittest.SynchronousTestCase, X):
|
||||
pass
|
||||
|
||||
class B(unittest.SynchronousTestCase, X):
|
||||
pass
|
||||
|
||||
"""
|
||||
|
||||
class PackageTest(unittest.SynchronousTestCase):
|
||||
files = [
|
||||
('badpackage/__init__.py', 'frotz\n'),
|
||||
('badpackage/test_module.py', ''),
|
||||
('unimportablepackage/__init__.py', ''),
|
||||
('unimportablepackage/test_module.py', 'import notarealmoduleok\n'),
|
||||
('package2/__init__.py', ''),
|
||||
('package2/test_module.py', 'import frotz\n'),
|
||||
('package/__init__.py', ''),
|
||||
('package/frotz.py', 'frotz\n'),
|
||||
('package/test_bad_module.py',
|
||||
'raise ZeroDivisionError("fake error")'),
|
||||
('package/test_dos_module.py', dosModule),
|
||||
('package/test_import_module.py', 'import frotz'),
|
||||
('package/test_module.py', testModule),
|
||||
('goodpackage/__init__.py', ''),
|
||||
('goodpackage/test_sample.py', testSample),
|
||||
('goodpackage/sub/__init__.py', ''),
|
||||
('goodpackage/sub/test_sample.py', testSample),
|
||||
('inheritancepackage/__init__.py', ''),
|
||||
('inheritancepackage/test_x.py', testInheritanceSample),
|
||||
]
|
||||
|
||||
|
||||
def _toModuleName(self, filename):
|
||||
name = os.path.splitext(filename)[0]
|
||||
segs = name.split('/')
|
||||
if segs[-1] == '__init__':
|
||||
segs = segs[:-1]
|
||||
return '.'.join(segs)
|
||||
|
||||
|
||||
def getModules(self):
|
||||
"""
|
||||
Return matching module names for files listed in C{self.files}.
|
||||
"""
|
||||
return [self._toModuleName(filename) for (filename, code) in self.files]
|
||||
|
||||
|
||||
def cleanUpModules(self):
|
||||
modules = self.getModules()
|
||||
modules.sort()
|
||||
modules.reverse()
|
||||
for module in modules:
|
||||
try:
|
||||
del sys.modules[module]
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
|
||||
def createFiles(self, files, parentDir='.'):
|
||||
for filename, contents in self.files:
|
||||
filename = os.path.join(parentDir, filename)
|
||||
self._createDirectory(filename)
|
||||
with open(filename, 'w') as fd:
|
||||
fd.write(contents)
|
||||
|
||||
|
||||
def _createDirectory(self, filename):
|
||||
directory = os.path.dirname(filename)
|
||||
if not os.path.exists(directory):
|
||||
os.makedirs(directory)
|
||||
|
||||
|
||||
def setUp(self, parentDir=None):
|
||||
invalidateImportCaches()
|
||||
if parentDir is None:
|
||||
parentDir = self.mktemp()
|
||||
self.parent = parentDir
|
||||
self.createFiles(self.files, parentDir)
|
||||
|
||||
|
||||
def tearDown(self):
|
||||
self.cleanUpModules()
|
||||
|
||||
|
||||
|
||||
class SysPathManglingTest(PackageTest):
|
||||
def setUp(self, parent=None):
|
||||
invalidateImportCaches()
|
||||
self.oldPath = sys.path[:]
|
||||
self.newPath = sys.path[:]
|
||||
if parent is None:
|
||||
parent = self.mktemp()
|
||||
PackageTest.setUp(self, parent)
|
||||
self.newPath.append(self.parent)
|
||||
self.mangleSysPath(self.newPath)
|
||||
|
||||
|
||||
def tearDown(self):
|
||||
PackageTest.tearDown(self)
|
||||
self.mangleSysPath(self.oldPath)
|
||||
|
||||
|
||||
def mangleSysPath(self, pathVar):
|
||||
sys.path[:] = pathVar
|
||||
@@ -0,0 +1,270 @@
|
||||
# -*- test-case-name: twisted.trial.test.test_tests -*-
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
Definitions of test cases with various interesting behaviors, to be used by
|
||||
L{twisted.trial.test.test_tests} and other test modules to exercise different
|
||||
features of trial's test runner.
|
||||
|
||||
See the L{twisted.trial.test.test_tests} module docstring for details about how
|
||||
this code is arranged.
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import
|
||||
|
||||
from twisted.trial.unittest import (
|
||||
SynchronousTestCase, TestCase, SkipTest, FailTest)
|
||||
|
||||
|
||||
class SkippingMixin(object):
|
||||
def test_skip1(self):
|
||||
raise SkipTest('skip1')
|
||||
|
||||
def test_skip2(self):
|
||||
raise RuntimeError("I should not get raised")
|
||||
test_skip2.skip = 'skip2'
|
||||
|
||||
def test_skip3(self):
|
||||
self.fail('I should not fail')
|
||||
test_skip3.skip = 'skip3'
|
||||
|
||||
|
||||
|
||||
class SynchronousSkipping(SkippingMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousSkipping(SkippingMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class SkippingSetUpMixin(object):
|
||||
def setUp(self):
|
||||
raise SkipTest('skipSetUp')
|
||||
|
||||
def test_1(self):
|
||||
pass
|
||||
|
||||
def test_2(self):
|
||||
pass
|
||||
|
||||
|
||||
class SynchronousSkippingSetUp(SkippingSetUpMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousSkippingSetUp(SkippingSetUpMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class DeprecatedReasonlessSkipMixin(object):
|
||||
def test_1(self):
|
||||
raise SkipTest()
|
||||
|
||||
|
||||
|
||||
class SynchronousDeprecatedReasonlessSkip(
|
||||
DeprecatedReasonlessSkipMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousDeprecatedReasonlessSkip(
|
||||
DeprecatedReasonlessSkipMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class SkippedClassMixin(object):
|
||||
skip = 'class'
|
||||
def setUp(self):
|
||||
self.__class__._setUpRan = True
|
||||
def test_skip1(self):
|
||||
raise SkipTest('skip1')
|
||||
def test_skip2(self):
|
||||
raise RuntimeError("Ought to skip me")
|
||||
test_skip2.skip = 'skip2'
|
||||
def test_skip3(self):
|
||||
pass
|
||||
def test_skip4(self):
|
||||
raise RuntimeError("Skip me too")
|
||||
|
||||
|
||||
|
||||
class SynchronousSkippedClass(SkippedClassMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousSkippedClass(SkippedClassMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class TodoMixin(object):
|
||||
def test_todo1(self):
|
||||
self.fail("deliberate failure")
|
||||
test_todo1.todo = "todo1"
|
||||
|
||||
def test_todo2(self):
|
||||
raise RuntimeError("deliberate error")
|
||||
test_todo2.todo = "todo2"
|
||||
|
||||
def test_todo3(self):
|
||||
"""unexpected success"""
|
||||
test_todo3.todo = 'todo3'
|
||||
|
||||
|
||||
|
||||
|
||||
class SynchronousTodo(TodoMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousTodo(TodoMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class SetUpTodoMixin(object):
|
||||
def setUp(self):
|
||||
raise RuntimeError("deliberate error")
|
||||
|
||||
def test_todo1(self):
|
||||
pass
|
||||
test_todo1.todo = "setUp todo1"
|
||||
|
||||
|
||||
|
||||
class SynchronousSetUpTodo(SetUpTodoMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousSetUpTodo(SetUpTodoMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class TearDownTodoMixin(object):
|
||||
def tearDown(self):
|
||||
raise RuntimeError("deliberate error")
|
||||
|
||||
def test_todo1(self):
|
||||
pass
|
||||
test_todo1.todo = "tearDown todo1"
|
||||
|
||||
|
||||
|
||||
class SynchronousTearDownTodo(TearDownTodoMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousTearDownTodo(TearDownTodoMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class TodoClassMixin(object):
|
||||
todo = "class"
|
||||
def test_todo1(self):
|
||||
pass
|
||||
test_todo1.todo = "method"
|
||||
def test_todo2(self):
|
||||
pass
|
||||
def test_todo3(self):
|
||||
self.fail("Deliberate Failure")
|
||||
test_todo3.todo = "method"
|
||||
def test_todo4(self):
|
||||
self.fail("Deliberate Failure")
|
||||
|
||||
|
||||
|
||||
class SynchronousTodoClass(TodoClassMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousTodoClass(TodoClassMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class StrictTodoMixin(object):
|
||||
def test_todo1(self):
|
||||
raise RuntimeError("expected failure")
|
||||
test_todo1.todo = (RuntimeError, "todo1")
|
||||
|
||||
def test_todo2(self):
|
||||
raise RuntimeError("expected failure")
|
||||
test_todo2.todo = ((RuntimeError, OSError), "todo2")
|
||||
|
||||
def test_todo3(self):
|
||||
raise RuntimeError("we had no idea!")
|
||||
test_todo3.todo = (OSError, "todo3")
|
||||
|
||||
def test_todo4(self):
|
||||
raise RuntimeError("we had no idea!")
|
||||
test_todo4.todo = ((OSError, SyntaxError), "todo4")
|
||||
|
||||
def test_todo5(self):
|
||||
self.fail("deliberate failure")
|
||||
test_todo5.todo = (FailTest, "todo5")
|
||||
|
||||
def test_todo6(self):
|
||||
self.fail("deliberate failure")
|
||||
test_todo6.todo = (RuntimeError, "todo6")
|
||||
|
||||
def test_todo7(self):
|
||||
pass
|
||||
test_todo7.todo = (RuntimeError, "todo7")
|
||||
|
||||
|
||||
|
||||
class SynchronousStrictTodo(StrictTodoMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousStrictTodo(StrictTodoMixin, TestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AddCleanupMixin(object):
|
||||
def setUp(self):
|
||||
self.log = ['setUp']
|
||||
|
||||
def brokenSetUp(self):
|
||||
self.log = ['setUp']
|
||||
raise RuntimeError("Deliberate failure")
|
||||
|
||||
def skippingSetUp(self):
|
||||
self.log = ['setUp']
|
||||
raise SkipTest("Don't do this")
|
||||
|
||||
def append(self, thing):
|
||||
self.log.append(thing)
|
||||
|
||||
def tearDown(self):
|
||||
self.log.append('tearDown')
|
||||
|
||||
def runTest(self):
|
||||
self.log.append('runTest')
|
||||
|
||||
|
||||
|
||||
class SynchronousAddCleanup(AddCleanupMixin, SynchronousTestCase):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
class AsynchronousAddCleanup(AddCleanupMixin, TestCase):
|
||||
pass
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,46 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
#
|
||||
# Maintainer: Jonathan Lange
|
||||
|
||||
"""
|
||||
Tests for L{twisted.plugins.twisted_trial}.
|
||||
"""
|
||||
|
||||
from twisted.plugin import getPlugins
|
||||
from twisted.trial import unittest
|
||||
from twisted.trial.itrial import IReporter
|
||||
|
||||
|
||||
class PluginsTests(unittest.SynchronousTestCase):
|
||||
"""
|
||||
Tests for Trial's reporter plugins.
|
||||
"""
|
||||
|
||||
def getPluginsByLongOption(self, longOption):
|
||||
"""
|
||||
Return the Trial reporter plugin with the given long option.
|
||||
|
||||
If more than one is found, raise ValueError. If none are found, raise
|
||||
IndexError.
|
||||
"""
|
||||
plugins = [
|
||||
plugin for plugin in getPlugins(IReporter)
|
||||
if plugin.longOpt == longOption]
|
||||
if len(plugins) > 1:
|
||||
raise ValueError(
|
||||
"More than one plugin found with long option %r: %r"
|
||||
% (longOption, plugins))
|
||||
return plugins[0]
|
||||
|
||||
|
||||
def test_subunitPlugin(self):
|
||||
"""
|
||||
One of the reporter plugins is the subunit reporter plugin.
|
||||
"""
|
||||
subunitPlugin = self.getPluginsByLongOption('subunit')
|
||||
self.assertEqual('Subunit Reporter', subunitPlugin.name)
|
||||
self.assertEqual('twisted.trial.reporter', subunitPlugin.module)
|
||||
self.assertEqual('subunit', subunitPlugin.longOpt)
|
||||
self.assertIdentical(None, subunitPlugin.shortOpt)
|
||||
self.assertEqual('SubunitReporter', subunitPlugin.klass)
|
||||
@@ -0,0 +1,254 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
from __future__ import division, absolute_import
|
||||
|
||||
import sys
|
||||
import traceback
|
||||
|
||||
from zope.interface import implementer
|
||||
|
||||
from twisted.python.failure import Failure
|
||||
from twisted.trial.unittest import SynchronousTestCase, PyUnitResultAdapter
|
||||
from twisted.trial.itrial import IReporter, ITestCase
|
||||
|
||||
import unittest as pyunit
|
||||
|
||||
|
||||
class PyUnitTestTests(SynchronousTestCase):
|
||||
|
||||
class PyUnitTest(pyunit.TestCase):
|
||||
|
||||
def test_pass(self):
|
||||
pass
|
||||
|
||||
|
||||
def setUp(self):
|
||||
self.original = self.PyUnitTest('test_pass')
|
||||
self.test = ITestCase(self.original)
|
||||
|
||||
|
||||
def test_callable(self):
|
||||
"""
|
||||
Tests must be callable in order to be used with Python's unittest.py.
|
||||
"""
|
||||
self.assertTrue(callable(self.test),
|
||||
"%r is not callable." % (self.test,))
|
||||
|
||||
|
||||
|
||||
class PyUnitResultTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests to show that PyUnitResultAdapter wraps TestResult objects from the
|
||||
standard library 'unittest' module in such a way as to make them usable and
|
||||
useful from Trial.
|
||||
"""
|
||||
|
||||
# Once erroneous is ported to Python 3 this can be replaced with
|
||||
# erroneous.ErrorTest:
|
||||
class ErrorTest(SynchronousTestCase):
|
||||
"""
|
||||
A test case which has a L{test_foo} which will raise an error.
|
||||
|
||||
@ivar ran: boolean indicating whether L{test_foo} has been run.
|
||||
"""
|
||||
ran = False
|
||||
|
||||
def test_foo(self):
|
||||
"""
|
||||
Set C{self.ran} to True and raise a C{ZeroDivisionError}
|
||||
"""
|
||||
self.ran = True
|
||||
1/0
|
||||
|
||||
|
||||
def test_dontUseAdapterWhenReporterProvidesIReporter(self):
|
||||
"""
|
||||
The L{PyUnitResultAdapter} is only used when the result passed to
|
||||
C{run} does *not* provide L{IReporter}.
|
||||
"""
|
||||
@implementer(IReporter)
|
||||
class StubReporter(object):
|
||||
"""
|
||||
A reporter which records data about calls made to it.
|
||||
|
||||
@ivar errors: Errors passed to L{addError}.
|
||||
@ivar failures: Failures passed to L{addFailure}.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.errors = []
|
||||
self.failures = []
|
||||
|
||||
def startTest(self, test):
|
||||
"""
|
||||
Do nothing.
|
||||
"""
|
||||
|
||||
def stopTest(self, test):
|
||||
"""
|
||||
Do nothing.
|
||||
"""
|
||||
|
||||
def addError(self, test, error):
|
||||
"""
|
||||
Record the error.
|
||||
"""
|
||||
self.errors.append(error)
|
||||
|
||||
test = self.ErrorTest("test_foo")
|
||||
result = StubReporter()
|
||||
test.run(result)
|
||||
self.assertIsInstance(result.errors[0], Failure)
|
||||
|
||||
|
||||
def test_success(self):
|
||||
class SuccessTest(SynchronousTestCase):
|
||||
ran = False
|
||||
def test_foo(s):
|
||||
s.ran = True
|
||||
test = SuccessTest('test_foo')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
|
||||
self.assertTrue(test.ran)
|
||||
self.assertEqual(1, result.testsRun)
|
||||
self.assertTrue(result.wasSuccessful())
|
||||
|
||||
def test_failure(self):
|
||||
class FailureTest(SynchronousTestCase):
|
||||
ran = False
|
||||
def test_foo(s):
|
||||
s.ran = True
|
||||
s.fail('boom!')
|
||||
test = FailureTest('test_foo')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
|
||||
self.assertTrue(test.ran)
|
||||
self.assertEqual(1, result.testsRun)
|
||||
self.assertEqual(1, len(result.failures))
|
||||
self.assertFalse(result.wasSuccessful())
|
||||
|
||||
def test_error(self):
|
||||
test = self.ErrorTest('test_foo')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
|
||||
self.assertTrue(test.ran)
|
||||
self.assertEqual(1, result.testsRun)
|
||||
self.assertEqual(1, len(result.errors))
|
||||
self.assertFalse(result.wasSuccessful())
|
||||
|
||||
def test_setUpError(self):
|
||||
class ErrorTest(SynchronousTestCase):
|
||||
ran = False
|
||||
def setUp(self):
|
||||
1/0
|
||||
def test_foo(s):
|
||||
s.ran = True
|
||||
test = ErrorTest('test_foo')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
|
||||
self.assertFalse(test.ran)
|
||||
self.assertEqual(1, result.testsRun)
|
||||
self.assertEqual(1, len(result.errors))
|
||||
self.assertFalse(result.wasSuccessful())
|
||||
|
||||
def test_tracebackFromFailure(self):
|
||||
"""
|
||||
Errors added through the L{PyUnitResultAdapter} have the same traceback
|
||||
information as if there were no adapter at all.
|
||||
"""
|
||||
try:
|
||||
1/0
|
||||
except ZeroDivisionError:
|
||||
exc_info = sys.exc_info()
|
||||
f = Failure()
|
||||
pyresult = pyunit.TestResult()
|
||||
result = PyUnitResultAdapter(pyresult)
|
||||
result.addError(self, f)
|
||||
self.assertEqual(pyresult.errors[0][1],
|
||||
''.join(traceback.format_exception(*exc_info)))
|
||||
|
||||
|
||||
def test_traceback(self):
|
||||
"""
|
||||
As test_tracebackFromFailure, but covering more code.
|
||||
"""
|
||||
class ErrorTest(SynchronousTestCase):
|
||||
exc_info = None
|
||||
def test_foo(self):
|
||||
try:
|
||||
1/0
|
||||
except ZeroDivisionError:
|
||||
self.exc_info = sys.exc_info()
|
||||
raise
|
||||
test = ErrorTest('test_foo')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
|
||||
# We can't test that the tracebacks are equal, because Trial's
|
||||
# machinery inserts a few extra frames on the top and we don't really
|
||||
# want to trim them off without an extremely good reason.
|
||||
#
|
||||
# So, we just test that the result's stack ends with the
|
||||
# exception's stack.
|
||||
|
||||
expected_stack = ''.join(traceback.format_tb(test.exc_info[2]))
|
||||
observed_stack = '\n'.join(result.errors[0][1].splitlines()[:-1])
|
||||
|
||||
self.assertEqual(expected_stack.strip(),
|
||||
observed_stack[-len(expected_stack):].strip())
|
||||
|
||||
|
||||
def test_tracebackFromCleanFailure(self):
|
||||
"""
|
||||
Errors added through the L{PyUnitResultAdapter} have the same
|
||||
traceback information as if there were no adapter at all, even
|
||||
if the Failure that held the information has been cleaned.
|
||||
"""
|
||||
try:
|
||||
1/0
|
||||
except ZeroDivisionError:
|
||||
exc_info = sys.exc_info()
|
||||
f = Failure()
|
||||
f.cleanFailure()
|
||||
pyresult = pyunit.TestResult()
|
||||
result = PyUnitResultAdapter(pyresult)
|
||||
result.addError(self, f)
|
||||
self.assertEqual(pyresult.errors[0][1],
|
||||
''.join(traceback.format_exception(*exc_info)))
|
||||
|
||||
|
||||
def test_trialSkip(self):
|
||||
"""
|
||||
Skips using trial's skipping functionality are reported as skips in
|
||||
the L{pyunit.TestResult}.
|
||||
"""
|
||||
class SkipTest(SynchronousTestCase):
|
||||
def test_skip(self):
|
||||
1/0
|
||||
test_skip.skip = "Let's skip!"
|
||||
|
||||
test = SkipTest('test_skip')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
self.assertEqual(result.skipped, [(test, "Let's skip!")])
|
||||
|
||||
|
||||
def test_pyunitSkip(self):
|
||||
"""
|
||||
Skips using pyunit's skipping functionality are reported as skips in
|
||||
the L{pyunit.TestResult}.
|
||||
"""
|
||||
class SkipTest(SynchronousTestCase):
|
||||
@pyunit.skip("skippy")
|
||||
def test_skip(self):
|
||||
1/0
|
||||
|
||||
test = SkipTest('test_skip')
|
||||
result = pyunit.TestResult()
|
||||
test.run(result)
|
||||
self.assertEqual(result.skipped, [(test, "skippy")])
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,868 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
from __future__ import absolute_import, division
|
||||
|
||||
import gc
|
||||
import re
|
||||
import sys
|
||||
import textwrap
|
||||
import types
|
||||
|
||||
from twisted.python import util
|
||||
from twisted.python.compat import NativeStringIO
|
||||
from twisted.python.filepath import FilePath
|
||||
from twisted.python.usage import UsageError
|
||||
from twisted.scripts import trial
|
||||
from twisted.trial import unittest
|
||||
from twisted.trial._dist.disttrial import DistTrialRunner
|
||||
from twisted.trial.runner import TestLoader
|
||||
from twisted.trial.runner import TrialRunner, TestSuite, DestructiveTestSuite
|
||||
from twisted.trial.test.test_loader import testNames
|
||||
|
||||
pyunit = __import__('unittest')
|
||||
|
||||
|
||||
def sibpath(filename):
|
||||
"""
|
||||
For finding files in twisted/trial/test
|
||||
"""
|
||||
return util.sibpath(__file__, filename)
|
||||
|
||||
|
||||
|
||||
class ForceGarbageCollectionTests(unittest.SynchronousTestCase):
|
||||
"""
|
||||
Tests for the --force-gc option.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.config = trial.Options()
|
||||
self.log = []
|
||||
self.patch(gc, 'collect', self.collect)
|
||||
test = pyunit.FunctionTestCase(self.simpleTest)
|
||||
self.test = TestSuite([test, test])
|
||||
|
||||
|
||||
def simpleTest(self):
|
||||
"""
|
||||
A simple test method that records that it was run.
|
||||
"""
|
||||
self.log.append('test')
|
||||
|
||||
|
||||
def collect(self):
|
||||
"""
|
||||
A replacement for gc.collect that logs calls to itself.
|
||||
"""
|
||||
self.log.append('collect')
|
||||
|
||||
|
||||
def makeRunner(self):
|
||||
"""
|
||||
Return a L{TrialRunner} object that is safe to use in tests.
|
||||
"""
|
||||
runner = trial._makeRunner(self.config)
|
||||
runner.stream = NativeStringIO()
|
||||
return runner
|
||||
|
||||
|
||||
def test_forceGc(self):
|
||||
"""
|
||||
Passing the --force-gc option to the trial script forces the garbage
|
||||
collector to run before and after each test.
|
||||
"""
|
||||
self.config['force-gc'] = True
|
||||
self.config.postOptions()
|
||||
runner = self.makeRunner()
|
||||
runner.run(self.test)
|
||||
self.assertEqual(self.log, ['collect', 'test', 'collect',
|
||||
'collect', 'test', 'collect'])
|
||||
|
||||
|
||||
def test_unforceGc(self):
|
||||
"""
|
||||
By default, no garbage collection is forced.
|
||||
"""
|
||||
self.config.postOptions()
|
||||
runner = self.makeRunner()
|
||||
runner.run(self.test)
|
||||
self.assertEqual(self.log, ['test', 'test'])
|
||||
|
||||
|
||||
|
||||
class SuiteUsedTests(unittest.SynchronousTestCase):
|
||||
"""
|
||||
Check the category of tests suite used by the loader.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
"""
|
||||
Create a trial configuration object.
|
||||
"""
|
||||
self.config = trial.Options()
|
||||
|
||||
|
||||
def test_defaultSuite(self):
|
||||
"""
|
||||
By default, the loader should use L{DestructiveTestSuite}
|
||||
"""
|
||||
loader = trial._getLoader(self.config)
|
||||
self.assertEqual(loader.suiteFactory, DestructiveTestSuite)
|
||||
|
||||
|
||||
def test_untilFailureSuite(self):
|
||||
"""
|
||||
The C{until-failure} configuration uses the L{TestSuite} to keep
|
||||
instances alive across runs.
|
||||
"""
|
||||
self.config['until-failure'] = True
|
||||
loader = trial._getLoader(self.config)
|
||||
self.assertEqual(loader.suiteFactory, TestSuite)
|
||||
|
||||
|
||||
|
||||
class TestModuleTests(unittest.SynchronousTestCase):
|
||||
def setUp(self):
|
||||
self.config = trial.Options()
|
||||
|
||||
def tearDown(self):
|
||||
self.config = None
|
||||
|
||||
def test_testNames(self):
|
||||
"""
|
||||
Check that the testNames helper method accurately collects the
|
||||
names of tests in suite.
|
||||
"""
|
||||
self.assertEqual(testNames(self), [self.id()])
|
||||
|
||||
def assertSuitesEqual(self, test1, names):
|
||||
loader = TestLoader()
|
||||
names1 = testNames(test1)
|
||||
names2 = testNames(TestSuite(map(loader.loadByName, names)))
|
||||
names1.sort()
|
||||
names2.sort()
|
||||
self.assertEqual(names1, names2)
|
||||
|
||||
def test_baseState(self):
|
||||
self.assertEqual(0, len(self.config['tests']))
|
||||
|
||||
def test_testmoduleOnModule(self):
|
||||
"""
|
||||
Check that --testmodule loads a suite which contains the tests
|
||||
referred to in test-case-name inside its parameter.
|
||||
"""
|
||||
self.config.opt_testmodule(sibpath('moduletest.py'))
|
||||
self.assertSuitesEqual(trial._getSuite(self.config),
|
||||
['twisted.trial.test.test_log'])
|
||||
|
||||
def test_testmoduleTwice(self):
|
||||
"""
|
||||
When the same module is specified with two --testmodule flags, it
|
||||
should only appear once in the suite.
|
||||
"""
|
||||
self.config.opt_testmodule(sibpath('moduletest.py'))
|
||||
self.config.opt_testmodule(sibpath('moduletest.py'))
|
||||
self.assertSuitesEqual(trial._getSuite(self.config),
|
||||
['twisted.trial.test.test_log'])
|
||||
|
||||
def test_testmoduleOnSourceAndTarget(self):
|
||||
"""
|
||||
If --testmodule is specified twice, once for module A and once for
|
||||
a module which refers to module A, then make sure module A is only
|
||||
added once.
|
||||
"""
|
||||
self.config.opt_testmodule(sibpath('moduletest.py'))
|
||||
self.config.opt_testmodule(sibpath('test_log.py'))
|
||||
self.assertSuitesEqual(trial._getSuite(self.config),
|
||||
['twisted.trial.test.test_log'])
|
||||
|
||||
def test_testmoduleOnSelfModule(self):
|
||||
"""
|
||||
When given a module that refers to *itself* in the test-case-name
|
||||
variable, check that --testmodule only adds the tests once.
|
||||
"""
|
||||
self.config.opt_testmodule(sibpath('moduleself.py'))
|
||||
self.assertSuitesEqual(trial._getSuite(self.config),
|
||||
['twisted.trial.test.moduleself'])
|
||||
|
||||
def test_testmoduleOnScript(self):
|
||||
"""
|
||||
Check that --testmodule loads tests referred to in test-case-name
|
||||
buffer variables.
|
||||
"""
|
||||
self.config.opt_testmodule(sibpath('scripttest.py'))
|
||||
self.assertSuitesEqual(trial._getSuite(self.config),
|
||||
['twisted.trial.test.test_log',
|
||||
'twisted.trial.test.test_runner'])
|
||||
|
||||
def test_testmoduleOnNonexistentFile(self):
|
||||
"""
|
||||
Check that --testmodule displays a meaningful error message when
|
||||
passed a non-existent filename.
|
||||
"""
|
||||
buffy = NativeStringIO()
|
||||
stderr, sys.stderr = sys.stderr, buffy
|
||||
filename = 'test_thisbetternoteverexist.py'
|
||||
try:
|
||||
self.config.opt_testmodule(filename)
|
||||
self.assertEqual(0, len(self.config['tests']))
|
||||
self.assertEqual("File %r doesn't exist\n" % (filename,),
|
||||
buffy.getvalue())
|
||||
finally:
|
||||
sys.stderr = stderr
|
||||
|
||||
def test_testmoduleOnEmptyVars(self):
|
||||
"""
|
||||
Check that --testmodule adds no tests to the suite for modules
|
||||
which lack test-case-name buffer variables.
|
||||
"""
|
||||
self.config.opt_testmodule(sibpath('novars.py'))
|
||||
self.assertEqual(0, len(self.config['tests']))
|
||||
|
||||
def test_testmoduleOnModuleName(self):
|
||||
"""
|
||||
Check that --testmodule does *not* support module names as arguments
|
||||
and that it displays a meaningful error message.
|
||||
"""
|
||||
buffy = NativeStringIO()
|
||||
stderr, sys.stderr = sys.stderr, buffy
|
||||
moduleName = 'twisted.trial.test.test_script'
|
||||
try:
|
||||
self.config.opt_testmodule(moduleName)
|
||||
self.assertEqual(0, len(self.config['tests']))
|
||||
self.assertEqual("File %r doesn't exist\n" % (moduleName,),
|
||||
buffy.getvalue())
|
||||
finally:
|
||||
sys.stderr = stderr
|
||||
|
||||
def test_parseLocalVariable(self):
|
||||
declaration = '-*- test-case-name: twisted.trial.test.test_tests -*-'
|
||||
localVars = trial._parseLocalVariables(declaration)
|
||||
self.assertEqual({'test-case-name':
|
||||
'twisted.trial.test.test_tests'},
|
||||
localVars)
|
||||
|
||||
def test_trailingSemicolon(self):
|
||||
declaration = '-*- test-case-name: twisted.trial.test.test_tests; -*-'
|
||||
localVars = trial._parseLocalVariables(declaration)
|
||||
self.assertEqual({'test-case-name':
|
||||
'twisted.trial.test.test_tests'},
|
||||
localVars)
|
||||
|
||||
def test_parseLocalVariables(self):
|
||||
declaration = ('-*- test-case-name: twisted.trial.test.test_tests; '
|
||||
'foo: bar -*-')
|
||||
localVars = trial._parseLocalVariables(declaration)
|
||||
self.assertEqual({'test-case-name':
|
||||
'twisted.trial.test.test_tests',
|
||||
'foo': 'bar'},
|
||||
localVars)
|
||||
|
||||
def test_surroundingGuff(self):
|
||||
declaration = ('## -*- test-case-name: '
|
||||
'twisted.trial.test.test_tests -*- #')
|
||||
localVars = trial._parseLocalVariables(declaration)
|
||||
self.assertEqual({'test-case-name':
|
||||
'twisted.trial.test.test_tests'},
|
||||
localVars)
|
||||
|
||||
def test_invalidLine(self):
|
||||
self.assertRaises(ValueError, trial._parseLocalVariables,
|
||||
'foo')
|
||||
|
||||
def test_invalidDeclaration(self):
|
||||
self.assertRaises(ValueError, trial._parseLocalVariables,
|
||||
'-*- foo -*-')
|
||||
self.assertRaises(ValueError, trial._parseLocalVariables,
|
||||
'-*- foo: bar; qux -*-')
|
||||
self.assertRaises(ValueError, trial._parseLocalVariables,
|
||||
'-*- foo: bar: baz; qux: qax -*-')
|
||||
|
||||
def test_variablesFromFile(self):
|
||||
localVars = trial.loadLocalVariables(sibpath('moduletest.py'))
|
||||
self.assertEqual({'test-case-name':
|
||||
'twisted.trial.test.test_log'},
|
||||
localVars)
|
||||
|
||||
def test_noVariablesInFile(self):
|
||||
localVars = trial.loadLocalVariables(sibpath('novars.py'))
|
||||
self.assertEqual({}, localVars)
|
||||
|
||||
def test_variablesFromScript(self):
|
||||
localVars = trial.loadLocalVariables(sibpath('scripttest.py'))
|
||||
self.assertEqual(
|
||||
{'test-case-name': ('twisted.trial.test.test_log,'
|
||||
'twisted.trial.test.test_runner')},
|
||||
localVars)
|
||||
|
||||
def test_getTestModules(self):
|
||||
modules = trial.getTestModules(sibpath('moduletest.py'))
|
||||
self.assertEqual(modules, ['twisted.trial.test.test_log'])
|
||||
|
||||
def test_getTestModules_noVars(self):
|
||||
modules = trial.getTestModules(sibpath('novars.py'))
|
||||
self.assertEqual(len(modules), 0)
|
||||
|
||||
def test_getTestModules_multiple(self):
|
||||
modules = trial.getTestModules(sibpath('scripttest.py'))
|
||||
self.assertEqual(set(modules),
|
||||
set(['twisted.trial.test.test_log',
|
||||
'twisted.trial.test.test_runner']))
|
||||
|
||||
def test_looksLikeTestModule(self):
|
||||
for filename in ['test_script.py', 'twisted/trial/test/test_script.py']:
|
||||
self.assertTrue(trial.isTestFile(filename),
|
||||
"%r should be a test file" % (filename,))
|
||||
for filename in ['twisted/trial/test/moduletest.py',
|
||||
sibpath('scripttest.py'), sibpath('test_foo.bat')]:
|
||||
self.assertFalse(trial.isTestFile(filename),
|
||||
"%r should *not* be a test file" % (filename,))
|
||||
|
||||
|
||||
class WithoutModuleTests(unittest.SynchronousTestCase):
|
||||
"""
|
||||
Test the C{without-module} flag.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
"""
|
||||
Create a L{trial.Options} object to be used in the tests, and save
|
||||
C{sys.modules}.
|
||||
"""
|
||||
self.config = trial.Options()
|
||||
self.savedModules = dict(sys.modules)
|
||||
|
||||
|
||||
def tearDown(self):
|
||||
"""
|
||||
Restore C{sys.modules}.
|
||||
"""
|
||||
for module in ('imaplib', 'smtplib'):
|
||||
if module in self.savedModules:
|
||||
sys.modules[module] = self.savedModules[module]
|
||||
else:
|
||||
sys.modules.pop(module, None)
|
||||
|
||||
|
||||
def _checkSMTP(self):
|
||||
"""
|
||||
Try to import the C{smtplib} module, and return it.
|
||||
"""
|
||||
import smtplib
|
||||
return smtplib
|
||||
|
||||
|
||||
def _checkIMAP(self):
|
||||
"""
|
||||
Try to import the C{imaplib} module, and return it.
|
||||
"""
|
||||
import imaplib
|
||||
return imaplib
|
||||
|
||||
|
||||
def test_disableOneModule(self):
|
||||
"""
|
||||
Check that after disabling a module, it can't be imported anymore.
|
||||
"""
|
||||
self.config.parseOptions(["--without-module", "smtplib"])
|
||||
self.assertRaises(ImportError, self._checkSMTP)
|
||||
# Restore sys.modules
|
||||
del sys.modules["smtplib"]
|
||||
# Then the function should succeed
|
||||
self.assertIsInstance(self._checkSMTP(), types.ModuleType)
|
||||
|
||||
|
||||
def test_disableMultipleModules(self):
|
||||
"""
|
||||
Check that several modules can be disabled at once.
|
||||
"""
|
||||
self.config.parseOptions(["--without-module", "smtplib,imaplib"])
|
||||
self.assertRaises(ImportError, self._checkSMTP)
|
||||
self.assertRaises(ImportError, self._checkIMAP)
|
||||
# Restore sys.modules
|
||||
del sys.modules["smtplib"]
|
||||
del sys.modules["imaplib"]
|
||||
# Then the functions should succeed
|
||||
self.assertIsInstance(self._checkSMTP(), types.ModuleType)
|
||||
self.assertIsInstance(self._checkIMAP(), types.ModuleType)
|
||||
|
||||
|
||||
def test_disableAlreadyImportedModule(self):
|
||||
"""
|
||||
Disabling an already imported module should produce a warning.
|
||||
"""
|
||||
self.assertIsInstance(self._checkSMTP(), types.ModuleType)
|
||||
self.assertWarns(RuntimeWarning,
|
||||
"Module 'smtplib' already imported, disabling anyway.",
|
||||
trial.__file__,
|
||||
self.config.parseOptions, ["--without-module", "smtplib"])
|
||||
self.assertRaises(ImportError, self._checkSMTP)
|
||||
|
||||
|
||||
|
||||
class CoverageTests(unittest.SynchronousTestCase):
|
||||
"""
|
||||
Tests for the I{coverage} option.
|
||||
"""
|
||||
if getattr(sys, 'gettrace', None) is None:
|
||||
skip = (
|
||||
"Cannot test trace hook installation without inspection API.")
|
||||
|
||||
def setUp(self):
|
||||
"""
|
||||
Arrange for the current trace hook to be restored when the
|
||||
test is complete.
|
||||
"""
|
||||
self.addCleanup(sys.settrace, sys.gettrace())
|
||||
|
||||
|
||||
def test_tracerInstalled(self):
|
||||
"""
|
||||
L{trial.Options} handles C{"--coverage"} by installing a trace
|
||||
hook to record coverage information.
|
||||
"""
|
||||
options = trial.Options()
|
||||
options.parseOptions(["--coverage"])
|
||||
self.assertEqual(sys.gettrace(), options.tracer.globaltrace)
|
||||
|
||||
|
||||
def test_coverdirDefault(self):
|
||||
"""
|
||||
L{trial.Options.coverdir} returns a L{FilePath} based on the default
|
||||
for the I{temp-directory} option if that option is not specified.
|
||||
"""
|
||||
options = trial.Options()
|
||||
self.assertEqual(
|
||||
options.coverdir(),
|
||||
FilePath(".").descendant([options["temp-directory"], "coverage"]))
|
||||
|
||||
|
||||
def test_coverdirOverridden(self):
|
||||
"""
|
||||
If a value is specified for the I{temp-directory} option,
|
||||
L{trial.Options.coverdir} returns a child of that path.
|
||||
"""
|
||||
path = self.mktemp()
|
||||
options = trial.Options()
|
||||
options.parseOptions(["--temp-directory", path])
|
||||
self.assertEqual(
|
||||
options.coverdir(), FilePath(path).child("coverage"))
|
||||
|
||||
|
||||
|
||||
class OptionsTests(unittest.TestCase):
|
||||
"""
|
||||
Tests for L{trial.Options}.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
"""
|
||||
Build an L{Options} object to be used in the tests.
|
||||
"""
|
||||
self.options = trial.Options()
|
||||
|
||||
|
||||
def test_getWorkerArguments(self):
|
||||
"""
|
||||
C{_getWorkerArguments} discards options like C{random} as they only
|
||||
matter in the manager, and forwards options like C{recursionlimit} or
|
||||
C{disablegc}.
|
||||
"""
|
||||
self.addCleanup(sys.setrecursionlimit, sys.getrecursionlimit())
|
||||
if gc.isenabled():
|
||||
self.addCleanup(gc.enable)
|
||||
|
||||
self.options.parseOptions(["--recursionlimit", "2000", "--random",
|
||||
"4", "--disablegc"])
|
||||
args = self.options._getWorkerArguments()
|
||||
self.assertIn("--disablegc", args)
|
||||
args.remove("--disablegc")
|
||||
self.assertEqual(["--recursionlimit", "2000"], args)
|
||||
|
||||
|
||||
def test_jobsConflictWithDebug(self):
|
||||
"""
|
||||
C{parseOptions} raises a C{UsageError} when C{--debug} is passed along
|
||||
C{--jobs} as it's not supported yet.
|
||||
|
||||
@see: U{http://twistedmatrix.com/trac/ticket/5825}
|
||||
"""
|
||||
error = self.assertRaises(
|
||||
UsageError, self.options.parseOptions, ["--jobs", "4", "--debug"])
|
||||
self.assertEqual("You can't specify --debug when using --jobs",
|
||||
str(error))
|
||||
|
||||
|
||||
def test_jobsConflictWithProfile(self):
|
||||
"""
|
||||
C{parseOptions} raises a C{UsageError} when C{--profile} is passed
|
||||
along C{--jobs} as it's not supported yet.
|
||||
|
||||
@see: U{http://twistedmatrix.com/trac/ticket/5827}
|
||||
"""
|
||||
error = self.assertRaises(
|
||||
UsageError, self.options.parseOptions,
|
||||
["--jobs", "4", "--profile"])
|
||||
self.assertEqual("You can't specify --profile when using --jobs",
|
||||
str(error))
|
||||
|
||||
|
||||
def test_jobsConflictWithDebugStackTraces(self):
|
||||
"""
|
||||
C{parseOptions} raises a C{UsageError} when C{--debug-stacktraces} is
|
||||
passed along C{--jobs} as it's not supported yet.
|
||||
|
||||
@see: U{http://twistedmatrix.com/trac/ticket/5826}
|
||||
"""
|
||||
error = self.assertRaises(
|
||||
UsageError, self.options.parseOptions,
|
||||
["--jobs", "4", "--debug-stacktraces"])
|
||||
self.assertEqual(
|
||||
"You can't specify --debug-stacktraces when using --jobs",
|
||||
str(error))
|
||||
|
||||
|
||||
def test_jobsConflictWithExitFirst(self):
|
||||
"""
|
||||
C{parseOptions} raises a C{UsageError} when C{--exitfirst} is passed
|
||||
along C{--jobs} as it's not supported yet.
|
||||
|
||||
@see: U{http://twistedmatrix.com/trac/ticket/6436}
|
||||
"""
|
||||
error = self.assertRaises(
|
||||
UsageError, self.options.parseOptions,
|
||||
["--jobs", "4", "--exitfirst"])
|
||||
self.assertEqual(
|
||||
"You can't specify --exitfirst when using --jobs",
|
||||
str(error))
|
||||
|
||||
|
||||
def test_orderConflictWithRandom(self):
|
||||
"""
|
||||
C{parseOptions} raises a C{UsageError} when C{--order} is passed along
|
||||
with C{--random}.
|
||||
"""
|
||||
error = self.assertRaises(
|
||||
UsageError,
|
||||
self.options.parseOptions,
|
||||
["--order", "alphabetical", "--random", "1234"])
|
||||
self.assertEqual("You can't specify --random when using --order",
|
||||
str(error))
|
||||
|
||||
|
||||
|
||||
class MakeRunnerTests(unittest.TestCase):
|
||||
"""
|
||||
Tests for the L{_makeRunner} helper.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.options = trial.Options()
|
||||
|
||||
def test_jobs(self):
|
||||
"""
|
||||
L{_makeRunner} returns a L{DistTrialRunner} instance when the C{--jobs}
|
||||
option is passed, and passes the C{workerNumber} and C{workerArguments}
|
||||
parameters to it.
|
||||
"""
|
||||
self.options.parseOptions(["--jobs", "4", "--force-gc"])
|
||||
runner = trial._makeRunner(self.options)
|
||||
self.assertIsInstance(runner, DistTrialRunner)
|
||||
self.assertEqual(4, runner._workerNumber)
|
||||
self.assertEqual(["--force-gc"], runner._workerArguments)
|
||||
|
||||
|
||||
def test_dryRunWithJobs(self):
|
||||
"""
|
||||
L{_makeRunner} returns a L{TrialRunner} instance in C{DRY_RUN} mode
|
||||
when the C{--dry-run} option is passed, even if C{--jobs} is set.
|
||||
"""
|
||||
self.options.parseOptions(["--jobs", "4", "--dry-run"])
|
||||
runner = trial._makeRunner(self.options)
|
||||
self.assertIsInstance(runner, TrialRunner)
|
||||
self.assertEqual(TrialRunner.DRY_RUN, runner.mode)
|
||||
|
||||
|
||||
def test_DebuggerNotFound(self):
|
||||
namedAny = trial.reflect.namedAny
|
||||
|
||||
def namedAnyExceptdoNotFind(fqn):
|
||||
if fqn == "doNotFind":
|
||||
raise trial.reflect.ModuleNotFound(fqn)
|
||||
return namedAny(fqn)
|
||||
|
||||
self.patch(trial.reflect, "namedAny", namedAnyExceptdoNotFind)
|
||||
|
||||
options = trial.Options()
|
||||
options.parseOptions(["--debug", "--debugger", "doNotFind"])
|
||||
|
||||
self.assertRaises(trial._DebuggerNotFound, trial._makeRunner, options)
|
||||
|
||||
|
||||
def test_exitfirst(self):
|
||||
"""
|
||||
Passing C{--exitfirst} wraps the reporter with a
|
||||
L{reporter._ExitWrapper} that stops on any non-success.
|
||||
"""
|
||||
self.options.parseOptions(["--exitfirst"])
|
||||
runner = trial._makeRunner(self.options)
|
||||
self.assertTrue(runner._exitFirst)
|
||||
|
||||
|
||||
class RunTests(unittest.TestCase):
|
||||
"""
|
||||
Tests for the L{run} function.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
# don't re-parse cmdline options, because if --reactor was passed to
|
||||
# the test run trial will try to restart the (already running) reactor
|
||||
self.patch(trial.Options, "parseOptions", lambda self: None)
|
||||
|
||||
|
||||
def test_debuggerNotFound(self):
|
||||
"""
|
||||
When a debugger is not found, an error message is printed to the user.
|
||||
|
||||
"""
|
||||
|
||||
def _makeRunner(*args, **kwargs):
|
||||
raise trial._DebuggerNotFound('foo')
|
||||
self.patch(trial, "_makeRunner", _makeRunner)
|
||||
|
||||
try:
|
||||
trial.run()
|
||||
except SystemExit as e:
|
||||
self.assertIn("foo", str(e))
|
||||
else:
|
||||
self.fail("Should have exited due to non-existent debugger!")
|
||||
|
||||
|
||||
|
||||
class TestArgumentOrderTests(unittest.TestCase):
|
||||
"""
|
||||
Tests for the order-preserving behavior on provided command-line tests.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
self.config = trial.Options()
|
||||
self.loader = TestLoader()
|
||||
|
||||
|
||||
def test_preserveArgumentOrder(self):
|
||||
"""
|
||||
Multiple tests passed on the command line are not reordered.
|
||||
"""
|
||||
tests = [
|
||||
"twisted.trial.test.test_tests",
|
||||
"twisted.trial.test.test_assertions",
|
||||
"twisted.trial.test.test_deferred",
|
||||
]
|
||||
self.config.parseOptions(tests)
|
||||
|
||||
suite = trial._getSuite(self.config)
|
||||
names = testNames(suite)
|
||||
|
||||
expectedSuite = TestSuite(map(self.loader.loadByName, tests))
|
||||
expectedNames = testNames(expectedSuite)
|
||||
|
||||
self.assertEqual(names, expectedNames)
|
||||
|
||||
|
||||
|
||||
class OrderTests(unittest.TestCase):
|
||||
"""
|
||||
Tests for the --order option.
|
||||
"""
|
||||
def setUp(self):
|
||||
self.config = trial.Options()
|
||||
|
||||
|
||||
def test_alphabetical(self):
|
||||
"""
|
||||
--order=alphabetical causes trial to run tests alphabetically within
|
||||
each test case.
|
||||
"""
|
||||
self.config.parseOptions([
|
||||
"--order", "alphabetical",
|
||||
"twisted.trial.test.ordertests.FooTest"])
|
||||
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadByNames(self.config['tests'])
|
||||
|
||||
self.assertEqual(
|
||||
testNames(suite), [
|
||||
'twisted.trial.test.ordertests.FooTest.test_first',
|
||||
'twisted.trial.test.ordertests.FooTest.test_fourth',
|
||||
'twisted.trial.test.ordertests.FooTest.test_second',
|
||||
'twisted.trial.test.ordertests.FooTest.test_third'])
|
||||
|
||||
|
||||
def test_alphabeticalModule(self):
|
||||
"""
|
||||
--order=alphabetical causes trial to run test classes within a given
|
||||
module alphabetically.
|
||||
"""
|
||||
self.config.parseOptions([
|
||||
"--order", "alphabetical", "twisted.trial.test.ordertests"])
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadByNames(self.config['tests'])
|
||||
|
||||
self.assertEqual(
|
||||
testNames(suite), [
|
||||
'twisted.trial.test.ordertests.BarTest.test_bar',
|
||||
'twisted.trial.test.ordertests.BazTest.test_baz',
|
||||
'twisted.trial.test.ordertests.FooTest.test_first',
|
||||
'twisted.trial.test.ordertests.FooTest.test_fourth',
|
||||
'twisted.trial.test.ordertests.FooTest.test_second',
|
||||
'twisted.trial.test.ordertests.FooTest.test_third'])
|
||||
|
||||
|
||||
def test_alphabeticalPackage(self):
|
||||
"""
|
||||
--order=alphabetical causes trial to run test modules within a given
|
||||
package alphabetically, with tests within each module alphabetized.
|
||||
"""
|
||||
self.config.parseOptions([
|
||||
"--order", "alphabetical", "twisted.trial.test"])
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadByNames(self.config['tests'])
|
||||
|
||||
names = testNames(suite)
|
||||
self.assertTrue(names, msg="Failed to load any tests!")
|
||||
self.assertEqual(names, sorted(names))
|
||||
|
||||
|
||||
def test_toptobottom(self):
|
||||
"""
|
||||
--order=toptobottom causes trial to run test methods within a given
|
||||
test case from top to bottom as they are defined in the body of the
|
||||
class.
|
||||
"""
|
||||
self.config.parseOptions([
|
||||
"--order", "toptobottom",
|
||||
"twisted.trial.test.ordertests.FooTest"])
|
||||
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadByNames(self.config['tests'])
|
||||
|
||||
self.assertEqual(
|
||||
testNames(suite), [
|
||||
'twisted.trial.test.ordertests.FooTest.test_first',
|
||||
'twisted.trial.test.ordertests.FooTest.test_second',
|
||||
'twisted.trial.test.ordertests.FooTest.test_third',
|
||||
'twisted.trial.test.ordertests.FooTest.test_fourth'])
|
||||
|
||||
|
||||
def test_toptobottomModule(self):
|
||||
"""
|
||||
--order=toptobottom causes trial to run test classes within a given
|
||||
module from top to bottom as they are defined in the module's source.
|
||||
"""
|
||||
self.config.parseOptions([
|
||||
"--order", "toptobottom", "twisted.trial.test.ordertests"])
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadByNames(self.config['tests'])
|
||||
|
||||
self.assertEqual(
|
||||
testNames(suite), [
|
||||
'twisted.trial.test.ordertests.FooTest.test_first',
|
||||
'twisted.trial.test.ordertests.FooTest.test_second',
|
||||
'twisted.trial.test.ordertests.FooTest.test_third',
|
||||
'twisted.trial.test.ordertests.FooTest.test_fourth',
|
||||
'twisted.trial.test.ordertests.BazTest.test_baz',
|
||||
'twisted.trial.test.ordertests.BarTest.test_bar'])
|
||||
|
||||
|
||||
def test_toptobottomPackage(self):
|
||||
"""
|
||||
--order=toptobottom causes trial to run test modules within a given
|
||||
package alphabetically, with tests within each module run top to
|
||||
bottom.
|
||||
"""
|
||||
self.config.parseOptions([
|
||||
"--order", "toptobottom", "twisted.trial.test"])
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadByNames(self.config['tests'])
|
||||
|
||||
names = testNames(suite)
|
||||
# twisted.trial.test.test_module, so split and key on the first 4 to
|
||||
# get stable alphabetical sort on those
|
||||
self.assertEqual(
|
||||
names, sorted(names, key=lambda name : name.split(".")[:4]),
|
||||
)
|
||||
|
||||
|
||||
def test_toptobottomMissingSource(self):
|
||||
"""
|
||||
--order=toptobottom detects the source line of methods from modules
|
||||
whose source file is missing.
|
||||
"""
|
||||
tempdir = self.mktemp()
|
||||
package = FilePath(tempdir).child('twisted_toptobottom_temp')
|
||||
package.makedirs()
|
||||
package.child('__init__.py').setContent(b'')
|
||||
package.child('test_missing.py').setContent(textwrap.dedent('''
|
||||
from twisted.trial.unittest import TestCase
|
||||
class TestMissing(TestCase):
|
||||
def test_second(self): pass
|
||||
def test_third(self): pass
|
||||
def test_fourth(self): pass
|
||||
def test_first(self): pass
|
||||
''').encode('utf8'))
|
||||
pathEntry = package.parent().path
|
||||
sys.path.insert(0, pathEntry)
|
||||
self.addCleanup(sys.path.remove, pathEntry)
|
||||
from twisted_toptobottom_temp import test_missing
|
||||
self.addCleanup(sys.modules.pop, 'twisted_toptobottom_temp')
|
||||
self.addCleanup(sys.modules.pop, test_missing.__name__)
|
||||
package.child('test_missing.py').remove()
|
||||
|
||||
self.config.parseOptions([
|
||||
"--order", "toptobottom", "twisted.trial.test.ordertests"])
|
||||
loader = trial._getLoader(self.config)
|
||||
suite = loader.loadModule(test_missing)
|
||||
|
||||
self.assertEqual(
|
||||
testNames(suite), [
|
||||
'twisted_toptobottom_temp.test_missing.TestMissing.test_second',
|
||||
'twisted_toptobottom_temp.test_missing.TestMissing.test_third',
|
||||
'twisted_toptobottom_temp.test_missing.TestMissing.test_fourth',
|
||||
'twisted_toptobottom_temp.test_missing.TestMissing.test_first'])
|
||||
|
||||
|
||||
def test_unknownOrder(self):
|
||||
"""
|
||||
An unknown order passed to --order raises a L{UsageError}.
|
||||
"""
|
||||
|
||||
self.assertRaises(
|
||||
UsageError, self.config.parseOptions, ["--order", "I don't exist"])
|
||||
|
||||
|
||||
|
||||
class HelpOrderTests(unittest.TestCase):
|
||||
"""
|
||||
Tests for the --help-orders flag.
|
||||
"""
|
||||
def test_help_ordersPrintsSynopsisAndQuits(self):
|
||||
"""
|
||||
--help-orders prints each of the available orders and then exits.
|
||||
"""
|
||||
self.patch(sys, "stdout", NativeStringIO())
|
||||
|
||||
exc = self.assertRaises(
|
||||
SystemExit, trial.Options().parseOptions, ["--help-orders"])
|
||||
self.assertEqual(exc.code, 0)
|
||||
|
||||
output = sys.stdout.getvalue()
|
||||
|
||||
msg = "%r with its description not properly described in %r"
|
||||
for orderName, (orderDesc, _) in trial._runOrders.items():
|
||||
match = re.search(
|
||||
"%s.*%s" % (re.escape(orderName), re.escape(orderDesc)),
|
||||
output,
|
||||
)
|
||||
|
||||
self.assertTrue(match, msg=msg % (orderName, output))
|
||||
@@ -0,0 +1,70 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
|
||||
"""
|
||||
Direct unit tests for L{twisted.trial.unittest.SynchronousTestCase} and
|
||||
L{twisted.trial.unittest.TestCase}.
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import
|
||||
|
||||
from twisted.trial.unittest import SynchronousTestCase, TestCase
|
||||
|
||||
|
||||
class TestCaseMixin(object):
|
||||
"""
|
||||
L{TestCase} tests.
|
||||
"""
|
||||
def setUp(self):
|
||||
"""
|
||||
Create a couple instances of C{MyTestCase}, each for the same test
|
||||
method, to be used in the test methods of this class.
|
||||
"""
|
||||
self.first = self.MyTestCase('test_1')
|
||||
self.second = self.MyTestCase('test_1')
|
||||
|
||||
|
||||
def test_equality(self):
|
||||
"""
|
||||
In order for one test method to be runnable twice, two TestCase
|
||||
instances with the same test method name must not compare as equal.
|
||||
"""
|
||||
self.assertTrue(self.first == self.first)
|
||||
self.assertTrue(self.first != self.second)
|
||||
self.assertFalse(self.first == self.second)
|
||||
|
||||
|
||||
def test_hashability(self):
|
||||
"""
|
||||
In order for one test method to be runnable twice, two TestCase
|
||||
instances with the same test method name should not have the same
|
||||
hash value.
|
||||
"""
|
||||
container = {}
|
||||
container[self.first] = None
|
||||
container[self.second] = None
|
||||
self.assertEqual(len(container), 2)
|
||||
|
||||
|
||||
|
||||
class SynchronousTestCaseTests(TestCaseMixin, SynchronousTestCase):
|
||||
class MyTestCase(SynchronousTestCase):
|
||||
"""
|
||||
Some test methods which can be used to test behaviors of
|
||||
L{SynchronousTestCase}.
|
||||
"""
|
||||
def test_1(self):
|
||||
pass
|
||||
|
||||
|
||||
|
||||
# Yes, subclass SynchronousTestCase again. There are no interesting behaviors
|
||||
# of self being tested below, only of self.MyTestCase.
|
||||
class AsynchronousTestCaseTests(TestCaseMixin, SynchronousTestCase):
|
||||
class MyTestCase(TestCase):
|
||||
"""
|
||||
Some test methods which can be used to test behaviors of
|
||||
L{TestCase}.
|
||||
"""
|
||||
def test_1(self):
|
||||
pass
|
||||
@@ -0,0 +1,754 @@
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
#
|
||||
|
||||
"""
|
||||
Tests for L{twisted.trial.util}
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import
|
||||
|
||||
import os, sys
|
||||
|
||||
from zope.interface import implementer
|
||||
|
||||
from twisted.python.compat import NativeStringIO
|
||||
from twisted.python import filepath
|
||||
from twisted.internet.interfaces import IProcessTransport
|
||||
from twisted.internet import defer
|
||||
from twisted.internet.base import DelayedCall
|
||||
from twisted.python.failure import Failure
|
||||
|
||||
from twisted.trial.unittest import SynchronousTestCase
|
||||
from twisted.trial import util
|
||||
from twisted.trial.util import (
|
||||
DirtyReactorAggregateError, _Janitor, excInfoOrFailureToExcInfo,
|
||||
acquireAttribute)
|
||||
|
||||
|
||||
|
||||
class MktempTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests for L{TestCase.mktemp}, a helper function for creating temporary file
|
||||
or directory names.
|
||||
"""
|
||||
def test_name(self):
|
||||
"""
|
||||
The path name returned by C{mktemp} is directly beneath a directory
|
||||
which identifies the test method which created the name.
|
||||
"""
|
||||
name = self.mktemp()
|
||||
dirs = os.path.dirname(name).split(os.sep)[:-1]
|
||||
self.assertEqual(
|
||||
dirs, ['twisted.trial.test.test_util', 'MktempTests', 'test_name'])
|
||||
|
||||
|
||||
def test_unique(self):
|
||||
"""
|
||||
Repeated calls to C{mktemp} return different values.
|
||||
"""
|
||||
name = self.mktemp()
|
||||
self.assertNotEqual(name, self.mktemp())
|
||||
|
||||
|
||||
def test_created(self):
|
||||
"""
|
||||
The directory part of the path name returned by C{mktemp} exists.
|
||||
"""
|
||||
name = self.mktemp()
|
||||
dirname = os.path.dirname(name)
|
||||
self.assertTrue(os.path.exists(dirname))
|
||||
self.assertFalse(os.path.exists(name))
|
||||
|
||||
|
||||
def test_location(self):
|
||||
"""
|
||||
The path returned by C{mktemp} is beneath the current working directory.
|
||||
"""
|
||||
path = os.path.abspath(self.mktemp())
|
||||
self.assertTrue(path.startswith(os.getcwd()))
|
||||
|
||||
|
||||
|
||||
class RunSequentiallyTests(SynchronousTestCase):
|
||||
"""
|
||||
Sometimes it is useful to be able to run an arbitrary list of callables,
|
||||
one after the other.
|
||||
|
||||
When some of those callables can return Deferreds, things become complex.
|
||||
"""
|
||||
|
||||
def assertDeferredResult(self, deferred, assertFunction, *args, **kwargs):
|
||||
"""
|
||||
Call the given assertion function against the current result of a
|
||||
Deferred.
|
||||
"""
|
||||
result = []
|
||||
deferred.addCallback(result.append)
|
||||
assertFunction(result[0], *args, **kwargs)
|
||||
|
||||
def test_emptyList(self):
|
||||
"""
|
||||
When asked to run an empty list of callables, runSequentially returns a
|
||||
successful Deferred that fires an empty list.
|
||||
"""
|
||||
d = util._runSequentially([])
|
||||
self.assertDeferredResult(d, self.assertEqual, [])
|
||||
|
||||
|
||||
def test_singleSynchronousSuccess(self):
|
||||
"""
|
||||
When given a callable that succeeds without returning a Deferred,
|
||||
include the return value in the results list, tagged with a SUCCESS
|
||||
flag.
|
||||
"""
|
||||
d = util._runSequentially([lambda: None])
|
||||
self.assertDeferredResult(d, self.assertEqual, [(defer.SUCCESS, None)])
|
||||
|
||||
|
||||
def test_singleSynchronousFailure(self):
|
||||
"""
|
||||
When given a callable that raises an exception, include a Failure for
|
||||
that exception in the results list, tagged with a FAILURE flag.
|
||||
"""
|
||||
d = util._runSequentially([lambda: self.fail('foo')])
|
||||
def check(results):
|
||||
[(flag, fail)] = results
|
||||
fail.trap(self.failureException)
|
||||
self.assertEqual(fail.getErrorMessage(), 'foo')
|
||||
self.assertEqual(flag, defer.FAILURE)
|
||||
self.assertDeferredResult(d, check)
|
||||
|
||||
|
||||
def test_singleAsynchronousSuccess(self):
|
||||
"""
|
||||
When given a callable that returns a successful Deferred, include the
|
||||
result of the Deferred in the results list, tagged with a SUCCESS flag.
|
||||
"""
|
||||
d = util._runSequentially([lambda: defer.succeed(None)])
|
||||
self.assertDeferredResult(d, self.assertEqual, [(defer.SUCCESS, None)])
|
||||
|
||||
|
||||
def test_singleAsynchronousFailure(self):
|
||||
"""
|
||||
When given a callable that returns a failing Deferred, include the
|
||||
failure the results list, tagged with a FAILURE flag.
|
||||
"""
|
||||
d = util._runSequentially([lambda: defer.fail(ValueError('foo'))])
|
||||
def check(results):
|
||||
[(flag, fail)] = results
|
||||
fail.trap(ValueError)
|
||||
self.assertEqual(fail.getErrorMessage(), 'foo')
|
||||
self.assertEqual(flag, defer.FAILURE)
|
||||
self.assertDeferredResult(d, check)
|
||||
|
||||
|
||||
def test_callablesCalledInOrder(self):
|
||||
"""
|
||||
Check that the callables are called in the given order, one after the
|
||||
other.
|
||||
"""
|
||||
log = []
|
||||
deferreds = []
|
||||
|
||||
def append(value):
|
||||
d = defer.Deferred()
|
||||
log.append(value)
|
||||
deferreds.append(d)
|
||||
return d
|
||||
|
||||
util._runSequentially([lambda: append('foo'),
|
||||
lambda: append('bar')])
|
||||
|
||||
# runSequentially should wait until the Deferred has fired before
|
||||
# running the second callable.
|
||||
self.assertEqual(log, ['foo'])
|
||||
deferreds[-1].callback(None)
|
||||
self.assertEqual(log, ['foo', 'bar'])
|
||||
|
||||
|
||||
def test_continuesAfterError(self):
|
||||
"""
|
||||
If one of the callables raises an error, then runSequentially continues
|
||||
to run the remaining callables.
|
||||
"""
|
||||
d = util._runSequentially([lambda: self.fail('foo'), lambda: 'bar'])
|
||||
def check(results):
|
||||
[(flag1, fail), (flag2, result)] = results
|
||||
fail.trap(self.failureException)
|
||||
self.assertEqual(flag1, defer.FAILURE)
|
||||
self.assertEqual(fail.getErrorMessage(), 'foo')
|
||||
self.assertEqual(flag2, defer.SUCCESS)
|
||||
self.assertEqual(result, 'bar')
|
||||
self.assertDeferredResult(d, check)
|
||||
|
||||
|
||||
def test_stopOnFirstError(self):
|
||||
"""
|
||||
If the C{stopOnFirstError} option is passed to C{runSequentially}, then
|
||||
no further callables are called after the first exception is raised.
|
||||
"""
|
||||
d = util._runSequentially([lambda: self.fail('foo'), lambda: 'bar'],
|
||||
stopOnFirstError=True)
|
||||
def check(results):
|
||||
[(flag1, fail)] = results
|
||||
fail.trap(self.failureException)
|
||||
self.assertEqual(flag1, defer.FAILURE)
|
||||
self.assertEqual(fail.getErrorMessage(), 'foo')
|
||||
self.assertDeferredResult(d, check)
|
||||
|
||||
|
||||
|
||||
class DirtyReactorAggregateErrorTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests for the L{DirtyReactorAggregateError}.
|
||||
"""
|
||||
|
||||
def test_formatDelayedCall(self):
|
||||
"""
|
||||
Delayed calls are formatted nicely.
|
||||
"""
|
||||
error = DirtyReactorAggregateError(["Foo", "bar"])
|
||||
self.assertEqual(str(error),
|
||||
"""\
|
||||
Reactor was unclean.
|
||||
DelayedCalls: (set twisted.internet.base.DelayedCall.debug = True to debug)
|
||||
Foo
|
||||
bar""")
|
||||
|
||||
|
||||
def test_formatSelectables(self):
|
||||
"""
|
||||
Selectables are formatted nicely.
|
||||
"""
|
||||
error = DirtyReactorAggregateError([], ["selectable 1", "selectable 2"])
|
||||
self.assertEqual(str(error),
|
||||
"""\
|
||||
Reactor was unclean.
|
||||
Selectables:
|
||||
selectable 1
|
||||
selectable 2""")
|
||||
|
||||
|
||||
def test_formatDelayedCallsAndSelectables(self):
|
||||
"""
|
||||
Both delayed calls and selectables can appear in the same error.
|
||||
"""
|
||||
error = DirtyReactorAggregateError(["bleck", "Boozo"],
|
||||
["Sel1", "Sel2"])
|
||||
self.assertEqual(str(error),
|
||||
"""\
|
||||
Reactor was unclean.
|
||||
DelayedCalls: (set twisted.internet.base.DelayedCall.debug = True to debug)
|
||||
bleck
|
||||
Boozo
|
||||
Selectables:
|
||||
Sel1
|
||||
Sel2""")
|
||||
|
||||
|
||||
|
||||
class StubReactor(object):
|
||||
"""
|
||||
A reactor stub which contains enough functionality to be used with the
|
||||
L{_Janitor}.
|
||||
|
||||
@ivar iterations: A list of the arguments passed to L{iterate}.
|
||||
@ivar removeAllCalled: Number of times that L{removeAll} was called.
|
||||
@ivar selectables: The value that will be returned from L{removeAll}.
|
||||
@ivar delayedCalls: The value to return from L{getDelayedCalls}.
|
||||
"""
|
||||
|
||||
def __init__(self, delayedCalls, selectables=None):
|
||||
"""
|
||||
@param delayedCalls: See L{StubReactor.delayedCalls}.
|
||||
@param selectables: See L{StubReactor.selectables}.
|
||||
"""
|
||||
self.delayedCalls = delayedCalls
|
||||
self.iterations = []
|
||||
self.removeAllCalled = 0
|
||||
if not selectables:
|
||||
selectables = []
|
||||
self.selectables = selectables
|
||||
|
||||
|
||||
def iterate(self, timeout=None):
|
||||
"""
|
||||
Increment C{self.iterations}.
|
||||
"""
|
||||
self.iterations.append(timeout)
|
||||
|
||||
|
||||
def getDelayedCalls(self):
|
||||
"""
|
||||
Return C{self.delayedCalls}.
|
||||
"""
|
||||
return self.delayedCalls
|
||||
|
||||
|
||||
def removeAll(self):
|
||||
"""
|
||||
Increment C{self.removeAllCalled} and return C{self.selectables}.
|
||||
"""
|
||||
self.removeAllCalled += 1
|
||||
return self.selectables
|
||||
|
||||
|
||||
|
||||
class StubErrorReporter(object):
|
||||
"""
|
||||
A subset of L{twisted.trial.itrial.IReporter} which records L{addError}
|
||||
calls.
|
||||
|
||||
@ivar errors: List of two-tuples of (test, error) which were passed to
|
||||
L{addError}.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.errors = []
|
||||
|
||||
|
||||
def addError(self, test, error):
|
||||
"""
|
||||
Record parameters in C{self.errors}.
|
||||
"""
|
||||
self.errors.append((test, error))
|
||||
|
||||
|
||||
|
||||
class JanitorTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests for L{_Janitor}!
|
||||
"""
|
||||
|
||||
def test_cleanPendingSpinsReactor(self):
|
||||
"""
|
||||
During pending-call cleanup, the reactor will be spun twice with an
|
||||
instant timeout. This is not a requirement, it is only a test for
|
||||
current behavior. Hopefully Trial will eventually not do this kind of
|
||||
reactor stuff.
|
||||
"""
|
||||
reactor = StubReactor([])
|
||||
jan = _Janitor(None, None, reactor=reactor)
|
||||
jan._cleanPending()
|
||||
self.assertEqual(reactor.iterations, [0, 0])
|
||||
|
||||
|
||||
def test_cleanPendingCancelsCalls(self):
|
||||
"""
|
||||
During pending-call cleanup, the janitor cancels pending timed calls.
|
||||
"""
|
||||
def func():
|
||||
return "Lulz"
|
||||
cancelled = []
|
||||
delayedCall = DelayedCall(300, func, (), {},
|
||||
cancelled.append, lambda x: None)
|
||||
reactor = StubReactor([delayedCall])
|
||||
jan = _Janitor(None, None, reactor=reactor)
|
||||
jan._cleanPending()
|
||||
self.assertEqual(cancelled, [delayedCall])
|
||||
|
||||
|
||||
def test_cleanPendingReturnsDelayedCallStrings(self):
|
||||
"""
|
||||
The Janitor produces string representations of delayed calls from the
|
||||
delayed call cleanup method. It gets the string representations
|
||||
*before* cancelling the calls; this is important because cancelling the
|
||||
call removes critical debugging information from the string
|
||||
representation.
|
||||
"""
|
||||
delayedCall = DelayedCall(300, lambda: None, (), {},
|
||||
lambda x: None, lambda x: None,
|
||||
seconds=lambda: 0)
|
||||
delayedCallString = str(delayedCall)
|
||||
reactor = StubReactor([delayedCall])
|
||||
jan = _Janitor(None, None, reactor=reactor)
|
||||
strings = jan._cleanPending()
|
||||
self.assertEqual(strings, [delayedCallString])
|
||||
|
||||
|
||||
def test_cleanReactorRemovesSelectables(self):
|
||||
"""
|
||||
The Janitor will remove selectables during reactor cleanup.
|
||||
"""
|
||||
reactor = StubReactor([])
|
||||
jan = _Janitor(None, None, reactor=reactor)
|
||||
jan._cleanReactor()
|
||||
self.assertEqual(reactor.removeAllCalled, 1)
|
||||
|
||||
|
||||
def test_cleanReactorKillsProcesses(self):
|
||||
"""
|
||||
The Janitor will kill processes during reactor cleanup.
|
||||
"""
|
||||
@implementer(IProcessTransport)
|
||||
class StubProcessTransport(object):
|
||||
"""
|
||||
A stub L{IProcessTransport} provider which records signals.
|
||||
@ivar signals: The signals passed to L{signalProcess}.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.signals = []
|
||||
|
||||
def signalProcess(self, signal):
|
||||
"""
|
||||
Append C{signal} to C{self.signals}.
|
||||
"""
|
||||
self.signals.append(signal)
|
||||
|
||||
pt = StubProcessTransport()
|
||||
reactor = StubReactor([], [pt])
|
||||
jan = _Janitor(None, None, reactor=reactor)
|
||||
jan._cleanReactor()
|
||||
self.assertEqual(pt.signals, ["KILL"])
|
||||
|
||||
|
||||
def test_cleanReactorReturnsSelectableStrings(self):
|
||||
"""
|
||||
The Janitor returns string representations of the selectables that it
|
||||
cleaned up from the reactor cleanup method.
|
||||
"""
|
||||
class Selectable(object):
|
||||
"""
|
||||
A stub Selectable which only has an interesting string
|
||||
representation.
|
||||
"""
|
||||
def __repr__(self):
|
||||
return "(SELECTABLE!)"
|
||||
|
||||
reactor = StubReactor([], [Selectable()])
|
||||
jan = _Janitor(None, None, reactor=reactor)
|
||||
self.assertEqual(jan._cleanReactor(), ["(SELECTABLE!)"])
|
||||
|
||||
|
||||
def test_postCaseCleanupNoErrors(self):
|
||||
"""
|
||||
The post-case cleanup method will return True and not call C{addError}
|
||||
on the result if there are no pending calls.
|
||||
"""
|
||||
reactor = StubReactor([])
|
||||
test = object()
|
||||
reporter = StubErrorReporter()
|
||||
jan = _Janitor(test, reporter, reactor=reactor)
|
||||
self.assertTrue(jan.postCaseCleanup())
|
||||
self.assertEqual(reporter.errors, [])
|
||||
|
||||
|
||||
def test_postCaseCleanupWithErrors(self):
|
||||
"""
|
||||
The post-case cleanup method will return False and call C{addError} on
|
||||
the result with a L{DirtyReactorAggregateError} Failure if there are
|
||||
pending calls.
|
||||
"""
|
||||
delayedCall = DelayedCall(300, lambda: None, (), {},
|
||||
lambda x: None, lambda x: None,
|
||||
seconds=lambda: 0)
|
||||
delayedCallString = str(delayedCall)
|
||||
reactor = StubReactor([delayedCall], [])
|
||||
test = object()
|
||||
reporter = StubErrorReporter()
|
||||
jan = _Janitor(test, reporter, reactor=reactor)
|
||||
self.assertFalse(jan.postCaseCleanup())
|
||||
self.assertEqual(len(reporter.errors), 1)
|
||||
self.assertEqual(reporter.errors[0][1].value.delayedCalls,
|
||||
[delayedCallString])
|
||||
|
||||
|
||||
def test_postClassCleanupNoErrors(self):
|
||||
"""
|
||||
The post-class cleanup method will not call C{addError} on the result
|
||||
if there are no pending calls or selectables.
|
||||
"""
|
||||
reactor = StubReactor([])
|
||||
test = object()
|
||||
reporter = StubErrorReporter()
|
||||
jan = _Janitor(test, reporter, reactor=reactor)
|
||||
jan.postClassCleanup()
|
||||
self.assertEqual(reporter.errors, [])
|
||||
|
||||
|
||||
def test_postClassCleanupWithPendingCallErrors(self):
|
||||
"""
|
||||
The post-class cleanup method call C{addError} on the result with a
|
||||
L{DirtyReactorAggregateError} Failure if there are pending calls.
|
||||
"""
|
||||
delayedCall = DelayedCall(300, lambda: None, (), {},
|
||||
lambda x: None, lambda x: None,
|
||||
seconds=lambda: 0)
|
||||
delayedCallString = str(delayedCall)
|
||||
reactor = StubReactor([delayedCall], [])
|
||||
test = object()
|
||||
reporter = StubErrorReporter()
|
||||
jan = _Janitor(test, reporter, reactor=reactor)
|
||||
jan.postClassCleanup()
|
||||
self.assertEqual(len(reporter.errors), 1)
|
||||
self.assertEqual(reporter.errors[0][1].value.delayedCalls,
|
||||
[delayedCallString])
|
||||
|
||||
|
||||
def test_postClassCleanupWithSelectableErrors(self):
|
||||
"""
|
||||
The post-class cleanup method call C{addError} on the result with a
|
||||
L{DirtyReactorAggregateError} Failure if there are selectables.
|
||||
"""
|
||||
selectable = "SELECTABLE HERE"
|
||||
reactor = StubReactor([], [selectable])
|
||||
test = object()
|
||||
reporter = StubErrorReporter()
|
||||
jan = _Janitor(test, reporter, reactor=reactor)
|
||||
jan.postClassCleanup()
|
||||
self.assertEqual(len(reporter.errors), 1)
|
||||
self.assertEqual(reporter.errors[0][1].value.selectables,
|
||||
[repr(selectable)])
|
||||
|
||||
|
||||
|
||||
class RemoveSafelyTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests for L{util._removeSafely}.
|
||||
"""
|
||||
def test_removeSafelyNoTrialMarker(self):
|
||||
"""
|
||||
If a path doesn't contain a node named C{"_trial_marker"}, that path is
|
||||
not removed by L{util._removeSafely} and a L{util._NoTrialMarker}
|
||||
exception is raised instead.
|
||||
"""
|
||||
directory = self.mktemp().encode("utf-8")
|
||||
os.mkdir(directory)
|
||||
dirPath = filepath.FilePath(directory)
|
||||
self.assertRaises(util._NoTrialMarker, util._removeSafely, dirPath)
|
||||
|
||||
|
||||
def test_removeSafelyRemoveFailsMoveSucceeds(self):
|
||||
"""
|
||||
If an L{OSError} is raised while removing a path in
|
||||
L{util._removeSafely}, an attempt is made to move the path to a new
|
||||
name.
|
||||
"""
|
||||
def dummyRemove():
|
||||
"""
|
||||
Raise an C{OSError} to emulate the branch of L{util._removeSafely}
|
||||
in which path removal fails.
|
||||
"""
|
||||
raise OSError()
|
||||
|
||||
# Patch stdout so we can check the print statements in _removeSafely
|
||||
out = NativeStringIO()
|
||||
self.patch(sys, 'stdout', out)
|
||||
|
||||
# Set up a trial directory with a _trial_marker
|
||||
directory = self.mktemp().encode("utf-8")
|
||||
os.mkdir(directory)
|
||||
dirPath = filepath.FilePath(directory)
|
||||
dirPath.child(b'_trial_marker').touch()
|
||||
# Ensure that path.remove() raises an OSError
|
||||
dirPath.remove = dummyRemove
|
||||
|
||||
util._removeSafely(dirPath)
|
||||
self.assertIn("could not remove FilePath", out.getvalue())
|
||||
|
||||
|
||||
def test_removeSafelyRemoveFailsMoveFails(self):
|
||||
"""
|
||||
If an L{OSError} is raised while removing a path in
|
||||
L{util._removeSafely}, an attempt is made to move the path to a new
|
||||
name. If that attempt fails, the L{OSError} is re-raised.
|
||||
"""
|
||||
def dummyRemove():
|
||||
"""
|
||||
Raise an C{OSError} to emulate the branch of L{util._removeSafely}
|
||||
in which path removal fails.
|
||||
"""
|
||||
raise OSError("path removal failed")
|
||||
|
||||
def dummyMoveTo(path):
|
||||
"""
|
||||
Raise an C{OSError} to emulate the branch of L{util._removeSafely}
|
||||
in which path movement fails.
|
||||
"""
|
||||
raise OSError("path movement failed")
|
||||
|
||||
# Patch stdout so we can check the print statements in _removeSafely
|
||||
out = NativeStringIO()
|
||||
self.patch(sys, 'stdout', out)
|
||||
|
||||
# Set up a trial directory with a _trial_marker
|
||||
directory = self.mktemp().encode("utf-8")
|
||||
os.mkdir(directory)
|
||||
dirPath = filepath.FilePath(directory)
|
||||
dirPath.child(b'_trial_marker').touch()
|
||||
|
||||
# Ensure that path.remove() and path.moveTo() both raise OSErrors
|
||||
dirPath.remove = dummyRemove
|
||||
dirPath.moveTo = dummyMoveTo
|
||||
|
||||
error = self.assertRaises(OSError, util._removeSafely, dirPath)
|
||||
self.assertEqual(str(error), "path movement failed")
|
||||
self.assertIn("could not remove FilePath", out.getvalue())
|
||||
|
||||
|
||||
|
||||
class ExcInfoTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests for L{excInfoOrFailureToExcInfo}.
|
||||
"""
|
||||
def test_excInfo(self):
|
||||
"""
|
||||
L{excInfoOrFailureToExcInfo} returns exactly what it is passed, if it is
|
||||
passed a tuple like the one returned by L{sys.exc_info}.
|
||||
"""
|
||||
info = (ValueError, ValueError("foo"), None)
|
||||
self.assertTrue(info is excInfoOrFailureToExcInfo(info))
|
||||
|
||||
|
||||
def test_failure(self):
|
||||
"""
|
||||
When called with a L{Failure} instance, L{excInfoOrFailureToExcInfo}
|
||||
returns a tuple like the one returned by L{sys.exc_info}, with the
|
||||
elements taken from the type, value, and traceback of the failure.
|
||||
"""
|
||||
try:
|
||||
1 / 0
|
||||
except:
|
||||
f = Failure()
|
||||
self.assertEqual((f.type, f.value, f.tb), excInfoOrFailureToExcInfo(f))
|
||||
|
||||
|
||||
|
||||
class AcquireAttributeTests(SynchronousTestCase):
|
||||
"""
|
||||
Tests for L{acquireAttribute}.
|
||||
"""
|
||||
def test_foundOnEarlierObject(self):
|
||||
"""
|
||||
The value returned by L{acquireAttribute} is the value of the requested
|
||||
attribute on the first object in the list passed in which has that
|
||||
attribute.
|
||||
"""
|
||||
self.value = value = object()
|
||||
self.assertTrue(value is acquireAttribute([self, object()], "value"))
|
||||
|
||||
|
||||
def test_foundOnLaterObject(self):
|
||||
"""
|
||||
The same as L{test_foundOnEarlierObject}, but for the case where the 2nd
|
||||
element in the object list has the attribute and the first does not.
|
||||
"""
|
||||
self.value = value = object()
|
||||
self.assertTrue(value is acquireAttribute([object(), self], "value"))
|
||||
|
||||
|
||||
def test_notFoundException(self):
|
||||
"""
|
||||
If none of the objects passed in the list to L{acquireAttribute} have
|
||||
the requested attribute, L{AttributeError} is raised.
|
||||
"""
|
||||
self.assertRaises(AttributeError, acquireAttribute, [object()], "foo")
|
||||
|
||||
|
||||
def test_notFoundDefault(self):
|
||||
"""
|
||||
If none of the objects passed in the list to L{acquireAttribute} have
|
||||
the requested attribute and a default value is given, the default value
|
||||
is returned.
|
||||
"""
|
||||
default = object()
|
||||
self.assertTrue(default is acquireAttribute([object()], "foo", default))
|
||||
|
||||
|
||||
|
||||
class ListToPhraseTests(SynchronousTestCase):
|
||||
"""
|
||||
Input is transformed into a string representation of the list,
|
||||
with each item separated by delimiter (defaulting to a comma) and the final
|
||||
two being separated by a final delimiter.
|
||||
"""
|
||||
|
||||
def test_empty(self):
|
||||
"""
|
||||
If things is empty, an empty string is returned.
|
||||
"""
|
||||
sample = []
|
||||
expected = ''
|
||||
result = util._listToPhrase(sample, 'and')
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
|
||||
def test_oneWord(self):
|
||||
"""
|
||||
With a single item, the item is returned.
|
||||
"""
|
||||
sample = ['One']
|
||||
expected = 'One'
|
||||
result = util._listToPhrase(sample, 'and')
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
|
||||
def test_twoWords(self):
|
||||
"""
|
||||
Two words are separated by the final delimiter.
|
||||
"""
|
||||
sample = ['One', 'Two']
|
||||
expected = 'One and Two'
|
||||
result = util._listToPhrase(sample, 'and')
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
|
||||
def test_threeWords(self):
|
||||
"""
|
||||
With more than two words, the first two are separated by the delimiter.
|
||||
"""
|
||||
sample = ['One', 'Two', 'Three']
|
||||
expected = 'One, Two, and Three'
|
||||
result = util._listToPhrase(sample, 'and')
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
|
||||
def test_fourWords(self):
|
||||
"""
|
||||
If a delimiter is specified, it is used instead of the default comma.
|
||||
"""
|
||||
sample = ['One', 'Two', 'Three', 'Four']
|
||||
expected = 'One; Two; Three; or Four'
|
||||
result = util._listToPhrase(sample, 'or', delimiter='; ')
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
|
||||
def test_notString(self):
|
||||
"""
|
||||
If something in things is not a string, it is converted into one.
|
||||
"""
|
||||
sample = [1, 2, 'three']
|
||||
expected = '1, 2, and three'
|
||||
result = util._listToPhrase(sample, 'and')
|
||||
self.assertEqual(expected, result)
|
||||
|
||||
|
||||
def test_stringTypeError(self):
|
||||
"""
|
||||
If things is a string, a TypeError is raised.
|
||||
"""
|
||||
sample = "One, two, three"
|
||||
error = self.assertRaises(TypeError, util._listToPhrase, sample, 'and')
|
||||
self.assertEqual(str(error), "Things must be a list or a tuple")
|
||||
|
||||
|
||||
def test_iteratorTypeError(self):
|
||||
"""
|
||||
If things is an iterator, a TypeError is raised.
|
||||
"""
|
||||
sample = iter([1, 2, 3])
|
||||
error = self.assertRaises(TypeError, util._listToPhrase, sample, 'and')
|
||||
self.assertEqual(str(error), "Things must be a list or a tuple")
|
||||
|
||||
|
||||
def test_generatorTypeError(self):
|
||||
"""
|
||||
If things is a generator, a TypeError is raised.
|
||||
"""
|
||||
def sample():
|
||||
for i in range(2):
|
||||
yield i
|
||||
error = self.assertRaises(TypeError, util._listToPhrase, sample, 'and')
|
||||
self.assertEqual(str(error), "Things must be a list or a tuple")
|
||||
@@ -0,0 +1,411 @@
|
||||
# -*- test-case-name: twisted.trial.test.test_util -*-
|
||||
# Copyright (c) Twisted Matrix Laboratories.
|
||||
# See LICENSE for details.
|
||||
#
|
||||
|
||||
"""
|
||||
A collection of utility functions and classes, used internally by Trial.
|
||||
|
||||
This code is for Trial's internal use. Do NOT use this code if you are writing
|
||||
tests. It is subject to change at the Trial maintainer's whim. There is
|
||||
nothing here in this module for you to use unless you are maintaining Trial.
|
||||
|
||||
Any non-Trial Twisted code that uses this module will be shot.
|
||||
|
||||
Maintainer: Jonathan Lange
|
||||
|
||||
@var DEFAULT_TIMEOUT_DURATION: The default timeout which will be applied to
|
||||
asynchronous (ie, Deferred-returning) test methods, in seconds.
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import, print_function
|
||||
|
||||
from random import randrange
|
||||
|
||||
from twisted.internet import defer, utils, interfaces
|
||||
from twisted.python.failure import Failure
|
||||
from twisted.python.filepath import FilePath
|
||||
from twisted.python.lockfile import FilesystemLock
|
||||
|
||||
__all__ = [
|
||||
'DEFAULT_TIMEOUT_DURATION',
|
||||
|
||||
'excInfoOrFailureToExcInfo', 'suppress', 'acquireAttribute']
|
||||
|
||||
DEFAULT_TIMEOUT = object()
|
||||
DEFAULT_TIMEOUT_DURATION = 120.0
|
||||
|
||||
|
||||
|
||||
class DirtyReactorAggregateError(Exception):
|
||||
"""
|
||||
Passed to L{twisted.trial.itrial.IReporter.addError} when the reactor is
|
||||
left in an unclean state after a test.
|
||||
|
||||
@ivar delayedCalls: The L{DelayedCall<twisted.internet.base.DelayedCall>}
|
||||
objects which weren't cleaned up.
|
||||
@ivar selectables: The selectables which weren't cleaned up.
|
||||
"""
|
||||
|
||||
def __init__(self, delayedCalls, selectables=None):
|
||||
self.delayedCalls = delayedCalls
|
||||
self.selectables = selectables
|
||||
|
||||
|
||||
def __str__(self):
|
||||
"""
|
||||
Return a multi-line message describing all of the unclean state.
|
||||
"""
|
||||
msg = "Reactor was unclean."
|
||||
if self.delayedCalls:
|
||||
msg += ("\nDelayedCalls: (set "
|
||||
"twisted.internet.base.DelayedCall.debug = True to "
|
||||
"debug)\n")
|
||||
msg += "\n".join(map(str, self.delayedCalls))
|
||||
if self.selectables:
|
||||
msg += "\nSelectables:\n"
|
||||
msg += "\n".join(map(str, self.selectables))
|
||||
return msg
|
||||
|
||||
|
||||
|
||||
class _Janitor(object):
|
||||
"""
|
||||
The guy that cleans up after you.
|
||||
|
||||
@ivar test: The L{TestCase} to report errors about.
|
||||
@ivar result: The L{IReporter} to report errors to.
|
||||
@ivar reactor: The reactor to use. If None, the global reactor
|
||||
will be used.
|
||||
"""
|
||||
def __init__(self, test, result, reactor=None):
|
||||
"""
|
||||
@param test: See L{_Janitor.test}.
|
||||
@param result: See L{_Janitor.result}.
|
||||
@param reactor: See L{_Janitor.reactor}.
|
||||
"""
|
||||
self.test = test
|
||||
self.result = result
|
||||
self.reactor = reactor
|
||||
|
||||
|
||||
def postCaseCleanup(self):
|
||||
"""
|
||||
Called by L{unittest.TestCase} after a test to catch any logged errors
|
||||
or pending L{DelayedCall<twisted.internet.base.DelayedCall>}s.
|
||||
"""
|
||||
calls = self._cleanPending()
|
||||
if calls:
|
||||
aggregate = DirtyReactorAggregateError(calls)
|
||||
self.result.addError(self.test, Failure(aggregate))
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def postClassCleanup(self):
|
||||
"""
|
||||
Called by L{unittest.TestCase} after the last test in a C{TestCase}
|
||||
subclass. Ensures the reactor is clean by murdering the threadpool,
|
||||
catching any pending
|
||||
L{DelayedCall<twisted.internet.base.DelayedCall>}s, open sockets etc.
|
||||
"""
|
||||
selectables = self._cleanReactor()
|
||||
calls = self._cleanPending()
|
||||
if selectables or calls:
|
||||
aggregate = DirtyReactorAggregateError(calls, selectables)
|
||||
self.result.addError(self.test, Failure(aggregate))
|
||||
self._cleanThreads()
|
||||
|
||||
|
||||
def _getReactor(self):
|
||||
"""
|
||||
Get either the passed-in reactor or the global reactor.
|
||||
"""
|
||||
if self.reactor is not None:
|
||||
reactor = self.reactor
|
||||
else:
|
||||
from twisted.internet import reactor
|
||||
return reactor
|
||||
|
||||
|
||||
def _cleanPending(self):
|
||||
"""
|
||||
Cancel all pending calls and return their string representations.
|
||||
"""
|
||||
reactor = self._getReactor()
|
||||
|
||||
# flush short-range timers
|
||||
reactor.iterate(0)
|
||||
reactor.iterate(0)
|
||||
|
||||
delayedCallStrings = []
|
||||
for p in reactor.getDelayedCalls():
|
||||
if p.active():
|
||||
delayedString = str(p)
|
||||
p.cancel()
|
||||
else:
|
||||
print("WEIRDNESS! pending timed call not active!")
|
||||
delayedCallStrings.append(delayedString)
|
||||
return delayedCallStrings
|
||||
_cleanPending = utils.suppressWarnings(
|
||||
_cleanPending, (('ignore',), {'category': DeprecationWarning,
|
||||
'message':
|
||||
r'reactor\.iterate cannot be used.*'}))
|
||||
|
||||
def _cleanThreads(self):
|
||||
reactor = self._getReactor()
|
||||
if interfaces.IReactorThreads.providedBy(reactor):
|
||||
if reactor.threadpool is not None:
|
||||
# Stop the threadpool now so that a new one is created.
|
||||
# This improves test isolation somewhat (although this is a
|
||||
# post class cleanup hook, so it's only isolating classes
|
||||
# from each other, not methods from each other).
|
||||
reactor._stopThreadPool()
|
||||
|
||||
|
||||
def _cleanReactor(self):
|
||||
"""
|
||||
Remove all selectables from the reactor, kill any of them that were
|
||||
processes, and return their string representation.
|
||||
"""
|
||||
reactor = self._getReactor()
|
||||
selectableStrings = []
|
||||
for sel in reactor.removeAll():
|
||||
if interfaces.IProcessTransport.providedBy(sel):
|
||||
sel.signalProcess('KILL')
|
||||
selectableStrings.append(repr(sel))
|
||||
return selectableStrings
|
||||
|
||||
|
||||
|
||||
_DEFAULT = object()
|
||||
def acquireAttribute(objects, attr, default=_DEFAULT):
|
||||
"""
|
||||
Go through the list 'objects' sequentially until we find one which has
|
||||
attribute 'attr', then return the value of that attribute. If not found,
|
||||
return 'default' if set, otherwise, raise AttributeError.
|
||||
"""
|
||||
for obj in objects:
|
||||
if hasattr(obj, attr):
|
||||
return getattr(obj, attr)
|
||||
if default is not _DEFAULT:
|
||||
return default
|
||||
raise AttributeError('attribute %r not found in %r' % (attr, objects))
|
||||
|
||||
|
||||
|
||||
def excInfoOrFailureToExcInfo(err):
|
||||
"""
|
||||
Coerce a Failure to an _exc_info, if err is a Failure.
|
||||
|
||||
@param err: Either a tuple such as returned by L{sys.exc_info} or a
|
||||
L{Failure} object.
|
||||
@return: A tuple like the one returned by L{sys.exc_info}. e.g.
|
||||
C{exception_type, exception_object, traceback_object}.
|
||||
"""
|
||||
if isinstance(err, Failure):
|
||||
# Unwrap the Failure into an exc_info tuple.
|
||||
err = (err.type, err.value, err.getTracebackObject())
|
||||
return err
|
||||
|
||||
|
||||
|
||||
def suppress(action='ignore', **kwarg):
|
||||
"""
|
||||
Sets up the .suppress tuple properly, pass options to this method as you
|
||||
would the stdlib warnings.filterwarnings()
|
||||
|
||||
So, to use this with a .suppress magic attribute you would do the
|
||||
following:
|
||||
|
||||
>>> from twisted.trial import unittest, util
|
||||
>>> import warnings
|
||||
>>>
|
||||
>>> class TestFoo(unittest.TestCase):
|
||||
... def testFooBar(self):
|
||||
... warnings.warn("i am deprecated", DeprecationWarning)
|
||||
... testFooBar.suppress = [util.suppress(message='i am deprecated')]
|
||||
...
|
||||
>>>
|
||||
|
||||
Note that as with the todo and timeout attributes: the module level
|
||||
attribute acts as a default for the class attribute which acts as a default
|
||||
for the method attribute. The suppress attribute can be overridden at any
|
||||
level by specifying C{.suppress = []}
|
||||
"""
|
||||
return ((action,), kwarg)
|
||||
|
||||
|
||||
|
||||
# This should be deleted, and replaced with twisted.application's code; see
|
||||
# #6016:
|
||||
def profiled(f, outputFile):
|
||||
def _(*args, **kwargs):
|
||||
import profile
|
||||
prof = profile.Profile()
|
||||
try:
|
||||
result = prof.runcall(f, *args, **kwargs)
|
||||
prof.dump_stats(outputFile)
|
||||
except SystemExit:
|
||||
pass
|
||||
prof.print_stats()
|
||||
return result
|
||||
return _
|
||||
|
||||
|
||||
|
||||
@defer.inlineCallbacks
|
||||
def _runSequentially(callables, stopOnFirstError=False):
|
||||
"""
|
||||
Run the given callables one after the other. If a callable returns a
|
||||
Deferred, wait until it has finished before running the next callable.
|
||||
|
||||
@param callables: An iterable of callables that take no parameters.
|
||||
|
||||
@param stopOnFirstError: If True, then stop running callables as soon as
|
||||
one raises an exception or fires an errback. False by default.
|
||||
|
||||
@return: A L{Deferred} that fires a list of C{(flag, value)} tuples. Each
|
||||
tuple will be either C{(SUCCESS, <return value>)} or C{(FAILURE,
|
||||
<Failure>)}.
|
||||
"""
|
||||
results = []
|
||||
for f in callables:
|
||||
d = defer.maybeDeferred(f)
|
||||
try:
|
||||
thing = yield d
|
||||
results.append((defer.SUCCESS, thing))
|
||||
except Exception:
|
||||
results.append((defer.FAILURE, Failure()))
|
||||
if stopOnFirstError:
|
||||
break
|
||||
defer.returnValue(results)
|
||||
|
||||
|
||||
|
||||
class _NoTrialMarker(Exception):
|
||||
"""
|
||||
No trial marker file could be found.
|
||||
|
||||
Raised when trial attempts to remove a trial temporary working directory
|
||||
that does not contain a marker file.
|
||||
"""
|
||||
|
||||
|
||||
|
||||
def _removeSafely(path):
|
||||
"""
|
||||
Safely remove a path, recursively.
|
||||
|
||||
If C{path} does not contain a node named C{_trial_marker}, a
|
||||
L{_NoTrialMarker} exception is raised and the path is not removed.
|
||||
"""
|
||||
if not path.child(b'_trial_marker').exists():
|
||||
raise _NoTrialMarker(
|
||||
'%r is not a trial temporary path, refusing to remove it'
|
||||
% (path,))
|
||||
try:
|
||||
path.remove()
|
||||
except OSError as e:
|
||||
print ("could not remove %r, caught OSError [Errno %s]: %s"
|
||||
% (path, e.errno, e.strerror))
|
||||
try:
|
||||
newPath = FilePath(b'_trial_temp_old' +
|
||||
str(randrange(10000000)).encode("utf-8"))
|
||||
path.moveTo(newPath)
|
||||
except OSError as e:
|
||||
print ("could not rename path, caught OSError [Errno %s]: %s"
|
||||
% (e.errno,e.strerror))
|
||||
raise
|
||||
|
||||
|
||||
|
||||
class _WorkingDirectoryBusy(Exception):
|
||||
"""
|
||||
A working directory was specified to the runner, but another test run is
|
||||
currently using that directory.
|
||||
"""
|
||||
|
||||
|
||||
|
||||
def _unusedTestDirectory(base):
|
||||
"""
|
||||
Find an unused directory named similarly to C{base}.
|
||||
|
||||
Once a directory is found, it will be locked and a marker dropped into it
|
||||
to identify it as a trial temporary directory.
|
||||
|
||||
@param base: A template path for the discovery process. If this path
|
||||
exactly cannot be used, a path which varies only in a suffix of the
|
||||
basename will be used instead.
|
||||
@type base: L{FilePath}
|
||||
|
||||
@return: A two-tuple. The first element is a L{FilePath} representing the
|
||||
directory which was found and created. The second element is a locked
|
||||
L{FilesystemLock<twisted.python.lockfile.FilesystemLock>}. Another
|
||||
call to C{_unusedTestDirectory} will not be able to reused the
|
||||
same name until the lock is released, either explicitly or by this
|
||||
process exiting.
|
||||
"""
|
||||
counter = 0
|
||||
while True:
|
||||
if counter:
|
||||
testdir = base.sibling('%s-%d' % (base.basename(), counter))
|
||||
else:
|
||||
testdir = base
|
||||
|
||||
testDirLock = FilesystemLock(testdir.path + '.lock')
|
||||
if testDirLock.lock():
|
||||
# It is not in use
|
||||
if testdir.exists():
|
||||
# It exists though - delete it
|
||||
_removeSafely(testdir)
|
||||
|
||||
# Create it anew and mark it as ours so the next _removeSafely on
|
||||
# it succeeds.
|
||||
testdir.makedirs()
|
||||
testdir.child(b'_trial_marker').setContent(b'')
|
||||
return testdir, testDirLock
|
||||
else:
|
||||
# It is in use
|
||||
if base.basename() == '_trial_temp':
|
||||
counter += 1
|
||||
else:
|
||||
raise _WorkingDirectoryBusy()
|
||||
|
||||
|
||||
|
||||
def _listToPhrase(things, finalDelimiter, delimiter=', '):
|
||||
"""
|
||||
Produce a string containing each thing in C{things},
|
||||
separated by a C{delimiter}, with the last couple being separated
|
||||
by C{finalDelimiter}
|
||||
|
||||
@param things: The elements of the resulting phrase
|
||||
@type things: L{list} or L{tuple}
|
||||
|
||||
@param finalDelimiter: What to put between the last two things
|
||||
(typically 'and' or 'or')
|
||||
@type finalDelimiter: L{str}
|
||||
|
||||
@param delimiter: The separator to use between each thing,
|
||||
not including the last two. Should typically include a trailing space.
|
||||
@type delimiter: L{str}
|
||||
|
||||
@return: The resulting phrase
|
||||
@rtype: L{str}
|
||||
"""
|
||||
if not isinstance(things, (list, tuple)):
|
||||
raise TypeError("Things must be a list or a tuple")
|
||||
if not things:
|
||||
return ''
|
||||
if len(things) == 1:
|
||||
return str(things[0])
|
||||
if len(things) == 2:
|
||||
return "%s %s %s" % (str(things[0]), finalDelimiter, str(things[1]))
|
||||
else:
|
||||
strThings = []
|
||||
for thing in things:
|
||||
strThings.append(str(thing))
|
||||
return "%s%s%s %s" % (delimiter.join(strThings[:-1]),
|
||||
delimiter, finalDelimiter, strThings[-1])
|
||||
Reference in New Issue
Block a user