~bzr-pqm/bzr/bzr.dev

1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
1
# Copyright (C) 2006 Canonical Ltd
2
#
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.
7
#
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.
12
#
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
16
17
"""TreeBuilder helper class.
18
19
TreeBuilders are used to build trees of various shapres or properties. This 
20
can be extremely useful in testing for instance.
21
"""
22
23
from bzrlib import errors
24
25
26
class TreeBuilder(object):
27
    """A TreeBuilder allows the creation of specific content in one tree at a
28
    time.
29
    """
30
31
    def __init__(self):
32
        """Construct a TreeBuilder."""
33
        self._tree = None
1731.1.50 by Aaron Bentley
Merge bzr.dev
34
        self._root_done = False
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
35
36
    def build(self, recipe):
37
        """Build recipe into the current tree.
38
39
        :param recipe: A sequence of paths. For each path, the corresponding
40
            path in the current tree is created and added. If the path ends in
41
            '/' then a directory is added, otherwise a regular file is added.
42
        """
43
        self._ensure_building()
1731.1.50 by Aaron Bentley
Merge bzr.dev
44
        if not self._root_done:
45
            self._tree.add('', 'root-id', 'directory')
46
            self._root_done = True
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
47
        for name in recipe:
48
            assert isinstance(name, basestring)
49
            if name[-1] == '/':
50
                self._tree.mkdir(name[:-1])
51
            else:
52
                end = '\n'
53
                content = "contents of %s%s" % (name.encode('utf-8'), end)
54
                self._tree.add(name, None, 'file')
55
                file_id = self._tree.path2id(name)
56
                self._tree.put_file_bytes_non_atomic(file_id, content)
57
58
    def _ensure_building(self):
59
        """Raise NotBuilding if there is no current tree being built."""
60
        if self._tree is None:
61
            raise errors.NotBuilding
62
            
63
    def finish_tree(self):
64
        """Finish building the current tree."""
65
        self._ensure_building()
66
        tree = self._tree
67
        self._tree = None
68
        tree.unlock()
69
70
    def start_tree(self, tree):
71
        """Start building on tree.
72
        
73
        :param tree: A tree to start building on. It must provide the 
74
            MutableTree interface.
75
        """
76
        if self._tree is not None:
77
            raise errors.AlreadyBuilding
78
        self._tree = tree
1986.1.8 by Robert Collins
Update to bzr.dev, which involves adding lock_tree_write to MutableTree and MemoryTree.
79
        self._tree.lock_tree_write()