/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 breezy/tests/test_shelf.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-19 13:16:11 UTC
  • mto: (6968.4.3 git-archive)
  • mto: This revision was merged to the branch mainline in revision 6972.
  • Revision ID: jelmer@jelmer.uk-20180519131611-l9h9ud41j7qg1m03
Move tar/zip to breezy.archive.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_shelf.py
 
1
# Copyright (C) 2008-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
import os
 
18
 
 
19
from .. import (
 
20
    errors,
 
21
    ignores,
 
22
    osutils,
 
23
    shelf,
 
24
    tests,
 
25
    transform,
 
26
    workingtree,
 
27
    )
 
28
from ..bzr import (
 
29
    pack,
 
30
    )
 
31
from . import (
 
32
    features,
 
33
    KnownFailure,
 
34
    )
 
35
from ..errors import (
 
36
    MalformedTransform,
 
37
    )
 
38
 
 
39
 
 
40
EMPTY_SHELF = (b"Bazaar pack format 1 (introduced in 0.18)\n"
 
41
               b"B23\n"
 
42
               b"metadata\n\n"
 
43
               b"d11:revision_id5:null:e"
 
44
               b"B159\n"
 
45
               b"attribs\n\n"
 
46
               b"d10:_id_numberi0e18:_new_executabilityde7:_new_idde"
 
47
               b"9:_new_namede11:_new_parentde16:_non_present_idsde"
 
48
               b"17:_removed_contentsle11:_removed_idle14:_tree_path_idsdeeE")
 
49
 
 
50
 
 
51
class TestErrors(tests.TestCase):
 
52
 
 
53
    def test_invalid_shelf_id(self):
 
54
        invalid_id = "foo"
 
55
        err = shelf.InvalidShelfId(invalid_id)
 
56
        self.assertEqual('"foo" is not a valid shelf id, '
 
57
                         'try a number instead.', str(err))
 
58
 
 
59
 
 
60
class TestPrepareShelf(tests.TestCaseWithTransport):
 
61
 
 
62
    def prepare_shelve_rename(self):
 
63
        tree = self.make_branch_and_tree('.')
 
64
        self.build_tree(['foo'])
 
65
        tree.add(['foo'], [b'foo-id'])
 
66
        tree.commit('foo')
 
67
        tree.rename_one('foo', 'bar')
 
68
        tree.lock_tree_write()
 
69
        self.addCleanup(tree.unlock)
 
70
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
71
        self.addCleanup(creator.finalize)
 
72
        self.assertEqual([('rename', b'foo-id', 'foo', 'bar')],
 
73
                          list(creator.iter_shelvable()))
 
74
        return creator
 
75
 
 
76
    def check_shelve_rename(self, creator):
 
77
        work_trans_id = creator.work_transform.trans_id_file_id(b'foo-id')
 
78
        self.assertEqual('foo', creator.work_transform.final_name(
 
79
                         work_trans_id))
 
80
        shelf_trans_id = creator.shelf_transform.trans_id_file_id(b'foo-id')
 
81
        self.assertEqual('bar', creator.shelf_transform.final_name(
 
82
                         shelf_trans_id))
 
83
 
 
84
    def test_shelve_rename(self):
 
85
        creator = self.prepare_shelve_rename()
 
86
        creator.shelve_rename(b'foo-id')
 
87
        self.check_shelve_rename(creator)
 
88
 
 
89
    def test_shelve_change_handles_rename(self):
 
90
        creator = self.prepare_shelve_rename()
 
91
        creator.shelve_change(('rename', b'foo-id', 'foo', 'bar'))
 
92
        self.check_shelve_rename(creator)
 
93
 
 
94
    def prepare_shelve_move(self):
 
95
        tree = self.make_branch_and_tree('.')
 
96
        self.build_tree(['foo/', 'bar/', 'foo/baz'])
 
97
        tree.add(['foo', 'bar', 'foo/baz'], [b'foo-id', b'bar-id', b'baz-id'])
 
98
        tree.commit('foo')
 
99
        tree.rename_one('foo/baz', 'bar/baz')
 
100
        tree.lock_tree_write()
 
101
        self.addCleanup(tree.unlock)
 
102
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
103
        self.addCleanup(creator.finalize)
 
104
        self.assertEqual([('rename', b'baz-id', 'foo/baz', 'bar/baz')],
 
105
                         list(creator.iter_shelvable()))
 
106
        return creator, tree
 
107
 
 
108
    def check_shelve_move(self, creator, tree):
 
109
        work_trans_id = creator.work_transform.trans_id_file_id(b'baz-id')
 
110
        work_foo = creator.work_transform.trans_id_file_id(b'foo-id')
 
111
        self.assertEqual(work_foo, creator.work_transform.final_parent(
 
112
                         work_trans_id))
 
113
        shelf_trans_id = creator.shelf_transform.trans_id_file_id(b'baz-id')
 
114
        shelf_bar = creator.shelf_transform.trans_id_file_id(b'bar-id')
 
