1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tests for version_info"""
19
from cStringIO import StringIO
24
from bzrlib.tests import TestCaseWithTransport
25
from bzrlib.rio import read_stanzas
27
from bzrlib.version_info_formats.format_custom import CustomVersionInfoBuilder
28
from bzrlib.version_info_formats.format_rio import RioVersionInfoBuilder
29
from bzrlib.version_info_formats.format_python import PythonVersionInfoBuilder
32
class TestVersionInfo(TestCaseWithTransport):
34
def create_branch(self):
35
wt = self.make_branch_and_tree('branch')
37
self.build_tree(['branch/a'])
39
wt.commit('a', rev_id='r1')
41
self.build_tree(['branch/b'])
43
wt.commit('b', rev_id='r2')
45
self.build_tree_contents([('branch/a', 'new contents\n')])
46
wt.commit(u'\xe52', rev_id='r3')
50
def test_rio_version_text(self):
51
wt = self.create_branch()
55
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
62
self.assertContainsRe(val, 'build-date:')
63
self.assertContainsRe(val, 'date:')
64
self.assertContainsRe(val, 'revno: 3')
65
self.assertContainsRe(val, 'revision-id: r3')
67
val = regen(check_for_clean=True)
68
self.assertContainsRe(val, 'clean: True')
70
self.build_tree(['branch/c'])
71
val = regen(check_for_clean=True)
72
self.assertContainsRe(val, 'clean: False')
75
val = regen(include_revision_history=True)
76
self.assertContainsRe(val, 'id: r1')
77
self.assertContainsRe(val, 'message: a')
78
self.assertContainsRe(val, 'id: r2')
79
self.assertContainsRe(val, 'message: b')
80
self.assertContainsRe(val, 'id: r3')
81
self.assertContainsRe(val, 'message: \xc3\xa52') # utf8 encoding '\xe5'
83
def test_rio_version(self):
84
wt = self.create_branch()
88
builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
92
stanzas = list(read_stanzas(sio))
93
self.assertEqual(1, len(stanzas))
96
def get_one_stanza(stanza, key):
97
new_stanzas = list(read_stanzas(
98
StringIO(stanza[key].encode('utf8'))))
99
self.assertEqual(1, len(new_stanzas))
100
return new_stanzas[0]
103
self.failUnless('date' in stanza)
104
self.failUnless('build-date' in stanza)
105
self.assertEqual(['3'], stanza.get_all('revno'))
106
self.assertEqual(['r3'], stanza.get_all('revision-id'))
108
stanza = regen(check_for_clean=True)
109
self.assertEqual(['True'], stanza.get_all('clean'))
111
self.build_tree(['branch/c'])
112
stanza = regen(check_for_clean=True, include_file_revisions=True)
113
self.assertEqual(['False'], stanza.get_all('clean'))
115
# XXX: This assumes it's being run against a repository that updates
116
# the root revision on every commit. Newer ones that use
117
# RootCommitBuilder won't update it on each commit.
118
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
119
self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
120
self.assertEqual(['r3', 'r3', 'r2', 'unversioned'],
121
file_rev_stanza.get_all('revision'))
122
os.remove('branch/c')
124
stanza = regen(include_revision_history=True)
125
revision_stanza = get_one_stanza(stanza, 'revisions')
126
self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
127
self.assertEqual(['a', 'b', u'\xe52'], revision_stanza.get_all('message'))
128
self.assertEqual(3, len(revision_stanza.get_all('date')))
130
# a was modified, so it should show up modified again
131
self.build_tree(['branch/a', 'branch/c'])
133
wt.rename_one('b', 'd')
134
stanza = regen(check_for_clean=True, include_file_revisions=True)
135
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
136
self.assertEqual(['', 'a', 'b', 'c', 'd'],
137
file_rev_stanza.get_all('path'))
138
self.assertEqual(['r3', 'modified', 'renamed to d', 'new',
140
file_rev_stanza.get_all('revision'))
142
wt.commit('modified', rev_id='r4')
143
wt.remove(['c', 'd'])
144
os.remove('branch/d')
145
stanza = regen(check_for_clean=True, include_file_revisions=True)
146
file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
147
self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
148
self.assertEqual(['r4', 'r4', 'unversioned', 'removed'],
149
file_rev_stanza.get_all('revision'))
151
def test_python_version(self):
152
wt = self.create_branch()
155
"""Create a test module, import and return it"""
156
outf = open('test_version_information.py', 'wb')
158
builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
160
builder.generate(outf)
163
module_info = imp.find_module('test_version_information',
165
tvi = imp.load_module('tvi', *module_info)
166
# Make sure the module isn't cached
167
sys.modules.pop('tvi', None)
168
sys.modules.pop('test_version_information', None)
169
# Delete the compiled versions, because we are generating
170
# a new file fast enough that python doesn't detect it
171
# needs to recompile, and using sleep() just makes the
173
if os.path.exists('test_version_information.pyc'):
174
os.remove('test_version_information.pyc')
175
if os.path.exists('test_version_information.pyo'):
176
os.remove('test_version_information.pyo')
180
self.assertEqual(3, tvi.version_info['revno'])
181
self.assertEqual('r3', tvi.version_info['revision_id'])
182
self.failUnless(tvi.version_info.has_key('date'))
183
self.assertEqual(None, tvi.version_info['clean'])
185
tvi = regen(check_for_clean=True)
186
self.assertEqual(True, tvi.version_info['clean'])
188
self.build_tree(['branch/c'])
189
tvi = regen(check_for_clean=True, include_file_revisions=True)
190
self.assertEqual(False, tvi.version_info['clean'])
191
self.assertEqual(['', 'a', 'b', 'c'],
192
sorted(tvi.file_revisions.keys()))
193
self.assertEqual('r3', tvi.file_revisions['a'])
194
self.assertEqual('r2', tvi.file_revisions['b'])
195
self.assertEqual('unversioned', tvi.file_revisions['c'])
196
os.remove('branch/c')
198
tvi = regen(include_revision_history=True)
200
rev_info = [(rev, message) for rev, message, timestamp, timezone
202
self.assertEqual([('r1', 'a'), ('r2', 'b'), ('r3', u'\xe52')], rev_info)
204
# a was modified, so it should show up modified again
205
self.build_tree(['branch/a', 'branch/c'])
207
wt.rename_one('b', 'd')
208
tvi = regen(check_for_clean=True, include_file_revisions=True)
209
self.assertEqual(['', 'a', 'b', 'c', 'd'],
210
sorted(tvi.file_revisions.keys()))
211
self.assertEqual('modified', tvi.file_revisions['a'])
212
self.assertEqual('renamed to d', tvi.file_revisions['b'])
213
self.assertEqual('new', tvi.file_revisions['c'])
214
self.assertEqual('renamed from b', tvi.file_revisions['d'])
216
wt.commit('modified', rev_id='r4')
217
wt.remove(['c', 'd'])
218
os.remove('branch/d')
219
tvi = regen(check_for_clean=True, include_file_revisions=True)
220
self.assertEqual(['', 'a', 'c', 'd'],
221
sorted(tvi.file_revisions.keys()))
222
self.assertEqual('r4', tvi.file_revisions['a'])
223
self.assertEqual('unversioned', tvi.file_revisions['c'])
224
self.assertEqual('removed', tvi.file_revisions['d'])
226
def test_custom_version_text(self):
227
wt = self.create_branch()
229
def regen(tpl, **kwargs):
231
builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
232
template=tpl, **kwargs)
233
builder.generate(sio)
237
val = regen('build-date: "{build_date}"\ndate: "{date}"')
238
self.assertContainsRe(val, 'build-date: "[0-9-+: ]+"')
239
self.assertContainsRe(val, 'date: "[0-9-+: ]+"')
241
val = regen('revno: {revno}')
242
self.assertEqual(val, 'revno: 3')
244
val = regen('revision-id: {revision_id}')
245
self.assertEqual(val, 'revision-id: r3')
247
val = regen('clean: {clean}', check_for_clean=True)
248
self.assertEqual(val, 'clean: 1')
250
self.build_tree(['branch/c'])
251
val = regen('clean: {clean}', check_for_clean=True)
252
self.assertEqual(val, 'clean: 0')
253
os.remove('branch/c')