/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-11-11 13:10:32 UTC
  • mto: This revision was merged to the branch mainline in revision 6804.
  • Revision ID: jelmer@jelmer.uk-20171111131032-31lgi8qmvlz8363d
Fix typos.

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 os
 
20
import sys
 
21
 
 
22
from .. import (
 
23
    registry,
 
24
    tests,
 
25
    version_info_formats,
 
26
    )
 
27
from ..sixish import (
 
28
    BytesIO,
 
29
    )
 
30
from . import TestCaseWithTransport
 
31
from ..rio import read_stanzas
 
32
 
 
33
from ..version_info_formats.format_custom import (
 
34
    CustomVersionInfoBuilder,
 
35
    MissingTemplateVariable,
 
36
    NoTemplate,
 
37
    )
 
38
from ..version_info_formats.format_rio import RioVersionInfoBuilder
 
39
from ..version_info_formats.format_python import PythonVersionInfoBuilder
 
40
 
 
41
 
 
42
class VersionInfoTestCase(TestCaseWithTransport):
 
43
 
 
44
    def create_branch(self):
 
45
        wt = self.make_branch_and_tree('branch')
 
46
 
 
47
        self.build_tree(['branch/a'])
 
48
        wt.add('a')
 
49
        wt.commit('a', rev_id='r1')
 
50
 
 
51
        self.build_tree(['branch/b'])
 
52
        wt.add('b')
 
53
        wt.commit('b', rev_id='r2')
 
54
 
 
55
        self.build_tree_contents([('branch/a', 'new contents\n')])
 
56
        wt.commit(u'\xe52', rev_id='r3')
 
57
 
 
58
        return wt
 
59
 
 
60
    def create_tree_with_dotted_revno(self):
 
61
        wt = self.make_branch_and_tree('branch')
 
62
        self.build_tree(['branch/a'])
 
63
        wt.add('a')
 
64
        wt.commit('a', rev_id='r1')
 
65
 
 
66
        other = wt.controldir.sprout('other').open_workingtree()
 
67
        self.build_tree(['other/b.a'])
 
68
        other.add(['b.a'])
 
69
        other.commit('b.a', rev_id='o2')
 
70
 
 
71
        os.chdir('branch')
 
72
        self.run_bzr('merge ../other')
 
73
        wt.commit('merge', rev_id='merge')
 
74
 
 
75
        wt.update(revision='o2')
 
76
 
 
77
        return wt
 
78
 
 
79
 
 
80
class TestVersionInfoRio(VersionInfoTestCase):
 
81
 
 
82
    def test_rio_null(self):
 
83
        wt = self.make_branch_and_tree('branch')
 
84
 
 
85
        sio = BytesIO()
 
86
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
 
87
        builder.generate(sio)
 
88
        val = sio.getvalue()
 
89
        self.assertContainsRe(val, 'build-date:')
 
90
        self.assertContainsRe(val, 'revno: 0')
 
91
 
 
92
    def test_rio_dotted_revno(self):
 
93
        wt = self.create_tree_with_dotted_revno()
 
94
 
 
95
        sio = BytesIO()
 
96
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
 
97
        builder.generate(sio)
 
98
        val = sio.getvalue()
 
99
        self.assertContainsRe(val, 'revno: 1.1.1')
 
100
 
 
101
    def regen_text(self, wt, **kwargs):
 
102
        sio = BytesIO()
 
103
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
 
104
        builder.generate(sio)
 
105
        val = sio.getvalue()
 
106
        return val
 
107
 
 
108
    def test_simple(self):
 
109
        wt = self.create_branch()
 
110
 
 
111
        val = self.regen_text(wt)
 
112
        self.assertContainsRe(val, 'build-date:')
 
113
        self.assertContainsRe(val, 'date:')
 
114
        self.assertContainsRe(val, 'revno: 3')
 
115
        self.assertContainsRe(val, 'revision-id: r3')
 
116
 
 
117
    def test_clean(self):
 
118
        wt = self.create_branch()
 
119
        val = self.regen_text(wt, check_for_clean=True)
 
120
        self.assertContainsRe(val, 'clean: True')
 
121
 
 
122
    def test_no_clean(self):
 
123
        wt = self.create_branch()
 
124
        self.build_tree(['branch/c'])
 
125
        val = self.regen_text(wt, check_for_clean=True)
 
126
        self.assertContainsRe(val, 'clean: False')
 
127
 
 
128
    def test_history(self):
 
129
        wt = self.create_branch()
 
130
 
 
131
        val = self.regen_text(wt, include_revision_history=True)
 
132
        self.assertContainsRe(val, 'id: r1')
 
133
        self.assertContainsRe(val, 'message: a')
 
134
        self.assertContainsRe(val, 'id: r2')
 
135
        self.assertContainsRe(val, 'message: b')
 
136
        self.assertContainsRe(val, 'id: r3')
 
137
        self.assertContainsRe(val, 'message: \xc3\xa52') # utf8 encoding '\xe5'
 
138
 
 
139
    def regen(self, wt, **kwargs):
 
140
        sio = BytesIO()
 
141
        builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
 
142
        builder.generate(sio)
 
143
        sio.seek(0)
 
144
        stanzas = list(read_stanzas(sio))
 
145
        self.assertEqual(1, len(stanzas))
 
146
        return stanzas[0]
 
147
 
 
148
    def test_rio_version_hook(self):
 
149
        def update_stanza(rev, stanza):
 
