/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branchbuilder.py

  • Committer: John Arbash Meinel
  • Date: 2008-07-22 18:12:25 UTC
  • mto: (3514.4.6 merge_lca_multi)
  • mto: This revision was merged to the branch mainline in revision 3590.
  • Revision ID: john@arbash-meinel.com-20080722181225-nx1dwfmb4wky600x
Revert back to using MemoryTree.mkdir() rather than creating the directory during add().

This complicates the api a bit, because we have to use multiple passes,
but at least we don't change any tested behavior.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2007 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
"""Utility for create branches with particular contents."""
 
18
 
 
19
from bzrlib import bzrdir, errors, memorytree
 
20
 
 
21
 
 
22
class BranchBuilder(object):
 
23
    """A BranchBuilder aids creating Branches with particular shapes.
 
24
    
 
25
    The expected way to use BranchBuilder is to construct a
 
26
    BranchBuilder on the transport you want your branch on, and then call
 
27
    appropriate build_ methods on it to get the shape of history you want.
 
28
 
 
29
    For instance:
 
30
      builder = BranchBuilder(self.get_transport().clone('relpath'))
 
31
      builder.build_commit()
 
32
      builder.build_commit()
 
33
      builder.build_commit()
 
34
      branch = builder.get_branch()
 
35
    """
 
36
 
 
37
    def __init__(self, transport, format=None):
 
38
        """Construct a BranchBuilder on transport.
 
39
        
 
40
        :param transport: The transport the branch should be created on.
 
41
            If the path of the transport does not exist but its parent does
 
42
            it will be created.
 
43
        :param format: The name of a format in the bzrdir format registry
 
44
            for the branch to be built.
 
45
        """
 
46
        if not transport.has('.'):
 
47
            transport.mkdir('.')
 
48
        if format is None:
 
49
            format = 'default'
 
50
        self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
 
51
            format=bzrdir.format_registry.make_bzrdir(format))
 
52
 
 
53
    def build_commit(self):
 
54
        """Build a commit on the branch."""
 
55
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
56
        tree.lock_write()
 
57
        try:
 
58
            tree.add('')
 
59
            return tree.commit('commit %d' % (self._branch.revno() + 1))
 
60
        finally:
 
61
            tree.unlock()
 
62
 
 
63
    def build_snapshot(self, parent_ids, revision_id, actions):
 
64
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
65
        tree.lock_write()
 
66
        try:
 
67
            # Unfortunately, MemoryTree.add(directory) just creates an
 
68
            # inventory entry. And the only public function to create a
 
69
            # directory is MemoryTree.mkdir() which creates the directory, but
 
70
            # also always adds it. So we have to use a multi-pass setup.
 
71
            to_add_directories = []
 
72
            to_add_files = []
 
73
            to_add_file_ids = []
 
74
            to_add_kinds = []
 
75
            new_contents = {}
 
76
            to_unversion_ids = []
 
77
            # to_rename = []
 
78
            for action, info in actions:
 
79
                if action == 'add':
 
80
                    path, file_id, kind, content = info
 
81
                    if kind == 'directory':
 
82
                        to_add_directories.append((path, file_id))
 
83
                    else:
 
84
                        to_add_files.append(path)
 
85
                        to_add_file_ids.append(file_id)
 
86
                        to_add_kinds.append(kind)
 
87
                        if content is not None:
 
88
                            new_contents[file_id] = content
 
89
                elif action == 'modify':
 
90
                    file_id, content = info
 
91
                    new_contents[file_id] = content
 
92
                elif action == 'unversion':
 
93
                    to_unversion_ids.append(info)
 
94
                else:
 
95
                    raise errors.UnknownBuildAction(action)
 
96
            if to_unversion_ids:
 
97
                tree.unversion(to_unversion_ids)
 
98
            for path, file_id in to_add_directories:
 
99
                if path == '':
 
100
                    # Special case, because the path already exists
 
101
                    tree.add([path], [file_id], ['directory'])
 
102
                else:
 
103
                    tree.mkdir(path, file_id)
 
104
            tree.add(to_add_files, to_add_file_ids, to_add_kinds)
 
105
            for file_id, content in new_contents.iteritems():
 
106
                tree.put_file_bytes_non_atomic(file_id, content)
 
107
 
 
108
            return tree.commit('commit %s' % (revision_id,), rev_id=revision_id)
 
109
        finally:
 
110
            tree.unlock()
 
111
 
 
112
    def get_branch(self):
 
113
        """Return the branch created by the builder."""
 
114
        return self._branch