← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_version_info.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

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