115
        self.assertEqual(shelf_bar, creator.shelf_transform.final_parent(
 
116
                         shelf_trans_id))
 
117
        creator.transform()
 
118
        self.assertEqual('foo/baz', tree.id2path(b'baz-id'))
 
119
 
 
120
    def test_shelve_move(self):
 
121
        creator, tree = self.prepare_shelve_move()
 
122
        creator.shelve_rename(b'baz-id')
 
123
        self.check_shelve_move(creator, tree)
 
124
 
 
125
    def test_shelve_change_handles_move(self):
 
126
        creator, tree = self.prepare_shelve_move()
 
127
        creator.shelve_change(('rename', 'baz-id', 'foo/baz', 'bar/baz'))
 
128
        self.check_shelve_move(creator, tree)
 
129
 
 
130
    def test_shelve_changed_root_id(self):
 
131
        tree = self.make_branch_and_tree('.')
 
132
        self.build_tree(['foo'])
 
133
        tree.set_root_id(b'first-root-id')
 
134
        tree.add(['foo'], [b'foo-id'])
 
135
        tree.commit('foo')
 
136
        tree.set_root_id(b'second-root-id')
 
137
        tree.lock_tree_write()
 
138
        self.addCleanup(tree.unlock)
 
139
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
140
        self.addCleanup(creator.finalize)
 
141
        self.expectFailure('shelf doesn\'t support shelving root changes yet',
 
142
            self.assertEqual, [
 
143
                ('delete file', b'first-root-id', 'directory', ''),
 
144
                ('add file', b'second-root-id', 'directory', ''),
 
145
                ('rename', b'foo-id', u'foo', u'foo'),
 
146
                ], list(creator.iter_shelvable()))
 
147
 
 
148
        self.assertEqual([('delete file', b'first-root-id', 'directory', ''),
 
149
                          ('add file', b'second-root-id', 'directory', ''),
 
150
                          ('rename', b'foo-id', u'foo', u'foo'),
 
151
                         ], list(creator.iter_shelvable()))
 
152
 
 
153
    def assertShelvedFileEqual(self, expected_content, creator, file_id):
 
154
        s_trans_id = creator.shelf_transform.trans_id_file_id(file_id)
 
155
        shelf_file = creator.shelf_transform._limbo_name(s_trans_id)
 
156
        self.assertFileEqual(expected_content, shelf_file)
 
157
 
 
158
    def prepare_content_change(self):
 
159
        tree = self.make_branch_and_tree('.')
 
160
        tree.lock_write()
 
161
        self.addCleanup(tree.unlock)
 
162
        self.build_tree_contents([('foo', b'a\n')])
 
163
        tree.add('foo', b'foo-id')
 
164
        tree.commit('Committed foo')
 
165
        self.build_tree_contents([('foo', b'b\na\nc\n')])
 
166
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
167
        self.addCleanup(creator.finalize)
 
168
        return creator
 
169
 
 
170
    def test_shelve_content_change(self):
 
171
        creator = self.prepare_content_change()
 
172
        self.assertEqual([('modify text', b'foo-id')],
 
173
                         list(creator.iter_shelvable()))
 
174
        creator.shelve_lines(b'foo-id', ['a\n', 'c\n'])
 
175
        creator.transform()
 
176
        self.assertFileEqual('a\nc\n', 'foo')
 
177
        self.assertShelvedFileEqual('b\na\n', creator, b'foo-id')
 
178
 
 
179
    def test_shelve_change_handles_modify_text(self):
 
180
        creator = self.prepare_content_change()
 
181
        creator.shelve_change(('modify text', b'foo-id'))
 
182
        creator.transform()
 
183
        self.assertFileEqual('a\n', 'foo')
 
184
        self.assertShelvedFileEqual('b\na\nc\n', creator, b'foo-id')
 
185
 
 
186
    def test_shelve_all(self):
 
187
        creator = self.prepare_content_change()
 
188
        creator.shelve_all()
 
189
        creator.transform()
 
190
        self.assertFileEqual('a\n', 'foo')
 
191
        self.assertShelvedFileEqual('b\na\nc\n', creator, b'foo-id')
 
192
 
 
193
    def prepare_shelve_creation(self):
 
194
        tree = self.make_branch_and_tree('.')
 
195
        tree.lock_write()
 
196
        self.addCleanup(tree.unlock)
 
197
        tree.commit('Empty tree')
 
198
        self.build_tree_contents([('foo', b'a\n'), ('bar/',)])
 
199
        tree.add(['foo', 'bar'], [b'foo-id', b'bar-id'])
 
200
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
201
        self.addCleanup(creator.finalize)
 
202
        self.assertEqual([('add file', b'bar-id', 'directory', 'bar'),
 
203
                          ('add file', b'foo-id', 'file', 'foo')],
 
204
                          sorted(list(creator.iter_shelvable())))
 
205
        return creator, tree
 
206
 
 
207
    def check_shelve_creation(self, creator, tree):
 
208
        self.assertRaises(StopIteration,
 
209
                          next, tree.iter_entries_by_dir(specific_files=['foo']))
 
