twisted.test.test_plugin.PluginTests

class documentation

class PluginTests(unittest.TestCase): (source)

View In Hierarchy

Tests which verify the behavior of the current, active Twisted plugins directory.

Method setUp Save sys.path and sys.modules, and create a package for tests.
Method tearDown Restore sys.path and sys.modules to their original values.
Method test_cache Check that the cache returned by plugin.getCache hold the plugin testplugin, and that this plugin has the properties we expect: provide TestPlugin, has the good name and description, and can be loaded successfully.
Method test_cacheRepr CachedPlugin has a helpful repr which contains relevant information about it.
Method test_deployedMode The dropin.cache file may not be writable: the cache should still be attainable, but an error should be logged to show that the cache couldn't be updated.
Method test_detectFilesChanged Check that if the content of a plugin change, plugin.getPlugins is able to detect the new plugins added.
Method test_detectFilesRemoved Check that when a dropin file is removed, plugin.getPlugins doesn't return it anymore.
Method test_detectNewFiles Check that plugin.getPlugins is able to detect plugins added at runtime.
Method test_nonDirectoryChildEntry Test that getCache skips over any entries in a plugin package's __path__ which refer to children of paths which are not directories.
Method test_nonexistentPathEntry Test that getCache skips over any entries in a plugin package's __path__ which do not exist.
Method test_plugins plugin.getPlugins should return the list of plugins matching the specified interface (here, ITestPlugin2), and these plugins should be instances of classes with a test method, to be sure plugin.getPlugins...
Instance Variable module Undocumented
Instance Variable originalPath Undocumented
Instance Variable originalPlugin Undocumented
Instance Variable package Undocumented
Instance Variable root Undocumented
Instance Variable savedModules Undocumented
Method _clearCache Remove the plugins droping.cache file.
Method _unimportPythonModule Undocumented
Method _withCacheness This is a paranoid test wrapper, that calls meth 2 times, clear the cache, and calls it 2 other times. It's supposed to ensure that the plugin system behaves correctly no matter what the state of the cache is.

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method assertFailure Fail if deferred does not errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout 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 timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
Instance Variable timeout A real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
Method _deprecateReactor Deprecate iterate, crash and stop on reactor. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
Method _runFixturesAndTest Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

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

Inherited from _Assertions (via TestCase, SynchronousTestCase):

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

Save sys.path and sys.modules, and create a package for tests.

def tearDown(self): (source)

Restore sys.path and sys.modules to their original values.

@_withCacheness
def test_cache(self): (source)

Check that the cache returned by plugin.getCache hold the plugin testplugin, and that this plugin has the properties we expect: provide TestPlugin, has the good name and description, and can be loaded successfully.

def test_cacheRepr(self): (source)

CachedPlugin has a helpful repr which contains relevant information about it.

def test_deployedMode(self): (source)

The dropin.cache file may not be writable: the cache should still be attainable, but an error should be logged to show that the cache couldn't be updated.

@_withCacheness
def test_detectFilesChanged(self): (source)

Check that if the content of a plugin change, plugin.getPlugins is able to detect the new plugins added.

@_withCacheness
def test_detectFilesRemoved(self): (source)

Check that when a dropin file is removed, plugin.getPlugins doesn't return it anymore.

@_withCacheness
def test_detectNewFiles(self): (source)

Check that plugin.getPlugins is able to detect plugins added at runtime.

@_withCacheness
def test_nonDirectoryChildEntry(self): (source)

Test that getCache skips over any entries in a plugin package's __path__ which refer to children of paths which are not directories.

@_withCacheness
def test_nonexistentPathEntry(self): (source)

Test that getCache skips over any entries in a plugin package's __path__ which do not exist.

@_withCacheness
def test_plugins(self): (source)

plugin.getPlugins should return the list of plugins matching the specified interface (here, ITestPlugin2), and these plugins should be instances of classes with a test method, to be sure plugin.getPlugins load classes correctly.

module = (source)

Undocumented

originalPath = (source)

Undocumented

originalPlugin: str = (source)

Undocumented

package = (source)

Undocumented

root = (source)

Undocumented

savedModules = (source)

Undocumented

def _clearCache(self): (source)

Remove the plugins droping.cache file.

def _unimportPythonModule(self, module, deleteSource=False): (source)

Undocumented

def _withCacheness(meth): (source)

This is a paranoid test wrapper, that calls meth 2 times, clear the cache, and calls it 2 other times. It's supposed to ensure that the plugin system behaves correctly no matter what the state of the cache is.

Parameters
meth:CallableUndocumented