def preview_tree_post(testcase, tree):
basis = tree.basis_tree()
tt = TransformPreview(basis)
testcase.addCleanup(tt.finalize)
tree.lock_read()
testcase.addCleanup(tree.unlock)
pp = None
transform._prepare_revert_transform(basis, tree, tt, None, False, None,
basis, {})
preview_tree = tt.get_preview_tree()
preview_tree.set_parent_ids(tree.get_parent_ids())
return preview_tree
def preview_tree_post(testcase, tree):
basis = tree.basis_tree()
tt = TransformPreview(basis)
testcase.addCleanup(tt.finalize)
tree.lock_read()
testcase.addCleanup(tree.unlock)
pp = None
transform._prepare_revert_transform(basis, tree, tt, None, False, None,
basis, {})
preview_tree = tt.get_preview_tree()
preview_tree.set_parent_ids(tree.get_parent_ids())
return preview_tree
def __init__(self, db_branch, committer=None, no_race_check=False, merge_parents=None, committer_id=None):
"""Create context for direct commit to branch.
Before constructing a `DirectBranchCommit`, set up a server that
allows write access to lp-internal:/// URLs:
bzrserver = get_rw_server()
bzrserver.start_server()
try:
branchcommit = DirectBranchCommit(branch)
# ...
finally:
bzrserver.stop_server()
Or in tests, just call `useBzrBranches` before creating a
`DirectBranchCommit`.
:param db_branch: a Launchpad `Branch` object.
:param committer: the `Person` writing to the branch. Defaults to
the branch owner.
:param no_race_check: don't check for other commits before committing
our changes, for use in tests.
:param committer_id: Optional identification (typically with email
address) of the person doing the commit, for use in bzr. If not
given, the `committer`'s email address will be used instead.
"""
self.db_branch = db_branch
self.last_scanned_id = self.db_branch.last_scanned_id
if committer is None:
committer = db_branch.owner
self.committer = committer
self.committer_id = committer_id
self.no_race_check = no_race_check
# Directories we create on the branch, and their ids.
self.path_ids = {}
self.bzrbranch = self.db_branch.getBzrBranch()
self.bzrbranch.lock_write()
self.is_locked = True
try:
self.revision_tree = self.bzrbranch.basis_tree()
self.transform_preview = TransformPreview(self.revision_tree)
assert self.transform_preview.find_conflicts() == [], "TransformPreview is not in a consistent state."
if not no_race_check:
last_revision = self.bzrbranch.last_revision()
if not self._matchingLastMirrored(last_revision):
raise StaleLastMirrored(db_branch, get_branch_info(self.bzrbranch))
self.is_open = True
except:
self.unlock()
raise
self.files = set()
self.merge_parents = merge_parents
def preview_tree_pre(testcase, tree):
tt = TransformPreview(tree)
testcase.addCleanup(tt.finalize)
preview_tree = tt.get_preview_tree()
preview_tree.set_parent_ids(tree.get_parent_ids())
return preview_tree
def __init__(self, db_branch, committer=None, no_race_check=False,
merge_parents=None, committer_id=None):
"""Create context for direct commit to branch.
Before constructing a `DirectBranchCommit`, set up a server that
allows write access to lp-internal:/// URLs:
bzrserver = get_rw_server()
bzrserver.start_server()
try:
branchcommit = DirectBranchCommit(branch)
# ...
finally:
bzrserver.stop_server()
Or in tests, just call `useBzrBranches` before creating a
`DirectBranchCommit`.
:param db_branch: a Launchpad `Branch` object.
:param committer: the `Person` writing to the branch. Defaults to
the branch owner.
:param no_race_check: don't check for other commits before committing
our changes, for use in tests.
:param committer_id: Optional identification (typically with email
address) of the person doing the commit, for use in bzr. If not
given, the `committer`'s email address will be used instead.
"""
self.db_branch = db_branch
self.last_scanned_id = self.db_branch.last_scanned_id
if committer is None:
committer = db_branch.owner
self.committer = committer
self.committer_id = committer_id
self.no_race_check = no_race_check
# Directories we create on the branch, and their ids.
self.path_ids = {}
self.bzrbranch = self.db_branch.getBzrBranch()
self.bzrbranch.lock_write()
self.is_locked = True
try:
self.revision_tree = self.bzrbranch.basis_tree()
self.transform_preview = TransformPreview(self.revision_tree)
assert self.transform_preview.find_conflicts() == [], (
"TransformPreview is not in a consistent state.")
if not no_race_check:
last_revision = self.bzrbranch.last_revision()
if not self._matchingLastMirrored(last_revision):
raise StaleLastMirrored(
db_branch, get_branch_info(self.bzrbranch))
self.is_open = True
except:
self.unlock()
raise
self.files = set()
self.merge_parents = merge_parents
class DirectBranchCommit:
"""Commit a set of files straight into a branch.
Use this to write a set of files into a branch efficiently, without
caring what was in there before. The files may be new to the branch
or they may exist there already; in the latter case they will be
overwritten.
The branch is write-locked for the entire lifetime of this object.
Be sure to call unlock() when done. This will be done for you as
part of a successful commit, but unlocking more than once will do no
harm.
The trick for this was invented by Aaron Bentley. It saves having
to do a full checkout of the branch.
"""
is_open = False
is_locked = False
commit_builder = None
def __init__(self, db_branch, committer=None, no_race_check=False,
merge_parents=None, committer_id=None):
"""Create context for direct commit to branch.
Before constructing a `DirectBranchCommit`, set up a server that
allows write access to lp-internal:/// URLs:
bzrserver = get_rw_server()
bzrserver.start_server()
try:
branchcommit = DirectBranchCommit(branch)
# ...
finally:
bzrserver.stop_server()
Or in tests, just call `useBzrBranches` before creating a
`DirectBranchCommit`.
:param db_branch: a Launchpad `Branch` object.
:param committer: the `Person` writing to the branch. Defaults to
the branch owner.
:param no_race_check: don't check for other commits before committing
our changes, for use in tests.
:param committer_id: Optional identification (typically with email
address) of the person doing the commit, for use in bzr. If not
given, the `committer`'s email address will be used instead.
"""
self.db_branch = db_branch
self.last_scanned_id = self.db_branch.last_scanned_id
if committer is None:
committer = db_branch.owner
self.committer = committer
self.committer_id = committer_id
self.no_race_check = no_race_check
# Directories we create on the branch, and their ids.
self.path_ids = {}
self.bzrbranch = self.db_branch.getBzrBranch()
self.bzrbranch.lock_write()
self.is_locked = True
try:
self.revision_tree = self.bzrbranch.basis_tree()
self.transform_preview = TransformPreview(self.revision_tree)
assert self.transform_preview.find_conflicts() == [], (
"TransformPreview is not in a consistent state.")
if not no_race_check:
last_revision = self.bzrbranch.last_revision()
if not self._matchingLastMirrored(last_revision):
raise StaleLastMirrored(
db_branch, get_branch_info(self.bzrbranch))
self.is_open = True
except:
self.unlock()
raise
self.files = set()
self.merge_parents = merge_parents
def _matchingLastMirrored(self, revision_id):
if (self.db_branch.last_mirrored_id is None
and revision_id == NULL_REVISION):
return True
return revision_id == self.db_branch.last_mirrored_id
def _getDir(self, path):
"""Get trans_id for directory "path." Create if necessary."""
path_id = self.path_ids.get(path)
if path_id:
# This is a path we've just created in the branch.
return path_id
if self.revision_tree.path2id(path):
# This is a path that was already in the branch.
return self.transform_preview.trans_id_tree_path(path)
# Look up (or create) parent directory.
parent_dir, dirname = os.path.split(path)
if dirname:
parent_id = self._getDir(parent_dir)
else:
parent_id = ROOT_PARENT
# Create new directory.
dirfile_id = gen_file_id(path)
path_id = self.transform_preview.new_directory(
dirname, parent_id, dirfile_id)
self.path_ids[path] = path_id
return path_id
def writeFile(self, path, contents):
"""Write file to branch; may be an update or a new file.
If you write a file multiple times, the first one is used and
the rest ignored.
"""
assert self.is_open, "Writing file to closed DirectBranchCommit."
if path in self.files:
# We already have this file. Ignore second write.
return
file_id = self.revision_tree.path2id(path)
if file_id is None:
parent_path, name = os.path.split(path)
parent_id = self._getDir(parent_path)
file_id = gen_file_id(name)
self.transform_preview.new_file(
name, parent_id, [contents], file_id)
else:
trans_id = self.transform_preview.trans_id_tree_path(path)
# Delete old contents. It doesn't actually matter whether
# we do this before creating the new contents.
self.transform_preview.delete_contents(trans_id)
self.transform_preview.create_file([contents], trans_id)
self.files.add(path)
def _checkForRace(self):
"""Check if bzrbranch has any changes waiting to be scanned.
If it does, raise `ConcurrentUpdateError`.
"""
assert self.is_locked, "Getting revision on un-locked branch."
if self.no_race_check:
return
last_revision = self.bzrbranch.last_revision()
if last_revision != self.last_scanned_id:
raise ConcurrentUpdateError(
"Branch has been changed. Not committing.")
def getBzrCommitterID(self):
"""Find the committer id to pass to bzr."""
if self.committer_id is not None:
return self.committer_id
elif self.committer.preferredemail is not None:
return format_address_for_person(self.committer)
else:
return '"%s" <%s>' % (
self.committer.displayname,
config.canonical.noreply_from_address)
def commit(self, commit_message, txn=None):
"""Commit to branch.
:param commit_message: Message for branch's commit log.
:param txn: Transaction to commit. Can be helpful in avoiding
long idle times in database transactions. May be committed
more than once.
"""
assert self.is_open, "Committing closed DirectBranchCommit."
assert self.is_locked, "Not locked at commit time."
try:
self._checkForRace()
if txn:
txn.commit()
rev_id = self.revision_tree.get_revision_id()
if rev_id == NULL_REVISION:
if list(self.transform_preview.iter_changes()) == []:
return
committer_id = self.getBzrCommitterID()
# XXX: AaronBentley 2010-08-06 bug=614404: a bzr username is
# required to generate the revision-id.
with override_environ(BZR_EMAIL=committer_id):
new_rev_id = self.transform_preview.commit(
self.bzrbranch, commit_message, self.merge_parents,
committer=committer_id)
IMasterObject(self.db_branch).branchChanged(
get_stacked_on_url(self.bzrbranch), new_rev_id,
self.db_branch.control_format, self.db_branch.branch_format,
self.db_branch.repository_format)
if txn:
txn.commit()
finally:
self.unlock()
self.is_open = False
return new_rev_id
def unlock(self):
"""Release commit lock, if held."""
if self.is_locked:
self.transform_preview.finalize()
self.bzrbranch.unlock()
self.is_locked = False
class DirectBranchCommit:
"""Commit a set of files straight into a branch.
Use this to write a set of files into a branch efficiently, without
caring what was in there before. The files may be new to the branch
or they may exist there already; in the latter case they will be
overwritten.
The branch is write-locked for the entire lifetime of this object.
Be sure to call unlock() when done. This will be done for you as
part of a successful commit, but unlocking more than once will do no
harm.
The trick for this was invented by Aaron Bentley. It saves having
to do a full checkout of the branch.
"""
is_open = False
is_locked = False
commit_builder = None
def __init__(self, db_branch, committer=None, no_race_check=False, merge_parents=None, committer_id=None):
"""Create context for direct commit to branch.
Before constructing a `DirectBranchCommit`, set up a server that
allows write access to lp-internal:/// URLs:
bzrserver = get_rw_server()
bzrserver.start_server()
try:
branchcommit = DirectBranchCommit(branch)
# ...
finally:
bzrserver.stop_server()
Or in tests, just call `useBzrBranches` before creating a
`DirectBranchCommit`.
:param db_branch: a Launchpad `Branch` object.
:param committer: the `Person` writing to the branch. Defaults to
the branch owner.
:param no_race_check: don't check for other commits before committing
our changes, for use in tests.
:param committer_id: Optional identification (typically with email
address) of the person doing the commit, for use in bzr. If not
given, the `committer`'s email address will be used instead.
"""
self.db_branch = db_branch
self.last_scanned_id = self.db_branch.last_scanned_id
if committer is None:
committer = db_branch.owner
self.committer = committer
self.committer_id = committer_id
self.no_race_check = no_race_check
# Directories we create on the branch, and their ids.
self.path_ids = {}
self.bzrbranch = self.db_branch.getBzrBranch()
self.bzrbranch.lock_write()
self.is_locked = True
try:
self.revision_tree = self.bzrbranch.basis_tree()
self.transform_preview = TransformPreview(self.revision_tree)
assert self.transform_preview.find_conflicts() == [], "TransformPreview is not in a consistent state."
if not no_race_check:
last_revision = self.bzrbranch.last_revision()
if not self._matchingLastMirrored(last_revision):
raise StaleLastMirrored(db_branch, get_branch_info(self.bzrbranch))
self.is_open = True
except:
self.unlock()
raise
self.files = set()
self.merge_parents = merge_parents
def _matchingLastMirrored(self, revision_id):
if self.db_branch.last_mirrored_id is None and revision_id == NULL_REVISION:
return True
return revision_id == self.db_branch.last_mirrored_id
def _getDir(self, path):
"""Get trans_id for directory "path." Create if necessary."""
path_id = self.path_ids.get(path)
if path_id:
# This is a path we've just created in the branch.
return path_id
if self.revision_tree.path2id(path):
# This is a path that was already in the branch.
return self.transform_preview.trans_id_tree_path(path)
# Look up (or create) parent directory.
parent_dir, dirname = os.path.split(path)
if dirname:
parent_id = self._getDir(parent_dir)
else:
parent_id = ROOT_PARENT
# Create new directory.
dirfile_id = gen_file_id(path)
path_id = self.transform_preview.new_directory(dirname, parent_id, dirfile_id)
self.path_ids[path] = path_id
return path_id
def writeFile(self, path, contents):
"""Write file to branch; may be an update or a new file.
If you write a file multiple times, the first one is used and
the rest ignored.
"""
assert self.is_open, "Writing file to closed DirectBranchCommit."
if path in self.files:
# We already have this file. Ignore second write.
return
file_id = self.revision_tree.path2id(path)
if file_id is None:
parent_path, name = os.path.split(path)
parent_id = self._getDir(parent_path)
file_id = gen_file_id(name)
self.transform_preview.new_file(name, parent_id, [contents], file_id)
else:
trans_id = self.transform_preview.trans_id_tree_path(path)
# Delete old contents. It doesn't actually matter whether
# we do this before creating the new contents.
self.transform_preview.delete_contents(trans_id)
self.transform_preview.create_file([contents], trans_id)
self.files.add(path)
def _checkForRace(self):
"""Check if bzrbranch has any changes waiting to be scanned.
If it does, raise `ConcurrentUpdateError`.
"""
assert self.is_locked, "Getting revision on un-locked branch."
if self.no_race_check:
return
last_revision = self.bzrbranch.last_revision()
if last_revision != self.last_scanned_id:
raise ConcurrentUpdateError("Branch has been changed. Not committing.")
def getBzrCommitterID(self):
"""Find the committer id to pass to bzr."""
if self.committer_id is not None:
return self.committer_id
elif self.committer.preferredemail is not None:
return format_address_for_person(self.committer)
else:
return '"%s" <%s>' % (self.committer.displayname, config.canonical.noreply_from_address)
def commit(self, commit_message, txn=None):
"""Commit to branch.
:param commit_message: Message for branch's commit log.
:param txn: Transaction to commit. Can be helpful in avoiding
long idle times in database transactions. May be committed
more than once.
"""
assert self.is_open, "Committing closed DirectBranchCommit."
assert self.is_locked, "Not locked at commit time."
try:
self._checkForRace()
if txn:
txn.commit()
rev_id = self.revision_tree.get_revision_id()
if rev_id == NULL_REVISION:
if list(self.transform_preview.iter_changes()) == []:
return
committer_id = self.getBzrCommitterID()
# XXX: AaronBentley 2010-08-06 bug=614404: a bzr username is
# required to generate the revision-id.
with override_environ(BZR_EMAIL=committer_id):
new_rev_id = self.transform_preview.commit(
self.bzrbranch, commit_message, self.merge_parents, committer=committer_id
)
IMasterObject(self.db_branch).branchChanged(
get_stacked_on_url(self.bzrbranch),
new_rev_id,
self.db_branch.control_format,
self.db_branch.branch_format,
self.db_branch.repository_format,
)
if txn:
txn.commit()
finally:
self.unlock()
self.is_open = False
return new_rev_id
def unlock(self):
"""Release commit lock, if held."""
if self.is_locked:
self.transform_preview.finalize()
self.bzrbranch.unlock()
self.is_locked = False
def preview_tree_pre(testcase, tree):
tt = TransformPreview(tree)
testcase.addCleanup(tt.finalize)
preview_tree = tt.get_preview_tree()
preview_tree.set_parent_ids(tree.get_parent_ids())
return preview_tree
def mutable_trees_to_preview_trees(test_case, source, target):
preview = TransformPreview(target)
test_case.addCleanup(preview.finalize)
return source, preview.get_preview_tree()
def mutable_trees_to_preview_trees(test_case, source, target):
preview = TransformPreview(target)
test_case.addCleanup(preview.finalize)
return source, preview.get_preview_tree()
