/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_version_info.py

 * ``Repository.get_data_stream`` is now deprecated in favour of
   ``Repository.get_data_stream_for_search`` which allows less network
   traffic when requesting data streams over a smart server. (Robert Collins)

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
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Tests for version_info"""
 
18
 
 
19
from cStringIO import StringIO
 
20
import imp
 
21
import os
 
22
import sys
 
23
 
 
24
from bzrlib import (
 
25
    symbol_versioning,
 
26
    tests,
 
27
    version_info_formats,
 
28
    )
 
29
from bzrlib.tests import TestCaseWithTransport
 
30
from bzrlib.rio import read_stanzas
 
31
 
 
32
from bzrlib.version_info_formats.format_custom import CustomVersionInfoBuilder
 
33
from bzrlib.version_info_formats.format_rio import RioVersionInfoBuilder
 
34
from bzrlib.version_info_formats.format_python import PythonVersionInfoBuilder
 
35
 
 
36
 
 
37
class TestVersionInfo(TestCaseWithTransport):
 
38
 
 
39
    def create_branch(self):
 
40
        wt = self.make_branch_and_tree('branch')
 
41
 
 
42
        self.build_tree(['branch/a'])
 
43
        wt.add('a')
 
44
        wt.commit('a', rev_id='r1')
 
45
 
 
46
        self.build_tree(['branch/b'])
 
47
        wt.add('b')
 
48
        wt.commit('b', rev_id='r2')
 
49
 
 
50
        self.build_tree_contents([('branch/a', 'new contents\n')])
 
51
        wt.commit(u'\xe52', rev_id='r3')
 
52
 
 
53
        return wt
 
54
 
 
55
    def test_rio_version_text(self):
 
56
        wt = self.create_branch()
 
57
 
 
58
        def regen(**kwargs):
 
59
            sio = StringIO()
 
60
            builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
 
61
                                            **kwargs)
 
62
            builder.generate(sio)
 
63
            val = sio.getvalue()
 
64
            return val
 
65
 
 
66
        val = regen()
 
67
        self.assertContainsRe(val, 'build-date:')
 
68
        self.assertContainsRe(val, 'date:')
 
69
        self.assertContainsRe(val, 'revno: 3')
 
70
        self.assertContainsRe(val, 'revision-id: r3')
 
71
 
 
72
        val = regen(check_for_clean=True)
 
73
        self.assertContainsRe(val, 'clean: True')
 
74
 
 
75
        self.build_tree(['branch/c'])
 
76
        val = regen(check_for_clean=True)
 
77
        self.assertContainsRe(val, 'clean: False')
 
78
        os.remove('branch/c')
 
79
 
 
80
        val = regen(include_revision_history=True)
 
81
        self.assertContainsRe(val, 'id: r1')
 
82
        self.assertContainsRe(val, 'message: a')
 
83
        self.assertContainsRe(val, 'id: r2')
 
84
        self.assertContainsRe(val, 'message: b')
 
85
        self.assertContainsRe(val, 'id: r3')
 
86
        self.assertContainsRe(val, 'message: \xc3\xa52') # utf8 encoding '\xe5'
 
87
 
 
88
    def test_rio_version(self):
 
89
        wt = self.create_branch()
 
90
 
 
91
        def regen(**kwargs):
 
92
            sio = StringIO()
 
93
            builder = RioVersionInfoBuilder(wt.branch, working_tree=wt,
 
94
                                            **kwargs)
 
95
            builder.generate(sio)
 
96
            sio.seek(0)
 
97
            stanzas = list(read_stanzas(sio))
 
98
            self.assertEqual(1, len(stanzas))
 
99
            return stanzas[0]
 
100
 
 
101
        def get_one_stanza(stanza, key):
 
102
            new_stanzas = list(read_stanzas(
 
103
                                StringIO(stanza[key].encode('utf8'))))
 
104
            self.assertEqual(1, len(new_stanzas))
 
105
            return new_stanzas[0]
 
106
 
 
107
        stanza = regen()
 
108
        self.failUnless('date' in stanza)
 
109
        self.failUnless('build-date' in stanza)
 
110
        self.assertEqual(['3'], stanza.get_all('revno'))
 
111
        self.assertEqual(['r3'], stanza.get_all('revision-id'))
 
112
 
 
113
        stanza = regen(check_for_clean=True)
 
114
        self.assertEqual(['True'], stanza.get_all('clean'))
 
115
 
 
116
        self.build_tree(['branch/c'])
 
117
        stanza = regen(check_for_clean=True, include_file_revisions=True)
 
118
        self.assertEqual(['False'], stanza.get_all('clean'))
 
119
 
 
120
        # XXX: This assumes it's being run against a repository that updates
 
121
        # the root revision on every commit.  Newer ones that use
 
122
        # RootCommitBuilder won't update it on each commit.
 
123
        file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
 
124
        self.assertEqual(['', 'a', 'b', 'c'], file_rev_stanza.get_all('path'))
 
125
        self.assertEqual(['r3', 'r3', 'r2', 'unversioned'],
 
126
            file_rev_stanza.get_all('revision'))
 
127
        os.remove('branch/c')
 
128
 
 
129
        stanza = regen(include_revision_history=True)
 
130
        revision_stanza = get_one_stanza(stanza, 'revisions')
 
131
        self.assertEqual(['r1', 'r2', 'r3'], revision_stanza.get_all('id'))
 
132
        self.assertEqual(['a', 'b', u'\xe52'], revision_stanza.get_all('message'))
 
133
        self.assertEqual(3, len(revision_stanza.get_all('date')))
 
134
 
 
135
        # a was modified, so it should show up modified again
 
136
        self.build_tree(['branch/a', 'branch/c'])
 
137
        wt.add('c')
 
138
        wt.rename_one('b', 'd')
 
139
        stanza = regen(check_for_clean=True, include_file_revisions=True)
 
140
        file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
 
141
        self.assertEqual(['', 'a', 'b', 'c', 'd'], 
 
142
                          file_rev_stanza.get_all('path'))
 
143
        self.assertEqual(['r3', 'modified', 'renamed to d', 'new', 
 
144
                          'renamed from b'],
 
145
                         file_rev_stanza.get_all('revision'))
 
146
 
 
147
        wt.commit('modified', rev_id='r4')
 
148
        wt.remove(['c', 'd'])
 
149
        os.remove('branch/d')
 
150
        stanza = regen(check_for_clean=True, include_file_revisions=True)
 
151
        file_rev_stanza = get_one_stanza(stanza, 'file-revisions')
 
152
        self.assertEqual(['', 'a', 'c', 'd'], file_rev_stanza.get_all('path'))
 
153
        self.assertEqual(['r4', 'r4', 'unversioned', 'removed'],
 
154
                         file_rev_stanza.get_all('revision'))
 
155
 
 
156
    def test_python_version(self):
 
157
        wt = self.create_branch()
 
158
 
 
159
        def regen(**kwargs):
 
160
            """Create a test module, import and return it"""
 
161
            outf = open('test_version_information.py', 'wb')
 
162
            try:
 
163
                builder = PythonVersionInfoBuilder(wt.branch, working_tree=wt,
 
164
                                                   **kwargs)
 
165
                builder.generate(outf)
 
166
            finally:
 
167
                outf.close()
 
168
            module_info = imp.find_module('test_version_information',
 
169
                                          [os.getcwdu()])
 
170
            tvi = imp.load_module('tvi', *module_info)
 
171
            # Make sure the module isn't cached
 
172
            sys.modules.pop('tvi', None)
 
173
            sys.modules.pop('test_version_information', None)
 
174
            # Delete the compiled versions, because we are generating
 
175
            # a new file fast enough that python doesn't detect it
 
176
            # needs to recompile, and using sleep() just makes the
 
177
            # test slow
 
178
            if os.path.exists('test_version_information.pyc'):
 
179
                os.remove('test_version_information.pyc')
 
180
            if os.path.exists('test_version_information.pyo'):
 
181
                os.remove('test_version_information.pyo')
 
182
            return tvi
 
183
 
 
184
        tvi = regen()
 
185
        self.assertEqual(3, tvi.version_info['revno'])
 
186
        self.assertEqual('r3', tvi.version_info['revision_id'])
 
187
        self.failUnless(tvi.version_info.has_key('date'))
 
188
        self.assertEqual(None, tvi.version_info['clean'])
 
189
 
 
190
        tvi = regen(check_for_clean=True)
 
191
        self.assertEqual(True, tvi.version_info['clean'])
 
192
 
 
193
        self.build_tree(['branch/c'])
 
194
        tvi = regen(check_for_clean=True, include_file_revisions=True)
 
195
        self.assertEqual(False, tvi.version_info['clean'])
 
196
        self.assertEqual(['', 'a', 'b', 'c'], 
 
197
                         sorted(tvi.file_revisions.keys()))
 
198
        self.assertEqual('r3', tvi.file_revisions['a'])
 
199
        self.assertEqual('r2', tvi.file_revisions['b'])
 
200
        self.assertEqual('unversioned', tvi.file_revisions['c'])
 
201
        os.remove('branch/c')
 
202
 
 
203
        tvi = regen(include_revision_history=True)
 
204
 
 
205
        rev_info = [(rev, message) for rev, message, timestamp, timezone
 
206
                                   in tvi.revisions]
 
207
        self.assertEqual([('r1', 'a'), ('r2', 'b'), ('r3', u'\xe52')], rev_info)
 
208
 
 
209
        # a was modified, so it should show up modified again
 
210
        self.build_tree(['branch/a', 'branch/c'])
 
211
        wt.add('c')
 
212
        wt.rename_one('b', 'd')
 
213
        tvi = regen(check_for_clean=True, include_file_revisions=True)
 
214
        self.assertEqual(['', 'a', 'b', 'c', 'd'], 
 
215
                          sorted(tvi.file_revisions.keys()))
 
216
        self.assertEqual('modified', tvi.file_revisions['a'])
 
217
        self.assertEqual('renamed to d', tvi.file_revisions['b'])
 
218
        self.assertEqual('new', tvi.file_revisions['c'])
 
219
        self.assertEqual('renamed from b', tvi.file_revisions['d'])
 
220
 
 
221
        wt.commit('modified', rev_id='r4')
 
222
        wt.remove(['c', 'd'])
 
223
        os.remove('branch/d')
 
224
        tvi = regen(check_for_clean=True, include_file_revisions=True)
 
225
        self.assertEqual(['', 'a', 'c', 'd'], 
 
226
                          sorted(tvi.file_revisions.keys()))
 
227
        self.assertEqual('r4', tvi.file_revisions['a'])
 
228
        self.assertEqual('unversioned', tvi.file_revisions['c'])
 
229
        self.assertEqual('removed', tvi.file_revisions['d'])
 
230
 
 
231
    def test_custom_version_text(self):
 
232
        wt = self.create_branch()
 
233
 
 
234
        def regen(tpl, **kwargs):
 
235
            sio = StringIO()
 
236
            builder = CustomVersionInfoBuilder(wt.branch, working_tree=wt,
 
237
                                               template=tpl, **kwargs)
 
238
            builder.generate(sio)
 
239
            val = sio.getvalue()
 
240
            return val
 
241
 
 
242
        val = regen('build-date: "{build_date}"\ndate: "{date}"')
 
243
        self.assertContainsRe(val, 'build-date: "[0-9-+: ]+"')
 
244
        self.assertContainsRe(val, 'date: "[0-9-+: ]+"')
 
245
 
 
246
        val = regen('revno: {revno}')
 
247
        self.assertEqual(val, 'revno: 3')
 
248
 
 
249
        val = regen('revision-id: {revision_id}')
 
250
        self.assertEqual(val, 'revision-id: r3')
 
251
 
 
252
        val = regen('clean: {clean}', check_for_clean=True)
 
253
        self.assertEqual(val, 'clean: 1')
 
254
 
 
255
        self.build_tree(['branch/c'])
 
256
        val = regen('clean: {clean}', check_for_clean=True)
 
257
        self.assertEqual(val, 'clean: 0')
 
258
        os.remove('branch/c')
 
259
 
 
260
 
 
261
class TestBuilder(version_info_formats.VersionInfoBuilder):
 
262
    pass
 
263
 
 
264
 
 
265
class TestVersionInfoFormatRegistry(tests.TestCase):
 
266
 
 
267
    def setUp(self):
 
268
        super(TestVersionInfoFormatRegistry, self).setUp()
 
269
        registry = version_info_formats.format_registry
 
270
        self._default_key = registry._default_key
 
271
        self._dict = registry._dict.copy()
 
272
        self._help_dict = registry._help_dict.copy()
 
273
        self._info_dict = registry._info_dict.copy()
 
274
        self.addCleanup(self._cleanup)
 
275
 
 
276
    def _cleanup(self):
 
277
        # Restore the registry to pristine state after the test runs
 
278
        registry = version_info_formats.format_registry
 
279
        registry._default_key = self._default_key
 
280
        registry._dict = self._dict
 
281
        registry._help_dict = self._help_dict
 
282
        registry._info_dict = self._info_dict
 
283
 
 
284
    def test_register_remove(self):
 
285
        registry = version_info_formats.format_registry
 
286
        registry.register('testbuilder',
 
287
            TestBuilder, 'a simple test builder')
 
288
        self.assertIs(TestBuilder, registry.get('testbuilder'))
 
289
        self.assertEqual('a simple test builder',
 
290
                         registry.get_help('testbuilder'))
 
291
        registry.remove('testbuilder')
 
292
        self.assertRaises(KeyError, registry.get, 'testbuilder')
 
293
 
 
294
    def test_old_functions(self):
 
295
        self.applyDeprecated(symbol_versioning.one_zero,
 
296
            version_info_formats.register_builder,
 
297
            'test-builder', __name__, 'TestBuilder')
 
298
        formats = self.applyDeprecated(symbol_versioning.one_zero,
 
299
            version_info_formats.get_builder_formats)
 
300
        self.failUnless('test-builder' in formats)
 
301
        self.assertIs(TestBuilder,
 
302
            self.applyDeprecated(symbol_versioning.one_zero,
 
303
                version_info_formats.get_builder, 'test-builder'))
 
304
        version_info_formats.format_registry.remove('test-builder')