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 (
30
from . import TestCaseWithTransport
31
from ..rio import read_stanzas
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):
41
44
def create_branch(self):
42
45
wt = self.make_branch_and_tree('branch')
44
47
self.build_tree(['branch/a'])
46
wt.commit('a', rev_id='r1')
49
wt.commit('a', rev_id=b'r1')
48
51
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')
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='o2')
80
class TestVersionInfoRio(VersionInfoTestCase):
57
82
def test_rio_null(self):
58
83
wt = self.make_branch_and_tree('branch')
61
86
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt)
62
87
builder.generate(sio)
63
88
val = sio.getvalue()
64
89
self.assertContainsRe(val, 'build-date:')
65
90
self.assertContainsRe(val, 'revno: 0')
67
def test_rio_version_text(self):
68
wt = self.create_branch()
72
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
79
self.assertContainsRe(val, 'build-date:')
80
self.assertContainsRe(val, 'date:')
81
self.assertContainsRe(val, 'revno: 3')
82
self.assertContainsRe(val, 'revision-id: r3')
84
val = regen(check_for_clean=True)
85
self.assertContainsRe(val, 'clean: True')
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, b'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, b'build-date:')
113
self.assertContainsRe(val, b'date:')
114
self.assertContainsRe(val, b'revno: 3')
115
self.assertContainsRe(val, b'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, b'clean: True')
122
def test_no_clean(self):
123
wt = self.create_branch()
87
124
self.build_tree(['branch/c'])
88
val = regen(check_for_clean=True)
89
self.assertContainsRe(val, 'clean: False')
92
val = regen(include_revision_history=True)
93
self.assertContainsRe(val, 'id: r1')
94
self.assertContainsRe(val, 'message: a')
95
self.assertContainsRe(val, 'id: r2')
96
self.assertContainsRe(val, 'message: b')
97
self.assertContainsRe(val, 'id: r3')
98
self.assertContainsRe(val, 'message: \xc3\xa52') # utf8 encoding '\xe5'
125
val = self.regen_text(wt, check_for_clean=True)
126
self.assertContainsRe(val, b'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, b'id: r1')
133
self.assertContainsRe(val, b'message: a')
134
self.assertContainsRe(val, b'id: r2')
135
self.assertContainsRe(val, b'message: b')
136
self.assertContainsRe(val, b'id: r3')
137
self.assertContainsRe(val, b'message: \xc3\xa52') # utf8 encoding '\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(sio))
145
self.assertEqual(1, len(stanzas))
100
148
def test_rio_version_hook(self):
101
149
def update_stanza(rev, stanza):
104
152
'revision', update_stanza, None)
105
153
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))
155
stanza = self.regen(wt)
118
156
self.assertEqual(['bloe'], stanza.get_all('bla'))
120
def test_rio_version(self):
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):
121
164
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)
165
stanza = self.regen(wt)
166
self.assertTrue('date' in stanza)
167
self.assertTrue('build-date' in stanza)
142
168
self.assertEqual(['3'], stanza.get_all('revno'))
143
169
self.assertEqual(['r3'], stanza.get_all('revision-id'))
145
stanza = regen(check_for_clean=True)
146
self.assertEqual(['True'], stanza.get_all('clean'))
171
def test_not_clean(self):
172
wt = self.create_branch()
148
173
self.build_tree(['branch/c'])
149
stanza = regen(check_for_clean=True, include_file_revisions=True)
174
stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
150
175
self.assertEqual(['False'], stanza.get_all('clean'))
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)
152
181
# This assumes it's being run against a tree that does not update the
153
182
# root revision on every commit.
154
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
183
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
155
184
self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
156
185
self.assertEqual(['r1', 'r3', 'r2', 'unversioned'],
157
186
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')
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')
162
192
self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
163
193
self.assertEqual(['a', 'b', u'\xe52'], revision_stanza.get_all('message'))
164
194
self.assertEqual(3, len(revision_stanza.get_all('date')))
196
def test_file_revisions_with_rename(self):
166
197
# a was modified, so it should show up modified again
198
wt = self.create_branch()
167
199
self.build_tree(['branch/a', 'branch/c'])
169
201
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')
202
stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
203
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
172
204
self.assertEqual(['', 'a', 'b', 'c', 'd'],
173
205
file_rev_stanza.get_all('path'))
174
206
self.assertEqual(['r1', 'modified', 'renamed to d', 'new',
175
207
'renamed from b'],
176
208
file_rev_stanza.get_all('revision'))
178
wt.commit('modified', rev_id='r4')
210
def test_file_revisions_with_removal(self):
211
wt = self.create_branch()
212
self.build_tree(['branch/a', 'branch/c'])
214
wt.rename_one('b', 'd')
216
wt.commit('modified', rev_id=b'r4')
179
218
wt.remove(['c', 'd'])
180
219
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')
220
stanza = self.regen(wt, check_for_clean=True, include_file_revisions=True)
221
file_rev_stanza = self.get_one_stanza(stanza, 'file-revisions')
183
222
self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
184
223
self.assertEqual(['r1', 'r4', 'unversioned', 'removed'],
185
224
file_rev_stanza.get_all('revision'))
226
def test_revision(self):
227
wt = self.create_branch()
228
self.build_tree(['branch/a', 'branch/c'])
230
wt.rename_one('b', 'd')
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'))
240
class PythonVersionInfoTests(VersionInfoTestCase):
187
242
def test_python_null(self):
188
243
wt = self.make_branch_and_tree('branch')
191
246
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
192
247
builder.generate(sio)
193
248
val = sio.getvalue()
194
249
self.assertContainsRe(val, "'revision_id': None")
195
self.assertContainsRe(val, "'revno': 0")
250
self.assertContainsRe(val, "'revno': '0'")
251
self.assertNotContainsString(val, '\n\n\n\n')
253
def test_python_dotted_revno(self):
254
wt = self.create_tree_with_dotted_revno()
257
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt)
258
builder.generate(sio)
260
self.assertContainsRe(val, "'revno': '1.1.1'")
262
def regen(self, wt, **kwargs):
263
"""Create a test module, import and return it"""
264
with open('test_version_information.py', 'wb') as outf:
265
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
267
builder.generate(outf)
269
module_info = imp.find_module('test_version_information',
271
tvi = imp.load_module('tvi', *module_info)
272
# Make sure the module isn't cached
273
sys.modules.pop('tvi', None)
274
sys.modules.pop('test_version_information', None)
275
# Delete the compiled versions, because we are generating
276
# a new file fast enough that python doesn't detect it
277
# needs to recompile, and using sleep() just makes the
279
if os.path.exists('test_version_information.pyc'):
280
os.remove('test_version_information.pyc')
281
if os.path.exists('test_version_information.pyo'):
282
os.remove('test_version_information.pyo')
197
285
def test_python_version(self):
198
286
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'])
289
self.assertEqual('3', tvi.version_info['revno'])
227
290
self.assertEqual('r3', tvi.version_info['revision_id'])
228
self.failUnless(tvi.version_info.has_key('date'))
291
self.assertTrue('date' in tvi.version_info)
229
292
self.assertEqual(None, tvi.version_info['clean'])
231
tvi = regen(check_for_clean=True)
294
tvi = self.regen(wt, check_for_clean=True)
232
295
self.assertEqual(True, tvi.version_info['clean'])
234
297
self.build_tree(['branch/c'])
235
tvi = regen(check_for_clean=True, include_file_revisions=True)
298
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
236
299
self.assertEqual(False, tvi.version_info['clean'])
237
300
self.assertEqual(['', 'a', 'b', 'c'],
238
301
sorted(tvi.file_revisions.keys()))
259
322
self.assertEqual('new', tvi.file_revisions['c'])
260
323
self.assertEqual('renamed from b', tvi.file_revisions['d'])
262
wt.commit('modified', rev_id='r4')
325
wt.commit('modified', rev_id=b'r4')
263
326
wt.remove(['c', 'd'])
264
327
os.remove('branch/d')
265
tvi = regen(check_for_clean=True, include_file_revisions=True)
328
tvi = self.regen(wt, check_for_clean=True, include_file_revisions=True)
266
329
self.assertEqual(['', 'a', 'c', 'd'],
267
330
sorted(tvi.file_revisions.keys()))
268
331
self.assertEqual('r4', tvi.file_revisions['a'])
269
332
self.assertEqual('unversioned', tvi.file_revisions['c'])
270
333
self.assertEqual('removed', tvi.file_revisions['d'])
336
class CustomVersionInfoTests(VersionInfoTestCase):
272
338
def test_custom_null(self):
274
340
wt = self.make_branch_and_tree('branch')
275
341
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
276
342
template='revno: {revno}')
277
343
builder.generate(sio)
278
self.assertEquals("revno: 0", sio.getvalue())
344
self.assertEqual("revno: 0", sio.getvalue())
280
346
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
281
347
template='{revno} revid: {revision_id}')
282
348
# revision_id is not available yet
283
self.assertRaises(errors.MissingTemplateVariable,
284
builder.generate, sio)
286
def test_custom_version_text(self):
349
self.assertRaises(MissingTemplateVariable, builder.generate, sio)
351
def test_custom_dotted_revno(self):
353
wt = self.create_tree_with_dotted_revno()
354
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
355
template='{revno} revid: {revision_id}')
356
builder.generate(sio)
357
self.assertEqual("1.1.1 revid: o2", sio.getvalue())
359
def regen(self, wt, tpl, **kwargs):
361
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
362
template=tpl, **kwargs)
363
builder.generate(sio)
367
def test_build_date(self):
287
368
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}"')
370
val = self.regen(wt, 'build-date: "{build_date}"\ndate: "{date}"')
298
371
self.assertContainsRe(val, 'build-date: "[0-9-+: ]+"')
299
372
self.assertContainsRe(val, 'date: "[0-9-+: ]+"')
301
val = regen('revno: {revno}')
374
def test_revno(self):
375
wt = self.create_branch()
376
val = self.regen(wt, 'revno: {revno}')
302
377
self.assertEqual(val, 'revno: 3')
304
val = regen('revision-id: {revision_id}')
379
def test_revision_id(self):
380
wt = self.create_branch()
381
val = self.regen(wt, 'revision-id: {revision_id}')
305
382
self.assertEqual(val, 'revision-id: r3')
307
val = regen('clean: {clean}', check_for_clean=True)
384
def test_clean(self):
385
wt = self.create_branch()
386
val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
308
387
self.assertEqual(val, 'clean: 1')
389
def test_not_clean(self):
390
wt = self.create_branch()
310
392
self.build_tree(['branch/c'])
311
val = regen('clean: {clean}', check_for_clean=True)
393
val = self.regen(wt, 'clean: {clean}', check_for_clean=True)
312
394
self.assertEqual(val, 'clean: 0')
313
395
os.remove('branch/c')
315
397
def test_custom_without_template(self):
316
398
builder = CustomVersionInfoBuilder(None)
318
self.assertRaises(errors.NoTemplate, builder.generate, sio)
400
self.assertRaises(NoTemplate, builder.generate, sio)
321
403
class TestBuilder(version_info_formats.VersionInfoBuilder):