b.t.TestCaseInTempDir(TestCaseWithMemoryTransport) : class documentation

Part of bzrlib.tests View In Hierarchy

Known subclasses: bzrlib.plugins.launchpad.test_account.LaunchpadAccountTests, bzrlib.plugins.launchpad.test_lp_directory.DirectoryUrlTests, bzrlib.plugins.launchpad.test_lp_directory.LocalDirectoryURLTests, bzrlib.plugins.launchpad.test_lp_directory.TestDebuntuExpansions, bzrlib.plugins.launchpad.test_register.TestGatherUserCredentials, bzrlib.plugins.netrc_credential_store.tests.test_netrc.TestNetrcCS, bzrlib.plugins.netrc_credential_store.tests.test_netrc.TestNetrcCSNoNetrc, bzrlib.tests.blackbox.test_debug.TestDebugOption, bzrlib.tests.blackbox.test_exceptions.TestExceptionReporting, bzrlib.tests.blackbox.test_log.TestLogEncodings, bzrlib.tests.blackbox.test_lsprof.TestLSProf, bzrlib.tests.blackbox.test_re_sign.ReSign, bzrlib.tests.blackbox.test_script.TestTestScript, bzrlib.tests.blackbox.test_shared_repository.TestSharedRepo, bzrlib.tests.blackbox.test_version.TestVersionBzrLogLocation, bzrlib.tests.blackbox.test_version.TestVersionUnicodeOutput, bzrlib.tests.commands.test_revert.TestRevert, bzrlib.tests.doc_generate.TestSphinx, bzrlib.tests.test__walkdirs_win32.TestWin32Finder, bzrlib.tests.test_atomicfile.TestAtomicFile, bzrlib.tests.test_clean_tree.TestCleanTree, bzrlib.tests.test_commands.TestInsideCommand, bzrlib.tests.test_config.TestAuthenticationStorage, bzrlib.tests.test_config.TestBranchConfigItems, bzrlib.tests.test_config.TestGlobalConfigItems, bzrlib.tests.test_config.TestGlobalConfigSavingOptions, bzrlib.tests.test_config.TestIniBaseConfigOnDisk, bzrlib.tests.test_config.TestIniConfig, bzrlib.tests.test_config.TestIniConfigOptionExpansionDefaultValue, bzrlib.tests.test_config.TestIniConfigSaving, bzrlib.tests.test_config.TestLocationConfig, bzrlib.tests.test_config.TestLocationConfigOptionExpansion, bzrlib.tests.test_config.TestLockableConfig, bzrlib.tests.test_config.TestXDGConfigDir, bzrlib.tests.test_crash.TestApportReporting, bzrlib.tests.test_debug.TestDebugFlags, bzrlib.tests.test_diff.TestDiffFiles, bzrlib.tests.test_diff.TestPatienceDiffLibFiles, bzrlib.tests.test_dirstate.TestSHA1Provider, bzrlib.tests.test_filters.TestFilteredSha, bzrlib.tests.test_hashcache.TestHashCache, bzrlib.tests.test_hashcache.TestHashCacheFakeFilesystem, bzrlib.tests.test_https_ca_bundle.TestGetCAPath, bzrlib.tests.test_ignores.TestUserIgnores, bzrlib.tests.test_lazy_import.ImportReplacerHelper, bzrlib.tests.test_lock.TestOSLock, bzrlib.tests.test_lockable_files.TestLockableFiles_LockDir, bzrlib.tests.test_lockable_files.TestLockableFiles_TransportLock, bzrlib.tests.test_lsprof.TestStatsSave, bzrlib.tests.test_mergetools.TestCheckAvailability, bzrlib.tests.test_mergetools.TestFilenameSubstitution, bzrlib.tests.test_mergetools.TestInvoke, bzrlib.tests.test_msgeditor.TestPlatformErrnoWorkarounds, bzrlib.tests.test_multiparent.TestMultiVersionedFile, bzrlib.tests.test_osutils.TestCanonicalRelPath, bzrlib.tests.test_osutils.TestCopyTree, bzrlib.tests.test_osutils.TestCreationOps, bzrlib.tests.test_osutils.TestDeleteAny, bzrlib.tests.test_osutils.TestDirReader, bzrlib.tests.test_osutils.TestKind, bzrlib.tests.test_osutils.TestLinks, bzrlib.tests.test_osutils.TestLstat, bzrlib.tests.test_osutils.TestMacFuncsDirs, bzrlib.tests.test_osutils.TestParentDirectories, bzrlib.tests.test_osutils.TestReadLink, bzrlib.tests.test_osutils.TestRename, bzrlib.tests.test_osutils.TestResourceLoading, bzrlib.tests.test_osutils.TestRmTree, bzrlib.tests.test_osutils.TestShaFileByName, bzrlib.tests.test_osutils.TestSizeShaFile, bzrlib.tests.test_osutils.TestUmask, bzrlib.tests.test_osutils.TestWalkDirs, bzrlib.tests.test_osutils.TestWin32FuncsDirs, bzrlib.tests.test_patch.TestPatch, bzrlib.tests.test_plugins.BaseTestPlugins, bzrlib.tests.test_plugins.TestLoadFromPath, bzrlib.tests.test_plugins.TestPluginHelp, bzrlib.tests.test_registry.TestRegistryWithDirs, bzrlib.tests.test_remote.TestRemoteSSHTransportAuthentication, bzrlib.tests.test_sampler.DemoTest, bzrlib.tests.test_selftest.TestLoadTestIdList, bzrlib.tests.test_selftest.TestSelftestWithIdList, bzrlib.tests.test_selftest.TestTestCaseInTempDir, bzrlib.tests.test_selftest.TestTreeShape, bzrlib.tests.test_smtp_connection.TestSMTPConnection, bzrlib.tests.test_store.TestCompressedTextStore, bzrlib.tests.test_store.TestMixedTextStore, bzrlib.tests.test_store.TestTextStore, bzrlib.tests.test_textfile.TextPath, bzrlib.tests.test_trace.TestBzrLog, bzrlib.tests.test_trace.TestTraceConfiguration, bzrlib.tests.test_transform.TestTransformMerge, bzrlib.tests.test_transport.FakeNFSDecoratorTests, bzrlib.tests.test_transport.FakeVFATDecoratorTests, bzrlib.tests.test_transport.TestTransportFromPath, bzrlib.tests.test_transport.TestTransportFromUrl, bzrlib.tests.test_transport.TestTransportImplementation, bzrlib.tests.test_urlutils.TestCwdToURL, bzrlib.tests.test_weave.TestWeaveFile, bzrlib.tests.test_win32utils.Test_CommandLineToArgv, bzrlib.tests.test_win32utils.TestSetHidden, bzrlib.tests.test_win32utils.TestWin32UtilsGlobExpand, bzrlib.tests.TestCaseWithTransport

