/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_version_info.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
Merge rename-controldir branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_version_info.py
 
1
# Copyright (C) 2005-2012, 2016 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
"""Tests for version_info"""
 
18
 
 
19
import imp
 
20
import os
 
21
import sys
 
22
 
 
23
from .. import (
 
24
    errors,
 
25
    registry,
 
26
    tests,
 
27
    version_info_formats,
 
28
    )
 
29
from ..sixish import (
 
30
    BytesIO,
 
31
    )
 
32
from . import TestCaseWithTransport
 
33
from ..rio import read_stanzas
 
34
 
 
35
from ..version_info_formats.format_custom import CustomVersionInfoBuilder
 
36
from ..version_info_formats.format_rio import RioVersionInfoBuilder
 
37
from ..version_info_formats.format_python import PythonVersionInfoBuilder
 
38
 
 
39
 
 
40
class VersionInfoTestCase(TestCaseWithTransport):
 
41
 
 
42
    def create_branch(self):
 
43
        wt = self.make_branch_and_tree('branch')
 
44
 
 
45
        self.build_tree(['branch/a'])
 
46
        wt.add('a')
 
47
        wt.commit('a', rev_id='r1')
 
48
 
 
49
        self.build_tree(['branch/b'])
 
50
        wt.add('b')
 
51
        wt.commit('b', rev_id='r2')
 
52
 
 
53
        self.build_tree_contents([('branch/a', 'new contents\n')])
 
54
        wt.commit(u'\xe52', rev_id='r3')
 
55
 
 
56
        return wt
 
57
 
 
58
    def create_tree_with_dotted_revno(self):
 
59
        wt = self.make_branch_and_tree('branch')
 
60
        self.build_tree(['branch/a'])
 
61
        wt.add('a')
 
62
        wt.commit('a', rev_id='r1')
 
63
 
 
64
        other = wt.controldir.sprout('other').open_workingtree()
 
65
        self.build_tree(['other/b.a'])
 
66
        other.add(['b.a'])
 
67
        other.commit('b.a', rev_id='o2')
 
68
 
 
69
        os.chdir('branch')
 
70
        self.run_bzr('merge ../other')
 
71
        wt.commit('merge', rev_id='merge')
 
72
 
 
73
        wt.update(revision='o2')
 
74
 
 
75
        return wt
 
76
 
 
77
 
 
78
class TestVersionInfoRio(VersionInfoTestCase):
 
79
 
 
80
    def test_rio_null(self):
 
81
        wt = self.make_branch_and_tree('branch')
 
82
 
 
83
        sio = BytesIO()
 
84
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
 
85
        builder.generate(sio)
 
86
        val = sio.getvalue()
 
87
        self.assertContainsRe(val, 'build-date:')
 
88
        self.assertContainsRe(val, 'revno: 0')
 
89
 
 
90
    def test_rio_dotted_revno(self):
 
91
        wt = self.create_tree_with_dotted_revno()
 
92
 
 
93
        sio = BytesIO()
 
94
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
 
95
        builder.generate(sio)
 
96
        val = sio.getvalue()
 
97
        self.assertContainsRe(val, 'revno: 1.1.1')
 
98
 
 
99
    def regen_text(self, wt, **kwargs):
 
100
        sio = BytesIO()
 
101
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
 
102
        builder.generate(sio)
 
103
        val = sio.getvalue()
 
104
        return val
 
105
 
 
106
    def test_simple(self):
 
107
        wt = self.create_branch()
 
108
 
 
109
        val = self.regen_text(wt)
 
110
        self.assertContainsRe(val, 'build-date:')
 
111
        self.assertContainsRe(val, 'date:')
 
112
        self.assertContainsRe(val, 'revno: 3')
 
113
        self.assertContainsRe(val, 'revision-id: r3')
 
114
 
 
115
    def test_clean(self):
 
116
        wt = self.create_branch()
 
117
        val = self.regen_text(wt, check_for_clean=True)
 
118
        self.assertContainsRe(val, 'clean: True')
 
119
 
 
120
    def test_no_clean(self):
 
121
        wt = self.create_branch()
 
122
        self.build_tree(['branch/c'])
 
123
        val = self.regen_text(wt, check_for_clean=True)
 
124
        self.assertContainsRe(val, 'clean: False')
 
125
 
 
126
    def test_history(self):
 
127
        wt = self.create_branch()
 
128
 
 
129
        val = self.regen_text(wt, include_revision_history=True)
 
130
        self.assertContainsRe(val, 'id: r1')
 
