17
17
"""Tests for version_info"""
19
from cStringIO import StringIO
29
25
version_info_formats,
31
from bzrlib.tests import TestCaseWithTransport
32
from bzrlib.rio import read_stanzas
34
from bzrlib.version_info_formats.format_custom import CustomVersionInfoBuilder
35
from bzrlib.version_info_formats.format_rio import RioVersionInfoBuilder
36
from bzrlib.version_info_formats.format_python import PythonVersionInfoBuilder
39
class TestVersionInfo(TestCaseWithTransport):
27
from ..sixish import (
31
from . import TestCaseWithTransport
32
from ..rio import read_stanzas, read_stanzas_unicode
34
from ..version_info_formats.format_custom import (
35
CustomVersionInfoBuilder,
36
MissingTemplateVariable,
39
from ..version_info_formats.format_rio import RioVersionInfoBuilder
40
from ..version_info_formats.format_python import PythonVersionInfoBuilder
43
class VersionInfoTestCase(TestCaseWithTransport):
41
45
def create_branch(self):
42
46
wt = self.make_branch_and_tree('branch')
44
48
self.build_tree(['branch/a'])
46
wt.commit('a', rev_id='r1')
50
wt.commit('a', rev_id=b'r1')
48
52
self.build_tree(['branch/b'])
50
wt.commit('b', rev_id='r2')
52
self.build_tree_contents([('branch/a', 'new contents\n')])
53
wt.commit(u'\xe52', rev_id='r3')
54
wt.commit('b', rev_id=b'r2')
56
self.build_tree_contents([('branch/a', b'new contents\n')])
57
wt.commit(u'\xe52', rev_id=b'r3')
61
def create_tree_with_dotted_revno(self):
62
wt = self.make_branch_and_tree('branch')
63
self.build_tree(['branch/a'])
65
wt.commit('a', rev_id=b'r1')
67
other = wt.controldir.sprout('other').open_workingtree()
68
self.build_tree(['other/b.a'])
70
other.commit('b.a', rev_id=b'o2')
73
self.run_bzr('merge ../other')
74
wt.commit('merge', rev_id=b'merge')
76
wt.update(revision=b'o2')
81
class TestVersionInfoRio(VersionInfoTestCase):
57
83
def test_rio_null(self):
58
84
wt = self.make_branch_and_tree('branch')
64
90
self.assertContainsRe(val, 'build-date:')
65
91
self.assertContainsRe(val, 'revno: 0')
67
def test_rio_version_text(self):
93
def test_rio_dotted_revno(self):
94
wt = self.create_tree_with_dotted_revno()
97
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
100
self.assertContainsRe(val, 'revno: 1.1.1')
102
def regen_text(self, wt, **kwargs):
104
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
105
builder.generate(sio)
109
def test_simple(self):
68
110
wt = self.create_branch()
72
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
112
val = self.regen_text(wt)
79
113
self.assertContainsRe(val, 'build-date:')
80
114
self.assertContainsRe(val, 'date:')
81
115
self.assertContainsRe(val, 'revno: 3')
82
116
self.assertContainsRe(val, 'revision-id: r3')
84
val = regen(check_for_clean=True)
118
def test_clean(self):
119
wt = self.create_branch()
120
val = self.regen_text(wt, check_for_clean=True)
85
121
self.assertContainsRe(val, 'clean: True')
123
def test_no_clean(self):
124
wt = self.create_branch()
87
125
self.build_tree(['branch/c'])
88
val = regen(check_for_clean=True)
126
val = self.regen_text(wt, check_for_clean=True)
89
127
self.assertContainsRe(val, 'clean: False')
92
val = regen(include_revision_history=True)
129
def test_history(self):
130
wt = self.create_branch()
132
val = self.regen_text(wt, include_revision_history=True)
93
133
self.assertContainsRe(val, 'id: r1')
94
134
self.assertContainsRe(val, 'message: a')
95
135
self.assertContainsRe(val, 'id: r2')
96
136
self.assertContainsRe(val, 'message: b')
97
137
self.assertContainsRe(val, 'id: r3')
98
self.assertContainsRe(val, 'message: \xc3\xa52') # utf8 encoding '\xe5'
138
self.assertContainsRe(val, 'message: \xe5')
140
def regen(self, wt, **kwargs):
142
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt, **kwargs)
143
builder.generate(sio)
145
stanzas = list(read_stanzas_unicode(sio))
146
self.assertEqual(1, len(stanzas))
100
149
def test_rio_version_hook(self):
101
150
def update_stanza(rev, stanza):
104
153
'revision', update_stanza, None)
105
154
wt = self.create_branch()
109
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
111
builder.generate(sio)
113
stanzas = list(read_stanzas(sio))
114
self.assertEqual(1, len(stanzas))
156
stanza = self.regen(wt)
118
157
self.assertEqual(['bloe'], stanza.get_all('bla'))
120
def test_rio_version(self):
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]
164
def test_build_date(self):
121
165
wt = self.create_branch()
125
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
127
builder.generate(sio)
129
stanzas = list(read_stanzas(sio))
130
self.assertEqual(1, len(stanzas))
133
def get_one_stanza(stanza, key):
134
new_stanzas = list(read_stanzas(
135
StringIO(stanza[key].encode('utf8'))))
136
self.assertEqual(1, len(new_stanzas))
137
return new_stanzas[0]
140
self.failUnless('date' in stanza)
141
self.failUnless('build-date' in stanza)
166
stanza = self.regen(wt)
167
self.assertTrue('date' in stanza)
168
self.assertTrue('build-date' in stanza)
142
169
self.assertEqual(['3'], stanza.get_all('revno'))
143
170
self.assertEqual(['r3'], stanza.get_all('revision-id'))
145
stanza = regen(check_for_clean=True)
146
self.assertEqual(['True'], stanza.get_all('clean'))
172
def test_not_clean(self):
173
wt = self.create_branch()
148
174
self.build_tree(['branch/c'])
149
stanza = regen(check_for_clean=True, include_file_revisions=True)
175
stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
150
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, include_file_revisions=True)
152
182
# This assumes it's being run against a tree that does not update the
153
183
# root revision on every commit.
154
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
184
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
155
185
self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
156
186
self.assertEqual(['r1', 'r3', 'r2', 'unversioned'],
157
187
file_rev_stanza.get_all('revision'))
158
os.remove('branch/c')
160
stanza = regen(include_revision_history=True)
161
revision_stanza = get_one_stanza(stanza, 'revisions')
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')
162
193
self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
163
194
self.assertEqual(['a', 'b', u'\xe52'], revision_stanza.get_all('message'))
164
195
self.assertEqual(3, len(revision_stanza.get_all('date')))
197
def test_file_revisions_with_rename(self):
166
198
# a was modified, so it should show up modified again
199
wt = self.create_branch()
167
200
self.build_tree(['branch/a', 'branch/c'])
169
202
wt.rename_one('b', 'd')
170
stanza = regen(check_for_clean=True, include_file_revisions=True)
171
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
203
stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
204
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
172
205
self.assertEqual(['', 'a', 'b', 'c', 'd'],
173
206
file_rev_stanza.get_all('path'))
174
207
self.assertEqual(['r1', 'modified', 'renamed to d', 'new',
175
208
'renamed from b'],
176
209
file_rev_stanza.get_all('revision'))
178
wt.commit('modified', rev_id='r4')
211
def test_file_revisions_with_removal(self):
212
wt = self.create_branch()
213
self.build_tree(['branch/a', 'branch/c'])
215
wt.rename_one('b', 'd')
217
wt.commit('modified', rev_id=b'r4')
179
219
wt.remove(['c', 'd'])
180
220
os.remove('branch/d')
181
stanza = regen(check_for_clean=True, include_file_revisions=True)
182
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
221
stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
222
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
183
223
self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
184
224
self.assertEqual(['r1', 'r4', 'unversioned', 'removed'],
185
225
file_rev_stanza.get_all('revision'))
227
def test_revision(self):
228
wt = self.create_branch()
229
self.build_tree(['branch/a', 'branch/c'])
231
wt.rename_one('b', 'd')
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'))
241
class PythonVersionInfoTests(VersionInfoTestCase):
187
243
def test_python_null(self):
188
244
wt = self.make_branch_and_tree('branch')
192
248
builder.generate(sio)
193
249
val = sio.getvalue()
194
250
self.assertContainsRe(val, "'revision_id': None")
195
self.assertContainsRe(val, "'revno': 0")
251
self.assertContainsRe(val, "'revno': '0'")
252
self.assertNotContainsString(val, '\n\n\n\n')
254
def test_python_dotted_revno(self):
255
wt = self.create_tree_with_dotted_revno()
258
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
259
builder.generate(sio)
261
self.assertContainsRe(val, "'revno': '1.1.1'")
263
def regen(self, wt, **kwargs):
264
"""Create a test module, import and return it"""
265
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
268
builder.generate(outf)
270
exec(outf.getvalue(), {}, local_vars)
197
273
def test_python_version(self):
198
274
wt = self.create_branch()
201
"""Create a test module, import and return it"""
202
outf = open('test_version_information.py', 'wb')
204
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
206
builder.generate(outf)
209
module_info = imp.find_module('test_version_information',
211
tvi = imp.load_module('tvi', *module_info)
212
# Make sure the module isn't cached
213
sys.modules.pop('tvi', None)
214
sys.modules.pop('test_version_information', None)
215
# Delete the compiled versions, because we are generating
216
# a new file fast enough that python doesn't detect it
217
# needs to recompile, and using sleep() just makes the
219
if os.path.exists('test_version_information.pyc'):
220
os.remove('test_version_information.pyc')
221
if os.path.exists('test_version_information.pyo'):
222
os.remove('test_version_information.pyo')
226
self.assertEqual(3, tvi.version_info['revno'])
227
self.assertEqual('r3', tvi.version_info['revision_id'])
228
self.failUnless(tvi.version_info.has_key('date'))
229
self.assertEqual(None, tvi.version_info['clean'])
231
tvi = regen(check_for_clean=True)
232
self.assertEqual(True, tvi.version_info['clean'])
277
self.assertEqual('3', tvi['version_info']['revno'])
278
self.assertEqual(b'r3', tvi['version_info']['revision_id'])
279
self.assertTrue('date' in tvi['version_info'])
280
self.assertEqual(None, tvi['version_info']['clean'])
282
tvi = self.regen(wt, check_for_clean=True)
283
self.assertTrue(tvi['version_info']['clean'])
234
285
self.build_tree(['branch/c'])
235
tvi = regen(check_for_clean=True, include_file_revisions=True)
236
self.assertEqual(False, tvi.version_info['clean'])
286
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
287
self.assertFalse(tvi['version_info']['clean'])
237
288
self.assertEqual(['', 'a', 'b', 'c'],
238
sorted(tvi.file_revisions.keys()))
239
self.assertEqual('r3', tvi.file_revisions['a'])
240
self.assertEqual('r2', tvi.file_revisions['b'])
241
self.assertEqual('unversioned', tvi.file_revisions['c'])
289
sorted(tvi['file_revisions'].keys()))
290
self.assertEqual(b'r3', tvi['file_revisions']['a'])
291
self.assertEqual(b'r2', tvi['file_revisions']['b'])
292
self.assertEqual('unversioned', tvi['file_revisions']['c'])
242
293
os.remove('branch/c')
244
tvi = regen(include_revision_history=True)
295
tvi = self.regen(wt, include_revision_history=True)
246
297
rev_info = [(rev, message) for rev, message, timestamp, timezone
248
self.assertEqual([('r1', 'a'), ('r2', 'b'), ('r3', u'\xe52')], rev_info)
299
self.assertEqual([(b'r1', 'a'), (b'r2', 'b'), (b'r3', u'\xe52')], rev_info)
250
301
# a was modified, so it should show up modified again
251
302
self.build_tree(['branch/a', 'branch/c'])
253
304
wt.rename_one('b', 'd')
254
tvi = regen(check_for_clean=True, include_file_revisions=True)
305
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
255
306
self.assertEqual(['', 'a', 'b', 'c', 'd'],
256
sorted(tvi.file_revisions.keys()))
257
self.assertEqual('modified', tvi.file_revisions['a'])
258
self.assertEqual('renamed to d', tvi.file_revisions['b'])
259
self.assertEqual('new', tvi.file_revisions['c'])
260
self.assertEqual('renamed from b', tvi.file_revisions['d'])
307
sorted(tvi['file_revisions'].keys()))
308
self.assertEqual('modified', tvi['file_revisions']['a'])
309
self.assertEqual('renamed to d', tvi['file_revisions']['b'])
310
self.assertEqual('new', tvi['file_revisions']['c'])
311
self.assertEqual('renamed from b', tvi['file_revisions']['d'])
262
wt.commit('modified', rev_id='r4')
313
wt.commit('modified', rev_id=b'r4')
263
314
wt.remove(['c', 'd'])
264
315
os.remove('branch/d')
265
tvi = regen(check_for_clean=True, include_file_revisions=True)
316
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
266
317
self.assertEqual(['', 'a', 'c', 'd'],
267
sorted(tvi.file_revisions.keys()))
268
self.assertEqual('r4', tvi.file_revisions['a'])
269
self.assertEqual('unversioned', tvi.file_revisions['c'])
270
self.assertEqual('removed', tvi.file_revisions['d'])
318
sorted(tvi['file_revisions'].keys()))
319
self.assertEqual(b'r4', tvi['file_revisions']['a'])
320
self.assertEqual('unversioned', tvi['file_revisions']['c'])
321
self.assertEqual('removed', tvi['file_revisions']['d'])
324
class CustomVersionInfoTests(VersionInfoTestCase):
272
326
def test_custom_null(self):
275
329
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
276
330
template='revno: {revno}')
277
331
builder.generate(sio)
278
self.assertEquals("revno: 0", sio.getvalue())
332
self.assertEqual("revno: 0", sio.getvalue())
280
334
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
281
335
template='{revno} revid: {revision_id}')
282
336
# revision_id is not available yet
283
self.assertRaises(errors.MissingTemplateVariable,
284
builder.generate, sio)
286
def test_custom_version_text(self):
337
self.assertRaises(MissingTemplateVariable, builder.generate, sio)
339
def test_custom_dotted_revno(self):
341
wt = self.create_tree_with_dotted_revno()
342
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
343
template='{revno} revid: {revision_id}')
344
builder.generate(sio)
345
self.assertEqual("1.1.1 revid: o2", sio.getvalue())
347
def regen(self, wt, tpl, **kwargs):
349
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
350
template=tpl, **kwargs)
351
builder.generate(sio)
355
def test_build_date(self):
287
356
wt = self.create_branch()
289
def regen(tpl, **kwargs):
291
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
292
template=tpl, **kwargs)
293
builder.generate(sio)
297
val = regen('build-date: "{build_date}"\ndate: "{date}"')
358
val = self.regen(wt, 'build-date: "{build_date}"\ndate: "{date}"')
298
359
self.assertContainsRe(val, 'build-date: "[0-9-+: ]+"')
299
360
self.assertContainsRe(val, 'date: "[0-9-+: ]+"')
301
val = regen('revno: {revno}')
362
def test_revno(self):
363
wt = self.create_branch()
364
val = self.regen(wt, 'revno: {revno}')
302
365
self.assertEqual(val, 'revno: 3')
304
val = regen('revision-id: {revision_id}')
367
def test_revision_id(self):
368
wt = self.create_branch()
369
val = self.regen(wt, 'revision-id: {revision_id}')
305
370
self.assertEqual(val, 'revision-id: r3')
307
val = regen('clean: {clean}', check_for_clean=True)
372
def test_clean(self):
373
wt = self.create_branch()
374
val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
308
375
self.assertEqual(val, 'clean: 1')
377
def test_not_clean(self):
378
wt = self.create_branch()
310
380
self.build_tree(['branch/c'])
311
val = regen('clean: {clean}', check_for_clean=True)
381
val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
312
382
self.assertEqual(val, 'clean: 0')
313
383
os.remove('branch/c')
315
385
def test_custom_without_template(self):
316
386
builder = CustomVersionInfoBuilder(None)
318
self.assertRaises(errors.NoTemplate, builder.generate, sio)
388
self.assertRaises(NoTemplate, builder.generate, sio)
321
391
class TestBuilder(version_info_formats.VersionInfoBuilder):