Derived class that runs a test within a temporary directory.

This is useful for tests that need to create a branch, etc.

The directory is created in a slightly complex way: for each
Python invocation, a new temporary top-level directory is created.
All test cases create their own directory within that.  If the
tests complete successfully, the directory is removed.

:ivar test_base_dir: The path of the top-level directory for this
test, which contains a home directory and a work directory.

:ivar test_home_dir: An initially empty directory under test_base_dir
which is used as $HOME for this test.

:ivar test_dir: A directory under test_base_dir used as the current
directory when the test proper is run.
Method setUp Undocumented
Method check_file_contents Undocumented
Method makeAndChdirToTestDir See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
Method deleteTestDir Undocumented
Method build_tree Build a test tree according to a pattern.
Method assertInWorkingTree Assert whether path or paths are in the WorkingTree
Method assertNotInWorkingTree Assert whether path or paths are not in the WorkingTree
Method _getTestDirPrefix Undocumented

Inherited from TestCaseWithMemoryTransport:

Method __init__ Undocumented
Method get_transport Return a writeable transport.
Method get_readonly_transport Return a readonly transport for the test scratch space
Method create_transport_readonly_server Create a transport server from class defined at init.
Method get_readonly_server Get the server instance for the readonly transport
Method get_readonly_url Get a URL for the readonly transport.
Method get_vfs_only_server Get the vfs only read/write server instance.
Method get_server Get the read/write server instance.
Method get_url Get a URL (or maybe a path) for the readwrite transport.
Method get_vfs_only_url Get a URL (or maybe a path for the plain old vfs transport.
Method make_branch Create a branch on the transport at relpath.
Method get_default_format Undocumented
Method resolve_format Resolve an object to a ControlDir format object.
Method make_bzrdir Undocumented
Method make_repository Create a repository on our default transport at relpath.
Method make_smart_server Undocumented
Method make_branch_and_memory_tree Create a branch on the default transport and a MemoryTree for it.
Method make_branch_builder Undocumented
Method overrideEnvironmentForTesting Undocumented
Method setup_smart_server_with_call_log Sets up a smart server as the transport server with a call log.
Method reset_smart_call_log Undocumented
Method _adjust_url Get a URL (or maybe a path) for the readwrite transport.
Method _create_safety_net Make a fake bzr directory.
Method _check_safety_net Check that the safety .bzr directory have not been touched.
Method _make_test_root Undocumented

Inherited from TestCase (via TestCaseWithMemoryTransport):

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 setUp(self):
Undocumented
def check_file_contents(self, filename, expect):
Undocumented
def _getTestDirPrefix(self):
Undocumented
def makeAndChdirToTestDir(self):
See TestCaseWithMemoryTransport.makeAndChdirToTestDir().

For TestCaseInTempDir we create a temporary directory based on the test name and then create two subdirs - test and home under it.

def deleteTestDir(self):
Undocumented
def build_tree(self, shape, line_endings='binary', transport=None):
Build a test tree according to a pattern.

shape is a sequence of file specifications. If the final character is '/', a directory is created.

This assumes that all the elements in the tree being built are new.

This doesn't add anything to a branch.

Parametersshape (type: list or tuple.)
line_endingsEither 'binary' or 'native' in binary mode, exact contents are written in native mode, the line endings match the default platform endings.
transportA transport to write to, for building trees on VFS's. If the transport is readonly or None, "." is opened automatically.
ReturnsNone
def assertInWorkingTree(self, path, root_path='.', tree=None):
Assert whether path or paths are in the WorkingTree
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
Assert whether path or paths are not in the WorkingTree
API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.