b.t.t.TestDoWithCleanups(CleanupsTestCase) : class documentation

Part of bzrlib.tests.test_cleanup View In Hierarchy

No class docstring
Method trivial_func Undocumented
Method test_runs_func _do_with_cleanups runs the function it is given, and returns the
Method test_runs_cleanups Cleanup functions are run (in the given order).
Method failing_func Undocumented
Method test_func_error_propagates Errors from the main function are propagated (after running
Method test_func_error_trumps_cleanup_error Errors from the main function a propagated even if a cleanup raises
Method test_func_passes_and_error_from_cleanup An error from a cleanup is propagated when the main function doesn't
Method test_multiple_cleanup_failures When multiple cleanups fail (as tends to happen when something has
Method make_two_failing_cleanup_funcs Undocumented
Method test_multiple_cleanup_failures_debug_flag Undocumented
Method test_func_and_cleanup_errors_debug_flag Undocumented
Method test_func_may_mutate_cleanups The main func may mutate the cleanups before it returns.
Method test_cleanup_error_debug_flag The -Dcleanup debug flag causes cleanup errors to be reported to the

Inherited from CleanupsTestCase:

Method setUp Undocumented
Method no_op_cleanup Undocumented
Method assertLogContains Undocumented
Method failing_cleanup Undocumented

Inherited from TestCase (via CleanupsTestCase):

Method __init__ Undocumented
Method debug Undocumented
Method discardDetail Extend the addDetail, getDetails api so we can remove a detail.
Method install_counter_hook Install a counting hook.
Method disable_directory_isolation Turn off directory isolation checks.
Method enable_directory_isolation Enable directory isolation checks.
Method permit_dir Permit a directory to be used by this test. See permit_url.
Method permit_url Declare that url is an ok url to use in this test.
Method permit_source_tree_branch_repo Permit the source tree bzr is running from to be opened.
Method record_directory_isolation Gather accessed directories to permit later access.
Method start_server Start transport_server for this test.
Method assertEqual Undocumented
Method assertEqualDiff Assert two texts are equal, if not raise an exception.
Method assertEqualMode Undocumented
Method assertEqualStat assert that expected and actual are the same stat result.
Method assertLength Assert that obj_with_len is of length length.
Method assertLogsError Assert that func(*args, **kwargs) quietly logs a specific error.
Method assertPositive Assert that val is greater than 0.
Method assertNegative Assert that val is less than 0.
Method assertStartsWith Undocumented
Method assertEndsWith Asserts that s ends with suffix.
Method assertContainsRe Assert that a contains something matching a regular expression.
Method assertNotContainsRe Assert that a does not match a regular expression
Method assertContainsString Undocumented
Method assertNotContainsString Undocumented
Method assertSubset Assert that every entry in sublist is present in superlist.
Method assertListRaises Fail unless excClass is raised when the iterator from func is used.
Method assertRaises Assert that a callable raises a particular exception.
Method assertIs Undocumented
Method assertIsNot Undocumented
Method assertTransportMode Fail if a path does not have mode "mode".
Method assertIsSameRealPath Fail if path1 and path2 points to different files
Method assertIsInstance Fail if obj is not an instance of kls
Method assertFileEqual Fail if path does not contain 'content'.
Method assertDocstring Fail if obj does not have expected_docstring
Method failUnlessExists Undocumented
Method assertPathExists Fail unless path or paths, which may be abs or relative, exist.
Method failIfExists Undocumented
Method assertPathDoesNotExist Fail if path or paths, which may be abs or relative, exist.
Method applyDeprecated Call a deprecated callable without warning the user.
Method callCatchWarnings Call a callable that raises python warnings.
Method callDeprecated Assert that a callable is deprecated in a particular way.
Method thisFailsStrictLockCheck It is known that this test would fail with -Dstrict_locks.
Method overrideAttr Overrides an object attribute restoring it after the test.
Method overrideEnv Set an environment variable, and reset it after the test.
Method recordCalls Monkeypatch in a wrapper that will record calls.
Method knownFailure Declare that this test fails for a known reason
Method time Run callable and accrue the time it takes to the benchmark time.
Method log Undocumented
Method get_log Get a unicode string containing the log from bzrlib.trace.
Method requireFeature This test requires a specific feature is available.
Method run_bzr Invoke bzr, as if it were run from the command line.
Method run_bzr_error Run bzr, and check that stderr contains the supplied regexes
Method run_bzr_subprocess Run bzr in a subprocess for testing.
Method start_bzr_subprocess Start bzr in a subprocess for testing.
Method get_source_path Return the path of the directory containing bzrlib.
Method get_bzr_path Return the path of the 'bzr' executable for this test suite.
Method finish_bzr_subprocess Finish the execution of process.
Method check_tree_shape Compare a tree to a list of expected names.
Method apply_redirected Call callable with redirected std io pipes.
Method reduceLockdirTimeout Reduce the default lock timeout for the duration of the test, so that
Method make_utf8_encoded_stringio Return a StringIOWrapper instance, that will encode Unicode
Method disable_verb Disable a smart server verb for one test.
Method _install_config_stats_hooks Install config hooks to count hook calls.
Method _clear_debug_flags Prevent externally set debug flags affecting tests.
Method _clear_hooks Undocumented
Method _silenceUI Turn off UI for duration of test
Method _check_locks Check that all lock take/release actions have been paired.
Method _track_locks Track lock activity during tests.
Method _lock_acquired Undocumented
Method _lock_released Undocumented
Method _lock_broken Undocumented
Method _preopen_isolate_transport Check that all transport openings are done in the test work area.
Method _preopen_isolate_url Undocumented
Method _track_transports Install checks for transport usage.
Method _ndiff_strings Return ndiff between two strings containing lines.
Method _capture_deprecation_warnings A helper for callDeprecated and applyDeprecated.
Method _startLogFile Setup a in-memory target for bzr and testcase log messages
Method _finishLogFile Flush and dereference the in-memory log for this testcase
Method _cleanEnvironment Undocumented
Method _restoreHooks Undocumented
Method _suppress_log Remove the log info from details.
Method _do_skip Undocumented
Static Method _do_known_failure Undocumented
Static Method _do_not_applicable Undocumented
Static Method _report_skip Override the default _report_skip.
Static Method _report_expected_failure Strip the log.
Static Method _do_unsupported_or_skip Undocumented
Method _run_bzr_autosplit Run bazaar command line, splitting up a string command line.
Method _run_bzr_core Undocumented
Method _add_subprocess_log Undocumented
Method _subprocess_log_cleanup Undocumented
Method _popen Place a call to Popen.
def trivial_func(self):
Undocumented
def test_runs_func(self):
_do_with_cleanups runs the function it is given, and returns the result.
def test_runs_cleanups(self):
Cleanup functions are run (in the given order).
def failing_func(self):
Undocumented
def test_func_error_propagates(self):
Errors from the main function are propagated (after running cleanups).
def test_func_error_trumps_cleanup_error(self):
Errors from the main function a propagated even if a cleanup raises an error.

The cleanup error is be logged.

def test_func_passes_and_error_from_cleanup(self):
An error from a cleanup is propagated when the main function doesn't raise an error. Later cleanups are still executed.
def test_multiple_cleanup_failures(self):
When multiple cleanups fail (as tends to happen when something has gone wrong), the first error is propagated, and subsequent errors are logged.
def make_two_failing_cleanup_funcs(self):
Undocumented
def test_multiple_cleanup_failures_debug_flag(self):
Undocumented
def test_func_and_cleanup_errors_debug_flag(self):
Undocumented
def test_func_may_mutate_cleanups(self):
The main func may mutate the cleanups before it returns.

This allows a function to gradually add cleanups as it acquires resources, rather than planning all the cleanups up-front. The OperationWithCleanups helper relies on this working.

def test_cleanup_error_debug_flag(self):
The -Dcleanup debug flag causes cleanup errors to be reported to the user.
API Documentation for Bazaar, generated by pydoctor at 2019-07-21 00:34:56.