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('A-id', None,
120
[('add', ('', 'a-root-id', 'directory', None)),
121
('add', ('a', 'a-id', 'file', 'contents'))])
122
self.assertEqual('A-id', rev_id1)
125
def test_add_one_file(self):
126
builder = self.build_a_rev()
127
branch = builder.get_branch()
128
self.assertEqual((1, 'A-id'), branch.last_revision_info())
129
rev_tree = branch.repository.revision_tree('A-id')
131
self.addCleanup(rev_tree.unlock)
132
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
133
(u'a', 'a-id', 'file')], rev_tree)
134
self.assertEqual('contents', rev_tree.get_file_text('a-id'))
136
def test_add_second_file(self):
137
builder = self.build_a_rev()
138
rev_id2 = builder.build_snapshot('B-id', None,
139
[('add', ('b', 'b-id', 'file', 'content_b'))])
140
self.assertEqual('B-id', rev_id2)
141
branch = builder.get_branch()
142
self.assertEqual((2, rev_id2), branch.last_revision_info())
143
rev_tree = branch.repository.revision_tree(rev_id2)
145
self.addCleanup(rev_tree.unlock)
146
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
147
(u'a', 'a-id', 'file'),
148
(u'b', 'b-id', 'file')], rev_tree)
149
self.assertEqual('content_b', rev_tree.get_file_text('b-id'))
151
def test_add_empty_dir(self):
152
builder = self.build_a_rev()
153
rev_id2 = builder.build_snapshot('B-id', None,
154
[('add', ('b', 'b-id', 'directory', None))])
155
rev_tree = builder.get_branch().repository.revision_tree('B-id')
156
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
157
(u'a', 'a-id', 'file'),
158
(u'b', 'b-id', 'directory'),
161
def test_commit_timestamp(self):
162
builder = self.make_branch_builder('foo')
163
rev_id = builder.build_snapshot(None, None,
164
[('add', (u'', None, 'directory', None))],
165
timestamp=1234567890)
166
rev = builder.get_branch().repository.get_revision(rev_id)
171
def test_commit_message_default(self):
172
builder = BranchBuilder(self.get_transport().clone('foo'))
173
rev_id = builder.build_snapshot(None, None,
174
[('add', (u'', None, 'directory', None))])
175
branch = builder.get_branch()
176
rev = branch.repository.get_revision(rev_id)
177
self.assertEqual(u'commit 1', rev.message)
179
def test_commit_message_supplied(self):
180
builder = BranchBuilder(self.get_transport().clone('foo'))
181
rev_id = builder.build_snapshot(None, None,
182
[('add', (u'', None, 'directory', None))],
184
branch = builder.get_branch()
185
rev = branch.repository.get_revision(rev_id)
186
self.assertEqual(u'Foo', rev.message)
188
def test_commit_message_callback(self):
189
builder = BranchBuilder(self.get_transport().clone('foo'))
190
rev_id = builder.build_snapshot(None, None,
191
[('add', (u'', None, 'directory', None))],
192
message_callback=lambda x:u'Foo')
193
branch = builder.get_branch()
194
rev = branch.repository.get_revision(rev_id)
195
self.assertEqual(u'Foo', rev.message)
197
def test_modify_file(self):
198
builder = self.build_a_rev()
199
rev_id2 = builder.build_snapshot('B-id', None,
200
[('modify', ('a-id', 'new\ncontent\n'))])
201
self.assertEqual('B-id', rev_id2)
202
branch = builder.get_branch()
203
rev_tree = branch.repository.revision_tree(rev_id2)
205
self.addCleanup(rev_tree.unlock)
206
self.assertEqual('new\ncontent\n', rev_tree.get_file_text('a-id'))
208
def test_delete_file(self):
209
builder = self.build_a_rev()
210
rev_id2 = builder.build_snapshot('B-id', None,
211
[('unversion', 'a-id')])
212
self.assertEqual('B-id', rev_id2)
213
branch = builder.get_branch()
214
rev_tree = branch.repository.revision_tree(rev_id2)
216
self.addCleanup(rev_tree.unlock)
217
self.assertTreeShape([(u'', 'a-root-id', 'directory')], rev_tree)
219
def test_delete_directory(self):
220
builder = self.build_a_rev()
221
rev_id2 = builder.build_snapshot('B-id', None,
222
[('add', ('b', 'b-id', 'directory', None)),
223
('add', ('b/c', 'c-id', 'file', 'foo\n')),
224
('add', ('b/d', 'd-id', 'directory', None)),
225
('add', ('b/d/e', 'e-id', 'file', 'eff\n')),
227
rev_tree = builder.get_branch().repository.revision_tree('B-id')
228
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
229
(u'a', 'a-id', 'file'),
230
(u'b', 'b-id', 'directory'),
231
(u'b/c', 'c-id', 'file'),
232
(u'b/d', 'd-id', 'directory'),
233
(u'b/d/e', 'e-id', 'file')], rev_tree)
234
# Removing a directory removes all child dirs
235
builder.build_snapshot('C-id', None, [('unversion', 'b-id')])
236
rev_tree = builder.get_branch().repository.revision_tree('C-id')
237
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
238
(u'a', 'a-id', 'file'),
241
def test_unknown_action(self):
242
builder = self.build_a_rev()
243
e = self.assertRaises(ValueError,
244
builder.build_snapshot, 'B-id', None, [('weirdo', ('foo',))])
245
self.assertEqual('Unknown build action: "weirdo"', str(e))
247
def test_rename(self):
248
builder = self.build_a_rev()
249
builder.build_snapshot('B-id', None,
250
[('rename', ('a', 'b'))])
251
rev_tree = builder.get_branch().repository.revision_tree('B-id')
252
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
253
(u'b', 'a-id', 'file')], rev_tree)
255
def test_rename_into_subdir(self):
256
builder = self.build_a_rev()
257
builder.build_snapshot('B-id', None,
258
[('add', ('dir', 'dir-id', 'directory', None)),
259
('rename', ('a', 'dir/a'))])
260
rev_tree = builder.get_branch().repository.revision_tree('B-id')
261
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
262
(u'dir', 'dir-id', 'directory'),
263
(u'dir/a', 'a-id', 'file')], rev_tree)
265
def test_rename_out_of_unversioned_subdir(self):
266
builder = self.build_a_rev()
267
builder.build_snapshot('B-id', None,
268
[('add', ('dir', 'dir-id', 'directory', None)),
269
('rename', ('a', 'dir/a'))])
270
builder.build_snapshot('C-id', None,
271
[('rename', ('dir/a', 'a')),
272
('unversion', 'dir-id')])
273
rev_tree = builder.get_branch().repository.revision_tree('C-id')
274
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
275
(u'a', 'a-id', 'file')], rev_tree)
277
def test_set_parent(self):
278
builder = self.build_a_rev()
279
builder.start_series()
280
self.addCleanup(builder.finish_series)
281
builder.build_snapshot('B-id', ['A-id'],
282
[('modify', ('a-id', 'new\ncontent\n'))])
283
builder.build_snapshot('C-id', ['A-id'],
284
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
285
# We should now have a graph:
289
# And not A => B => C
290
repo = builder.get_branch().repository
291
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',)},
292
repo.get_parent_map(['B-id', 'C-id']))
293
b_tree = repo.revision_tree('B-id')
294
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
295
(u'a', 'a-id', 'file'),
297
self.assertEqual('new\ncontent\n', b_tree.get_file_text('a-id'))
299
# We should still be using the content from A in C, not from B
300
c_tree = repo.revision_tree('C-id')
301
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
302
(u'a', 'a-id', 'file'),
303
(u'c', 'c-id', 'file'),
305
self.assertEqual('contents', c_tree.get_file_text('a-id'))
306
self.assertEqual('alt\ncontent\n', c_tree.get_file_text('c-id'))
308
def test_set_merge_parent(self):
309
builder = self.build_a_rev()
310
builder.start_series()
311
self.addCleanup(builder.finish_series)
312
builder.build_snapshot('B-id', ['A-id'],
313
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))])
314
builder.build_snapshot('C-id', ['A-id'],
315
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
316
builder.build_snapshot('D-id', ['B-id', 'C-id'], [])
317
repo = builder.get_branch().repository
318
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
319
'D-id': ('B-id', 'C-id')},
320
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
321
d_tree = repo.revision_tree('D-id')
322
# Note: by default a merge node does *not* pull in the changes from the
323
# merged tree, you have to supply it yourself.
324
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
325
(u'a', 'a-id', 'file'),
326
(u'b', 'b-id', 'file'),
329
def test_set_merge_parent_and_contents(self):
330
builder = self.build_a_rev()
331
builder.start_series()
332
self.addCleanup(builder.finish_series)
333
builder.build_snapshot('B-id', ['A-id'],
334
[('add', ('b', 'b-id', 'file', 'b\ncontent\n'))])
335
builder.build_snapshot('C-id', ['A-id'],
336
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
337
builder.build_snapshot('D-id', ['B-id', 'C-id'],
338
[('add', ('c', 'c-id', 'file', 'alt\ncontent\n'))])
339
repo = builder.get_branch().repository
340
self.assertEqual({'B-id': ('A-id',), 'C-id': ('A-id',),
341
'D-id': ('B-id', 'C-id')},
342
repo.get_parent_map(['B-id', 'C-id', 'D-id']))
343
d_tree = repo.revision_tree('D-id')
344
self.assertTreeShape([(u'', 'a-root-id', 'directory'),
345
(u'a', 'a-id', 'file'),
346
(u'b', 'b-id', 'file'),
347
(u'c', 'c-id', 'file'),
349
# Because we copied the exact text into *this* tree, the 'c' file
350
# should look like it was not modified in the merge
351
self.assertEqual('C-id', d_tree.get_file_revision('c-id'))
353
def test_set_parent_to_null(self):
354
builder = self.build_a_rev()
355
builder.start_series()
356
self.addCleanup(builder.finish_series)
357
builder.build_snapshot('B-id', [],
358
[('add', ('', None, 'directory', None))])
359
# We should now have a graph:
362
repo = builder.get_branch().repository
363
self.assertEqual({'A-id': (_mod_revision.NULL_REVISION,),
364
'B-id': (_mod_revision.NULL_REVISION,),},
365
repo.get_parent_map(['A-id', 'B-id']))
368
def test_start_finish_series(self):
369
builder = BranchBuilder(self.get_transport().clone('foo'))
370
builder.start_series()
372
self.assertIsNot(None, builder._tree)
373
self.assertEqual('w', builder._tree._lock_mode)
374
self.assertTrue(builder._branch.is_locked())
376
builder.finish_series()
377
self.assertIs(None, builder._tree)
378
self.assertFalse(builder._branch.is_locked())
380
def test_ghost_mainline_history(self):
381
builder = BranchBuilder(self.get_transport().clone('foo'))
382
builder.start_series()
384
builder.build_snapshot('tip', ['ghost'],
385
[('add', ('', 'ROOT_ID', 'directory', ''))],
386
allow_leftmost_as_ghost=True)
388
builder.finish_series()
389
b = builder.get_branch()
391
self.addCleanup(b.unlock)
392
self.assertEqual(('ghost',),
393
b.repository.get_graph().get_parent_map(['tip'])['tip'])
395
def test_unversion_root_add_new_root(self):
396
builder = BranchBuilder(self.get_transport().clone('foo'))
397
builder.start_series()
398
builder.build_snapshot('rev-1', None,
399
[('add', ('', 'TREE_ROOT', 'directory', ''))])
400
builder.build_snapshot('rev-2', None,
401
[('unversion', 'TREE_ROOT'),
402
('add', ('', 'my-root', 'directory', ''))])
403
builder.finish_series()
404
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
405
self.assertTreeShape([(u'', 'my-root', 'directory')], rev_tree)
407
def test_empty_flush(self):
408
"""A flush with no actions before it is a no-op."""
409
builder = BranchBuilder(self.get_transport().clone('foo'))
410
builder.start_series()
411
builder.build_snapshot('rev-1', None,
412
[('add', ('', 'TREE_ROOT', 'directory', ''))])
413
builder.build_snapshot('rev-2', None, [('flush', None)])
414
builder.finish_series()
415
rev_tree = builder.get_branch().repository.revision_tree('rev-2')
416
self.assertTreeShape([(u'', 'TREE_ROOT', 'directory')], rev_tree)
418
def test_kind_change(self):
419
"""It's possible to change the kind of an entry in a single snapshot
420
with a bit of help from the 'flush' action.
422
builder = BranchBuilder(self.get_transport().clone('foo'))
423
builder.start_series()
424
builder.build_snapshot('A-id', None,
425
[('add', (u'', 'a-root-id', 'directory', None)),
426
('add', (u'a', 'a-id', 'file', 'content\n'))])
427
builder.build_snapshot('B-id', None,
428
[('unversion', 'a-id'),
430
('add', (u'a', 'a-id', 'directory', None))])
431
builder.finish_series()
432
rev_tree = builder.get_branch().repository.revision_tree('B-id')
433
self.assertTreeShape(
434
[(u'', 'a-root-id', 'directory'), (u'a', 'a-id', 'directory')],
437
def test_pivot_root(self):
438
"""It's possible (albeit awkward) to move an existing dir to the root
439
in a single snapshot by using unversion then flush then add.
441
builder = BranchBuilder(self.get_transport().clone('foo'))
442
builder.start_series()
443
builder.build_snapshot('A-id', None,
444
[('add', (u'', 'orig-root', 'directory', None)),
445
('add', (u'dir', 'dir-id', 'directory', None))])
446
builder.build_snapshot('B-id', None,
447
[('unversion', 'orig-root'), # implicitly unversions all children
449
('add', (u'', 'dir-id', 'directory', None))])
450
builder.finish_series()
451
rev_tree = builder.get_branch().repository.revision_tree('B-id')
452
self.assertTreeShape([(u'', 'dir-id', 'directory')], rev_tree)