210
        s_trans_id = creator.shelf_transform.trans_id_file_id(b'foo-id')
 
211
        self.assertEqual(b'foo-id',
 
212
                         creator.shelf_transform.final_file_id(s_trans_id))
 
213
        self.assertPathDoesNotExist('foo')
 
214
        self.assertPathDoesNotExist('bar')
 
215
        self.assertShelvedFileEqual('a\n', creator, b'foo-id')
 
216
        s_bar_trans_id = creator.shelf_transform.trans_id_file_id(b'bar-id')
 
217
        self.assertEqual('directory',
 
218
            creator.shelf_transform.final_kind(s_bar_trans_id))
 
219
 
 
220
    def test_shelve_creation(self):
 
221
        creator, tree = self.prepare_shelve_creation()
 
222
        creator.shelve_creation(b'foo-id')
 
223
        creator.shelve_creation(b'bar-id')
 
224
        creator.transform()
 
225
        self.check_shelve_creation(creator, tree)
 
226
 
 
227
    def test_shelve_change_handles_creation(self):
 
228
        creator, tree = self.prepare_shelve_creation()
 
229
        creator.shelve_change(('add file', b'foo-id', 'file', 'foo'))
 
230
        creator.shelve_change(('add file', b'bar-id', 'directory', 'bar'))
 
231
        creator.transform()
 
232
        self.check_shelve_creation(creator, tree)
 
233
 
 
234
    def test_shelve_directory_with_ignored(self):
 
235
        tree = self.make_branch_and_tree('.')
 
236
        tree.lock_write()
 
237
        self.addCleanup(tree.unlock)
 
238
        tree.commit('Empty tree')
 
239
        self.build_tree_contents([('foo', b'a\n'), ('bar/',), ('bar/ignored', b'ign\n')])
 
240
        tree.add(['foo', 'bar'], [b'foo-id', b'bar-id'])
 
241
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
242
        self.addCleanup(creator.finalize)
 
243
        self.assertEqual([('add file', b'bar-id', 'directory', 'bar'),
 
244
                          ('add file', b'foo-id', 'file', 'foo')],
 
245
                          sorted(list(creator.iter_shelvable())))
 
246
        ignores._set_user_ignores([])
 
247
        in_patterns = ['ignored',]
 
248
        ignores.add_unique_user_ignores(in_patterns)
 
249
 
 
250
        creator.shelve_change(('add file', b'bar-id', 'directory', 'bar'))
 
251
        try:
 
252
            creator.transform()
 
253
            self.check_shelve_creation(creator, tree)
 
254
        except MalformedTransform:
 
255
            raise KnownFailure('shelving directory with ignored file: see bug #611739')
 
256
 
 
257
    def _test_shelve_symlink_creation(self, link_name, link_target,
 
258
                                      shelve_change=False):
 
259
        self.requireFeature(features.SymlinkFeature)
 
260
        tree = self.make_branch_and_tree('.')
 
261
        tree.lock_write()
 
262
        self.addCleanup(tree.unlock)
 
263
        tree.commit('Empty tree')
 
264
        os.symlink(link_target, link_name)
 
265
        tree.add(link_name, b'foo-id')
 
266
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
267
        self.addCleanup(creator.finalize)
 
268
        self.assertEqual([('add file', b'foo-id', 'symlink', link_name)],
 
269
                         list(creator.iter_shelvable()))
 
270
        if shelve_change:
 
271
            creator.shelve_change(('add file', b'foo-id', 'symlink', link_name))
 
272
        else:
 
273
            creator.shelve_creation(b'foo-id')
 
274
        creator.transform()
 
275
        s_trans_id = creator.shelf_transform.trans_id_file_id(b'foo-id')
 
276
        self.assertPathDoesNotExist(link_name)
 
277
        limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
 
278
        self.assertEqual(link_target, osutils.readlink(limbo_name))
 
279
        ptree = creator.shelf_transform.get_preview_tree()
 
280
        self.assertEqual(
 
281
                link_target,
 
282
                ptree.get_symlink_target(ptree.id2path(b'foo-id'), b'foo-id'))
 
283
 
 
284
    def test_shelve_symlink_creation(self):
 
285
        self._test_shelve_symlink_creation('foo', 'bar')
 
286
 
 
287
    def test_shelve_unicode_symlink_creation(self):
 
288
        self.requireFeature(features.UnicodeFilenameFeature)
 
289
        self._test_shelve_symlink_creation(u'fo\N{Euro Sign}o',
 
290
                                           u'b\N{Euro Sign}ar')
 
291
 
 
292
    def test_shelve_change_handles_symlink_creation(self):
 
293
        self._test_shelve_symlink_creation('foo', 'bar', shelve_change=True)
 
294
 
 
295
    def _test_shelve_symlink_target_change(self, link_name,
 
296
                                           old_target, new_target,
 
297
                                           shelve_change=False):
 
298
        self.requireFeature(features.SymlinkFeature)
 
299
        tree = self.make_branch_and_tree('.')
 
