twisted.logger.test.test_legacy.LegacyLogObserverWrapperTests(unittest.TestCase)
class documentationtwisted.logger.test.test_legacy
(View In Hierarchy)
Tests for LegacyLogObserverWrapper
.
Method | test_interface | LegacyLogObserverWrapper
is an ILogObserver . |
Method | test_repr | LegacyLogObserverWrapper
returns the expected string. |
Method | observe | Send an event to a wrapped legacy observer and capture the event as seen by that observer. |
Method | forwardAndVerify | Send an event to a wrapped legacy observer and verify that its data is preserved. |
Method | test_forward | Basic forwarding: event keys as observed by a legacy observer are the same. |
Method | test_time | The new-style "log_time" key is copied to the
old-style "time" key. |
Method | test_timeAlreadySet | The new-style "log_time" key does not step on a
pre-existing old-style "time" key. |
Method | test_system | The new-style "log_system" key is copied to the
old-style "system" key. |
Method | test_systemAlreadySet | The new-style "log_system" key does not step on a
pre-existing old-style "system" key. |
Method | test_noSystem | If the new-style "log_system" key is absent, the
old-style "system" key is set to
"-" . |
Method | test_levelNotChange | If explicitly set, the isError key will be preserved when
forwarding from a new-style logging emitter to a legacy logging observer,
regardless of log level. |
Method | test_pythonLogLevelNotSet | The new-style "log_level" key is not translated
to the old-style "logLevel" key. |
Method | test_stringPythonLogLevel | No summary |
Method | test_message | The old-style "message" key is added, even if no
new-style "log_format" is given, as it is required,
but may be empty. |
Method | test_messageAlreadySet | The old-style "message" key is not modified if it
already exists. |
Method | test_format | Formatting is translated such that text is rendered correctly, even though old-style logging doesn't use PEP 3101 formatting. |
Method | test_formatMessage | Using the message key, which is special in old-style, works for new-style formatting. |
Method | test_formatAlreadySet | Formatting is not altered if the old-style
"format" key already exists. |
Method | eventWithFailure | Create a new-style event with a captured failure. |
Method | test_failure | Captured failures in the new style set the old-style
"failure" , "isError" , and
"why" keys. |
Method | test_failureAlreadySet | Captured failures in the new style do not step on a pre-existing
old-style "failure" key. |
Method | test_isErrorAlreadySet | Captured failures in the new style do not step on a pre-existing
old-style "isError" key. |
Method | test_whyAlreadySet | Captured failures in the new style do not step on a pre-existing
old-style "failure" key. |
Inherited from TestCase:
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 | __init__ | Construct an asynchronous test case for methodName . |
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 | __call__ | Run the test. Should always do exactly the same thing as run(). |
Method | deferSetUp | Undocumented |
Method | deferTestMethod | Undocumented |
Method | deferTearDown | Undocumented |
Method | deferRunCleanups | Run any scheduled cleanups and report errors (if any to the result object. |
Method | addCleanup | Extend the base cleanup feature with support for cleanup functions which return Deferreds. |
Method | getSuppress | Undocumented |
Method | getTimeout | No summary |
Method | _run | Run a single method, either a test method or fixture. |
Method | _ebDeferSetUp | Undocumented |
Method | _cbDeferTestMethod | Undocumented |
Method | _ebDeferTestMethod | Undocumented |
Method | _ebDeferTearDown | Undocumented |
Method | _cbDeferRunCleanups | Undocumented |
Method | _cleanUp | Undocumented |
Method | _classCleanUp | Undocumented |
Method | _makeReactorMethod | Create a method which wraps the reactor method name . The
new method issues a deprecation warning and calls the original. |
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 | _undeprecateReactor | Restore the deprecated reactor methods. Undoes what _deprecateReactor
did. |
Method | _runCleanups | Run the cleanups added with addCleanup
in order. |
Method | _runFixturesAndTest | Really run setUp , the test method, and
tearDown . Any of these may return defer.Deferred s.
After they complete, do some reactor cleanup. |
Method | _wait | Take a Deferred that only ever callbacks. Block until it happens. |
Inherited from SynchronousTestCase (via TestCase):
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 | 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. |
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 . |
Method | __eq__ | No summary |
Method | __ne__ | Undocumented |
Method | __hash__ | Undocumented |
Method | shortDescription | Undocumented |
Method | getSkip | No summary |
Method | getTodo | No summary |
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 | run | Run the test case, storing the results in result . |
Method | patch | Monkey patch an object for the duration of the test. |
Method | flushLoggedErrors | Remove stored errors received from the log. |
Method | flushWarnings | Remove stored warnings from the list of captured warnings and return them. |
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 | mktemp | Create a new path name which can be used for a new file or directory. |
Method | _getSuppress | No summary |
Method | _getSkipReason | Return the reason to use for skipping a test method. |
Method | _installObserver | Undocumented |
Method | _removeObserver | Undocumented |
Inherited from _Assertions (via TestCase, SynchronousTestCase):
Method | fail | Absolutely fail the test. Do not pass go, do not collect $200. |
Method | assertFalse | Fail the test if condition evaluates to True. |
Method | assertTrue | Fail the test if condition evaluates to False. |
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 | assertEqual | Fail the test if first and second are not
equal. |
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 | assertIsNot | Fail the test if first is second . This is an
obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method | assertNotEqual | Fail the test if first == second . |
Method | assertIn | Fail the test if containee is not found in
container . |
Method | assertNotIn | Fail the test if containee is found in
container . |
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 | 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 | assertSubstring | Fail if substring does not exist within
astring . |
Method | assertNotSubstring | Fail if astring contains substring . |
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 | assertIsInstance | Fail if instance is not an instance of the given class or
of one of the given classes. |
Method | assertNotIsInstance | Fail if instance is an instance of the given class or of
one of the given classes. |
Method | successResultOf | Return the current success result of deferred or raise
self.failureException . |
Method | failureResultOf | Return the current failure result of deferred or raise
self.failureException . |
Method | assertNoResult | Assert that deferred does not have a result at this
point. |
Method | assertRegex | Fail the test if a regexp search of text
fails. |
Send an event to a wrapped legacy observer and capture the event as seen by that observer.
Parameters | event | an event (type: dict ) |
Returns | the event as observed by the legacy wrapper |
Send an event to a wrapped legacy observer and verify that its data is preserved.
Parameters | event | an event (type: dict ) |
Returns | the event as observed by the legacy wrapper |
The new-style "log_time"
key does not step on a
pre-existing old-style "time"
key.
The new-style "log_system"
key does not step on a
pre-existing old-style "system"
key.
If the new-style "log_system"
key is absent, the
old-style "system"
key is set to
"-"
.
If explicitly set, the isError
key will be preserved when
forwarding from a new-style logging emitter to a legacy logging observer,
regardless of log level.
The new-style "log_level"
key is not translated
to the old-style "logLevel"
key.
Events are forwarded from the old module from to new module and are then seen by old-style observers. We don't want to add unexpected keys to old-style events.
If a stdlib log level was provided as a string (eg.
"WARNING"
) in the legacy "logLevel" key,
it does not get converted to a number. The documentation suggested that
numerical values should be used but this was not a requirement.
The old-style "message"
key is added, even if no
new-style "log_format"
is given, as it is required,
but may be empty.
Formatting is translated such that text is rendered correctly, even though old-style logging doesn't use PEP 3101 formatting.
Using the message key, which is special in old-style, works for new-style formatting.
Formatting is not altered if the old-style
"format"
key already exists.
Captured failures in the new style set the old-style
"failure"
, "isError"
, and
"why"
keys.
Captured failures in the new style do not step on a pre-existing
old-style "failure"
key.