twisted.application.twist.test.test

Tests for TwistOptions.

Method	patchExit	Patch `_twist.exit` so we can capture usage and prevent actual exits.
Method	patchOpen	Patch `_options.open` so we can capture usage and prevent actual opens.
Method	patchInstallReactor	Patch `_options.installReactor` so we can capture usage and prevent actual installs.
Method	test_synopsis	`TwistOptions.getSynopsis` appends arguments.
Method	test_version	`TwistOptions.opt_version` exits with `ExitStatus.EX_OK` and prints the version.
Method	test_reactor	`TwistOptions.installReactor` installs the chosen reactor and sets the reactor name.
Method	test_installCorrectReactor	`TwistOptions.installReactor` installs the chosen reactor after the command line options have been parsed.
Method	test_installReactorBogus	`TwistOptions.installReactor` raises UsageError if an unknown reactor is specified.
Method	test_installReactorDefault	`TwistOptions.installReactor` returns the currently installed reactor when the default reactor name is specified.
Method	test_logLevelValid	`TwistOptions.opt_log_level` sets the corresponding log level.
Method	test_logLevelInvalid	`TwistOptions.opt_log_level` with an invalid log level name raises UsageError.
Method	test_logFileStdout	`TwistOptions.opt_log_file` given `"-"` as a file name uses stdout.
Method	test_logFileStderr	`TwistOptions.opt_log_file` given `"+"` as a file name uses stderr.
Method	test_logFileNamed	`TwistOptions.opt_log_file` opens the given file name in append mode.
Method	test_logFileCantOpen	`TwistOptions.opt_log_file` exits with `ExitStatus.EX_IOERR` if unable to open the log file due to an `EnvironmentError`.
Method	test_logFormatText	`TwistOptions.opt_log_format` given `"text"` uses a `textFileLogObserver`.
Method	test_logFormatJSON	`TwistOptions.opt_log_format` given `"text"` uses a `textFileLogObserver`.
Method	test_logFormatInvalid	`TwistOptions.opt_log_format` given an invalid format name raises `UsageError`.
Method	test_selectDefaultLogObserverNoOverride	`TwistOptions.selectDefaultLogObserver` will not override an already selected observer.
Method	test_selectDefaultLogObserverDefaultWithTTY	`TwistOptions.selectDefaultLogObserver` will not override an already selected observer.
Method	test_selectDefaultLogObserverDefaultWithoutTTY	`TwistOptions.selectDefaultLogObserver` will not override an already selected observer.
Method	test_pluginsType	`TwistOptions.plugins` is a mapping of available plug-ins.
Method	test_pluginsIncludeWeb	`TwistOptions.plugins` includes a `"web"` plug-in. This is an attempt to verify that something we expect to be in the list is in there without enumerating all of the built-in plug-ins.
Method	test_subCommandsType	`TwistOptions.subCommands` is an iterable of tuples as expected by `twisted.python.usage.Options`.
Method	test_subCommandsIncludeWeb	`TwistOptions.subCommands` includes a sub-command for every plug-in.
Method	test_postOptionsNoSubCommand	`TwistOptions.postOptions` raises `UsageError` is it has no sub-command.
Method	_testLogFile	Set log file name and check the selected output stream.
Method	_testLogFormat	Set log file format and check the selected observer.

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.

def patchExit(self):

Patch _twist.exit so we can capture usage and prevent actual exits.

def patchOpen(self):

Patch _options.open so we can capture usage and prevent actual opens.

def patchInstallReactor(self):

Patch _options.installReactor so we can capture usage and prevent actual installs.

def test_synopsis(self):

TwistOptions.getSynopsis appends arguments.

def test_version(self):

TwistOptions.opt_version exits with ExitStatus.EX_OK and prints the version.

def test_reactor(self):

TwistOptions.installReactor installs the chosen reactor and sets the reactor name.

def test_installCorrectReactor(self):

TwistOptions.installReactor installs the chosen reactor after the command line options have been parsed.

def test_installReactorBogus(self):

TwistOptions.installReactor raises UsageError if an unknown reactor is specified.

def test_installReactorDefault(self):

TwistOptions.installReactor returns the currently installed reactor when the default reactor name is specified.

def test_logLevelValid(self):

TwistOptions.opt_log_level sets the corresponding log level.

def test_logLevelInvalid(self):

TwistOptions.opt_log_level with an invalid log level name raises UsageError.

def _testLogFile(self, name, expectedStream):

Set log file name and check the selected output stream.

Parameters	name	The name of the file.
	expectedStream	The expected stream.

def test_logFileStdout(self):

TwistOptions.opt_log_file given "-" as a file name uses stdout.

def test_logFileStderr(self):

TwistOptions.opt_log_file given "+" as a file name uses stderr.

def test_logFileNamed(self):

TwistOptions.opt_log_file opens the given file name in append mode.

def test_logFileCantOpen(self):

TwistOptions.opt_log_file exits with ExitStatus.EX_IOERR if unable to open the log file due to an EnvironmentError.

def _testLogFormat(self, format, expectedObserver):

Set log file format and check the selected observer.

Parameters	format	The format of the file.
	expectedObserver	The expected observer.

def test_logFormatText(self):

TwistOptions.opt_log_format given "text" uses a textFileLogObserver.

def test_logFormatJSON(self):

TwistOptions.opt_log_format given "text" uses a textFileLogObserver.

def test_logFormatInvalid(self):

TwistOptions.opt_log_format given an invalid format name raises UsageError.

def test_selectDefaultLogObserverNoOverride(self):

TwistOptions.selectDefaultLogObserver will not override an already selected observer.

def test_selectDefaultLogObserverDefaultWithTTY(self):

TwistOptions.selectDefaultLogObserver will not override an already selected observer.

def test_selectDefaultLogObserverDefaultWithoutTTY(self):

TwistOptions.selectDefaultLogObserver will not override an already selected observer.

def test_pluginsType(self):

TwistOptions.plugins is a mapping of available plug-ins.

def test_pluginsIncludeWeb(self):

TwistOptions.plugins includes a "web" plug-in. This is an attempt to verify that something we expect to be in the list is in there without enumerating all of the built-in plug-ins.

def test_subCommandsType(self):

TwistOptions.subCommands is an iterable of tuples as expected by twisted.python.usage.Options.

def test_subCommandsIncludeWeb(self):

TwistOptions.subCommands includes a sub-command for every plug-in.

def test_postOptionsNoSubCommand(self):

TwistOptions.postOptions raises UsageError is it has no sub-command.

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

twisted.application.twist.test.test_options.OptionsTests(twisted.trial.unittest.TestCase) class documentation

`twisted.application.twist.test.test_options.OptionsTests(twisted.trial.unittest.TestCase)` class documentation