300
        tree.lock_write()
 
301
        self.addCleanup(tree.unlock)
 
302
        os.symlink(old_target, link_name)
 
303
        tree.add(link_name, b'foo-id')
 
304
        tree.commit("commit symlink")
 
305
        os.unlink(link_name)
 
306
        os.symlink(new_target, link_name)
 
307
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
308
        self.addCleanup(creator.finalize)
 
309
        self.assertEqual([('modify target', b'foo-id', link_name,
 
310
                           old_target, new_target)],
 
311
                         list(creator.iter_shelvable()))
 
312
        if shelve_change:
 
313
            creator.shelve_change(('modify target', b'foo-id', link_name,
 
314
                                   old_target, new_target))
 
315
        else:
 
316
            creator.shelve_modify_target(b'foo-id')
 
317
        creator.transform()
 
318
        self.assertEqual(old_target, osutils.readlink(link_name))
 
319
        s_trans_id = creator.shelf_transform.trans_id_file_id(b'foo-id')
 
320
        limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
 
321
        self.assertEqual(new_target, osutils.readlink(limbo_name))
 
322
        ptree = creator.shelf_transform.get_preview_tree()
 
323
        self.assertEqual(new_target, ptree.get_symlink_target(ptree.id2path(b'foo-id')))
 
324
 
 
325
    def test_shelve_symlink_target_change(self):
 
326
        self._test_shelve_symlink_target_change('foo', 'bar', 'baz')
 
327
 
 
328
    def test_shelve_unicode_symlink_target_change(self):
 
329
        self.requireFeature(features.UnicodeFilenameFeature)
 
330
        self._test_shelve_symlink_target_change(
 
331
            u'fo\N{Euro Sign}o', u'b\N{Euro Sign}ar', u'b\N{Euro Sign}az')
 
332
 
 
333
    def test_shelve_change_handles_symlink_target_change(self):
 
334
        self._test_shelve_symlink_target_change('foo', 'bar', 'baz',
 
335
                                                shelve_change=True)
 
336
 
 
337
    def test_shelve_creation_no_contents(self):
 
338
        tree = self.make_branch_and_tree('.')
 
339
        tree.lock_write()
 
340
        self.addCleanup(tree.unlock)
 
341
        tree.commit('Empty tree')
 
342
        self.build_tree(['foo'])
 
343
        tree.add('foo', b'foo-id')
 
344
        os.unlink('foo')
 
345
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
346
        self.addCleanup(creator.finalize)
 
347
        self.assertEqual([('add file', b'foo-id', None, 'foo')],
 
348
                         sorted(list(creator.iter_shelvable())))
 
349
        creator.shelve_creation(b'foo-id')
 
350
        creator.transform()
 
351
        self.assertRaises(StopIteration,
 
352
                          next, tree.iter_entries_by_dir(specific_files=['foo']))
 
353
        self.assertShelvedFileEqual('', creator, b'foo-id')
 
354
        s_trans_id = creator.shelf_transform.trans_id_file_id(b'foo-id')
 
355
        self.assertEqual(b'foo-id',
 
356
                         creator.shelf_transform.final_file_id(s_trans_id))
 
357
        self.assertPathDoesNotExist('foo')
 
358
 
 
359
    def prepare_shelve_deletion(self):
 
360
        tree = self.make_branch_and_tree('tree')
 
361
        tree.lock_write()
 
362
        self.addCleanup(tree.unlock)
 
363
        self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', b'baz')])
 
364
        tree.add(['foo', 'foo/bar'], [b'foo-id', b'bar-id'])
 
365
        tree.commit('Added file and directory')
 
366
        tree.unversion(['foo', 'foo/bar'])
 
367
        os.unlink('tree/foo/bar')
 
368
        os.rmdir('tree/foo')
 
369
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
370
        self.addCleanup(creator.finalize)
 
371
        self.assertEqual([('delete file', b'bar-id', 'file', 'foo/bar'),
 
372
                          ('delete file', b'foo-id', 'directory', 'foo')],
 
373
                          sorted(list(creator.iter_shelvable())))
 
374
        return creator, tree
 
375
 
 
376
    def check_shelve_deletion(self, tree):
 
377
        self.assertTrue(tree.has_id(b'foo-id'))
 
378
        self.assertTrue(tree.has_id(b'bar-id'))
 
379
        self.assertFileEqual('baz', 'tree/foo/bar')
 
380
 
 
381
    def test_shelve_deletion(self):
 
382
        creator, tree = self.prepare_shelve_deletion()
 
383
        creator.shelve_deletion(b'foo-id')
 
384
        creator.shelve_deletion(b'bar-id')
 
385
        creator.transform()
 
386
        self.check_shelve_deletion(tree)
 
387
 
 
388
    def test_shelve_change_handles_deletion(self):
 
389
        creator, tree = self.prepare_shelve_deletion()
 
390
        creator.shelve_change(('delete file', b'foo-id', 'directory', 'foo'))
 
