1
# Copyright (C) 2007-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for the BranchBuilder class."""
20
branch as _mod_branch,
21
revision as _mod_revision,
24
from bzrlib.branchbuilder import BranchBuilder
27
class TestBranchBuilder(tests.TestCaseWithMemoryTransport):
29
def test_create(self):
30
"""Test the constructor api."""
31
builder = BranchBuilder(self.get_transport().clone('foo'))
32
# we dont care if the branch has been built or not at this point.
34
def test_get_branch(self):
35
"""get_branch returns the created branch."""
36
builder = BranchBuilder(self.get_transport().clone('foo'))
37
branch = builder.get_branch()
38
self.assertIsInstance(branch, _mod_branch.Branch)
39
self.assertEqual(self.get_transport().clone('foo').base,
42
(0, _mod_revision.NULL_REVISION),
43
branch.last_revision_info())
45
def test_format(self):
46
"""Making a BranchBuilder with a format option sets the branch type."""
47
builder = BranchBuilder(self.get_transport(), format='dirstate-tags')
48
branch = builder.get_branch()
49
self.assertIsInstance(branch, _mod_branch.BzrBranch6)
51
def test_build_one_commit(self):
52
"""doing build_commit causes a commit to happen."""
53
builder = BranchBuilder(self.get_transport().clone('foo'))
54
rev_id = builder.build_commit()
55
branch = builder.get_branch()
56
self.assertEqual((1, rev_id), branch.last_revision_info())
59
branch.repository.get_revision(branch.last_revision()).message)
61
def test_build_commit_timestamp(self):
62
"""You can set a date when committing."""
63
builder = self.make_branch_builder('foo')
64
rev_id = builder.build_commit(timestamp=1236043340)
65
branch = builder.get_branch()
66
self.assertEqual((1, rev_id), branch.last_revision_info())
67
rev = branch.repository.get_revision(branch.last_revision())
75
def test_build_two_commits(self):
76
"""The second commit has the right parents and message."""
77
builder = BranchBuilder(self.get_transport().clone('foo'))
78
rev_id1 = builder.build_commit()
79
rev_id2 = builder.build_commit()
80
branch = builder.get_branch()
81
self.assertEqual((2, rev_id2), branch.last_revision_info())
84
branch.repository.get_revision(branch.last_revision()).message)
87
branch.repository.get_revision(branch.last_revision()).parent_ids)
90
class TestBranchBuilderBuildSnapshot(tests.TestCaseWithMemoryTransport):
92
def assertTreeShape(self, expected_shape, tree):
93
"""Check that the tree shape matches expectations."""
96
entries = [(path, ie.file_id, ie.kind)
97
for path, ie in tree.iter_entries_by_dir()]
100
self.assertEqual(expected_shape, entries)
102
def build_a_rev(self):
103
builder = BranchBuilder(self.get_transport().clone('foo'))
104
rev_id1 = builder.build_snapshot('A-id', None,
105
[('add', ('', 'a-root-id', 'directory', None)),
106
('add', ('a', 'a-id', 'file', 'contents'))])
107
self.assertEqual('A-id', rev_id1)
110
def test_add_one_file(self):
111
builder = self.build_a_rev()
112
branch = builder.get_branch()
113
self.assertEqual((1, 'A-id'), branch.last_revision_info())
114
rev_tree = branch.repository.revision_tree('A-id')
116
self.addCleanup(rev_tree.unlock)
117
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
118
(u'a', 'a-id', 'file')], rev_tree)
119
self.assertEqual('contents', rev_tree.get_file_text('a-id'))
121
def test_add_second_file(self):
122
builder = self.build_a_rev()
123
rev_id2 = builder.build_snapshot('B-id', None,
124
[('add', ('b', 'b-id', 'file', 'content_b'))])
125
self.assertEqual('B-id', rev_id2)
126
branch = builder.get_branch()
127
self.assertEqual((2, rev_id2), branch.last_revision_info())
128
rev_tree = branch.repository.revision_tree(rev_id2)
130
self.addCleanup(rev_tree.unlock)
131
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
132
(u'a', 'a-id', 'file'),
133
(u'b', 'b-id', 'file')], rev_tree)
134
self.assertEqual('content_b', rev_tree.get_file_text('b-id'))
136
def test_add_empty_dir(self):
137
builder = self.build_a_rev()
138
rev_id2 = builder.build_snapshot('B-id', None,
139
[('add', ('b', 'b-id', 'directory', None))])
140
rev_tree = builder.get_branch().repository.revision_tree('B-id')
141
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
142
(u'a', 'a-id', 'file'),
143
(u'b', 'b-id', 'directory'),
146
def test_commit_timestamp(self):
147
builder = self.make_branch_builder('foo')
148
rev_id = builder.build_snapshot(None, None,
149
[('add', (u'', None, 'directory', None))],
150
timestamp=1234567890)
151
rev = builder.get_branch().repository.get_revision(rev_id)
156
def test_commit_message_default(self):
157
builder = BranchBuilder(self.get_transport().clone('foo'))
158
rev_id = builder.build_snapshot(None, None,
159
[('add', (u'', None, 'directory', None))])
160
branch = builder.get_branch()
161
rev = branch.repository.get_revision(rev_id)
162
self.assertEqual(u'commit 1', rev.message)
164
def test_commit_message_supplied(self):
165
builder = BranchBuilder(self.get_transport().clone('foo'))
166
rev_id = builder.build_snapshot(None, None,
167
[('add', (u'', None, 'directory', None))],
169
branch = builder.get_branch()
170
rev = branch.repository.get_revision(rev_id)
171
self.assertEqual(u'Foo', rev.message)
173
def test_commit_message_callback(self):
174
builder = BranchBuilder(self.get_transport().clone('foo'))
175
rev_id = builder.build_snapshot(None, None,
176
[('add', (u'', None, 'directory', None))],
177
message_callback=lambda x:u'Foo')
178
branch = builder.get_branch()
179
rev = branch.repository.get_revision(rev_id)
180
self.assertEqual(u'Foo', rev.message)
182
def test_modify_file(self):
183
builder = self.build_a_rev()
184
rev_id2 = builder.build_snapshot('B-id', None,
185
[('modify', ('a-id', 'new\ncontent\n'))])
186
self.assertEqual('B-id', rev_id2)
187
branch = builder.get_branch()
188
rev_tree = branch.repository.revision_tree(rev_id2)
190
self.addCleanup(rev_tree.unlock)
191
self.assertEqual('new\ncontent\n', rev_tree.get_file_text('a-id'))
193
def test_delete_file(self):
194
builder = self.build_a_rev()
195
rev_id2 = builder.build_snapshot('B-id', None,
196
[('unversion', 'a-id')])
197
self.assertEqual('B-id', rev_id2)
198
branch = builder.get_branch()
199
rev_tree = branch.repository.revision_tree(rev_id2)
201
self.addCleanup(rev_tree.unlock)
202
self.assertTreeShape([(u'', 'a-root-id', 'directory')], rev_tree)
204
def test_delete_directory(self):
205
builder = self.build_a_rev()
206
rev_id2 = builder.build_snapshot('B-id', None,
207
[('add', ('b', 'b-id', 'directory', None)),
208
('add', ('b/c', 'c-id', 'file', 'foo\n')),
209
('add', ('b/d', 'd-id', 'directory', None)),
210
('add', ('b/d/e', 'e-id', 'file', 'eff\n')),
212
rev_tree = builder.get_branch().repository.revision_tree('B-id')
213
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
214
(u'a', 'a-id', 'file'),
215
(u'b', 'b-id', 'directory'),
216
(u'b/c', 'c-id', 'file'),
217
(u'b/d', 'd-id', 'directory'),
218
(u'b/d/e', 'e-id', 'file')], rev_tree)
219
# Removing a directory removes all child dirs
220
builder.build_snapshot('C-id', None, [('unversion', 'b-id')])
221
rev_tree = builder.get_branch().repository.revision_tree('C-id')
222
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
223
(u'a', 'a-id', 'file'),
226
def test_unknown_action(self):
227
builder = self.build_a_rev()
228
e = self.assertRaises(ValueError,
229
builder.build_snapshot, 'B-id', None, [('weirdo', ('foo',))])
230
self.assertEqual('Unknown build action: "weirdo"', str(e))
232
def test_rename(self):
233
builder = self.build_a_rev()
234
builder.build_snapshot('B-id', None,
235
[('rename', ('a', 'b'))])
236
rev_tree = builder.get_branch().repository.revision_tree('B-id')
237
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
238
(u'b', 'a-id', 'file')], rev_tree)
240
def test_rename_into_subdir(self):
241
builder = self.build_a_rev()
242
builder.build_snapshot('B-id', None,
243
[('add', ('dir', 'dir-id', 'directory', None)),
244
('rename', ('a', 'dir/a'))])
245
rev_tree = builder.get_branch().repository.revision_tree('B-id')
246
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
247
(u'dir', 'dir-id', 'directory'),
248
(u'dir/a', 'a-id', 'file')], rev_tree)
250
def test_rename_out_of_unversioned_subdir(self):
251
builder = self.build_a_rev()
252
builder.build_snapshot('B-id', None,
253
[('add', ('dir', 'dir-id', 'directory', None)),
254
('rename', ('a', 'dir/a'))])
255
builder.build_snapshot('C-id', None,
256
[('rename', ('dir/a', 'a')),
257
('unversion', 'dir-id')])
258
rev_tree = builder.get_branch().repository.revision_tree('C-id')
259
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
260
(u'a', 'a-id', 'file')], rev_tree)
262
def test_set_parent(self):
263
builder = self.build_a_rev()
264
builder.start_series()
265
self.addCleanup(builder.finish_series)
266
builder.build_snapshot('B-id', ['A-id'],
267
[('modify', ('a-id', 'new\ncontent\n'))])
268
builder.build_snapshot('C-id', ['A-id'],
269
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
270
# We should now have a graph:
274
# And not A => B => C
275
repo = builder.get_branch().repository
276
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',)},
277
repo.get_parent_map(['B-id', 'C-id']))
278
b_tree = repo.revision_tree('B-id')
279
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
280
(u'a', 'a-id', 'file'),
282
self.assertEqual('new\ncontent\n', b_tree.get_file_text('a-id'))
284
# We should still be using the content from A in C, not from B
285
c_tree = repo.revision_tree('C-id')
286
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
287
(u'a', 'a-id', 'file'),
288
(u'c', 'c-id', 'file'),
290
self.assertEqual('contents', c_tree.get_file_text('a-id'))
291
self.assertEqual('alt\ncontent\n', c_tree.get_file_text('c-id'))
293
def test_set_merge_parent(self):
294
builder = self.build_a_rev()
295
builder.start_series()
296
self.addCleanup(builder.finish_series)
297
builder.build_snapshot('B-id', ['A-id'],
298
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))])
299
builder.build_snapshot('C-id', ['A-id'],
300
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
301
builder.build_snapshot('D-id', ['B-id', 'C-id'], [])
302
repo = builder.get_branch().repository
303
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
304
'D-id': ('B-id', 'C-id')},
305
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
306
d_tree = repo.revision_tree('D-id')
307
# Note: by default a merge node does *not* pull in the changes from the
308
# merged tree, you have to supply it yourself.
309
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
310
(u'a', 'a-id', 'file'),
311
(u'b', 'b-id', 'file'),
314
def test_set_merge_parent_and_contents(self):
315
builder = self.build_a_rev()
316
builder.start_series()
317
self.addCleanup(builder.finish_series)
318
builder.build_snapshot('B-id', ['A-id'],
319
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))])
320
builder.build_snapshot('C-id', ['A-id'],
321
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
322
builder.build_snapshot('D-id', ['B-id', 'C-id'],
323
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
324
repo = builder.get_branch().repository
325
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
326
'D-id': ('B-id', 'C-id')},
327
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
328
d_tree = repo.revision_tree('D-id')
329
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
330
(u'a', 'a-id', 'file'),
331
(u'b', 'b-id', 'file'),
332
(u'c', 'c-id', 'file'),
334
# Because we copied the exact text into *this* tree, the 'c' file
335
# should look like it was not modified in the merge
336
self.assertEqual('C-id', d_tree.get_file_revision('c-id'))
338
def test_set_parent_to_null(self):
339
builder = self.build_a_rev()
340
builder.start_series()
341
self.addCleanup(builder.finish_series)
342
builder.build_snapshot('B-id', [],
343
[('add', ('', None, 'directory', None))])
344
# We should now have a graph:
347
repo = builder.get_branch().repository
348
self.assertEqual({'A-id': (_mod_revision.NULL_REVISION,),
349
'B-id': (_mod_revision.NULL_REVISION,),},
350
repo.get_parent_map(['A-id', 'B-id']))
353
def test_start_finish_series(self):
354
builder = BranchBuilder(self.get_transport().clone('foo'))
355
builder.start_series()
357
self.assertIsNot(None, builder._tree)
358
self.assertEqual('w', builder._tree._lock_mode)
359
self.assertTrue(builder._branch.is_locked())
361
builder.finish_series()
362
self.assertIs(None, builder._tree)
363
self.assertFalse(builder._branch.is_locked())
365
def test_ghost_mainline_history(self):
366
builder = BranchBuilder(self.get_transport().clone('foo'))
367
builder.start_series()
369
builder.build_snapshot('tip', ['ghost'],
370
[('add', ('', 'ROOT_ID', 'directory', ''))],
371
allow_leftmost_as_ghost=True)
373
builder.finish_series()
374
b = builder.get_branch()
376
self.addCleanup(b.unlock)
377
self.assertEqual(('ghost',),
378
b.repository.get_graph().get_parent_map(['tip'])['tip'])
380
def test_unversion_root_add_new_root(self):
381
builder = BranchBuilder(self.get_transport().clone('foo'))
382
builder.start_series()
383
builder.build_snapshot('rev-1', None,
384
[('add', ('', 'TREE_ROOT', 'directory', ''))])
385
builder.build_snapshot('rev-2', None,
386
[('unversion', 'TREE_ROOT'),
387
('add', ('', 'my-root', 'directory', ''))])
388
builder.finish_series()
389
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
390
self.assertTreeShape([(u'', 'my-root', 'directory')], rev_tree)
392
def test_empty_flush(self):
393
"""A flush with no actions before it is a no-op."""
394
builder = BranchBuilder(self.get_transport().clone('foo'))
395
builder.start_series()
396
builder.build_snapshot('rev-1', None,
397
[('add', ('', 'TREE_ROOT', 'directory', ''))])
398
builder.build_snapshot('rev-2', None, [('flush', None)])
399
builder.finish_series()
400
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
401
self.assertTreeShape([(u'', 'TREE_ROOT', 'directory')], rev_tree)
403
def test_kind_change(self):
404
"""It's possible to change the kind of an entry in a single snapshot
405
with a bit of help from the 'flush' action.
407
builder = BranchBuilder(self.get_transport().clone('foo'))
408
builder.start_series()
409
builder.build_snapshot('A-id', None,
410
[('add', (u'', 'a-root-id', 'directory', None)),
411
('add', (u'a', 'a-id', 'file', 'content\n'))])
412
builder.build_snapshot('B-id', None,
413
[('unversion', 'a-id'),
415
('add', (u'a', 'a-id', 'directory', None))])
416
builder.finish_series()
417
rev_tree = builder.get_branch().repository.revision_tree('B-id')
418
self.assertTreeShape(
419
[(u'', 'a-root-id', 'directory'), (u'a', 'a-id', 'directory')],
422
def test_pivot_root(self):
423
"""It's possible (albeit awkward) to move an existing dir to the root
424
in a single snapshot by using unversion then flush then add.
426
builder = BranchBuilder(self.get_transport().clone('foo'))
427
builder.start_series()
428
builder.build_snapshot('A-id', None,
429
[('add', (u'', 'orig-root', 'directory', None)),
430
('add', (u'dir', 'dir-id', 'directory', None))])
431
builder.build_snapshot('B-id', None,
432
[('unversion', 'orig-root'), # implicitly unversions all children
434
('add', (u'', 'dir-id', 'directory', None))])
435
builder.finish_series()
436
rev_tree = builder.get_branch().repository.revision_tree('B-id')
437
self.assertTreeShape([(u'', 'dir-id', 'directory')], rev_tree)