131
        self.assertContainsRe(val, 'message: a')
 
132
        self.assertContainsRe(val, 'id: r2')
 
133
        self.assertContainsRe(val, 'message: b')
 
134
        self.assertContainsRe(val, 'id: r3')
 
135
        self.assertContainsRe(val, 'message: \xc3\xa52') # utf8 encoding '\xe5'
 
136
 
 
137
    def regen(self, wt, **kwargs):
 
138
        sio = BytesIO()
 
139
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
 
140
        builder.generate(sio)
 
141
        sio.seek(0)
 
142
        stanzas = list(read_stanzas(sio))
 
143
        self.assertEqual(1, len(stanzas))
 
144
        return stanzas[0]
 
145
 
 
146
    def test_rio_version_hook(self):
 
147
        def update_stanza(rev, stanza):
 
148
            stanza.add('bla', 'bloe')
 
149
        RioVersionInfoBuilder.hooks.install_named_hook(
 
150
            'revision', update_stanza, None)
 
151
        wt = self.create_branch()
 
152
 
 
153
        stanza = self.regen(wt)
 
154
        self.assertEqual(['bloe'], stanza.get_all('bla'))
 
155
 
 
156
    def get_one_stanza(self, stanza, key):
 
157
        new_stanzas = list(read_stanzas(BytesIO(stanza[key].encode('utf8'))))
 
158
        self.assertEqual(1, len(new_stanzas))
 
159
        return new_stanzas[0]
 
160
 
 
161
    def test_build_date(self):
 
162
        wt = self.create_branch()
 
163
        stanza = self.regen(wt)
 
164
        self.assertTrue('date' in stanza)
 
165
        self.assertTrue('build-date' in stanza)
 
166
        self.assertEqual(['3'], stanza.get_all('revno'))
 
167
        self.assertEqual(['r3'], stanza.get_all('revision-id'))
 
168
 
 
169
    def test_not_clean(self):
 
170
        wt = self.create_branch()
 
171
        self.build_tree(['branch/c'])
 
172
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
173
        self.assertEqual(['False'], stanza.get_all('clean'))
 
174
 
 
175
    def test_file_revisions(self):
 
176
        wt = self.create_branch()
 
177
        self.build_tree(['branch/c'])
 
178
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
179
        # This assumes it's being run against a tree that does not update the
 
180
        # root revision on every commit.
 
181
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
182
        self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
 
183
        self.assertEqual(['r1', 'r3', 'r2', 'unversioned'],
 
184
            file_rev_stanza.get_all('revision'))
 
185
 
 
186
    def test_revision_history(self):
 
187
        wt = self.create_branch()
 
188
        stanza = self.regen(wt, include_revision_history=True)
 
189
        revision_stanza = self.get_one_stanza(stanza, 'revisions')
 
190
        self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
 
191
        self.assertEqual(['a', 'b', u'\xe52'], revision_stanza.get_all('message'))
 
192
        self.assertEqual(3, len(revision_stanza.get_all('date')))
 
193
 
 
194
    def test_file_revisions_with_rename(self):
 
195
        # a was modified, so it should show up modified again
 
196
        wt = self.create_branch()
 
197
        self.build_tree(['branch/a', 'branch/c'])
 
198
        wt.add('c')
 
199
        wt.rename_one('b', 'd')
 
200
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
201
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
202
        self.assertEqual(['', 'a', 'b', 'c', 'd'],
 
203
                          file_rev_stanza.get_all('path'))
 
204
        self.assertEqual(['r1', 'modified', 'renamed to d', 'new',
 
205
                          'renamed from b'],
 
206
                         file_rev_stanza.get_all('revision'))
 
207
 
 
208
    def test_file_revisions_with_removal(self):
 
209
        wt = self.create_branch()
 
210
        self.build_tree(['branch/a', 'branch/c'])
 
211
        wt.add('c')
 
212
        wt.rename_one('b', 'd')
 
213
 
 
214
        wt.commit('modified', rev_id='r4')
 
215
 
 
216
        wt.remove(['c', 'd'])
 
217
        os.remove('branch/d')
 
218
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
219
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
220
        self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
 
221
        self.assertEqual(['r1', 'r4', 'unversioned', 'removed'],
 
222
                         file_rev_stanza.get_all('revision'))
 
223
 
 
224
    def test_revision(self):
 
225
        wt = self.create_branch()
 
226
        self.build_tree(['branch/a', 'branch/c'])
 
227
        wt.add('c')
 
228
        wt.rename_one('b', 'd')
 