391
        creator.shelve_change(('delete file', b'bar-id', 'file', 'foo/bar'))
 
392
        creator.transform()
 
393
        self.check_shelve_deletion(tree)
 
394
 
 
395
    def test_shelve_delete_contents(self):
 
396
        tree = self.make_branch_and_tree('tree')
 
397
        self.build_tree(['tree/foo',])
 
398
        tree.add('foo', b'foo-id')
 
399
        tree.commit('Added file and directory')
 
400
        os.unlink('tree/foo')
 
401
        tree.lock_tree_write()
 
402
        self.addCleanup(tree.unlock)
 
403
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
404
        self.addCleanup(creator.finalize)
 
405
        self.assertEqual([('delete file', b'foo-id', 'file', 'foo')],
 
406
                         sorted(list(creator.iter_shelvable())))
 
407
        creator.shelve_deletion(b'foo-id')
 
408
        creator.transform()
 
409
        self.assertPathExists('tree/foo')
 
410
 
 
411
    def prepare_shelve_change_kind(self):
 
412
        tree = self.make_branch_and_tree('tree')
 
413
        self.build_tree_contents([('tree/foo', b'bar')])
 
414
        tree.add('foo', b'foo-id')
 
415
        tree.commit('Added file and directory')
 
416
        os.unlink('tree/foo')
 
417
        os.mkdir('tree/foo')
 
418
        tree.lock_tree_write()
 
419
        self.addCleanup(tree.unlock)
 
420
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
421
        self.addCleanup(creator.finalize)
 
422
        self.assertEqual([('change kind', b'foo-id', 'file', 'directory',
 
423
                           'foo')], sorted(list(creator.iter_shelvable())))
 
424
        return creator
 
425
 
 
426
    def check_shelve_change_kind(self, creator):
 
427
        self.assertFileEqual('bar', 'tree/foo')
 
428
        s_trans_id = creator.shelf_transform.trans_id_file_id(b'foo-id')
 
429
        self.assertEqual('directory',
 
430
                         creator.shelf_transform._new_contents[s_trans_id])
 
431
 
 
432
    def test_shelve_change_kind(self):
 
433
        creator = self.prepare_shelve_change_kind()
 
434
        creator.shelve_content_change(b'foo-id')
 
435
        creator.transform()
 
436
        self.check_shelve_change_kind(creator)
 
437
 
 
438
    def test_shelve_change_handles_change_kind(self):
 
439
        creator = self.prepare_shelve_change_kind()
 
440
        creator.shelve_change(('change kind', b'foo-id', 'file', 'directory',
 
441
                               'foo'))
 
442
        creator.transform()
 
443
        self.check_shelve_change_kind(creator)
 
444
 
 
445
    def test_shelve_change_unknown_change(self):
 
446
        tree = self.make_branch_and_tree('tree')
 
447
        tree.lock_tree_write()
 
448
        self.addCleanup(tree.unlock)
 
449
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
450
        self.addCleanup(creator.finalize)
 
451
        e = self.assertRaises(ValueError, creator.shelve_change, ('unknown',))
 
452
        self.assertEqual('Unknown change kind: "unknown"', str(e))
 
453
 
 
454
    def test_shelve_unversion(self):
 
455
        tree = self.make_branch_and_tree('tree')
 
456
        self.build_tree(['tree/foo',])
 
457
        tree.add('foo', b'foo-id')
 
458
        tree.commit('Added file and directory')
 
459
        tree.unversion(['foo'])
 
460
        tree.lock_tree_write()
 
461
        self.addCleanup(tree.unlock)
 
462
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
463
        self.addCleanup(creator.finalize)
 
464
        self.assertEqual([('delete file', b'foo-id', 'file', 'foo')],
 
465
                         sorted(list(creator.iter_shelvable())))
 
466
        creator.shelve_deletion(b'foo-id')
 
467
        creator.transform()
 
468
        self.assertPathExists('tree/foo')
 
469
 
 
470
    def test_shelve_serialization(self):
 
471
        tree = self.make_branch_and_tree('.')
 
472
        tree.lock_tree_write()
 
473
        self.addCleanup(tree.unlock)
 
474
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
475
        self.addCleanup(creator.finalize)
 
476
        shelf_file = open('shelf', 'wb')
 
477
        self.addCleanup(shelf_file.close)
 
478
        try:
 
479
            creator.write_shelf(shelf_file)
 
480
        finally:
 
481
            shelf_file.close()
 
482
        self.assertFileEqual(EMPTY_SHELF, 'shelf')
 
483
 
 
484
    def test_write_shelf(self):
 
485
        tree = self.make_branch_and_tree('tree')
 
486
        self.build_tree(['tree/foo'])
 
487
        tree.add('foo', b'foo-id')
 
488
        tree.lock_tree_write()
 
489
        self.addCleanup(tree.unlock)
 
490
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
491
        self.addCleanup(creator.finalize)
 
492
        list(creator.iter_shelvable())
 
493
        creator.shelve_creation(b'foo-id')
 
494
        with open('shelf', 'wb') as shelf_file:
 
