1
# Copyright (C) 2005-2012, 2016 Canonical Ltd
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.
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.
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
17
"""Tests for version_info"""
26
from ..sixish import (
30
from . import TestCaseWithTransport
31
from ..rio import read_stanzas, read_stanzas_unicode
33
from ..version_info_formats.format_custom import (
34
CustomVersionInfoBuilder,
35
MissingTemplateVariable,
38
from ..version_info_formats.format_rio import RioVersionInfoBuilder
39
from ..version_info_formats.format_python import PythonVersionInfoBuilder
42
class VersionInfoTestCase(TestCaseWithTransport):
44
def create_branch(self):
45
wt = self.make_branch_and_tree('branch')
47
self.build_tree(['branch/a'])
49
wt.commit('a', rev_id=b'r1')
51
self.build_tree(['branch/b'])
53
wt.commit('b', rev_id=b'r2')
55
self.build_tree_contents([('branch/a', b'new contents\n')])
56
wt.commit(u'\xe52', rev_id=b'r3')
60
def create_tree_with_dotted_revno(self):
61
wt = self.make_branch_and_tree('branch')
62
self.build_tree(['branch/a'])
64
wt.commit('a', rev_id=b'r1')
66
other = wt.controldir.sprout('other').open_workingtree()
67
self.build_tree(['other/b.a'])
69
other.commit('b.a', rev_id=b'o2')
72
self.run_bzr('merge ../other')
73
wt.commit('merge', rev_id=b'merge')
75
wt.update(revision=b'o2')
80
class TestVersionInfoRio(VersionInfoTestCase):
82
def test_rio_null(self):
83
wt = self.make_branch_and_tree('branch')
86
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
89
self.assertContainsRe(val, 'build-date:')
90
self.assertContainsRe(val, 'revno: 0')
92
def test_rio_dotted_revno(self):
93
wt = self.create_tree_with_dotted_revno()
96
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
99
self.assertContainsRe(val, 'revno: 1.1.1')
101
def regen_text(self, wt, **kwargs):
103
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
104
builder.generate(sio)
108
def test_simple(self):
109
wt = self.create_branch()
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')
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')
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')
128
def test_history(self):
129
wt = self.create_branch()
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: \xe5')
139
def regen(self, wt, **kwargs):
141
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
142
builder.generate(sio)
144
stanzas = list(read_stanzas_unicode(sio))
145
self.assertEqual(1, len(stanzas))
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()
155
stanza = self.regen(wt)
156
self.assertEqual(['bloe'], stanza.get_all('bla'))
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]
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'))
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,
175
include_file_revisions=True)
176
self.assertEqual(['False'], stanza.get_all('clean'))
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,
182
include_file_revisions=True)
183
# This assumes it's being run against a tree that does not update the
184
# root revision on every commit.
185
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
186
self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
187
self.assertEqual(['r1', 'r3', 'r2', 'unversioned'],
188
file_rev_stanza.get_all('revision'))
190
def test_revision_history(self):
191
wt = self.create_branch()
192
stanza = self.regen(wt, include_revision_history=True)
193
revision_stanza = self.get_one_stanza(stanza, 'revisions')
194
self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
195
self.assertEqual(['a', 'b', u'\xe52'],
196
revision_stanza.get_all('message'))
197
self.assertEqual(3, len(revision_stanza.get_all('date')))
199
def test_file_revisions_with_rename(self):
200
# a was modified, so it should show up modified again
201
wt = self.create_branch()
202
self.build_tree(['branch/a', 'branch/c'])
204
wt.rename_one('b', 'd')
205
stanza = self.regen(wt, check_for_clean=True,
206
include_file_revisions=True)
207
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
208
self.assertEqual(['', 'a', 'b', 'c', 'd'],
209
file_rev_stanza.get_all('path'))
210
self.assertEqual(['r1', 'modified', 'renamed to d', 'new',
212
file_rev_stanza.get_all('revision'))
214
def test_file_revisions_with_removal(self):
215
wt = self.create_branch()
216
self.build_tree(['branch/a', 'branch/c'])
218
wt.rename_one('b', 'd')
220
wt.commit('modified', rev_id=b'r4')
222
wt.remove(['c', 'd'])
223
os.remove('branch/d')
224
stanza = self.regen(wt, check_for_clean=True,
225
include_file_revisions=True)
226
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
227
self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
228
self.assertEqual(['r1', 'r4', 'unversioned', 'removed'],
229
file_rev_stanza.get_all('revision'))
231
def test_revision(self):
232
wt = self.create_branch()
233
self.build_tree(['branch/a', 'branch/c'])
235
wt.rename_one('b', 'd')
238
wt, check_for_clean=True, include_file_revisions=True,
239
revision_id=wt.last_revision())
240
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
241
self.assertEqual(['', 'a', 'b'], file_rev_stanza.get_all('path'))
242
self.assertEqual(['r1', 'r3', 'r2'],
243
file_rev_stanza.get_all('revision'))
246
class PythonVersionInfoTests(VersionInfoTestCase):
248
def test_python_null(self):
249
wt = self.make_branch_and_tree('branch')
252
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
253
builder.generate(sio)
255
self.assertContainsRe(val, "'revision_id': None")
256
self.assertContainsRe(val, "'revno': '0'")
257
self.assertNotContainsString(val, '\n\n\n\n')
259
def test_python_dotted_revno(self):
260
wt = self.create_tree_with_dotted_revno()
263
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
264
builder.generate(sio)
266
self.assertContainsRe(val, "'revno': '1.1.1'")
268
def regen(self, wt, **kwargs):
269
"""Create a test module, import and return it"""
270
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
273
builder.generate(outf)
275
exec(outf.getvalue(), {}, local_vars)
278
def test_python_version(self):
279
wt = self.create_branch()
282
self.assertEqual('3', tvi['version_info']['revno'])
283
self.assertEqual(b'r3', tvi['version_info']['revision_id'])
284
self.assertTrue('date' in tvi['version_info'])
285
self.assertEqual(None, tvi['version_info']['clean'])
287
tvi = self.regen(wt, check_for_clean=True)
288
self.assertTrue(tvi['version_info']['clean'])
290
self.build_tree(['branch/c'])
291
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
292
self.assertFalse(tvi['version_info']['clean'])
293
self.assertEqual(['', 'a', 'b', 'c'],
294
sorted(tvi['file_revisions'].keys()))
295
self.assertEqual(b'r3', tvi['file_revisions']['a'])
296
self.assertEqual(b'r2', tvi['file_revisions']['b'])
297
self.assertEqual('unversioned', tvi['file_revisions']['c'])
298
os.remove('branch/c')
300
tvi = self.regen(wt, include_revision_history=True)
302
rev_info = [(rev, message) for rev, message, timestamp, timezone
304
self.assertEqual([(b'r1', 'a'), (b'r2', 'b'),
305
(b'r3', u'\xe52')], rev_info)
307
# a was modified, so it should show up modified again
308
self.build_tree(['branch/a', 'branch/c'])
310
wt.rename_one('b', 'd')
311
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
312
self.assertEqual(['', 'a', 'b', 'c', 'd'],
313
sorted(tvi['file_revisions'].keys()))
314
self.assertEqual('modified', tvi['file_revisions']['a'])
315
self.assertEqual('renamed to d', tvi['file_revisions']['b'])
316
self.assertEqual('new', tvi['file_revisions']['c'])
317
self.assertEqual('renamed from b', tvi['file_revisions']['d'])
319
wt.commit('modified', rev_id=b'r4')
320
wt.remove(['c', 'd'])
321
os.remove('branch/d')
322
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
323
self.assertEqual(['', 'a', 'c', 'd'],
324
sorted(tvi['file_revisions'].keys()))
325
self.assertEqual(b'r4', tvi['file_revisions']['a'])
326
self.assertEqual('unversioned', tvi['file_revisions']['c'])
327
self.assertEqual('removed', tvi['file_revisions']['d'])
330
class CustomVersionInfoTests(VersionInfoTestCase):
332
def test_custom_null(self):
334
wt = self.make_branch_and_tree('branch')
335
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
336
template='revno: {revno}')
337
builder.generate(sio)
338
self.assertEqual("revno: 0", sio.getvalue())
340
builder = CustomVersionInfoBuilder(
341
wt.branch, working_tree=wt,
342
template='{revno} revid: {revision_id}')
343
# revision_id is not available yet
344
self.assertRaises(MissingTemplateVariable, builder.generate, sio)
346
def test_custom_dotted_revno(self):
348
wt = self.create_tree_with_dotted_revno()
349
builder = CustomVersionInfoBuilder(
350
wt.branch, working_tree=wt,
351
template='{revno} revid: {revision_id}')
352
builder.generate(sio)
353
self.assertEqual("1.1.1 revid: o2", sio.getvalue())
355
def regen(self, wt, tpl, **kwargs):
357
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
358
template=tpl, **kwargs)
359
builder.generate(sio)
363
def test_build_date(self):
364
wt = self.create_branch()
366
val = self.regen(wt, 'build-date: "{build_date}"\ndate: "{date}"')
367
self.assertContainsRe(val, 'build-date: "[0-9-+: ]+"')
368
self.assertContainsRe(val, 'date: "[0-9-+: ]+"')
370
def test_revno(self):
371
wt = self.create_branch()
372
val = self.regen(wt, 'revno: {revno}')
373
self.assertEqual(val, 'revno: 3')
375
def test_revision_id(self):
376
wt = self.create_branch()
377
val = self.regen(wt, 'revision-id: {revision_id}')
378
self.assertEqual(val, 'revision-id: r3')
380
def test_clean(self):
381
wt = self.create_branch()
382
val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
383
self.assertEqual(val, 'clean: 1')
385
def test_not_clean(self):
386
wt = self.create_branch()
388
self.build_tree(['branch/c'])
389
val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
390
self.assertEqual(val, 'clean: 0')
391
os.remove('branch/c')
393
def test_custom_without_template(self):
394
builder = CustomVersionInfoBuilder(None)
396
self.assertRaises(NoTemplate, builder.generate, sio)
399
class TestBuilder(version_info_formats.VersionInfoBuilder):
403
class TestVersionInfoFormatRegistry(tests.TestCase):
406
super(TestVersionInfoFormatRegistry, self).setUp()
407
self.overrideAttr(version_info_formats,
408
'format_registry', registry.Registry())
410
def test_register_remove(self):
411
registry = version_info_formats.format_registry
412
registry.register('testbuilder',
413
TestBuilder, 'a simple test builder')
414
self.assertIs(TestBuilder, registry.get('testbuilder'))
415
self.assertEqual('a simple test builder',
416
registry.get_help('testbuilder'))
417
registry.remove('testbuilder')
418
self.assertRaises(KeyError, registry.get, 'testbuilder')
added
removed
breezy/tests/test_version_info.py
