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

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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