495
            creator.write_shelf(shelf_file)
 
496
        parser = pack.ContainerPushParser()
 
497
        with open('shelf', 'rb') as shelf_file:
 
498
            parser.accept_bytes(shelf_file.read())
 
499
        tt = transform.TransformPreview(tree)
 
500
        self.addCleanup(tt.finalize)
 
501
        records = iter(parser.read_pending_records())
 
502
        #skip revision-id
 
503
        next(records)
 
504
        tt.deserialize(records)
 
505
 
 
506
    def test_shelve_unversioned(self):
 
507
        tree = self.make_branch_and_tree('tree')
 
508
        tree.lock_tree_write()
 
509
        try:
 
510
            self.assertRaises(errors.PathsNotVersionedError,
 
511
                              shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
 
512
        finally:
 
513
            tree.unlock()
 
514
        # We should be able to lock/unlock the tree if ShelfCreator cleaned
 
515
        # after itself.
 
516
        wt = workingtree.WorkingTree.open('tree')
 
517
        wt.lock_tree_write()
 
518
        wt.unlock()
 
519
        # And a second tentative should raise the same error (no
 
520
        # limbo/pending_deletion leftovers).
 
521
        tree.lock_tree_write()
 
522
        try:
 
523
            self.assertRaises(errors.PathsNotVersionedError,
 
524
                              shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
 
525
        finally:
 
526
            tree.unlock()
 
527
 
 
528
    def test_shelve_skips_added_root(self):
 
529
        """Skip adds of the root when iterating through shelvable changes."""
 
530
        tree = self.make_branch_and_tree('tree')
 
531
        tree.lock_tree_write()
 
532
        self.addCleanup(tree.unlock)
 
533
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
534
        self.addCleanup(creator.finalize)
 
535
        self.assertEqual([], list(creator.iter_shelvable()))
 
536
 
 
537
    def test_shelve_skips_added_root(self):
 
538
        """Skip adds of the root when iterating through shelvable changes."""
 
539
        tree = self.make_branch_and_tree('tree')
 
540
        tree.lock_tree_write()
 
541
        self.addCleanup(tree.unlock)
 
542
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
543
        self.addCleanup(creator.finalize)
 
544
        self.assertEqual([], list(creator.iter_shelvable()))
 
545
 
 
546
 
 
547
class TestUnshelver(tests.TestCaseWithTransport):
 
548
 
 
549
    def test_make_merger(self):
 
550
        tree = self.make_branch_and_tree('tree')
 
551
        tree.commit('first commit')
 
552
        self.build_tree_contents([('tree/foo', b'bar')])
 
553
        tree.lock_write()
 
554
        self.addCleanup(tree.unlock)
 
555
        tree.add('foo', b'foo-id')
 
556
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
557
        self.addCleanup(creator.finalize)
 
558
        list(creator.iter_shelvable())
 
559
        creator.shelve_creation(b'foo-id')
 
560
        with open('shelf-file', 'w+b') as shelf_file:
 
561
            creator.write_shelf(shelf_file)
 
562
            creator.transform()
 
563
            shelf_file.seek(0)
 
564
            unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
565
            unshelver.make_merger().do_merge()
 
566
            self.addCleanup(unshelver.finalize)
 
567
            self.assertFileEqual('bar', 'tree/foo')
 
568
 
 
569
    def test_unshelve_changed(self):
 
570
        tree = self.make_branch_and_tree('tree')
 
571
        tree.lock_write()
 
572
        self.addCleanup(tree.unlock)
 
573
        self.build_tree_contents([('tree/foo', b'a\nb\nc\n')])
 
574
        tree.add('foo', b'foo-id')
 
575
        tree.commit('first commit')
 
576
        self.build_tree_contents([('tree/foo', b'a\nb\nd\n')])
 
577
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
578
        self.addCleanup(creator.finalize)
 
579
        list(creator.iter_shelvable())
 
580
        creator.shelve_lines(b'foo-id', ['a\n', 'b\n', 'c\n'])
 
581
        shelf_file = open('shelf', 'w+b')
 
582
        self.addCleanup(shelf_file.close)
 
583
        creator.write_shelf(shelf_file)
 
584
        creator.transform()
 
585
        self.build_tree_contents([('tree/foo', b'z\na\nb\nc\n')])
 
586
        shelf_file.seek(0)
 
587
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
588
        self.addCleanup(unshelver.finalize)
 
589
        unshelver.make_merger().do_merge()
 
590
        self.assertFileEqual('z\na\nb\nd\n', 'tree/foo')
 
591
 
 
592
    def test_unshelve_deleted(self):
 
593
        tree = self.make_branch_and_tree('tree')
 
594
        tree.lock_write()
 
595
        self.addCleanup(tree.unlock)
 
596
        self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', b'baz')])
 
597
        tree.add(['foo', 'foo/bar'], [b'foo-id', b'bar-id'])
 
598
        tree.commit('Added file and directory')
 
599
        tree.unversion(['foo', 'foo/bar'])
 
600
        os.unlink('tree/foo/bar')
 
601
        os.rmdir('tree/foo')
 
602
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
603
        list(creator.iter_shelvable())
 
604
        creator.shelve_deletion(b'foo-id')
 
605
        creator.shelve_deletion(b'bar-id')
 
606
        with open('shelf', 'w+b') as shelf_file:
 
607
            creator.write_shelf(shelf_file)
 
608
            creator.transform()
 
609
            creator.finalize()
 
610
        # validate the test setup
 
611
        self.assertTrue(tree.has_id(b'foo-id'))
 
612
        self.assertTrue(tree.has_id(b'bar-id'))
 
613
        self.assertFileEqual('baz', 'tree/foo/bar')
 
614
        with open('shelf', 'r+b') as shelf_file:
 
615
            unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
616
            self.addCleanup(unshelver.finalize)
 
617
            unshelver.make_merger().do_merge()
 
618
        self.assertFalse(tree.has_id(b'foo-id'))
 
619
        self.assertFalse(tree.has_id(b'bar-id'))
 
620
 
 
621
    def test_unshelve_base(self):
 
622
        tree = self.make_branch_and_tree('tree')
 
623
        tree.lock_write()
 
624
        self.addCleanup(tree.unlock)
 
625
        tree.commit('rev1', rev_id=b'rev1')
 
626
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
627
        self.addCleanup(creator.finalize)
 
628
        manager = tree.get_shelf_manager()
 
629
        shelf_id, shelf_file = manager.new_shelf()
 
630
        try:
 
631
            creator.write_shelf(shelf_file)
 
632
        finally:
 
633
            shelf_file.close()
 
634
        tree.commit('rev2', rev_id=b'rev2')
 
635
        shelf_file = manager.read_shelf(1)
 
636
        self.addCleanup(shelf_file.close)
 
637
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
638
        self.addCleanup(unshelver.finalize)
 
639
        self.assertEqual(b'rev1', unshelver.base_tree.get_revision_id())
 
640
 
 
641
    def test_unshelve_serialization(self):
 
642
        tree = self.make_branch_and_tree('.')
 
643
        self.build_tree_contents([('shelf', EMPTY_SHELF)])
 
644
        shelf_file = open('shelf', 'rb')
 
645
        self.addCleanup(shelf_file.close)
 
646
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
647
        unshelver.finalize()
 
648
 
 
649
    def test_corrupt_shelf(self):
 
650
        tree = self.make_branch_and_tree('.')
 
651
        self.build_tree_contents([('shelf', EMPTY_SHELF.replace(b'metadata',
 
652
                                                                b'foo'))])
 
653
        shelf_file = open('shelf', 'rb')
 
654
        self.addCleanup(shelf_file.close)
 
655
        e = self.assertRaises(shelf.ShelfCorrupt,
 
656
                              shelf.Unshelver.from_tree_and_shelf, tree,
 
657
                              shelf_file)
 
658
        self.assertEqual('Shelf corrupt.', str(e))
 
659
 
 
660
    def test_unshelve_subdir_in_now_removed_dir(self):
 
661
        tree = self.make_branch_and_tree('.')
 
662
        self.addCleanup(tree.lock_write().unlock)
 
663
        self.build_tree(['dir/', 'dir/subdir/', 'dir/subdir/foo'])
 
664
        tree.add(['dir'], [b'dir-id'])
 
665
        tree.commit('versioned dir')
 
666
        tree.add(['dir/subdir', 'dir/subdir/foo'], [b'subdir-id', b'foo-id'])
 
667
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
668
        self.addCleanup(creator.finalize)
 
669
        for change in creator.iter_shelvable():
 
670
            creator.shelve_change(change)
 
671
        shelf_manager = tree.get_shelf_manager()
 
672
        shelf_id = shelf_manager.shelve_changes(creator)
 
673
        self.assertPathDoesNotExist('dir/subdir')
 
674
        tree.remove(['dir'])
 
675
        unshelver = shelf_manager.get_unshelver(shelf_id)
 
676
        self.addCleanup(unshelver.finalize)
 
677
        unshelver.make_merger().do_merge()
 
678
        self.assertPathExists('dir/subdir/foo')
 
679
        self.assertEqual(b'dir-id', tree.path2id('dir'))
 
680
        self.assertEqual(b'subdir-id', tree.path2id('dir/subdir'))
 
681
        self.assertEqual(b'foo-id', tree.path2id('dir/subdir/foo'))
 
682
 
 
683
 
 
684
class TestShelfManager(tests.TestCaseWithTransport):
 
685
 
 
686
    def test_get_shelf_manager(self):
 
687
        tree = self.make_branch_and_tree('.')
 
688
        manager = tree.get_shelf_manager()
 
689
        self.assertEqual(tree._transport.base + 'shelf/',
 
690
                         manager.transport.base)
 
691
 
 
692
    def get_manager(self):
 
693
        return self.make_branch_and_tree('.').get_shelf_manager()
 
694
 
 
695
    def test_get_shelf_filename(self):
 
696
        tree = self.make_branch_and_tree('.')
 
697
        manager = tree.get_shelf_manager()
 
698
        self.assertEqual('shelf-1', manager.get_shelf_filename(1))
 
699
 
 
700
    def test_get_shelf_ids(self):
 
701
        tree = self.make_branch_and_tree('.')
 
702
        manager = tree.get_shelf_manager()
 
703
        self.assertEqual([1, 3], manager.get_shelf_ids(
 
704
                         ['shelf-1', 'shelf-02', 'shelf-3']))
 
705
 
 
706
    def test_new_shelf(self):
 
707
        manager = self.get_manager()
 
708
        shelf_id, shelf_file = manager.new_shelf()
 
709
        shelf_file.close()
 
710
        self.assertEqual(1, shelf_id)
 
711
        shelf_id, shelf_file = manager.new_shelf()
 
712
        shelf_file.close()
 
713
        self.assertEqual(2, shelf_id)
 
714
        manager.delete_shelf(1)
 
715
        shelf_id, shelf_file = manager.new_shelf()
 
716
        shelf_file.close()
 
717
        self.assertEqual(3, shelf_id)
 
718
 
 
719
    def test_active_shelves(self):
 
720
        manager = self.get_manager()
 
721
        self.assertEqual([], manager.active_shelves())
 
722
        shelf_id, shelf_file = manager.new_shelf()
 
723
        shelf_file.close()
 
724
        self.assertEqual([1], manager.active_shelves())
 
725
 
 
726
    def test_delete_shelf(self):
 
727
        manager = self.get_manager()
 
728
        shelf_id, shelf_file = manager.new_shelf()
 
729
        shelf_file.close()
 
730
        self.assertEqual([1], manager.active_shelves())
 
731
        manager.delete_shelf(1)
 
732
        self.assertEqual([], manager.active_shelves())
 
733
 
 
734
    def test_last_shelf(self):
 
735
        manager = self.get_manager()
 
736
        self.assertIs(None, manager.last_shelf())
 
737
        shelf_id, shelf_file = manager.new_shelf()
 
738
        shelf_file.close()
 
739
        self.assertEqual(1, manager.last_shelf())
 
740
 
 
741
    def test_read_shelf(self):
 
742
        manager = self.get_manager()
 
743
        shelf_id, shelf_file = manager.new_shelf()
 
744
        try:
 
745
            shelf_file.write('foo')
 
746
        finally:
 
747
            shelf_file.close()
 
748
        shelf_id, shelf_file = manager.new_shelf()
 
749
        try:
 
750
            shelf_file.write('bar')
 
751
        finally:
 
752
            shelf_file.close()
 
753
        shelf_file = manager.read_shelf(1)
 
754
        try:
 
755
            self.assertEqual('foo', shelf_file.read())
 
756
        finally:
 
757
            shelf_file.close()
 
758
        shelf_file = manager.read_shelf(2)
 
759
        try:
 
760
            self.assertEqual('bar', shelf_file.read())
 
761
        finally:
 
762
            shelf_file.close()
 
763
 
 
764
    def test_read_non_existant(self):
 
765
        manager = self.get_manager()
 
766
        e = self.assertRaises(shelf.NoSuchShelfId, manager.read_shelf, 1)
 
767
        self.assertEqual('No changes are shelved with id "1".', str(e))
 
768
 
 
769
    def test_shelve_changes(self):
 
770
        tree = self.make_branch_and_tree('tree')
 
771
        tree.commit('no-change commit')
 
772
        tree.lock_write()
 
773
        self.addCleanup(tree.unlock)
 
774
        self.build_tree_contents([('tree/foo', b'bar')])
 
775
        self.assertFileEqual('bar', 'tree/foo')
 
776
        tree.add('foo', b'foo-id')
 
777
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
778
        self.addCleanup(creator.finalize)
 
779
        list(creator.iter_shelvable())
 
780
        creator.shelve_creation(b'foo-id')
 
781
        shelf_manager = tree.get_shelf_manager()
 
782
        shelf_id = shelf_manager.shelve_changes(creator)
 
783
        self.assertPathDoesNotExist('tree/foo')
 
784
        unshelver = shelf_manager.get_unshelver(shelf_id)
 
785
        self.addCleanup(unshelver.finalize)
 
786
        unshelver.make_merger().do_merge()
 
787
        self.assertFileEqual('bar', 'tree/foo')
 
788
 
 
789
    def test_get_metadata(self):
 
790
        tree = self.make_branch_and_tree('.')
 
791
        tree.lock_tree_write()
 
792
        self.addCleanup(tree.unlock)
 
793
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
794
        self.addCleanup(creator.finalize)
 
795
        shelf_manager = tree.get_shelf_manager()
 
796
        shelf_id = shelf_manager.shelve_changes(creator, 'foo')
 
797
        metadata = shelf_manager.get_metadata(shelf_id)
 
798
        self.assertEqual('foo', metadata['message'])
 
799
        self.assertEqual('null:', metadata['revision_id'])