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
bzrbranch as _mod_bzrbranch,
22
revision as _mod_revision,
25
from ..branchbuilder import BranchBuilder
28
class TestBranchBuilder(tests.TestCaseWithMemoryTransport):
30
def test_create(self):
31
"""Test the constructor api."""
32
builder = BranchBuilder(self.get_transport().clone('foo'))
33
# we dont care if the branch has been built or not at this point.
35
def test_get_branch(self):
36
"""get_branch returns the created branch."""
37
builder = BranchBuilder(self.get_transport().clone('foo'))
38
branch = builder.get_branch()
39
self.assertIsInstance(branch, _mod_branch.Branch)
40
self.assertEqual(self.get_transport().clone('foo').base,
43
(0, _mod_revision.NULL_REVISION),
44
branch.last_revision_info())
46
def test_format(self):
47
"""Making a BranchBuilder with a format option sets the branch type."""
48
builder = BranchBuilder(self.get_transport(), format='dirstate-tags')
49
branch = builder.get_branch()
50
self.assertIsInstance(branch, _mod_bzrbranch.BzrBranch6)
52
def test_build_one_commit(self):
53
"""doing build_commit causes a commit to happen."""
54
builder = BranchBuilder(self.get_transport().clone('foo'))
55
rev_id = builder.build_commit()
56
branch = builder.get_branch()
57
self.assertEqual((1, rev_id), branch.last_revision_info())
60
branch.repository.get_revision(branch.last_revision()).message)
62
def test_build_commit_timestamp(self):
63
"""You can set a date when committing."""
64
builder = self.make_branch_builder('foo')
65
rev_id = builder.build_commit(timestamp=1236043340)
66
branch = builder.get_branch()
67
self.assertEqual((1, rev_id), branch.last_revision_info())
68
rev = branch.repository.get_revision(branch.last_revision())
76
def test_build_two_commits(self):
77
"""The second commit has the right parents and message."""
78
builder = BranchBuilder(self.get_transport().clone('foo'))
79
rev_id1 = builder.build_commit()
80
rev_id2 = builder.build_commit()
81
branch = builder.get_branch()
82
self.assertEqual((2, rev_id2), branch.last_revision_info())
85
branch.repository.get_revision(branch.last_revision()).message)
88
branch.repository.get_revision(branch.last_revision()).parent_ids)
90
def test_build_commit_parent_ids(self):
91
"""build_commit() takes a parent_ids argument."""
92
builder = BranchBuilder(self.get_transport().clone('foo'))
93
rev_id1 = builder.build_commit(
94
parent_ids=["ghost"], allow_leftmost_as_ghost=True)
95
rev_id2 = builder.build_commit(parent_ids=[])
96
branch = builder.get_branch()
97
self.assertEqual((1, rev_id2), branch.last_revision_info())
100
branch.repository.get_revision(rev_id1).parent_ids)
103
class TestBranchBuilderBuildSnapshot(tests.TestCaseWithMemoryTransport):
105
def assertTreeShape(self, expected_shape, tree):
106
"""Check that the tree shape matches expectations."""
109
entries = [(path, ie.file_id, ie.kind)
110
for path, ie in tree.iter_entries_by_dir()]
113
self.assertEqual(expected_shape, entries)
115
def build_a_rev(self):
116
builder = BranchBuilder(self.get_transport().clone('foo'))
117
rev_id1 = builder.build_snapshot('A-id', None,
118
[('add', ('', 'a-root-id', 'directory', None)),
119
('add', ('a', 'a-id', 'file', 'contents'))])
120
self.assertEqual('A-id', rev_id1)
123
def test_add_one_file(self):
124
builder = self.build_a_rev()
125
branch = builder.get_branch()
126
self.assertEqual((1, 'A-id'), branch.last_revision_info())
127
rev_tree = branch.repository.revision_tree('A-id')
129
self.addCleanup(rev_tree.unlock)
130
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
131
(u'a', 'a-id', 'file')], rev_tree)
132
self.assertEqual('contents', rev_tree.get_file_text('a-id'))
134
def test_add_second_file(self):
135
builder = self.build_a_rev()
136
rev_id2 = builder.build_snapshot('B-id', None,
137
[('add', ('b', 'b-id', 'file', 'content_b'))])
138
self.assertEqual('B-id', rev_id2)
139
branch = builder.get_branch()
140
self.assertEqual((2, rev_id2), branch.last_revision_info())
141
rev_tree = branch.repository.revision_tree(rev_id2)
143
self.addCleanup(rev_tree.unlock)
144
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
145
(u'a', 'a-id', 'file'),
146
(u'b', 'b-id', 'file')], rev_tree)
147
self.assertEqual('content_b', rev_tree.get_file_text('b-id'))
149
def test_add_empty_dir(self):
150
builder = self.build_a_rev()
151
rev_id2 = builder.build_snapshot('B-id', None,
152
[('add', ('b', 'b-id', 'directory', None))])
153
rev_tree = builder.get_branch().repository.revision_tree('B-id')
154
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
155
(u'a', 'a-id', 'file'),
156
(u'b', 'b-id', 'directory'),
159
def test_commit_timestamp(self):
160
builder = self.make_branch_builder('foo')
161
rev_id = builder.build_snapshot(None, None,
162
[('add', (u'', None, 'directory', None))],
163
timestamp=1234567890)
164
rev = builder.get_branch().repository.get_revision(rev_id)
169
def test_commit_message_default(self):
170
builder = BranchBuilder(self.get_transport().clone('foo'))
171
rev_id = builder.build_snapshot(None, None,
172
[('add', (u'', None, 'directory', None))])
173
branch = builder.get_branch()
174
rev = branch.repository.get_revision(rev_id)
175
self.assertEqual(u'commit 1', rev.message)
177
def test_commit_message_supplied(self):
178
builder = BranchBuilder(self.get_transport().clone('foo'))
179
rev_id = builder.build_snapshot(None, None,
180
[('add', (u'', None, 'directory', None))],
182
branch = builder.get_branch()
183
rev = branch.repository.get_revision(rev_id)
184
self.assertEqual(u'Foo', rev.message)
186
def test_commit_message_callback(self):
187
builder = BranchBuilder(self.get_transport().clone('foo'))
188
rev_id = builder.build_snapshot(None, None,
189
[('add', (u'', None, 'directory', None))],
190
message_callback=lambda x:u'Foo')
191
branch = builder.get_branch()
192
rev = branch.repository.get_revision(rev_id)
193
self.assertEqual(u'Foo', rev.message)
195
def test_modify_file(self):
196
builder = self.build_a_rev()
197
rev_id2 = builder.build_snapshot('B-id', None,
198
[('modify', ('a-id', 'new\ncontent\n'))])
199
self.assertEqual('B-id', rev_id2)
200
branch = builder.get_branch()
201
rev_tree = branch.repository.revision_tree(rev_id2)
203
self.addCleanup(rev_tree.unlock)
204
self.assertEqual('new\ncontent\n', rev_tree.get_file_text('a-id'))
206
def test_delete_file(self):
207
builder = self.build_a_rev()
208
rev_id2 = builder.build_snapshot('B-id', None,
209
[('unversion', 'a-id')])
210
self.assertEqual('B-id', rev_id2)
211
branch = builder.get_branch()
212
rev_tree = branch.repository.revision_tree(rev_id2)
214
self.addCleanup(rev_tree.unlock)
215
self.assertTreeShape([(u'', 'a-root-id', 'directory')], rev_tree)
217
def test_delete_directory(self):
218
builder = self.build_a_rev()
219
rev_id2 = builder.build_snapshot('B-id', None,
220
[('add', ('b', 'b-id', 'directory', None)),
221
('add', ('b/c', 'c-id', 'file', 'foo\n')),
222
('add', ('b/d', 'd-id', 'directory', None)),
223
('add', ('b/d/e', 'e-id', 'file', 'eff\n')),
225
rev_tree = builder.get_branch().repository.revision_tree('B-id')
226
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
227
(u'a', 'a-id', 'file'),
228
(u'b', 'b-id', 'directory'),
229
(u'b/c', 'c-id', 'file'),
230
(u'b/d', 'd-id', 'directory'),
231
(u'b/d/e', 'e-id', 'file')], rev_tree)
232
# Removing a directory removes all child dirs
233
builder.build_snapshot('C-id', None, [('unversion', 'b-id')])
234
rev_tree = builder.get_branch().repository.revision_tree('C-id')
235
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
236
(u'a', 'a-id', 'file'),
239
def test_unknown_action(self):
240
builder = self.build_a_rev()
241
e = self.assertRaises(ValueError,
242
builder.build_snapshot, 'B-id', None, [('weirdo', ('foo',))])
243
self.assertEqual('Unknown build action: "weirdo"', str(e))
245
def test_rename(self):
246
builder = self.build_a_rev()
247
builder.build_snapshot('B-id', None,
248
[('rename', ('a', 'b'))])
249
rev_tree = builder.get_branch().repository.revision_tree('B-id')
250
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
251
(u'b', 'a-id', 'file')], rev_tree)
253
def test_rename_into_subdir(self):
254
builder = self.build_a_rev()
255
builder.build_snapshot('B-id', None,
256
[('add', ('dir', 'dir-id', 'directory', None)),
257
('rename', ('a', 'dir/a'))])
258
rev_tree = builder.get_branch().repository.revision_tree('B-id')
259
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
260
(u'dir', 'dir-id', 'directory'),
261
(u'dir/a', 'a-id', 'file')], rev_tree)
263
def test_rename_out_of_unversioned_subdir(self):
264
builder = self.build_a_rev()
265
builder.build_snapshot('B-id', None,
266
[('add', ('dir', 'dir-id', 'directory', None)),
267
('rename', ('a', 'dir/a'))])
268
builder.build_snapshot('C-id', None,
269
[('rename', ('dir/a', 'a')),
270
('unversion', 'dir-id')])
271
rev_tree = builder.get_branch().repository.revision_tree('C-id')
272
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
273
(u'a', 'a-id', 'file')], rev_tree)
275
def test_set_parent(self):
276
builder = self.build_a_rev()
277
builder.start_series()
278
self.addCleanup(builder.finish_series)
279
builder.build_snapshot('B-id', ['A-id'],
280
[('modify', ('a-id', 'new\ncontent\n'))])
281
builder.build_snapshot('C-id', ['A-id'],
282
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
283
# We should now have a graph:
287
# And not A => B => C
288
repo = builder.get_branch().repository
289
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',)},
290
repo.get_parent_map(['B-id', 'C-id']))
291
b_tree = repo.revision_tree('B-id')
292
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
293
(u'a', 'a-id', 'file'),
295
self.assertEqual('new\ncontent\n', b_tree.get_file_text('a-id'))
297
# We should still be using the content from A in C, not from B
298
c_tree = repo.revision_tree('C-id')
299
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
300
(u'a', 'a-id', 'file'),
301
(u'c', 'c-id', 'file'),
303
self.assertEqual('contents', c_tree.get_file_text('a-id'))
304
self.assertEqual('alt\ncontent\n', c_tree.get_file_text('c-id'))
306
def test_set_merge_parent(self):
307
builder = self.build_a_rev()
308
builder.start_series()
309
self.addCleanup(builder.finish_series)
310
builder.build_snapshot('B-id', ['A-id'],
311
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))])
312
builder.build_snapshot('C-id', ['A-id'],
313
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
314
builder.build_snapshot('D-id', ['B-id', 'C-id'], [])
315
repo = builder.get_branch().repository
316
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
317
'D-id': ('B-id', 'C-id')},
318
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
319
d_tree = repo.revision_tree('D-id')
320
# Note: by default a merge node does *not* pull in the changes from the
321
# merged tree, you have to supply it yourself.
322
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
323
(u'a', 'a-id', 'file'),
324
(u'b', 'b-id', 'file'),
327
def test_set_merge_parent_and_contents(self):
328
builder = self.build_a_rev()
329
builder.start_series()
330
self.addCleanup(builder.finish_series)
331
builder.build_snapshot('B-id', ['A-id'],
332
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))])
333
builder.build_snapshot('C-id', ['A-id'],
334
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
335
builder.build_snapshot('D-id', ['B-id', 'C-id'],
336
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
337
repo = builder.get_branch().repository
338
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
339
'D-id': ('B-id', 'C-id')},
340
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
341
d_tree = repo.revision_tree('D-id')
342
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
343
(u'a', 'a-id', 'file'),
344
(u'b', 'b-id', 'file'),
345
(u'c', 'c-id', 'file'),
347
# Because we copied the exact text into *this* tree, the 'c' file
348
# should look like it was not modified in the merge
349
self.assertEqual('C-id', d_tree.get_file_revision('c-id'))
351
def test_set_parent_to_null(self):
352
builder = self.build_a_rev()
353
builder.start_series()
354
self.addCleanup(builder.finish_series)
355
builder.build_snapshot('B-id', [],
356
[('add', ('', None, 'directory', None))])
357
# We should now have a graph:
360
repo = builder.get_branch().repository
361
self.assertEqual({'A-id': (_mod_revision.NULL_REVISION,),
362
'B-id': (_mod_revision.NULL_REVISION,),},
363
repo.get_parent_map(['A-id', 'B-id']))
366
def test_start_finish_series(self):
367
builder = BranchBuilder(self.get_transport().clone('foo'))
368
builder.start_series()
370
self.assertIsNot(None, builder._tree)
371
self.assertEqual('w', builder._tree._lock_mode)
372
self.assertTrue(builder._branch.is_locked())
374
builder.finish_series()
375
self.assertIs(None, builder._tree)
376
self.assertFalse(builder._branch.is_locked())
378
def test_ghost_mainline_history(self):
379
builder = BranchBuilder(self.get_transport().clone('foo'))
380
builder.start_series()
382
builder.build_snapshot('tip', ['ghost'],
383
[('add', ('', 'ROOT_ID', 'directory', ''))],
384
allow_leftmost_as_ghost=True)
386
builder.finish_series()
387
b = builder.get_branch()
389
self.addCleanup(b.unlock)
390
self.assertEqual(('ghost',),
391
b.repository.get_graph().get_parent_map(['tip'])['tip'])
393
def test_unversion_root_add_new_root(self):
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,
399
[('unversion', 'TREE_ROOT'),
400
('add', ('', 'my-root', 'directory', ''))])
401
builder.finish_series()
402
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
403
self.assertTreeShape([(u'', 'my-root', 'directory')], rev_tree)
405
def test_empty_flush(self):
406
"""A flush with no actions before it is a no-op."""
407
builder = BranchBuilder(self.get_transport().clone('foo'))
408
builder.start_series()
409
builder.build_snapshot('rev-1', None,
410
[('add', ('', 'TREE_ROOT', 'directory', ''))])
411
builder.build_snapshot('rev-2', None, [('flush', None)])
412
builder.finish_series()
413
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
414
self.assertTreeShape([(u'', 'TREE_ROOT', 'directory')], rev_tree)
416
def test_kind_change(self):
417
"""It's possible to change the kind of an entry in a single snapshot
418
with a bit of help from the 'flush' action.
420
builder = BranchBuilder(self.get_transport().clone('foo'))
421
builder.start_series()
422
builder.build_snapshot('A-id', None,
423
[('add', (u'', 'a-root-id', 'directory', None)),
424
('add', (u'a', 'a-id', 'file', 'content\n'))])
425
builder.build_snapshot('B-id', None,
426
[('unversion', 'a-id'),
428
('add', (u'a', 'a-id', 'directory', None))])
429
builder.finish_series()
430
rev_tree = builder.get_branch().repository.revision_tree('B-id')
431
self.assertTreeShape(
432
[(u'', 'a-root-id', 'directory'), (u'a', 'a-id', 'directory')],
435
def test_pivot_root(self):
436
"""It's possible (albeit awkward) to move an existing dir to the root
437
in a single snapshot by using unversion then flush then add.
439
builder = BranchBuilder(self.get_transport().clone('foo'))
440
builder.start_series()
441
builder.build_snapshot('A-id', None,
442
[('add', (u'', 'orig-root', 'directory', None)),
443
('add', (u'dir', 'dir-id', 'directory', None))])
444
builder.build_snapshot('B-id', None,
445
[('unversion', 'orig-root'), # implicitly unversions all children
447
('add', (u'', 'dir-id', 'directory', None))])
448
builder.finish_series()
449
rev_tree = builder.get_branch().repository.revision_tree('B-id')
450
self.assertTreeShape([(u'', 'dir-id', 'directory')], rev_tree)