1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
57
conflicts as _mod_conflicts,
74
from bzrlib.transport import get_transport
76
from bzrlib.workingtree_4 import WorkingTreeFormat4
79
from bzrlib import symbol_versioning
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
81
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
82
from bzrlib.lockable_files import LockableFiles, TransportLock
83
from bzrlib.lockdir import LockDir
84
import bzrlib.mutabletree
85
from bzrlib.mutabletree import needs_tree_write_lock
86
from bzrlib.osutils import (
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport.local import LocalTransport
100
from bzrlib.progress import DummyProgress, ProgressPhase
101
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
102
from bzrlib.rio import RioReader, rio_file, Stanza
103
from bzrlib.symbol_versioning import (deprecated_passed,
106
DEPRECATED_PARAMETER,
113
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
117
@deprecated_function(zero_thirteen)
118
def gen_file_id(name):
119
"""Return new file id for the basename 'name'.
121
Use bzrlib.generate_ids.gen_file_id() instead
123
return generate_ids.gen_file_id(name)
126
@deprecated_function(zero_thirteen)
128
"""Return a new tree-root file id.
130
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
132
return generate_ids.gen_root_id()
135
class TreeEntry(object):
136
"""An entry that implements the minimum interface used by commands.
138
This needs further inspection, it may be better to have
139
InventoryEntries without ids - though that seems wrong. For now,
140
this is a parallel hierarchy to InventoryEntry, and needs to become
141
one of several things: decorates to that hierarchy, children of, or
143
Another note is that these objects are currently only used when there is
144
no InventoryEntry available - i.e. for unversioned objects.
145
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
148
def __eq__(self, other):
149
# yes, this us ugly, TODO: best practice __eq__ style.
150
return (isinstance(other, TreeEntry)
151
and other.__class__ == self.__class__)
153
def kind_character(self):
157
class TreeDirectory(TreeEntry):
158
"""See TreeEntry. This is a directory in a working tree."""
160
def __eq__(self, other):
161
return (isinstance(other, TreeDirectory)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeFile(TreeEntry):
169
"""See TreeEntry. This is a regular file in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeFile)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class TreeLink(TreeEntry):
180
"""See TreeEntry. This is a symlink in a working tree."""
182
def __eq__(self, other):
183
return (isinstance(other, TreeLink)
184
and other.__class__ == self.__class__)
186
def kind_character(self):
190
class WorkingTree(bzrlib.mutabletree.MutableTree):
191
"""Working copy tree.
193
The inventory is held in the `Branch` working-inventory, and the
194
files are in a directory on disk.
196
It is possible for a `WorkingTree` to have a filename which is
197
not listed in the Inventory and vice versa.
200
def __init__(self, basedir='.',
201
branch=DEPRECATED_PARAMETER,
207
"""Construct a WorkingTree for basedir.
209
If the branch is not supplied, it is opened automatically.
210
If the branch is supplied, it must be the branch for this basedir.
211
(branch.base is not cross checked, because for remote branches that
212
would be meaningless).
214
self._format = _format
215
self.bzrdir = _bzrdir
217
# not created via open etc.
218
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
219
"Please use bzrdir.open_workingtree or WorkingTree.open().",
222
wt = WorkingTree.open(basedir)
223
self._branch = wt.branch
224
self.basedir = wt.basedir
225
self._control_files = wt._control_files
226
self._hashcache = wt._hashcache
227
self._set_inventory(wt._inventory, dirty=False)
228
self._format = wt._format
229
self.bzrdir = wt.bzrdir
230
assert isinstance(basedir, basestring), \
231
"base directory %r is not a string" % basedir
232
basedir = safe_unicode(basedir)
233
mutter("opening working tree %r", basedir)
234
if deprecated_passed(branch):
236
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
237
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
238
" WorkingTree.open().",
242
self._branch = branch
244
self._branch = self.bzrdir.open_branch()
245
self.basedir = realpath(basedir)
246
# if branch is at our basedir and is a format 6 or less
247
if isinstance(self._format, WorkingTreeFormat2):
248
# share control object
249
self._control_files = self.branch.control_files
251
# assume all other formats have their own control files.
252
assert isinstance(_control_files, LockableFiles), \
253
"_control_files must be a LockableFiles, not %r" \
255
self._control_files = _control_files
256
# update the whole cache up front and write to disk if anything changed;
257
# in the future we might want to do this more selectively
258
# two possible ways offer themselves : in self._unlock, write the cache
259
# if needed, or, when the cache sees a change, append it to the hash
260
# cache file, and have the parser take the most recent entry for a
262
wt_trans = self.bzrdir.get_workingtree_transport(None)
263
cache_filename = wt_trans.local_abspath('stat-cache')
264
self._hashcache = hashcache.HashCache(basedir, cache_filename,
265
self._control_files._file_mode)
268
# is this scan needed ? it makes things kinda slow.
275
if _inventory is None:
276
self._inventory_is_modified = False
277
self.read_working_inventory()
279
# the caller of __init__ has provided an inventory,
280
# we assume they know what they are doing - as its only
281
# the Format factory and creation methods that are
282
# permitted to do this.
283
self._set_inventory(_inventory, dirty=False)
286
fget=lambda self: self._branch,
287
doc="""The branch this WorkingTree is connected to.
289
This cannot be set - it is reflective of the actual disk structure
290
the working tree has been constructed from.
293
def break_lock(self):
294
"""Break a lock if one is present from another instance.
296
Uses the ui factory to ask for confirmation if the lock may be from
299
This will probe the repository for its lock as well.
301
self._control_files.break_lock()
302
self.branch.break_lock()
304
def _set_inventory(self, inv, dirty):
305
"""Set the internal cached inventory.
307
:param inv: The inventory to set.
308
:param dirty: A boolean indicating whether the inventory is the same
309
logical inventory as whats on disk. If True the inventory is not
310
the same and should be written to disk or data will be lost, if
311
False then the inventory is the same as that on disk and any
312
serialisation would be unneeded overhead.
314
assert inv.root is not None
315
self._inventory = inv
316
self._inventory_is_modified = dirty
319
def open(path=None, _unsupported=False):
320
"""Open an existing working tree at path.
324
path = os.path.getcwdu()
325
control = bzrdir.BzrDir.open(path, _unsupported)
326
return control.open_workingtree(_unsupported)
329
def open_containing(path=None):
330
"""Open an existing working tree which has its root about path.
332
This probes for a working tree at path and searches upwards from there.
334
Basically we keep looking up until we find the control directory or
335
run into /. If there isn't one, raises NotBranchError.
336
TODO: give this a new exception.
337
If there is one, it is returned, along with the unused portion of path.
339
:return: The WorkingTree that contains 'path', and the rest of path
342
path = osutils.getcwd()
343
control, relpath = bzrdir.BzrDir.open_containing(path)
345
return control.open_workingtree(), relpath
348
def open_downlevel(path=None):
349
"""Open an unsupported working tree.
351
Only intended for advanced situations like upgrading part of a bzrdir.
353
return WorkingTree.open(path, _unsupported=True)
356
"""Iterate through file_ids for this tree.
358
file_ids are in a WorkingTree if they are in the working inventory
359
and the working file exists.
361
inv = self._inventory
362
for path, ie in inv.iter_entries():
363
if osutils.lexists(self.abspath(path)):
367
return "<%s of %s>" % (self.__class__.__name__,
368
getattr(self, 'basedir', None))
370
def abspath(self, filename):
371
return pathjoin(self.basedir, filename)
373
def basis_tree(self):
374
"""Return RevisionTree for the current last revision.
376
If the left most parent is a ghost then the returned tree will be an
377
empty tree - one obtained by calling repository.revision_tree(None).
380
revision_id = self.get_parent_ids()[0]
382
# no parents, return an empty revision tree.
383
# in the future this should return the tree for
384
# 'empty:' - the implicit root empty tree.
385
return self.branch.repository.revision_tree(None)
387
return self.revision_tree(revision_id)
388
except errors.NoSuchRevision:
390
# No cached copy available, retrieve from the repository.
391
# FIXME? RBC 20060403 should we cache the inventory locally
394
return self.branch.repository.revision_tree(revision_id)
395
except errors.RevisionNotPresent:
396
# the basis tree *may* be a ghost or a low level error may have
397
# occured. If the revision is present, its a problem, if its not
399
if self.branch.repository.has_revision(revision_id):
401
# the basis tree is a ghost so return an empty tree.
402
return self.branch.repository.revision_tree(None)
405
@deprecated_method(zero_eight)
406
def create(branch, directory):
407
"""Create a workingtree for branch at directory.
409
If existing_directory already exists it must have a .bzr directory.
410
If it does not exist, it will be created.
412
This returns a new WorkingTree object for the new checkout.
414
TODO FIXME RBC 20060124 when we have checkout formats in place this
415
should accept an optional revisionid to checkout [and reject this if
416
checking out into the same dir as a pre-checkout-aware branch format.]
418
XXX: When BzrDir is present, these should be created through that
421
warnings.warn('delete WorkingTree.create', stacklevel=3)
422
transport = get_transport(directory)
423
if branch.bzrdir.root_transport.base == transport.base:
425
return branch.bzrdir.create_workingtree()
426
# different directory,
427
# create a branch reference
428
# and now a working tree.
429
raise NotImplementedError
432
@deprecated_method(zero_eight)
433
def create_standalone(directory):
434
"""Create a checkout and a branch and a repo at directory.
436
Directory must exist and be empty.
438
please use BzrDir.create_standalone_workingtree
440
return bzrdir.BzrDir.create_standalone_workingtree(directory)
442
def relpath(self, path):
443
"""Return the local path portion from a given path.
445
The path may be absolute or relative. If its a relative path it is
446
interpreted relative to the python current working directory.
448
return osutils.relpath(self.basedir, path)
450
def has_filename(self, filename):
451
return osutils.lexists(self.abspath(filename))
453
def get_file(self, file_id):
454
return self.get_file_byname(self.id2path(file_id))
456
def get_file_text(self, file_id):
457
return self.get_file(file_id).read()
459
def get_file_byname(self, filename):
460
return file(self.abspath(filename), 'rb')
462
def annotate_iter(self, file_id):
463
"""See Tree.annotate_iter
465
This implementation will use the basis tree implementation if possible.
466
Lines not in the basis are attributed to CURRENT_REVISION
468
If there are pending merges, lines added by those merges will be
469
incorrectly attributed to CURRENT_REVISION (but after committing, the
470
attribution will be correct).
472
basis = self.basis_tree()
473
changes = self._iter_changes(basis, True, [file_id]).next()
474
changed_content, kind = changes[2], changes[6]
475
if not changed_content:
476
return basis.annotate_iter(file_id)
480
if kind[0] != 'file':
483
old_lines = list(basis.annotate_iter(file_id))
485
for tree in self.branch.repository.revision_trees(
486
self.get_parent_ids()[1:]):
487
if file_id not in tree:
489
old.append(list(tree.annotate_iter(file_id)))
490
return annotate.reannotate(old, self.get_file(file_id).readlines(),
493
def get_parent_ids(self):
494
"""See Tree.get_parent_ids.
496
This implementation reads the pending merges list and last_revision
497
value and uses that to decide what the parents list should be.
499
last_rev = self._last_revision()
505
merges_file = self._control_files.get_utf8('pending-merges')
506
except errors.NoSuchFile:
509
for l in merges_file.readlines():
510
parents.append(l.rstrip('\n'))
514
def get_root_id(self):
515
"""Return the id of this trees root"""
516
return self._inventory.root.file_id
518
def _get_store_filename(self, file_id):
519
## XXX: badly named; this is not in the store at all
520
return self.abspath(self.id2path(file_id))
523
def clone(self, to_bzrdir, revision_id=None, basis=None):
524
"""Duplicate this working tree into to_bzr, including all state.
526
Specifically modified files are kept as modified, but
527
ignored and unknown files are discarded.
529
If you want to make a new line of development, see bzrdir.sprout()
532
If not None, the cloned tree will have its last revision set to
533
revision, and and difference between the source trees last revision
534
and this one merged in.
537
If not None, a closer copy of a tree which may have some files in
538
common, and which file content should be preferentially copied from.
540
# assumes the target bzr dir format is compatible.
541
result = self._format.initialize(to_bzrdir)
542
self.copy_content_into(result, revision_id)
546
def copy_content_into(self, tree, revision_id=None):
547
"""Copy the current content and user files of this tree into tree."""
548
tree.set_root_id(self.get_root_id())
549
if revision_id is None:
550
merge.transform_tree(tree, self)
552
# TODO now merge from tree.last_revision to revision (to preserve
553
# user local changes)
554
merge.transform_tree(tree, self)
555
tree.set_parent_ids([revision_id])
557
def id2abspath(self, file_id):
558
return self.abspath(self.id2path(file_id))
560
def has_id(self, file_id):
561
# files that have been deleted are excluded
562
inv = self._inventory
563
if not inv.has_id(file_id):
565
path = inv.id2path(file_id)
566
return osutils.lexists(self.abspath(path))
568
def has_or_had_id(self, file_id):
569
if file_id == self.inventory.root.file_id:
571
return self.inventory.has_id(file_id)
573
__contains__ = has_id
575
def get_file_size(self, file_id):
576
return os.path.getsize(self.id2abspath(file_id))
579
def get_file_sha1(self, file_id, path=None, stat_value=None):
581
path = self._inventory.id2path(file_id)
582
return self._hashcache.get_sha1(path, stat_value)
584
def get_file_mtime(self, file_id, path=None):
586
path = self._inventory.id2path(file_id)
587
return os.lstat(self.abspath(path)).st_mtime
589
if not supports_executable():
590
def is_executable(self, file_id, path=None):
591
return self._inventory[file_id].executable
593
def is_executable(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
596
mode = os.lstat(self.abspath(path)).st_mode
597
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
600
def _add(self, files, ids, kinds):
601
"""See MutableTree._add."""
602
# TODO: Re-adding a file that is removed in the working copy
603
# should probably put it back with the previous ID.
604
# the read and write working inventory should not occur in this
605
# function - they should be part of lock_write and unlock.
606
inv = self.read_working_inventory()
607
for f, file_id, kind in zip(files, ids, kinds):
608
assert kind is not None
610
inv.add_path(f, kind=kind)
612
inv.add_path(f, kind=kind, file_id=file_id)
613
self._write_inventory(inv)
615
@needs_tree_write_lock
616
def _gather_kinds(self, files, kinds):
617
"""See MutableTree._gather_kinds."""
618
for pos, f in enumerate(files):
619
if kinds[pos] is None:
620
fullpath = normpath(self.abspath(f))
622
kinds[pos] = file_kind(fullpath)
624
if e.errno == errno.ENOENT:
625
raise errors.NoSuchFile(fullpath)
628
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
629
"""Add revision_id as a parent.
631
This is equivalent to retrieving the current list of parent ids
632
and setting the list to its value plus revision_id.
634
:param revision_id: The revision id to add to the parent list. It may
635
be a ghost revision as long as its not the first parent to be added,
636
or the allow_leftmost_as_ghost parameter is set True.
637
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
639
parents = self.get_parent_ids() + [revision_id]
640
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
641
or allow_leftmost_as_ghost)
643
@needs_tree_write_lock
644
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
645
"""Add revision_id, tree tuple as a parent.
647
This is equivalent to retrieving the current list of parent trees
648
and setting the list to its value plus parent_tuple. See also
649
add_parent_tree_id - if you only have a parent id available it will be
650
simpler to use that api. If you have the parent already available, using
651
this api is preferred.
653
:param parent_tuple: The (revision id, tree) to add to the parent list.
654
If the revision_id is a ghost, pass None for the tree.
655
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
657
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
658
if len(parent_ids) > 1:
659
# the leftmost may have already been a ghost, preserve that if it
661
allow_leftmost_as_ghost = True
662
self.set_parent_ids(parent_ids,
663
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
665
@needs_tree_write_lock
666
def add_pending_merge(self, *revision_ids):
667
# TODO: Perhaps should check at this point that the
668
# history of the revision is actually present?
669
parents = self.get_parent_ids()
671
for rev_id in revision_ids:
672
if rev_id in parents:
674
parents.append(rev_id)
677
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
679
@deprecated_method(zero_eleven)
681
def pending_merges(self):
682
"""Return a list of pending merges.
684
These are revisions that have been merged into the working
685
directory but not yet committed.
687
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
688
instead - which is available on all tree objects.
690
return self.get_parent_ids()[1:]
692
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
693
"""Common ghost checking functionality from set_parent_*.
695
This checks that the left hand-parent exists if there are any
698
if len(revision_ids) > 0:
699
leftmost_id = revision_ids[0]
700
if (not allow_leftmost_as_ghost and not
701
self.branch.repository.has_revision(leftmost_id)):
702
raise errors.GhostRevisionUnusableHere(leftmost_id)
704
def _set_merges_from_parent_ids(self, parent_ids):
705
merges = parent_ids[1:]
706
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
708
@needs_tree_write_lock
709
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
710
"""Set the parent ids to revision_ids.
712
See also set_parent_trees. This api will try to retrieve the tree data
713
for each element of revision_ids from the trees repository. If you have
714
tree data already available, it is more efficient to use
715
set_parent_trees rather than set_parent_ids. set_parent_ids is however
716
an easier API to use.
718
:param revision_ids: The revision_ids to set as the parent ids of this
719
working tree. Any of these may be ghosts.
721
self._check_parents_for_ghosts(revision_ids,
722
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
724
if len(revision_ids) > 0:
725
self.set_last_revision(revision_ids[0])
727
self.set_last_revision(None)
729
self._set_merges_from_parent_ids(revision_ids)
731
@needs_tree_write_lock
732
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
733
"""See MutableTree.set_parent_trees."""
734
parent_ids = [rev for (rev, tree) in parents_list]
736
self._check_parents_for_ghosts(parent_ids,
737
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
739
if len(parent_ids) == 0:
740
leftmost_parent_id = None
741
leftmost_parent_tree = None
743
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
745
if self._change_last_revision(leftmost_parent_id):
746
if leftmost_parent_tree is None:
747
# If we don't have a tree, fall back to reading the
748
# parent tree from the repository.
749
self._cache_basis_inventory(leftmost_parent_id)
751
inv = leftmost_parent_tree.inventory
752
xml = self._create_basis_xml_from_inventory(
753
leftmost_parent_id, inv)
754
self._write_basis_inventory(xml)
755
self._set_merges_from_parent_ids(parent_ids)
757
@needs_tree_write_lock
758
def set_pending_merges(self, rev_list):
759
parents = self.get_parent_ids()
760
leftmost = parents[:1]
761
new_parents = leftmost + rev_list
762
self.set_parent_ids(new_parents)
764
@needs_tree_write_lock
765
def set_merge_modified(self, modified_hashes):
767
for file_id, hash in modified_hashes.iteritems():
768
yield Stanza(file_id=file_id, hash=hash)
769
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
771
@needs_tree_write_lock
772
def _put_rio(self, filename, stanzas, header):
773
my_file = rio_file(stanzas, header)
774
self._control_files.put(filename, my_file)
776
@needs_write_lock # because merge pulls data into the branch.
777
def merge_from_branch(self, branch, to_revision=None):
778
"""Merge from a branch into this working tree.
780
:param branch: The branch to merge from.
781
:param to_revision: If non-None, the merge will merge to to_revision,
782
but not beyond it. to_revision does not need to be in the history
783
of the branch when it is supplied. If None, to_revision defaults to
784
branch.last_revision().
786
from bzrlib.merge import Merger, Merge3Merger
787
pb = bzrlib.ui.ui_factory.nested_progress_bar()
789
merger = Merger(self.branch, this_tree=self, pb=pb)
790
merger.pp = ProgressPhase("Merge phase", 5, pb)
791
merger.pp.next_phase()
792
# check that there are no
794
merger.check_basis(check_clean=True, require_commits=False)
795
if to_revision is None:
796
to_revision = branch.last_revision()
797
merger.other_rev_id = to_revision
798
if merger.other_rev_id is None:
799
raise error.NoCommits(branch)
800
self.branch.fetch(branch, last_revision=merger.other_rev_id)
801
merger.other_basis = merger.other_rev_id
802
merger.other_tree = self.branch.repository.revision_tree(
804
merger.pp.next_phase()
806
if merger.base_rev_id == merger.other_rev_id:
807
raise errors.PointlessMerge
808
merger.backup_files = False
809
merger.merge_type = Merge3Merger
810
merger.set_interesting_files(None)
811
merger.show_base = False
812
merger.reprocess = False
813
conflicts = merger.do_merge()
820
def merge_modified(self):
822
hashfile = self._control_files.get('merge-hashes')
823
except errors.NoSuchFile:
827
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
828
raise errors.MergeModifiedFormatError()
829
except StopIteration:
830
raise errors.MergeModifiedFormatError()
831
for s in RioReader(hashfile):
832
file_id = s.get("file_id")
833
if file_id not in self.inventory:
836
if hash == self.get_file_sha1(file_id):
837
merge_hashes[file_id] = hash
841
def mkdir(self, path, file_id=None):
842
"""See MutableTree.mkdir()."""
844
file_id = generate_ids.gen_file_id(os.path.basename(path))
845
os.mkdir(self.abspath(path))
846
self.add(path, file_id, 'directory')
849
def get_symlink_target(self, file_id):
850
return os.readlink(self.id2abspath(file_id))
852
def file_class(self, filename):
853
if self.path2id(filename):
855
elif self.is_ignored(filename):
861
"""Write the in memory inventory to disk."""
862
# TODO: Maybe this should only write on dirty ?
863
if self._control_files._lock_mode != 'w':
864
raise errors.NotWriteLocked(self)
866
xml5.serializer_v5.write_inventory(self._inventory, sio)
868
self._control_files.put('inventory', sio)
869
self._inventory_is_modified = False
871
def list_files(self, include_root=False):
872
"""Recursively list all files as (path, class, kind, id, entry).
874
Lists, but does not descend into unversioned directories.
876
This does not include files that have been deleted in this
879
Skips the control directory.
881
inv = self._inventory
882
if include_root is True:
883
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
884
# Convert these into local objects to save lookup times
885
pathjoin = osutils.pathjoin
886
file_kind = osutils.file_kind
888
# transport.base ends in a slash, we want the piece
889
# between the last two slashes
890
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
892
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
894
# directory file_id, relative path, absolute path, reverse sorted children
895
children = os.listdir(self.basedir)
897
# jam 20060527 The kernel sized tree seems equivalent whether we
898
# use a deque and popleft to keep them sorted, or if we use a plain
899
# list and just reverse() them.
900
children = collections.deque(children)
901
stack = [(inv.root.file_id, u'', self.basedir, children)]
903
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
906
f = children.popleft()
907
## TODO: If we find a subdirectory with its own .bzr
908
## directory, then that is a separate tree and we
909
## should exclude it.
911
# the bzrdir for this tree
912
if transport_base_dir == f:
915
# we know that from_dir_relpath and from_dir_abspath never end in a slash
916
# and 'f' doesn't begin with one, we can do a string op, rather
917
# than the checks of pathjoin(), all relative paths will have an extra slash
919
fp = from_dir_relpath + '/' + f
922
fap = from_dir_abspath + '/' + f
924
f_ie = inv.get_child(from_dir_id, f)
927
elif self.is_ignored(fp[1:]):
930
# we may not have found this file, because of a unicode issue
931
f_norm, can_access = osutils.normalized_filename(f)
932
if f == f_norm or not can_access:
933
# No change, so treat this file normally
936
# this file can be accessed by a normalized path
937
# check again if it is versioned
938
# these lines are repeated here for performance
940
fp = from_dir_relpath + '/' + f
941
fap = from_dir_abspath + '/' + f
942
f_ie = inv.get_child(from_dir_id, f)
945
elif self.is_ignored(fp[1:]):
954
raise errors.BzrCheckError(
955
"file %r entered as kind %r id %r, now of kind %r"
956
% (fap, f_ie.kind, f_ie.file_id, fk))
958
# make a last minute entry
960
yield fp[1:], c, fk, f_ie.file_id, f_ie
963
yield fp[1:], c, fk, None, fk_entries[fk]()
965
yield fp[1:], c, fk, None, TreeEntry()
968
if fk != 'directory':
971
# But do this child first
972
new_children = os.listdir(fap)
974
new_children = collections.deque(new_children)
975
stack.append((f_ie.file_id, fp, fap, new_children))
976
# Break out of inner loop,
977
# so that we start outer loop with child
980
# if we finished all children, pop it off the stack
983
@needs_tree_write_lock
984
def move(self, from_paths, to_dir=None, after=False, **kwargs):
987
to_dir must exist in the inventory.
989
If to_dir exists and is a directory, the files are moved into
990
it, keeping their old names.
992
Note that to_dir is only the last component of the new name;
993
this doesn't change the directory.
995
For each entry in from_paths the move mode will be determined
998
The first mode moves the file in the filesystem and updates the
999
inventory. The second mode only updates the inventory without
1000
touching the file on the filesystem. This is the new mode introduced
1003
move uses the second mode if 'after == True' and the target is not
1004
versioned but present in the working tree.
1006
move uses the second mode if 'after == False' and the source is
1007
versioned but no longer in the working tree, and the target is not
1008
versioned but present in the working tree.
1010
move uses the first mode if 'after == False' and the source is
1011
versioned and present in the working tree, and the target is not
1012
versioned and not present in the working tree.
1014
Everything else results in an error.
1016
This returns a list of (from_path, to_path) pairs for each
1017
entry that is moved.
1022
# check for deprecated use of signature
1024
to_dir = kwargs.get('to_name', None)
1026
raise TypeError('You must supply a target directory')
1028
symbol_versioning.warn('The parameter to_name was deprecated'
1029
' in version 0.13. Use to_dir instead',
1032
# check destination directory
1033
assert not isinstance(from_paths, basestring)
1034
inv = self.inventory
1035
to_abs = self.abspath(to_dir)
1036
if not isdir(to_abs):
1037
raise errors.BzrMoveFailedError('',to_dir,
1038
errors.NotADirectory(to_abs))
1039
if not self.has_filename(to_dir):
1040
raise errors.BzrMoveFailedError('',to_dir,
1041
errors.NotInWorkingDirectory(to_dir))
1042
to_dir_id = inv.path2id(to_dir)
1043
if to_dir_id is None:
1044
raise errors.BzrMoveFailedError('',to_dir,
1045
errors.NotVersionedError(path=str(to_dir)))
1047
to_dir_ie = inv[to_dir_id]
1048
if to_dir_ie.kind != 'directory':
1049
raise errors.BzrMoveFailedError('',to_dir,
1050
errors.NotADirectory(to_abs))
1052
# create rename entries and tuples
1053
for from_rel in from_paths:
1054
from_tail = splitpath(from_rel)[-1]
1055
from_id = inv.path2id(from_rel)
1057
raise errors.BzrMoveFailedError(from_rel,to_dir,
1058
errors.NotVersionedError(path=str(from_rel)))
1060
from_entry = inv[from_id]
1061
from_parent_id = from_entry.parent_id
1062
to_rel = pathjoin(to_dir, from_tail)
1063
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1065
from_tail=from_tail,
1066
from_parent_id=from_parent_id,
1067
to_rel=to_rel, to_tail=from_tail,
1068
to_parent_id=to_dir_id)
1069
rename_entries.append(rename_entry)
1070
rename_tuples.append((from_rel, to_rel))
1072
# determine which move mode to use. checks also for movability
1073
rename_entries = self._determine_mv_mode(rename_entries, after)
1075
original_modified = self._inventory_is_modified
1078
self._inventory_is_modified = True
1079
self._move(rename_entries)
1081
# restore the inventory on error
1082
self._inventory_is_modified = original_modified
1084
self._write_inventory(inv)
1085
return rename_tuples
1087
def _determine_mv_mode(self, rename_entries, after=False):
1088
"""Determines for each from-to pair if both inventory and working tree
1089
or only the inventory has to be changed.
1091
Also does basic plausability tests.
1093
inv = self.inventory
1095
for rename_entry in rename_entries:
1096
# store to local variables for easier reference
1097
from_rel = rename_entry.from_rel
1098
from_id = rename_entry.from_id
1099
to_rel = rename_entry.to_rel
1100
to_id = inv.path2id(to_rel)
1101
only_change_inv = False
1103
# check the inventory for source and destination
1105
raise errors.BzrMoveFailedError(from_rel,to_rel,
1106
errors.NotVersionedError(path=str(from_rel)))
1107
if to_id is not None:
1108
raise errors.BzrMoveFailedError(from_rel,to_rel,
1109
errors.AlreadyVersionedError(path=str(to_rel)))
1111
# try to determine the mode for rename (only change inv or change
1112
# inv and file system)
1114
if not self.has_filename(to_rel):
1115
raise errors.BzrMoveFailedError(from_id,to_rel,
1116
errors.NoSuchFile(path=str(to_rel),
1117
extra="New file has not been created yet"))
1118
only_change_inv = True
1119
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1120
only_change_inv = True
1121
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1122
only_change_inv = False
1124
# something is wrong, so lets determine what exactly
1125
if not self.has_filename(from_rel) and \
1126
not self.has_filename(to_rel):
1127
raise errors.BzrRenameFailedError(from_rel,to_rel,
1128
errors.PathsDoNotExist(paths=(str(from_rel),
1131
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1132
extra="(Use --after to update the Bazaar id)")
1133
rename_entry.only_change_inv = only_change_inv
1134
return rename_entries
1136
def _move(self, rename_entries):
1137
"""Moves a list of files.
1139
Depending on the value of the flag 'only_change_inv', the
1140
file will be moved on the file system or not.
1142
inv = self.inventory
1145
for entry in rename_entries:
1147
self._move_entry(entry)
1149
self._rollback_move(moved)
1153
def _rollback_move(self, moved):
1154
"""Try to rollback a previous move in case of an filesystem error."""
1155
inv = self.inventory
1158
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1159
entry.to_tail, entry.to_parent_id, entry.from_rel,
1160
entry.from_tail, entry.from_parent_id,
1161
entry.only_change_inv))
1162
except errors.BzrMoveFailedError, e:
1163
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1164
" The working tree is in an inconsistent state."
1165
" Please consider doing a 'bzr revert'."
1166
" Error message is: %s" % e)
1168
def _move_entry(self, entry):
1169
inv = self.inventory
1170
from_rel_abs = self.abspath(entry.from_rel)
1171
to_rel_abs = self.abspath(entry.to_rel)
1172
if from_rel_abs == to_rel_abs:
1173
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1174
"Source and target are identical.")
1176
if not entry.only_change_inv:
1178
osutils.rename(from_rel_abs, to_rel_abs)
1180
raise errors.BzrMoveFailedError(entry.from_rel,
1182
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1184
@needs_tree_write_lock
1185
def rename_one(self, from_rel, to_rel, after=False):
1188
This can change the directory or the filename or both.
1190
rename_one has several 'modes' to work. First, it can rename a physical
1191
file and change the file_id. That is the normal mode. Second, it can
1192
only change the file_id without touching any physical file. This is
1193
the new mode introduced in version 0.15.
1195
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1196
versioned but present in the working tree.
1198
rename_one uses the second mode if 'after == False' and 'from_rel' is
1199
versioned but no longer in the working tree, and 'to_rel' is not
1200
versioned but present in the working tree.
1202
rename_one uses the first mode if 'after == False' and 'from_rel' is
1203
versioned and present in the working tree, and 'to_rel' is not
1204
versioned and not present in the working tree.
1206
Everything else results in an error.
1208
inv = self.inventory
1211
# create rename entries and tuples
1212
from_tail = splitpath(from_rel)[-1]
1213
from_id = inv.path2id(from_rel)
1215
raise errors.BzrRenameFailedError(from_rel,to_rel,
1216
errors.NotVersionedError(path=str(from_rel)))
1217
from_entry = inv[from_id]
1218
from_parent_id = from_entry.parent_id
1219
to_dir, to_tail = os.path.split(to_rel)
1220
to_dir_id = inv.path2id(to_dir)
1221
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1223
from_tail=from_tail,
1224
from_parent_id=from_parent_id,
1225
to_rel=to_rel, to_tail=to_tail,
1226
to_parent_id=to_dir_id)
1227
rename_entries.append(rename_entry)
1229
# determine which move mode to use. checks also for movability
1230
rename_entries = self._determine_mv_mode(rename_entries, after)
1232
# check if the target changed directory and if the target directory is
1234
if to_dir_id is None:
1235
raise errors.BzrMoveFailedError(from_rel,to_rel,
1236
errors.NotVersionedError(path=str(to_dir)))
1238
# all checks done. now we can continue with our actual work
1239
mutter('rename_one:\n'
1244
' to_dir_id {%s}\n',
1245
from_id, from_rel, to_rel, to_dir, to_dir_id)
1247
self._move(rename_entries)
1248
self._write_inventory(inv)
1250
class _RenameEntry(object):
1251
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1252
to_rel, to_tail, to_parent_id, only_change_inv=False):
1253
self.from_rel = from_rel
1254
self.from_id = from_id
1255
self.from_tail = from_tail
1256
self.from_parent_id = from_parent_id
1257
self.to_rel = to_rel
1258
self.to_tail = to_tail
1259
self.to_parent_id = to_parent_id
1260
self.only_change_inv = only_change_inv
1264
"""Return all unknown files.
1266
These are files in the working directory that are not versioned or
1267
control files or ignored.
1269
for subp in self.extras():
1270
if not self.is_ignored(subp):
1273
@needs_tree_write_lock
1274
def unversion(self, file_ids):
1275
"""Remove the file ids in file_ids from the current versioned set.
1277
When a file_id is unversioned, all of its children are automatically
1280
:param file_ids: The file ids to stop versioning.
1281
:raises: NoSuchId if any fileid is not currently versioned.
1283
for file_id in file_ids:
1284
if self._inventory.has_id(file_id):
1285
self._inventory.remove_recursive_id(file_id)
1287
raise errors.NoSuchId(self, file_id)
1289
# in the future this should just set a dirty bit to wait for the
1290
# final unlock. However, until all methods of workingtree start
1291
# with the current in -memory inventory rather than triggering
1292
# a read, it is more complex - we need to teach read_inventory
1293
# to know when to read, and when to not read first... and possibly
1294
# to save first when the in memory one may be corrupted.
1295
# so for now, we just only write it if it is indeed dirty.
1297
self._write_inventory(self._inventory)
1299
@deprecated_method(zero_eight)
1300
def iter_conflicts(self):
1301
"""List all files in the tree that have text or content conflicts.
1302
DEPRECATED. Use conflicts instead."""
1303
return self._iter_conflicts()
1305
def _iter_conflicts(self):
1307
for info in self.list_files():
1309
stem = get_conflicted_stem(path)
1312
if stem not in conflicted:
1313
conflicted.add(stem)
1317
def pull(self, source, overwrite=False, stop_revision=None):
1318
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1321
pp = ProgressPhase("Pull phase", 2, top_pb)
1323
old_revision_history = self.branch.revision_history()
1324
basis_tree = self.basis_tree()
1325
count = self.branch.pull(source, overwrite, stop_revision)
1326
new_revision_history = self.branch.revision_history()
1327
if new_revision_history != old_revision_history:
1329
if len(old_revision_history):
1330
other_revision = old_revision_history[-1]
1332
other_revision = None
1333
repository = self.branch.repository
1334
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1336
new_basis_tree = self.branch.basis_tree()
1343
if (basis_tree.inventory.root is None and
1344
new_basis_tree.inventory.root is not None):
1345
self.set_root_id(new_basis_tree.inventory.root.file_id)
1348
# TODO - dedup parents list with things merged by pull ?
1349
# reuse the revisiontree we merged against to set the new
1351
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1352
# we have to pull the merge trees out again, because
1353
# merge_inner has set the ids. - this corner is not yet
1354
# layered well enough to prevent double handling.
1355
merges = self.get_parent_ids()[1:]
1356
parent_trees.extend([
1357
(parent, repository.revision_tree(parent)) for
1359
self.set_parent_trees(parent_trees)
1366
def put_file_bytes_non_atomic(self, file_id, bytes):
1367
"""See MutableTree.put_file_bytes_non_atomic."""
1368
stream = file(self.id2abspath(file_id), 'wb')
1373
# TODO: update the hashcache here ?
1376
"""Yield all unknown files in this WorkingTree.
1378
If there are any unknown directories then only the directory is
1379
returned, not all its children. But if there are unknown files
1380
under a versioned subdirectory, they are returned.
1382
Currently returned depth-first, sorted by name within directories.
1384
## TODO: Work from given directory downwards
1385
for path, dir_entry in self.inventory.directories():
1386
# mutter("search for unknowns in %r", path)
1387
dirabs = self.abspath(path)
1388
if not isdir(dirabs):
1389
# e.g. directory deleted
1393
for subf in os.listdir(dirabs):
1396
if subf not in dir_entry.children:
1397
subf_norm, can_access = osutils.normalized_filename(subf)
1398
if subf_norm != subf and can_access:
1399
if subf_norm not in dir_entry.children:
1400
fl.append(subf_norm)
1406
subp = pathjoin(path, subf)
1410
def ignored_files(self):
1411
"""Yield list of PATH, IGNORE_PATTERN"""
1412
for subp in self.extras():
1413
pat = self.is_ignored(subp)
1417
def get_ignore_list(self):
1418
"""Return list of ignore patterns.
1420
Cached in the Tree object after the first call.
1422
ignoreset = getattr(self, '_ignoreset', None)
1423
if ignoreset is not None:
1426
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1427
ignore_globs.update(ignores.get_runtime_ignores())
1428
ignore_globs.update(ignores.get_user_ignores())
1429
if self.has_filename(bzrlib.IGNORE_FILENAME):
1430
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1432
ignore_globs.update(ignores.parse_ignore_file(f))
1435
self._ignoreset = ignore_globs
1438
def _flush_ignore_list_cache(self):
1439
"""Resets the cached ignore list to force a cache rebuild."""
1440
self._ignoreset = None
1441
self._ignoreglobster = None
1443
def is_ignored(self, filename):
1444
r"""Check whether the filename matches an ignore pattern.
1446
Patterns containing '/' or '\' need to match the whole path;
1447
others match against only the last component.
1449
If the file is ignored, returns the pattern which caused it to
1450
be ignored, otherwise None. So this can simply be used as a
1451
boolean if desired."""
1452
if getattr(self, '_ignoreglobster', None) is None:
1453
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1454
return self._ignoreglobster.match(filename)
1456
def kind(self, file_id):
1457
return file_kind(self.id2abspath(file_id))
1459
def _comparison_data(self, entry, path):
1460
abspath = self.abspath(path)
1462
stat_value = os.lstat(abspath)
1464
if getattr(e, 'errno', None) == errno.ENOENT:
1471
mode = stat_value.st_mode
1472
kind = osutils.file_kind_from_stat_mode(mode)
1473
if not supports_executable():
1474
executable = entry.executable
1476
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1477
return kind, executable, stat_value
1479
def _file_size(self, entry, stat_value):
1480
return stat_value.st_size
1482
def last_revision(self):
1483
"""Return the last revision of the branch for this tree.
1485
This format tree does not support a separate marker for last-revision
1486
compared to the branch.
1488
See MutableTree.last_revision
1490
return self._last_revision()
1493
def _last_revision(self):
1494
"""helper for get_parent_ids."""
1495
return self.branch.last_revision()
1497
def is_locked(self):
1498
return self._control_files.is_locked()
1500
def lock_read(self):
1501
"""See Branch.lock_read, and WorkingTree.unlock."""
1502
self.branch.lock_read()
1504
return self._control_files.lock_read()
1506
self.branch.unlock()
1509
def lock_tree_write(self):
1510
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1511
self.branch.lock_read()
1513
return self._control_files.lock_write()
1515
self.branch.unlock()
1518
def lock_write(self):
1519
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1520
self.branch.lock_write()
1522
return self._control_files.lock_write()
1524
self.branch.unlock()
1527
def get_physical_lock_status(self):
1528
return self._control_files.get_physical_lock_status()
1530
def _basis_inventory_name(self):
1531
return 'basis-inventory-cache'
1533
@needs_tree_write_lock
1534
def set_last_revision(self, new_revision):
1535
"""Change the last revision in the working tree."""
1536
if self._change_last_revision(new_revision):
1537
self._cache_basis_inventory(new_revision)
1539
def _change_last_revision(self, new_revision):
1540
"""Template method part of set_last_revision to perform the change.
1542
This is used to allow WorkingTree3 instances to not affect branch
1543
when their last revision is set.
1545
if new_revision is None:
1546
self.branch.set_revision_history([])
1549
self.branch.generate_revision_history(new_revision)
1550
except errors.NoSuchRevision:
1551
# not present in the repo - dont try to set it deeper than the tip
1552
self.branch.set_revision_history([new_revision])
1555
def _write_basis_inventory(self, xml):
1556
"""Write the basis inventory XML to the basis-inventory file"""
1557
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1558
path = self._basis_inventory_name()
1560
self._control_files.put(path, sio)
1562
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1563
"""Create the text that will be saved in basis-inventory"""
1564
inventory.revision_id = revision_id
1565
return xml6.serializer_v6.write_inventory_to_string(inventory)
1567
def _cache_basis_inventory(self, new_revision):
1568
"""Cache new_revision as the basis inventory."""
1569
# TODO: this should allow the ready-to-use inventory to be passed in,
1570
# as commit already has that ready-to-use [while the format is the
1573
# this double handles the inventory - unpack and repack -
1574
# but is easier to understand. We can/should put a conditional
1575
# in here based on whether the inventory is in the latest format
1576
# - perhaps we should repack all inventories on a repository
1578
# the fast path is to copy the raw xml from the repository. If the
1579
# xml contains 'revision_id="', then we assume the right
1580
# revision_id is set. We must check for this full string, because a
1581
# root node id can legitimately look like 'revision_id' but cannot
1583
xml = self.branch.repository.get_inventory_xml(new_revision)
1584
firstline = xml.split('\n', 1)[0]
1585
if (not 'revision_id="' in firstline or
1586
'format="6"' not in firstline):
1587
inv = self.branch.repository.deserialise_inventory(
1589
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1590
self._write_basis_inventory(xml)
1591
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1594
def read_basis_inventory(self):
1595
"""Read the cached basis inventory."""
1596
path = self._basis_inventory_name()
1597
return self._control_files.get(path).read()
1600
def read_working_inventory(self):
1601
"""Read the working inventory.
1603
:raises errors.InventoryModified: read_working_inventory will fail
1604
when the current in memory inventory has been modified.
1606
# conceptually this should be an implementation detail of the tree.
1607
# XXX: Deprecate this.
1608
# ElementTree does its own conversion from UTF-8, so open in
1610
if self._inventory_is_modified:
1611
raise errors.InventoryModified(self)
1612
result = xml5.serializer_v5.read_inventory(
1613
self._control_files.get('inventory'))
1614
self._set_inventory(result, dirty=False)
1617
@needs_tree_write_lock
1618
def remove(self, files, verbose=False, to_file=None):
1619
"""Remove nominated files from the working inventory..
1621
This does not remove their text. This does not run on XXX on what? RBC
1623
TODO: Refuse to remove modified files unless --force is given?
1625
TODO: Do something useful with directories.
1627
TODO: Should this remove the text or not? Tough call; not
1628
removing may be useful and the user can just use use rm, and
1629
is the opposite of add. Removing it is consistent with most
1630
other tools. Maybe an option.
1632
## TODO: Normalize names
1633
## TODO: Remove nested loops; better scalability
1634
if isinstance(files, basestring):
1637
inv = self.inventory
1639
# do this before any modifications
1641
fid = inv.path2id(f)
1643
# TODO: Perhaps make this just a warning, and continue?
1644
# This tends to happen when
1645
raise errors.NotVersionedError(path=f)
1647
# having remove it, it must be either ignored or unknown
1648
if self.is_ignored(f):
1652
textui.show_status(new_status, inv[fid].kind, f,
1656
self._write_inventory(inv)
1658
@needs_tree_write_lock
1659
def revert(self, filenames, old_tree=None, backups=True,
1660
pb=DummyProgress(), report_changes=False):
1661
from bzrlib.conflicts import resolve
1662
if old_tree is None:
1663
old_tree = self.basis_tree()
1664
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1666
if not len(filenames):
1667
self.set_parent_ids(self.get_parent_ids()[:1])
1670
resolve(self, filenames, ignore_misses=True)
1673
def revision_tree(self, revision_id):
1674
"""See Tree.revision_tree.
1676
WorkingTree can supply revision_trees for the basis revision only
1677
because there is only one cached inventory in the bzr directory.
1679
if revision_id == self.last_revision():
1681
xml = self.read_basis_inventory()
1682
except errors.NoSuchFile:
1686
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1687
# dont use the repository revision_tree api because we want
1688
# to supply the inventory.
1689
if inv.revision_id == revision_id:
1690
return revisiontree.RevisionTree(self.branch.repository,
1692
except errors.BadInventoryFormat:
1694
# raise if there was no inventory, or if we read the wrong inventory.
1695
raise errors.NoSuchRevisionInTree(self, revision_id)
1697
# XXX: This method should be deprecated in favour of taking in a proper
1698
# new Inventory object.
1699
@needs_tree_write_lock
1700
def set_inventory(self, new_inventory_list):
1701
from bzrlib.inventory import (Inventory,
1706
inv = Inventory(self.get_root_id())
1707
for path, file_id, parent, kind in new_inventory_list:
1708
name = os.path.basename(path)
1711
# fixme, there should be a factory function inv,add_??
1712
if kind == 'directory':
1713
inv.add(InventoryDirectory(file_id, name, parent))
1714
elif kind == 'file':
1715
inv.add(InventoryFile(file_id, name, parent))
1716
elif kind == 'symlink':
1717
inv.add(InventoryLink(file_id, name, parent))
1719
raise errors.BzrError("unknown kind %r" % kind)
1720
self._write_inventory(inv)
1722
@needs_tree_write_lock
1723
def set_root_id(self, file_id):
1724
"""Set the root id for this tree."""
1727
symbol_versioning.warn(symbol_versioning.zero_twelve
1728
% 'WorkingTree.set_root_id with fileid=None',
1732
inv = self._inventory
1733
orig_root_id = inv.root.file_id
1734
# TODO: it might be nice to exit early if there was nothing
1735
# to do, saving us from trigger a sync on unlock.
1736
self._inventory_is_modified = True
1737
# we preserve the root inventory entry object, but
1738
# unlinkit from the byid index
1739
del inv._byid[inv.root.file_id]
1740
inv.root.file_id = file_id
1741
# and link it into the index with the new changed id.
1742
inv._byid[inv.root.file_id] = inv.root
1743
# and finally update all children to reference the new id.
1744
# XXX: this should be safe to just look at the root.children
1745
# list, not the WHOLE INVENTORY.
1748
if entry.parent_id == orig_root_id:
1749
entry.parent_id = inv.root.file_id
1752
"""See Branch.unlock.
1754
WorkingTree locking just uses the Branch locking facilities.
1755
This is current because all working trees have an embedded branch
1756
within them. IF in the future, we were to make branch data shareable
1757
between multiple working trees, i.e. via shared storage, then we
1758
would probably want to lock both the local tree, and the branch.
1760
raise NotImplementedError(self.unlock)
1763
"""Update a working tree along its branch.
1765
This will update the branch if its bound too, which means we have
1766
multiple trees involved:
1768
- The new basis tree of the master.
1769
- The old basis tree of the branch.
1770
- The old basis tree of the working tree.
1771
- The current working tree state.
1773
Pathologically, all three may be different, and non-ancestors of each
1774
other. Conceptually we want to:
1776
- Preserve the wt.basis->wt.state changes
1777
- Transform the wt.basis to the new master basis.
1778
- Apply a merge of the old branch basis to get any 'local' changes from
1780
- Restore the wt.basis->wt.state changes.
1782
There isn't a single operation at the moment to do that, so we:
1783
- Merge current state -> basis tree of the master w.r.t. the old tree
1785
- Do a 'normal' merge of the old branch basis if it is relevant.
1787
if self.branch.get_master_branch() is not None:
1789
update_branch = True
1791
self.lock_tree_write()
1792
update_branch = False
1795
old_tip = self.branch.update()
1798
return self._update_tree(old_tip)
1802
@needs_tree_write_lock
1803
def _update_tree(self, old_tip=None):
1804
"""Update a tree to the master branch.
1806
:param old_tip: if supplied, the previous tip revision the branch,
1807
before it was changed to the master branch's tip.
1809
# here if old_tip is not None, it is the old tip of the branch before
1810
# it was updated from the master branch. This should become a pending
1811
# merge in the working tree to preserve the user existing work. we
1812
# cant set that until we update the working trees last revision to be
1813
# one from the new branch, because it will just get absorbed by the
1814
# parent de-duplication logic.
1816
# We MUST save it even if an error occurs, because otherwise the users
1817
# local work is unreferenced and will appear to have been lost.
1821
last_rev = self.get_parent_ids()[0]
1824
if last_rev != self.branch.last_revision():
1825
# merge tree state up to new branch tip.
1826
basis = self.basis_tree()
1827
to_tree = self.branch.basis_tree()
1828
if basis.inventory.root is None:
1829
self.set_root_id(to_tree.inventory.root.file_id)
1830
result += merge.merge_inner(
1835
# TODO - dedup parents list with things merged by pull ?
1836
# reuse the tree we've updated to to set the basis:
1837
parent_trees = [(self.branch.last_revision(), to_tree)]
1838
merges = self.get_parent_ids()[1:]
1839
# Ideally we ask the tree for the trees here, that way the working
1840
# tree can decide whether to give us teh entire tree or give us a
1841
# lazy initialised tree. dirstate for instance will have the trees
1842
# in ram already, whereas a last-revision + basis-inventory tree
1843
# will not, but also does not need them when setting parents.
1844
for parent in merges:
1845
parent_trees.append(
1846
(parent, self.branch.repository.revision_tree(parent)))
1847
if old_tip is not None:
1848
parent_trees.append(
1849
(old_tip, self.branch.repository.revision_tree(old_tip)))
1850
self.set_parent_trees(parent_trees)
1851
last_rev = parent_trees[0][0]
1853
# the working tree had the same last-revision as the master
1854
# branch did. We may still have pivot local work from the local
1855
# branch into old_tip:
1856
if old_tip is not None:
1857
self.add_parent_tree_id(old_tip)
1858
if old_tip and old_tip != last_rev:
1859
# our last revision was not the prior branch last revision
1860
# and we have converted that last revision to a pending merge.
1861
# base is somewhere between the branch tip now
1862
# and the now pending merge
1863
from bzrlib.revision import common_ancestor
1865
base_rev_id = common_ancestor(self.branch.last_revision(),
1867
self.branch.repository)
1868
except errors.NoCommonAncestor:
1870
base_tree = self.branch.repository.revision_tree(base_rev_id)
1871
other_tree = self.branch.repository.revision_tree(old_tip)
1872
result += merge.merge_inner(
1879
def _write_hashcache_if_dirty(self):
1880
"""Write out the hashcache if it is dirty."""
1881
if self._hashcache.needs_write:
1883
self._hashcache.write()
1885
if e.errno not in (errno.EPERM, errno.EACCES):
1887
# TODO: jam 20061219 Should this be a warning? A single line
1888
# warning might be sufficient to let the user know what
1890
mutter('Could not write hashcache for %s\nError: %s',
1891
self._hashcache.cache_file_name(), e)
1893
@needs_tree_write_lock
1894
def _write_inventory(self, inv):
1895
"""Write inventory as the current inventory."""
1896
self._set_inventory(inv, dirty=True)
1899
def set_conflicts(self, arg):
1900
raise errors.UnsupportedOperation(self.set_conflicts, self)
1902
def add_conflicts(self, arg):
1903
raise errors.UnsupportedOperation(self.add_conflicts, self)
1906
def conflicts(self):
1907
conflicts = _mod_conflicts.ConflictList()
1908
for conflicted in self._iter_conflicts():
1911
if file_kind(self.abspath(conflicted)) != "file":
1913
except errors.NoSuchFile:
1916
for suffix in ('.THIS', '.OTHER'):
1918
kind = file_kind(self.abspath(conflicted+suffix))
1921
except errors.NoSuchFile:
1925
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1926
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1928
file_id=self.path2id(conflicted)))
1931
def walkdirs(self, prefix=""):
1932
disk_top = self.abspath(prefix)
1933
if disk_top.endswith('/'):
1934
disk_top = disk_top[:-1]
1935
top_strip_len = len(disk_top) + 1
1936
inventory_iterator = self._walkdirs(prefix)
1937
disk_iterator = osutils.walkdirs(disk_top, prefix)
1939
current_disk = disk_iterator.next()
1940
disk_finished = False
1942
if e.errno != errno.ENOENT:
1945
disk_finished = True
1947
current_inv = inventory_iterator.next()
1948
inv_finished = False
1949
except StopIteration:
1952
while not inv_finished or not disk_finished:
1953
if not disk_finished:
1954
# strip out .bzr dirs
1955
if current_disk[0][1][top_strip_len:] == '':
1956
# osutils.walkdirs can be made nicer -
1957
# yield the path-from-prefix rather than the pathjoined
1959
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
1960
if current_disk[1][bzrdir_loc][0] == '.bzr':
1961
# we dont yield the contents of, or, .bzr itself.
1962
del current_disk[1][bzrdir_loc]
1964
# everything is unknown
1967
# everything is missing
1970
direction = cmp(current_inv[0][0], current_disk[0][0])
1972
# disk is before inventory - unknown
1973
dirblock = [(relpath, basename, kind, stat, None, None) for
1974
relpath, basename, kind, stat, top_path in current_disk[1]]
1975
yield (current_disk[0][0], None), dirblock
1977
current_disk = disk_iterator.next()
1978
except StopIteration:
1979
disk_finished = True
1981
# inventory is before disk - missing.
1982
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1983
for relpath, basename, dkind, stat, fileid, kind in
1985
yield (current_inv[0][0], current_inv[0][1]), dirblock
1987
current_inv = inventory_iterator.next()
1988
except StopIteration:
1991
# versioned present directory
1992
# merge the inventory and disk data together
1994
for relpath, subiterator in itertools.groupby(sorted(
1995
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
1996
path_elements = list(subiterator)
1997
if len(path_elements) == 2:
1998
inv_row, disk_row = path_elements
1999
# versioned, present file
2000
dirblock.append((inv_row[0],
2001
inv_row[1], disk_row[2],
2002
disk_row[3], inv_row[4],
2004
elif len(path_elements[0]) == 5:
2006
dirblock.append((path_elements[0][0],
2007
path_elements[0][1], path_elements[0][2],
2008
path_elements[0][3], None, None))
2009
elif len(path_elements[0]) == 6:
2010
# versioned, absent file.
2011
dirblock.append((path_elements[0][0],
2012
path_elements[0][1], 'unknown', None,
2013
path_elements[0][4], path_elements[0][5]))
2015
raise NotImplementedError('unreachable code')
2016
yield current_inv[0], dirblock
2018
current_inv = inventory_iterator.next()
2019
except StopIteration:
2022
current_disk = disk_iterator.next()
2023
except StopIteration:
2024
disk_finished = True
2026
def _walkdirs(self, prefix=""):
2027
_directory = 'directory'
2028
# get the root in the inventory
2029
inv = self.inventory
2030
top_id = inv.path2id(prefix)
2034
pending = [(prefix, '', _directory, None, top_id, None)]
2037
currentdir = pending.pop()
2038
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2039
top_id = currentdir[4]
2041
relroot = currentdir[0] + '/'
2044
# FIXME: stash the node in pending
2046
for name, child in entry.sorted_children():
2047
dirblock.append((relroot + name, name, child.kind, None,
2048
child.file_id, child.kind
2050
yield (currentdir[0], entry.file_id), dirblock
2051
# push the user specified dirs from dirblock
2052
for dir in reversed(dirblock):
2053
if dir[2] == _directory:
2057
class WorkingTree2(WorkingTree):
2058
"""This is the Format 2 working tree.
2060
This was the first weave based working tree.
2061
- uses os locks for locking.
2062
- uses the branch last-revision.
2065
def lock_tree_write(self):
2066
"""See WorkingTree.lock_tree_write().
2068
In Format2 WorkingTrees we have a single lock for the branch and tree
2069
so lock_tree_write() degrades to lock_write().
2071
self.branch.lock_write()
2073
return self._control_files.lock_write()
2075
self.branch.unlock()
2079
# we share control files:
2080
if self._control_files._lock_count == 3:
2081
# _inventory_is_modified is always False during a read lock.
2082
if self._inventory_is_modified:
2084
self._write_hashcache_if_dirty()
2086
# reverse order of locking.
2088
return self._control_files.unlock()
2090
self.branch.unlock()
2093
class WorkingTree3(WorkingTree):
2094
"""This is the Format 3 working tree.
2096
This differs from the base WorkingTree by:
2097
- having its own file lock
2098
- having its own last-revision property.
2100
This is new in bzr 0.8
2104
def _last_revision(self):
2105
"""See Mutable.last_revision."""
2107
return self._control_files.get_utf8('last-revision').read()
2108
except errors.NoSuchFile:
2111
def _change_last_revision(self, revision_id):
2112
"""See WorkingTree._change_last_revision."""
2113
if revision_id is None or revision_id == NULL_REVISION:
2115
self._control_files._transport.delete('last-revision')
2116
except errors.NoSuchFile:
2120
self._control_files.put_utf8('last-revision', revision_id)
2123
@needs_tree_write_lock
2124
def set_conflicts(self, conflicts):
2125
self._put_rio('conflicts', conflicts.to_stanzas(),
2128
@needs_tree_write_lock
2129
def add_conflicts(self, new_conflicts):
2130
conflict_set = set(self.conflicts())
2131
conflict_set.update(set(list(new_conflicts)))
2132
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2133
key=_mod_conflicts.Conflict.sort_key)))
2136
def conflicts(self):
2138
confile = self._control_files.get('conflicts')
2139
except errors.NoSuchFile:
2140
return _mod_conflicts.ConflictList()
2142
if confile.next() != CONFLICT_HEADER_1 + '\n':
2143
raise errors.ConflictFormatError()
2144
except StopIteration:
2145
raise errors.ConflictFormatError()
2146
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2149
if self._control_files._lock_count == 1:
2150
# _inventory_is_modified is always False during a read lock.
2151
if self._inventory_is_modified:
2153
self._write_hashcache_if_dirty()
2154
# reverse order of locking.
2156
return self._control_files.unlock()
2158
self.branch.unlock()
2161
def get_conflicted_stem(path):
2162
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2163
if path.endswith(suffix):
2164
return path[:-len(suffix)]
2167
@deprecated_function(zero_eight)
2168
def is_control_file(filename):
2169
"""See WorkingTree.is_control_filename(filename)."""
2170
## FIXME: better check
2171
filename = normpath(filename)
2172
while filename != '':
2173
head, tail = os.path.split(filename)
2174
## mutter('check %r for control file' % ((head, tail),))
2177
if filename == head:
2183
class WorkingTreeFormat(object):
2184
"""An encapsulation of the initialization and open routines for a format.
2186
Formats provide three things:
2187
* An initialization routine,
2191
Formats are placed in an dict by their format string for reference
2192
during workingtree opening. Its not required that these be instances, they
2193
can be classes themselves with class methods - it simply depends on
2194
whether state is needed for a given format or not.
2196
Once a format is deprecated, just deprecate the initialize and open
2197
methods on the format class. Do not deprecate the object, as the
2198
object will be created every time regardless.
2201
_default_format = None
2202
"""The default format used for new trees."""
2205
"""The known formats."""
2208
def find_format(klass, a_bzrdir):
2209
"""Return the format for the working tree object in a_bzrdir."""
2211
transport = a_bzrdir.get_workingtree_transport(None)
2212
format_string = transport.get("format").read()
2213
return klass._formats[format_string]
2214
except errors.NoSuchFile:
2215
raise errors.NoWorkingTree(base=transport.base)
2217
raise errors.UnknownFormatError(format=format_string)
2220
def get_default_format(klass):
2221
"""Return the current default format."""
2222
return klass._default_format
2224
def get_format_string(self):
2225
"""Return the ASCII format string that identifies this format."""
2226
raise NotImplementedError(self.get_format_string)
2228
def get_format_description(self):
2229
"""Return the short description for this format."""
2230
raise NotImplementedError(self.get_format_description)
2232
def is_supported(self):
2233
"""Is this format supported?
2235
Supported formats can be initialized and opened.
2236
Unsupported formats may not support initialization or committing or
2237
some other features depending on the reason for not being supported.
2242
def register_format(klass, format):
2243
klass._formats[format.get_format_string()] = format
2246
def set_default_format(klass, format):
2247
klass._default_format = format
2250
def unregister_format(klass, format):
2251
assert klass._formats[format.get_format_string()] is format
2252
del klass._formats[format.get_format_string()]
2256
class WorkingTreeFormat2(WorkingTreeFormat):
2257
"""The second working tree format.
2259
This format modified the hash cache from the format 1 hash cache.
2262
def get_format_description(self):
2263
"""See WorkingTreeFormat.get_format_description()."""
2264
return "Working tree format 2"
2266
def stub_initialize_remote(self, control_files):
2267
"""As a special workaround create critical control files for a remote working tree
2269
This ensures that it can later be updated and dealt with locally,
2270
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2271
no working tree. (See bug #43064).
2275
xml5.serializer_v5.write_inventory(inv, sio)
2277
control_files.put('inventory', sio)
2279
control_files.put_utf8('pending-merges', '')
2282
def initialize(self, a_bzrdir, revision_id=None):
2283
"""See WorkingTreeFormat.initialize()."""
2284
if not isinstance(a_bzrdir.transport, LocalTransport):
2285
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2286
branch = a_bzrdir.open_branch()
2287
if revision_id is not None:
2290
revision_history = branch.revision_history()
2292
position = revision_history.index(revision_id)
2294
raise errors.NoSuchRevision(branch, revision_id)
2295
branch.set_revision_history(revision_history[:position + 1])
2298
revision = branch.last_revision()
2300
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2306
basis_tree = branch.repository.revision_tree(revision)
2307
if basis_tree.inventory.root is not None:
2308
wt.set_root_id(basis_tree.inventory.root.file_id)
2309
# set the parent list and cache the basis tree.
2310
wt.set_parent_trees([(revision, basis_tree)])
2311
transform.build_tree(basis_tree, wt)
2315
super(WorkingTreeFormat2, self).__init__()
2316
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2318
def open(self, a_bzrdir, _found=False):
2319
"""Return the WorkingTree object for a_bzrdir
2321
_found is a private parameter, do not use it. It is used to indicate
2322
if format probing has already been done.
2325
# we are being called directly and must probe.
2326
raise NotImplementedError
2327
if not isinstance(a_bzrdir.transport, LocalTransport):
2328
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2329
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2335
class WorkingTreeFormat3(WorkingTreeFormat):
2336
"""The second working tree format updated to record a format marker.
2339
- exists within a metadir controlling .bzr
2340
- includes an explicit version marker for the workingtree control
2341
files, separate from the BzrDir format
2342
- modifies the hash cache format
2344
- uses a LockDir to guard access for writes.
2347
def get_format_string(self):
2348
"""See WorkingTreeFormat.get_format_string()."""
2349
return "Bazaar-NG Working Tree format 3"
2351
def get_format_description(self):
2352
"""See WorkingTreeFormat.get_format_description()."""
2353
return "Working tree format 3"
2355
_lock_file_name = 'lock'
2356
_lock_class = LockDir
2358
def _open_control_files(self, a_bzrdir):
2359
transport = a_bzrdir.get_workingtree_transport(None)
2360
return LockableFiles(transport, self._lock_file_name,
2363
def initialize(self, a_bzrdir, revision_id=None):
2364
"""See WorkingTreeFormat.initialize().
2366
revision_id allows creating a working tree at a different
2367
revision than the branch is at.
2369
if not isinstance(a_bzrdir.transport, LocalTransport):
2370
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2371
transport = a_bzrdir.get_workingtree_transport(self)
2372
control_files = self._open_control_files(a_bzrdir)
2373
control_files.create_lock()
2374
control_files.lock_write()
2375
control_files.put_utf8('format', self.get_format_string())
2376
branch = a_bzrdir.open_branch()
2377
if revision_id is None:
2378
revision_id = branch.last_revision()
2379
# WorkingTree3 can handle an inventory which has a unique root id.
2380
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2381
# those trees. And because there isn't a format bump inbetween, we
2382
# are maintaining compatibility with older clients.
2383
# inv = Inventory(root_id=gen_root_id())
2385
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2391
_control_files=control_files)
2392
wt.lock_tree_write()
2394
basis_tree = branch.repository.revision_tree(revision_id)
2395
# only set an explicit root id if there is one to set.
2396
if basis_tree.inventory.root is not None:
2397
wt.set_root_id(basis_tree.inventory.root.file_id)
2398
if revision_id == NULL_REVISION:
2399
wt.set_parent_trees([])
2401
wt.set_parent_trees([(revision_id, basis_tree)])
2402
transform.build_tree(basis_tree, wt)
2404
# Unlock in this order so that the unlock-triggers-flush in
2405
# WorkingTree is given a chance to fire.
2406
control_files.unlock()
2411
super(WorkingTreeFormat3, self).__init__()
2412
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2414
def open(self, a_bzrdir, _found=False):
2415
"""Return the WorkingTree object for a_bzrdir
2417
_found is a private parameter, do not use it. It is used to indicate
2418
if format probing has already been done.
2421
# we are being called directly and must probe.
2422
raise NotImplementedError
2423
if not isinstance(a_bzrdir.transport, LocalTransport):
2424
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2425
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2427
def _open(self, a_bzrdir, control_files):
2428
"""Open the tree itself.
2430
:param a_bzrdir: the dir for the tree.
2431
:param control_files: the control files for the tree.
2433
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2437
_control_files=control_files)
2440
return self.get_format_string()
2443
__default_format = WorkingTreeFormat3()
2444
WorkingTreeFormat.register_format(__default_format)
2445
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2446
WorkingTreeFormat.set_default_format(__default_format)
2447
# formats which have no format string are not discoverable
2448
# and not independently creatable, so are not registered.
2449
_legacy_formats = [WorkingTreeFormat2(),
2453
class WorkingTreeTestProviderAdapter(object):
2454
"""A tool to generate a suite testing multiple workingtree formats at once.
2456
This is done by copying the test once for each transport and injecting
2457
the transport_server, transport_readonly_server, and workingtree_format
2458
classes into each copy. Each copy is also given a new id() to make it
2462
def __init__(self, transport_server, transport_readonly_server, formats):
2463
self._transport_server = transport_server
2464
self._transport_readonly_server = transport_readonly_server
2465
self._formats = formats
2467
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2468
"""Clone test for adaption."""
2469
new_test = deepcopy(test)
2470
new_test.transport_server = self._transport_server
2471
new_test.transport_readonly_server = self._transport_readonly_server
2472
new_test.bzrdir_format = bzrdir_format
2473
new_test.workingtree_format = workingtree_format
2474
def make_new_test_id():
2475
new_id = "%s(%s)" % (test.id(), variation)
2476
return lambda: new_id
2477
new_test.id = make_new_test_id()
2480
def adapt(self, test):
2481
from bzrlib.tests import TestSuite
2482
result = TestSuite()
2483
for workingtree_format, bzrdir_format in self._formats:
2484
new_test = self._clone_test(
2487
workingtree_format, workingtree_format.__class__.__name__)
2488
result.addTest(new_test)