150
            stanza.add('bla', 'bloe')
 
151
        RioVersionInfoBuilder.hooks.install_named_hook(
 
152
            'revision', update_stanza, None)
 
153
        wt = self.create_branch()
 
154
 
 
155
        stanza = self.regen(wt)
 
156
        self.assertEqual(['bloe'], stanza.get_all('bla'))
 
157
 
 
158
    def get_one_stanza(self, stanza, key):
 
159
        new_stanzas = list(read_stanzas(BytesIO(stanza[key].encode('utf8'))))
 
160
        self.assertEqual(1, len(new_stanzas))
 
161
        return new_stanzas[0]
 
162
 
 
163
    def test_build_date(self):
 
164
        wt = self.create_branch()
 
165
        stanza = self.regen(wt)
 
166
        self.assertTrue('date' in stanza)
 
167
        self.assertTrue('build-date' in stanza)
 
168
        self.assertEqual(['3'], stanza.get_all('revno'))
 
169
        self.assertEqual(['r3'], stanza.get_all('revision-id'))
 
170
 
 
171
    def test_not_clean(self):
 
172
        wt = self.create_branch()
 
173
        self.build_tree(['branch/c'])
 
174
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
175
        self.assertEqual(['False'], stanza.get_all('clean'))
 
176
 
 
177
    def test_file_revisions(self):
 
178
        wt = self.create_branch()
 
179
        self.build_tree(['branch/c'])
 
180
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
181
        # This assumes it's being run against a tree that does not update the
 
182
        # root revision on every commit.
 
183
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
184
        self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
 
185
        self.assertEqual(['r1', 'r3', 'r2', 'unversioned'],
 
186
            file_rev_stanza.get_all('revision'))
 
187
 
 
188
    def test_revision_history(self):
 
189
        wt = self.create_branch()
 
190
        stanza = self.regen(wt, include_revision_history=True)
 
191
        revision_stanza = self.get_one_stanza(stanza, 'revisions')
 
192
        self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
 
193
        self.assertEqual(['a', 'b', u'\xe52'], revision_stanza.get_all('message'))
 
194
        self.assertEqual(3, len(revision_stanza.get_all('date')))
 
195
 
 
196
    def test_file_revisions_with_rename(self):
 
197
        # a was modified, so it should show up modified again
 
198
        wt = self.create_branch()
 
199
        self.build_tree(['branch/a', 'branch/c'])
 
200
        wt.add('c')
 
201
        wt.rename_one('b', 'd')
 
202
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
203
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
204
        self.assertEqual(['', 'a', 'b', 'c', 'd'],
 
205
                          file_rev_stanza.get_all('path'))
 
206
        self.assertEqual(['r1', 'modified', 'renamed to d', 'new',
 
207
                          'renamed from b'],
 
208
                         file_rev_stanza.get_all('revision'))
 
209
 
 
210
    def test_file_revisions_with_removal(self):
 
211
        wt = self.create_branch()
 
212
        self.build_tree(['branch/a', 'branch/c'])
 
213
        wt.add('c')
 
214
        wt.rename_one('b', 'd')
 
215
 
 
216
        wt.commit('modified', rev_id='r4')
 
217
 
 
218
        wt.remove(['c', 'd'])
 
219
        os.remove('branch/d')
 
220
        stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
 
221
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
222
        self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
 
223
        self.assertEqual(['r1', 'r4', 'unversioned', 'removed'],
 
224
                         file_rev_stanza.get_all('revision'))
 
225
 
 
226
    def test_revision(self):
 
227
        wt = self.create_branch()
 
228
        self.build_tree(['branch/a', 'branch/c'])
 
229
        wt.add('c')
 
230
        wt.rename_one('b', 'd')
 
231
 
 
232
        stanza = self.regen(wt, check_for_clean=True,
 
233
            include_file_revisions=True, revision_id=wt.last_revision())
 
234
        file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
 
235
        self.assertEqual(['', 'a', 'b'], file_rev_stanza.get_all('path'))
 
236
        self.assertEqual(['r1', 'r3', 'r2'],
 
237
                         file_rev_stanza.get_all('revision'))
 
238
 
 
239
 
 
240
class PythonVersionInfoTests(VersionInfoTestCase):
 
241
 
 
242
    def test_python_null(self):
 
243
        wt = self.make_branch_and_tree('branch')
 
244
 
 
245
        sio = BytesIO()
 
246
        builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
 
247
        builder.generate(sio)
 
248
        val = sio.getvalue()
 
249
        self.assertContainsRe(val, "'revision_id': None")
 
250
        self.assertContainsRe(val, "'revno': '0'")
 
251
        self.assertNotContainsString(val, '\n\n\n\n')
 
252
 
 
253
    def test_python_dotted_revno(self):
 
254
        wt = self.create_tree_with_dotted_revno()
 
255
 
 
256
        sio = BytesIO()
 
257
        builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
 
258
        builder.generate(sio)
 
259
        val = sio.getvalue()
 
260
        self.assertContainsRe(val, "'revno': '1.1.1'")
 
261
 
 
262
    def regen(self, wt, **kwargs):
 
263
        """Create a test module, import and return it"""
 
264
        outf = open('test_version_information.py', 'wb')
 
265
        try:
 
266
            builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
 
267
                                               **kwargs)
 
268
            builder.generate(outf)
 
269
        finally:
 
270
            outf.close()
 
271
        import imp
 
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')