229
 
 
230
        stanza = self.regen(wt, check_for_clean=True,
 
231
            include_file_revisions=True, revision_id=wt.last_revision())
 
232
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
233
        self.assertEqual(['', 'a', 'b'], file_rev_stanza.get_all('path'))
 
234
        self.assertEqual(['r1', 'r3', 'r2'],
 
235
                         file_rev_stanza.get_all('revision'))
 
236
 
 
237
 
 
238
class PythonVersionInfoTests(VersionInfoTestCase):
 
239
 
 
240
    def test_python_null(self):
 
241
        wt = self.make_branch_and_tree('branch')
 
242
 
 
243
        sio = BytesIO()
 
244
        builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
 
245
        builder.generate(sio)
 
246
        val = sio.getvalue()
 
247
        self.assertContainsRe(val, "'revision_id': None")
 
248
        self.assertContainsRe(val, "'revno': '0'")
 
249
        self.assertNotContainsString(val, '\n\n\n\n')
 
250
 
 
251
    def test_python_dotted_revno(self):
 
252
        wt = self.create_tree_with_dotted_revno()
 
253
 
 
254
        sio = BytesIO()
 
255
        builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
 
256
        builder.generate(sio)
 
257
        val = sio.getvalue()
 
258
        self.assertContainsRe(val, "'revno': '1.1.1'")
 
259
 
 
260
    def regen(self, wt, **kwargs):
 
261
        """Create a test module, import and return it"""
 
262
        outf = open('test_version_information.py', 'wb')
 
263
        try:
 
264
            builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
 
265
                                               **kwargs)
 
266
            builder.generate(outf)
 
267
        finally:
 
268
            outf.close()
 
269
        module_info = imp.find_module('test_version_information',
 
270
                                      [self.test_dir])
 
271
        tvi = imp.load_module('tvi', *module_info)
 
272
        # Make sure the module isn't cached
 
273
        sys.modules.pop('tvi', None)
 
274
        sys.modules.pop('test_version_information', None)
 
275
        # Delete the compiled versions, because we are generating
 
276
        # a new file fast enough that python doesn't detect it
 
277
        # needs to recompile, and using sleep() just makes the
 
278
        # test slow
 
279
        if os.path.exists('test_version_information.pyc'):
 
280
            os.remove('test_version_information.pyc')
 
281
        if os.path.exists('test_version_information.pyo'):
 
282
            os.remove('test_version_information.pyo')
 
283
        return tvi
 
284
 
 
285
    def test_python_version(self):
 
286
        wt = self.create_branch()
 
287
 
 
288
        tvi = self.regen(wt)
 
289
        self.assertEqual('3', tvi.version_info['revno'])
 
290
        self.assertEqual('r3', tvi.version_info['revision_id'])
 
291
        self.assertTrue('date' in tvi.version_info)
 
292
        self.assertEqual(None, tvi.version_info['clean'])
 
293
 
 
294
        tvi = self.regen(wt, check_for_clean=True)
 
295
        self.assertEqual(True, tvi.version_info['clean'])
 
296
 
 
297
        self.build_tree(['branch/c'])
 
298
        tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
299
        self.assertEqual(False, tvi.version_info['clean'])
 
300
        self.assertEqual(['', 'a', 'b', 'c'],
 
301
                         sorted(tvi.file_revisions.keys()))
 
302
        self.assertEqual('r3', tvi.file_revisions['a'])
 
303
        self.assertEqual('r2', tvi.file_revisions['b'])
 
304
        self.assertEqual('unversioned', tvi.file_revisions['c'])
 
305
        os.remove('branch/c')
 
306
 
 
307
        tvi = self.regen(wt, include_revision_history=True)
 
308
 
 
309
        rev_info = [(rev, message) for rev, message, timestamp, timezone
 
310
                                   in tvi.revisions]
 
311
        self.assertEqual([('r1', 'a'), ('r2', 'b'), ('r3', u'\xe52')], rev_info)
 
312
 
 
313
        # a was modified, so it should show up modified again
 
314
        self.build_tree(['branch/a', 'branch/c'])
 
315
        wt.add('c')
 
316
        wt.rename_one('b', 'd')
 
317
        tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
318
        self.assertEqual(['', 'a', 'b', 'c', 'd'],
 
319
                          sorted(tvi.file_revisions.keys()))
 
320
        self.assertEqual('modified', tvi.file_revisions['a'])
 
321
        self.assertEqual('renamed to d', tvi.file_revisions['b'])
 
