/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-08-07 11:49:46 UTC
  • mto: (6747.3.4 avoid-set-revid-3)
  • mto: This revision was merged to the branch mainline in revision 6750.
  • Revision ID: jelmer@jelmer.uk-20170807114946-luclmxuawyzhpiot
Avoid setting revision_ids.

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