twisted.test.test_twistd.AppLoggerTests

Tests for app.AppLogger.

Instance Variable	observers	list of observers installed during the tests. (type: `list`)
Method	setUp	Override `globaLogBeginner.beginLoggingTo` so that we can trace the observers installed in `self.observers`.
Method	tearDown	Remove all installed observers.
Method	test_start	`app.AppLogger.start` calls `globalLogBeginner.addObserver`, and then writes some messages about twistd and the reactor.
Method	test_startUsesApplicationLogObserver	When the `ILogObserver` component is available on the application, that object will be used as the log observer instead of constructing a new one.
Method	test_startUsesConfiguredLogObserver	No summary
Method	test_configuredLogObserverBeatsComponent	`--logger` takes precedence over a `ILogObserver` component set on Application.
Method	test_configuredLogObserverBeatsLegacyComponent	`--logger` takes precedence over a `LegacyILogObserver` component set on Application.
Method	test_loggerComponentBeatsLegacyLoggerComponent	A `ILogObserver` takes precedence over a `LegacyILogObserver` component set on Application.
Method	test_configuredLogObserverBeatsSyslog	`--logger` takes precedence over a `--syslog` command line argument.
Method	test_configuredLogObserverBeatsLogfile	`--logger` takes precedence over a `--logfile` command line argument.
Method	test_getLogObserverStdout	When logfile is empty or set to `-`, `app.AppLogger._getLogObserver` returns a log observer pointing at `sys.stdout`.
Method	test_getLogObserverFile	When passing the `logfile` option, `app.AppLogger._getLogObserver` returns a log observer pointing at the specified path.
Method	test_stop	`app.AppLogger.stop` removes the observer created in `start`, and reinitialize its `_observer` so that if `stop` is called several times it doesn't break.
Method	test_legacyObservers	`app.AppLogger` using a legacy logger observer still works, wrapping it in a compat shim.
Method	test_unmarkedObserversDeprecated	`app.AppLogger` using a logger observer which does not implement `ILogObserver` or `LegacyILogObserver` will be wrapped in a compat shim and raise a `DeprecationWarning`.
Method	_makeObserver	Make a new observer which captures all logs sent to it.
Method	_checkObserver	Ensure that initial `twistd` logs are written to logs.
Method	_setupConfiguredLogger	Set up an AppLogger which exercises the `logger` configuration option.

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.

observers =

list of observers installed during the tests. (type: list)

def setUp(self):

Override globaLogBeginner.beginLoggingTo so that we can trace the observers installed in self.observers.

def tearDown(self):

Remove all installed observers.

def _makeObserver(self):

Make a new observer which captures all logs sent to it.

Returns An observer that stores all logs sent to it. (type: Callable that implements ILogObserver.)

def _checkObserver(self, observer):

Ensure that initial C{twistd} logs are written to logs.

@param observer: The observer made by L{self._makeObserver).

def test_start(self):

app.AppLogger.start calls globalLogBeginner.addObserver, and then writes some messages about twistd and the reactor.

def test_startUsesApplicationLogObserver(self):

When the ILogObserver component is available on the application, that object will be used as the log observer instead of constructing a new one.

def _setupConfiguredLogger(self, application, extraLogArgs={}, appLogger=app.AppLogger):

Set up an AppLogger which exercises the logger configuration option.

Parameters	application	The `Application` object to pass to `app.AppLogger.start`. (type: `Componentized`)
	extraLogArgs	extra values to pass to AppLogger. (type: `dict`)
	appLogger	factory for `AppLogger` instances. (type: `AppLogger` class, or a subclass)
Returns	The logs accumulated by the log observer. (type: `list`)

def test_startUsesConfiguredLogObserver(self):

When the logger key is specified in the configuration dictionary (i.e., when --logger is passed to twistd), the initial log observer will be the log observer returned from the callable which the value refers to in FQPN form.

def test_configuredLogObserverBeatsComponent(self):

--logger takes precedence over a ILogObserver component set on Application.

def test_configuredLogObserverBeatsLegacyComponent(self):

--logger takes precedence over a LegacyILogObserver component set on Application.

def test_loggerComponentBeatsLegacyLoggerComponent(self):

A ILogObserver takes precedence over a LegacyILogObserver component set on Application.

def test_configuredLogObserverBeatsSyslog(self):

--logger takes precedence over a --syslog command line argument.

def test_configuredLogObserverBeatsLogfile(self):

--logger takes precedence over a --logfile command line argument.

def test_getLogObserverStdout(self):

When logfile is empty or set to -, app.AppLogger._getLogObserver returns a log observer pointing at sys.stdout.

def test_getLogObserverFile(self):

When passing the logfile option, app.AppLogger._getLogObserver returns a log observer pointing at the specified path.

def test_stop(self):

app.AppLogger.stop removes the observer created in start, and reinitialize its _observer so that if stop is called several times it doesn't break.

def test_legacyObservers(self):

app.AppLogger using a legacy logger observer still works, wrapping it in a compat shim.

def test_unmarkedObserversDeprecated(self):

app.AppLogger using a logger observer which does not implement ILogObserver or LegacyILogObserver will be wrapped in a compat shim and raise a DeprecationWarning.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.

twisted.test.test_twistd.AppLoggerTests(unittest.TestCase) class documentation

`twisted.test.test_twistd.AppLoggerTests(unittest.TestCase)` class documentation