322
        self.assertEqual('new', tvi.file_revisions['c'])
 
323
        self.assertEqual('renamed from b', tvi.file_revisions['d'])
 
324
 
 
325
        wt.commit('modified', rev_id='r4')
 
326
        wt.remove(['c', 'd'])
 
327
        os.remove('branch/d')
 
328
        tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
329
        self.assertEqual(['', 'a', 'c', 'd'],
 
330
                          sorted(tvi.file_revisions.keys()))
 
331
        self.assertEqual('r4', tvi.file_revisions['a'])
 
332
        self.assertEqual('unversioned', tvi.file_revisions['c'])
 
333
        self.assertEqual('removed', tvi.file_revisions['d'])
 
334
 
 
335
 
 
336
class CustomVersionInfoTests(VersionInfoTestCase):
 
337
 
 
338
    def test_custom_null(self):
 
339
        sio = BytesIO()
 
340
        wt = self.make_branch_and_tree('branch')
 
341
        builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
 
342
            template='revno: {revno}')
 
343
        builder.generate(sio)
 
344
        self.assertEqual("revno: 0", sio.getvalue())
 
345
 
 
346
        builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt, 
 
347
            template='{revno} revid: {revision_id}')
 
348
        # revision_id is not available yet
 
349
        self.assertRaises(errors.MissingTemplateVariable, 
 
350
            builder.generate, sio)
 
351
 
 
352
    def test_custom_dotted_revno(self):
 
353
        sio = BytesIO()
 
354
        wt = self.create_tree_with_dotted_revno()
 
355
        builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt, 
 
356
            template='{revno} revid: {revision_id}')
 
357
        builder.generate(sio)
 
358
        self.assertEqual("1.1.1 revid: o2", sio.getvalue())
 
359
 
 
360
    def regen(self, wt, tpl, **kwargs):
 
361
        sio = BytesIO()
 
362
        builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
 
363
                                           template=tpl, **kwargs)
 
364
        builder.generate(sio)
 
365
        val = sio.getvalue()
 
366
        return val
 
367
 
 
368
    def test_build_date(self):
 
369
        wt = self.create_branch()
 
370
 
 
371
        val = self.regen(wt, 'build-date: "{build_date}"\ndate: "{date}"')
 
372
        self.assertContainsRe(val, 'build-date: "[0-9-+: ]+"')
 
373
        self.assertContainsRe(val, 'date: "[0-9-+: ]+"')
 
374
 
 
375
    def test_revno(self):
 
376
        wt = self.create_branch()
 
377
        val = self.regen(wt, 'revno: {revno}')
 
378
        self.assertEqual(val, 'revno: 3')
 
379
 
 
380
    def test_revision_id(self):
 
381
        wt = self.create_branch()
 
382
        val = self.regen(wt, 'revision-id: {revision_id}')
 
383
        self.assertEqual(val, 'revision-id: r3')
 
384
 
 
385
    def test_clean(self):
 
386
        wt = self.create_branch()
 
387
        val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
 
388
        self.assertEqual(val, 'clean: 1')
 
389
 
 
390
    def test_not_clean(self):
 
391
        wt = self.create_branch()
 
392
 
 
393
        self.build_tree(['branch/c'])
 
394
        val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
 
395
        self.assertEqual(val, 'clean: 0')
 
396
        os.remove('branch/c')
 
397
 
 
398
    def test_custom_without_template(self):
 
399
        builder = CustomVersionInfoBuilder(None)
 
400
        sio = BytesIO()
 
401
        self.assertRaises(errors.NoTemplate, builder.generate, sio)
 
402
 
 
403
 
 
404
class TestBuilder(version_info_formats.VersionInfoBuilder):
 
405
    pass
 
406
 
 
407
 
 
408
class TestVersionInfoFormatRegistry(tests.TestCase):
 
409
 
 
410
    def setUp(self):
 
411
        super(TestVersionInfoFormatRegistry, self).setUp()
 
412
        self.overrideAttr(version_info_formats,
 
413
                          'format_registry', registry.Registry())
 
414
 
 
415
    def test_register_remove(self):
 
416
        registry = version_info_formats.format_registry
 
417
        registry.register('testbuilder',
 
418
            TestBuilder, 'a simple test builder')
 
419
        self.assertIs(TestBuilder, registry.get('testbuilder'))
 
420
        self.assertEqual('a simple test builder',
 
421
                         registry.get_help('testbuilder'))
 
422
        registry.remove('testbuilder')
 
423
        self.assertRaises(KeyError, registry.get, 'testbuilder')