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,
25
branch as _mod_bzrbranch,
27
from ..branchbuilder import BranchBuilder
30
class TestBranchBuilder(tests.TestCaseWithMemoryTransport):
32
def test_create(self):
33
"""Test the constructor api."""
34
builder = BranchBuilder(self.get_transport().clone('foo'))
35
# we dont care if the branch has been built or not at this point.
37
def test_get_branch(self):
38
"""get_branch returns the created branch."""
39
builder = BranchBuilder(self.get_transport().clone('foo'))
40
branch = builder.get_branch()
41
self.assertIsInstance(branch, _mod_branch.Branch)
42
self.assertEqual(self.get_transport().clone('foo').base,
45
(0, _mod_revision.NULL_REVISION),
46
branch.last_revision_info())
48
def test_format(self):
49
"""Making a BranchBuilder with a format option sets the branch type."""
50
builder = BranchBuilder(self.get_transport(), format='dirstate-tags')
51
branch = builder.get_branch()
52
self.assertIsInstance(branch, _mod_bzrbranch.BzrBranch6)
54
def test_build_one_commit(self):
55
"""doing build_commit causes a commit to happen."""
56
builder = BranchBuilder(self.get_transport().clone('foo'))
57
rev_id = builder.build_commit()
58
branch = builder.get_branch()
59
self.assertEqual((1, rev_id), branch.last_revision_info())
62
branch.repository.get_revision(branch.last_revision()).message)
64
def test_build_commit_timestamp(self):
65
"""You can set a date when committing."""
66
builder = self.make_branch_builder('foo')
67
rev_id = builder.build_commit(timestamp=1236043340)
68
branch = builder.get_branch()
69
self.assertEqual((1, rev_id), branch.last_revision_info())
70
rev = branch.repository.get_revision(branch.last_revision())
78
def test_build_two_commits(self):
79
"""The second commit has the right parents and message."""
80
builder = BranchBuilder(self.get_transport().clone('foo'))
81
rev_id1 = builder.build_commit()
82
rev_id2 = builder.build_commit()
83
branch = builder.get_branch()
84
self.assertEqual((2, rev_id2), branch.last_revision_info())
87
branch.repository.get_revision(branch.last_revision()).message)
90
branch.repository.get_revision(branch.last_revision()).parent_ids)
92
def test_build_commit_parent_ids(self):
93
"""build_commit() takes a parent_ids argument."""
94
builder = BranchBuilder(self.get_transport().clone('foo'))
95
rev_id1 = builder.build_commit(
96
parent_ids=["ghost"], allow_leftmost_as_ghost=True)
97
rev_id2 = builder.build_commit(parent_ids=[])
98
branch = builder.get_branch()
99
self.assertEqual((1, rev_id2), branch.last_revision_info())
102
branch.repository.get_revision(rev_id1).parent_ids)
105
class TestBranchBuilderBuildSnapshot(tests.TestCaseWithMemoryTransport):
107
def assertTreeShape(self, expected_shape, tree):
108
"""Check that the tree shape matches expectations."""
111
entries = [(path, ie.file_id, ie.kind)
112
for path, ie in tree.iter_entries_by_dir()]
115
self.assertEqual(expected_shape, entries)
117
def build_a_rev(self):
118
builder = BranchBuilder(self.get_transport().clone('foo'))
119
rev_id1 = builder.build_snapshot(None,
120
[('add', ('', 'a-root-id', 'directory', None)),
121
('add', ('a', 'a-id', 'file', 'contents'))],
123
self.assertEqual('A-id', rev_id1)
126
def test_add_one_file(self):
127
builder = self.build_a_rev()
128
branch = builder.get_branch()
129
self.assertEqual((1, 'A-id'), branch.last_revision_info())
130
rev_tree = branch.repository.revision_tree('A-id')
132
self.addCleanup(rev_tree.unlock)
133
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
134
(u'a', 'a-id', 'file')], rev_tree)
135
self.assertEqual('contents', rev_tree.get_file_text('a'))
137
def test_add_second_file(self):
138
builder = self.build_a_rev()
139
rev_id2 = builder.build_snapshot(None,
140
[('add', ('b', 'b-id', 'file', 'content_b'))],
142
self.assertEqual('B-id', rev_id2)
143
branch = builder.get_branch()
144
self.assertEqual((2, rev_id2), branch.last_revision_info())
145
rev_tree = branch.repository.revision_tree(rev_id2)
147
self.addCleanup(rev_tree.unlock)
148
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
149
(u'a', 'a-id', 'file'),
150
(u'b', 'b-id', 'file')], rev_tree)
151
self.assertEqual('content_b', rev_tree.get_file_text('b'))
153
def test_add_empty_dir(self):
154
builder = self.build_a_rev()
155
rev_id2 = builder.build_snapshot(None,
156
[('add', ('b', 'b-id', 'directory', None))],
158
rev_tree = builder.get_branch().repository.revision_tree('B-id')
159
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
160
(u'a', 'a-id', 'file'),
161
(u'b', 'b-id', 'directory'),
164
def test_commit_timestamp(self):
165
builder = self.make_branch_builder('foo')
166
rev_id = builder.build_snapshot(None,
167
[('add', (u'', None, 'directory', None))],
168
timestamp=1234567890)
169
rev = builder.get_branch().repository.get_revision(rev_id)
174
def test_commit_message_default(self):
175
builder = BranchBuilder(self.get_transport().clone('foo'))
176
rev_id = builder.build_snapshot(None,
177
[('add', (u'', None, 'directory', None))])
178
branch = builder.get_branch()
179
rev = branch.repository.get_revision(rev_id)
180
self.assertEqual(u'commit 1', rev.message)
182
def test_commit_message_supplied(self):
183
builder = BranchBuilder(self.get_transport().clone('foo'))
184
rev_id = builder.build_snapshot(None,
185
[('add', (u'', None, 'directory', None))],
187
branch = builder.get_branch()
188
rev = branch.repository.get_revision(rev_id)
189
self.assertEqual(u'Foo', rev.message)
191
def test_commit_message_callback(self):
192
builder = BranchBuilder(self.get_transport().clone('foo'))
193
rev_id = builder.build_snapshot(None,
194
[('add', (u'', None, 'directory', None))],
195
message_callback=lambda x:u'Foo')
196
branch = builder.get_branch()
197
rev = branch.repository.get_revision(rev_id)
198
self.assertEqual(u'Foo', rev.message)
200
def test_modify_file(self):
201
builder = self.build_a_rev()
202
rev_id2 = builder.build_snapshot(None,
203
[('modify', ('a', 'new\ncontent\n'))],
205
self.assertEqual('B-id', rev_id2)
206
branch = builder.get_branch()
207
rev_tree = branch.repository.revision_tree(rev_id2)
209
self.addCleanup(rev_tree.unlock)
210
self.assertEqual('new\ncontent\n',
211
rev_tree.get_file_text(rev_tree.id2path(b'a-id')))
213
def test_delete_file(self):
214
builder = self.build_a_rev()
215
rev_id2 = builder.build_snapshot(None,
216
[('unversion', 'a')], revision_id='B-id')
217
self.assertEqual('B-id', rev_id2)
218
branch = builder.get_branch()
219
rev_tree = branch.repository.revision_tree(rev_id2)
221
self.addCleanup(rev_tree.unlock)
222
self.assertTreeShape([(u'', 'a-root-id', 'directory')], rev_tree)
224
def test_delete_directory(self):
225
builder = self.build_a_rev()
226
rev_id2 = builder.build_snapshot(None,
227
[('add', ('b', 'b-id', 'directory', None)),
228
('add', ('b/c', 'c-id', 'file', 'foo\n')),
229
('add', ('b/d', 'd-id', 'directory', None)),
230
('add', ('b/d/e', 'e-id', 'file', 'eff\n')),
231
], revision_id='B-id')
232
rev_tree = builder.get_branch().repository.revision_tree('B-id')
233
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
234
(u'a', 'a-id', 'file'),
235
(u'b', 'b-id', 'directory'),
236
(u'b/c', 'c-id', 'file'),
237
(u'b/d', 'd-id', 'directory'),
238
(u'b/d/e', 'e-id', 'file')], rev_tree)
239
# Removing a directory removes all child dirs
240
builder.build_snapshot(
241
None, [('unversion', 'b')],
243
rev_tree = builder.get_branch().repository.revision_tree('C-id')
244
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
245
(u'a', 'a-id', 'file'),
248
def test_unknown_action(self):
249
builder = self.build_a_rev()
250
e = self.assertRaises(ValueError,
251
builder.build_snapshot, None, [('weirdo', ('foo',))],
253
self.assertEqual('Unknown build action: "weirdo"', str(e))
255
def test_rename(self):
256
builder = self.build_a_rev()
257
builder.build_snapshot(None,
258
[('rename', ('a', 'b'))], revision_id='B-id')
259
rev_tree = builder.get_branch().repository.revision_tree('B-id')
260
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
261
(u'b', 'a-id', 'file')], rev_tree)
263
def test_rename_into_subdir(self):
264
builder = self.build_a_rev()
265
builder.build_snapshot(None,
266
[('add', ('dir', 'dir-id', 'directory', None)),
267
('rename', ('a', 'dir/a'))], revision_id='B-id')
268
rev_tree = builder.get_branch().repository.revision_tree('B-id')
269
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
270
(u'dir', 'dir-id', 'directory'),
271
(u'dir/a', 'a-id', 'file')], rev_tree)
273
def test_rename_out_of_unversioned_subdir(self):
274
builder = self.build_a_rev()
275
builder.build_snapshot(None,
276
[('add', ('dir', 'dir-id', 'directory', None)),
277
('rename', ('a', 'dir/a'))],
279
builder.build_snapshot(None,
280
[('rename', ('dir/a', 'a')),
281
('unversion', 'dir')], revision_id='C-id')
282
rev_tree = builder.get_branch().repository.revision_tree('C-id')
283
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
284
(u'a', 'a-id', 'file')], rev_tree)
286
def test_set_parent(self):
287
builder = self.build_a_rev()
288
builder.start_series()
289
self.addCleanup(builder.finish_series)
290
builder.build_snapshot(['A-id'],
291
[('modify', ('a', 'new\ncontent\n'))],
293
builder.build_snapshot(['A-id'],
294
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))],
296
# We should now have a graph:
300
# And not A => B => C
301
repo = builder.get_branch().repository
302
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',)},
303
repo.get_parent_map(['B-id', 'C-id']))
304
b_tree = repo.revision_tree('B-id')
305
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
306
(u'a', 'a-id', 'file'),
308
self.assertEqual('new\ncontent\n', b_tree.get_file_text('a'))
310
# We should still be using the content from A in C, not from B
311
c_tree = repo.revision_tree('C-id')
312
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
313
(u'a', 'a-id', 'file'),
314
(u'c', 'c-id', 'file'),
316
self.assertEqual('contents', c_tree.get_file_text('a'))
317
self.assertEqual('alt\ncontent\n', c_tree.get_file_text('c'))
319
def test_set_merge_parent(self):
320
builder = self.build_a_rev()
321
builder.start_series()
322
self.addCleanup(builder.finish_series)
323
builder.build_snapshot(['A-id'],
324
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))],
326
builder.build_snapshot(['A-id'],
327
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))],
329
builder.build_snapshot(['B-id', 'C-id'], [], revision_id='D-id')
330
repo = builder.get_branch().repository
331
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
332
'D-id': ('B-id', 'C-id')},
333
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
334
d_tree = repo.revision_tree('D-id')
335
# Note: by default a merge node does *not* pull in the changes from the
336
# merged tree, you have to supply it yourself.
337
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
338
(u'a', 'a-id', 'file'),
339
(u'b', 'b-id', 'file'),
342
def test_set_merge_parent_and_contents(self):
343
builder = self.build_a_rev()
344
builder.start_series()
345
self.addCleanup(builder.finish_series)
346
builder.build_snapshot(['A-id'],
347
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))],
349
builder.build_snapshot(['A-id'],
350
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))],
352
builder.build_snapshot(['B-id', 'C-id'],
353
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))],
355
repo = builder.get_branch().repository
356
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
357
'D-id': ('B-id', 'C-id')},
358
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
359
d_tree = repo.revision_tree('D-id')
360
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
361
(u'a', 'a-id', 'file'),
362
(u'b', 'b-id', 'file'),
363
(u'c', 'c-id', 'file'),
365
# Because we copied the exact text into *this* tree, the 'c' file
366
# should look like it was not modified in the merge
367
self.assertEqual('C-id', d_tree.get_file_revision('c'))
369
def test_set_parent_to_null(self):
370
builder = self.build_a_rev()
371
builder.start_series()
372
self.addCleanup(builder.finish_series)
373
builder.build_snapshot([],
374
[('add', ('', None, 'directory', None))],
376
# We should now have a graph:
379
repo = builder.get_branch().repository
380
self.assertEqual({'A-id': (_mod_revision.NULL_REVISION,),
381
'B-id': (_mod_revision.NULL_REVISION,),},
382
repo.get_parent_map(['A-id', 'B-id']))
385
def test_start_finish_series(self):
386
builder = BranchBuilder(self.get_transport().clone('foo'))
387
builder.start_series()
389
self.assertIsNot(None, builder._tree)
390
self.assertEqual('w', builder._tree._lock_mode)
391
self.assertTrue(builder._branch.is_locked())
393
builder.finish_series()
394
self.assertIs(None, builder._tree)
395
self.assertFalse(builder._branch.is_locked())
397
def test_ghost_mainline_history(self):
398
builder = BranchBuilder(self.get_transport().clone('foo'))
399
builder.start_series()
401
builder.build_snapshot(['ghost'],
402
[('add', ('', 'ROOT_ID', 'directory', ''))],
403
allow_leftmost_as_ghost=True, revision_id='tip')
405
builder.finish_series()
406
b = builder.get_branch()
408
self.addCleanup(b.unlock)
409
self.assertEqual(('ghost',),
410
b.repository.get_graph().get_parent_map(['tip'])['tip'])
412
def test_unversion_root_add_new_root(self):
413
builder = BranchBuilder(self.get_transport().clone('foo'))
414
builder.start_series()
415
builder.build_snapshot(None,
416
[('add', ('', 'TREE_ROOT', 'directory', ''))],
418
builder.build_snapshot(None,
420
('add', ('', 'my-root', 'directory', ''))],
422
builder.finish_series()
423
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
424
self.assertTreeShape([(u'', 'my-root', 'directory')], rev_tree)
426
def test_empty_flush(self):
427
"""A flush with no actions before it is a no-op."""
428
builder = BranchBuilder(self.get_transport().clone('foo'))
429
builder.start_series()
430
builder.build_snapshot(None,
431
[('add', ('', 'TREE_ROOT', 'directory', ''))],
433
builder.build_snapshot(None, [('flush', None)], revision_id='rev-2')
434
builder.finish_series()
435
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
436
self.assertTreeShape([(u'', 'TREE_ROOT', 'directory')], rev_tree)
438
def test_kind_change(self):
439
"""It's possible to change the kind of an entry in a single snapshot
440
with a bit of help from the 'flush' action.
442
builder = BranchBuilder(self.get_transport().clone('foo'))
443
builder.start_series()
444
builder.build_snapshot(None,
445
[('add', (u'', 'a-root-id', 'directory', None)),
446
('add', (u'a', 'a-id', 'file', 'content\n'))],
448
builder.build_snapshot(None,
451
('add', (u'a', 'a-id', 'directory', None))],
453
builder.finish_series()
454
rev_tree = builder.get_branch().repository.revision_tree('B-id')
455
self.assertTreeShape(
456
[(u'', 'a-root-id', 'directory'), (u'a', 'a-id', 'directory')],
459
def test_pivot_root(self):
460
"""It's possible (albeit awkward) to move an existing dir to the root
461
in a single snapshot by using unversion then flush then add.
463
builder = BranchBuilder(self.get_transport().clone('foo'))
464
builder.start_series()
465
builder.build_snapshot(None,
466
[('add', (u'', 'orig-root', 'directory', None)),
467
('add', (u'dir', 'dir-id', 'directory', None))],
469
builder.build_snapshot(None,
470
[('unversion', ''), # implicitly unversions all children
472
('add', (u'', 'dir-id', 'directory', None))],
474
builder.finish_series()
475
rev_tree = builder.get_branch().repository.revision_tree('B-id')
476
self.assertTreeShape([(u'', 'dir-id', 'directory')], rev_tree)