← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_plugins.py

(vila) Forbid more operations on ReadonlyTransportDecorator (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_plugins.py
1
 
# Copyright (C) 2005, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for plugins"""
18
18
 
20
20
# affects the global state of the process.  See bzrlib/plugins.py for more
21
21
# comments.
22
22
 
 
23
from cStringIO import StringIO
23
24
import logging
24
25
import os
25
 
from StringIO import StringIO
26
26
import sys
27
 
import zipfile
28
27
 
29
 
from bzrlib import plugin, tests
30
 
import bzrlib.plugin
31
 
import bzrlib.plugins
32
 
import bzrlib.commands
33
 
import bzrlib.help
34
 
from bzrlib.symbol_versioning import one_three
35
 
from bzrlib.tests import (
36
 
    TestCase,
37
 
    TestCaseInTempDir,
38
 
    TestUtil,
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    errors,
 
31
    osutils,
 
32
    plugin,
 
33
    plugins,
 
34
    tests,
 
35
    trace,
39
36
    )
40
 
from bzrlib.osutils import pathjoin, abspath, normpath
41
 
 
42
 
 
43
 
PLUGIN_TEXT = """\
44
 
import bzrlib.commands
45
 
class cmd_myplug(bzrlib.commands.Command):
46
 
    '''Just a simple test plugin.'''
47
 
    aliases = ['mplg']
48
 
    def run(self):
49
 
        print 'Hello from my plugin'
50
 
"""
 
37
 
51
38
 
52
39
# TODO: Write a test for plugin decoration of commands.
53
40
 
54
 
class TestLoadingPlugins(TestCaseInTempDir):
 
41
class BaseTestPlugins(tests.TestCaseInTempDir):
 
42
 
 
43
    def create_plugin(self, name, source=None, dir='.', file_name=None):
 
44
        if source is None:
 
45
            source = '''\
 
46
"""This is the doc for %s"""
 
47
''' % (name)
 
48
        if file_name is None:
 
49
            file_name = name + '.py'
 
50
        # 'source' must not fail to load
 
51
        path = osutils.pathjoin(dir, file_name)
 
52
        f = open(path, 'w')
 
53
        self.addCleanup(os.unlink, path)
 
54
        try:
 
55
            f.write(source + '\n')
 
56
        finally:
 
57
            f.close()
 
58
 
 
59
    def create_plugin_package(self, name, dir=None, source=None):
 
60
        if dir is None:
 
61
            dir = name
 
62
        if source is None:
 
63
            source = '''\
 
64
"""This is the doc for %s"""
 
65
dir_source = '%s'
 
66
''' % (name, dir)
 
67
        os.makedirs(dir)
 
68
        def cleanup():
 
69
            # Workaround lazy import random? madness
 
70
            osutils.rmtree(dir)
 
71
        self.addCleanup(cleanup)
 
72
        self.create_plugin(name, source, dir,
 
73
                           file_name='__init__.py')
 
74
 
 
75
    def _unregister_plugin(self, name):
 
76
        """Remove the plugin from sys.modules and the bzrlib namespace."""
 
77
        py_name = 'bzrlib.plugins.%s' % name
 
78
        if py_name in sys.modules:
 
79
            del sys.modules[py_name]
 
80
        if getattr(bzrlib.plugins, name, None) is not None:
 
81
            delattr(bzrlib.plugins, name)
 
82
 
 
83
    def _unregister_plugin_submodule(self, plugin_name, submodule_name):
 
84
        """Remove the submodule from sys.modules and the bzrlib namespace."""
 
85
        py_name = 'bzrlib.plugins.%s.%s' % (plugin_name, submodule_name)
 
86
        if py_name in sys.modules:
 
87
            del sys.modules[py_name]
 
88
        plugin = getattr(bzrlib.plugins, plugin_name, None)
 
89
        if plugin is not None:
 
90
            if getattr(plugin, submodule_name, None) is not None:
 
91
                delattr(plugin, submodule_name)
 
92
 
 
93
    def assertPluginUnknown(self, name):
 
94
        self.assertFalse(getattr(bzrlib.plugins, name, None) is not None)
 
95
        self.assertFalse('bzrlib.plugins.%s' % name in sys.modules)
 
96
 
 
97
    def assertPluginKnown(self, name):
 
98
        self.assertTrue(getattr(bzrlib.plugins, name, None) is not None)
 
99
        self.assertTrue('bzrlib.plugins.%s' % name in sys.modules)
 
100
 
 
101
 
 
102
class TestLoadingPlugins(BaseTestPlugins):
55
103
 
56
104
    activeattributes = {}
57
105
 
61
109
        # file name we can use which is also a valid attribute for accessing in
62
110
        # activeattributes. - we cannot give import parameters.
63
111
        tempattribute = "0"
64
 
        self.failIf(tempattribute in self.activeattributes)
 
112
        self.assertFalse(tempattribute in self.activeattributes)
65
113
        # set a place for the plugins to record their loading, and at the same
66
114
        # time validate that the location the plugins should record to is
67
115
        # valid and correct.
68
 
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
69
 
            [tempattribute] = []
70
 
        self.failUnless(tempattribute in self.activeattributes)
 
116
        self.__class__.activeattributes [tempattribute] = []
 
117
        self.assertTrue(tempattribute in self.activeattributes)
71
118
        # create two plugin directories
72
119
        os.mkdir('first')
73
120
        os.mkdir('second')
74
 
        # write a plugin that will record when its loaded in the 
 
121
        # write a plugin that will record when its loaded in the
75
122
        # tempattribute list.
76
123
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
77
124
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
96
143
        finally:
97
144
            # remove the plugin 'plugin'
98
145
            del self.activeattributes[tempattribute]
99
 
            if 'bzrlib.plugins.plugin' in sys.modules:
100
 
                del sys.modules['bzrlib.plugins.plugin']
101
 
            if getattr(bzrlib.plugins, 'plugin', None):
102
 
                del bzrlib.plugins.plugin
103
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
146
            self._unregister_plugin('plugin')
 
147
        self.assertPluginUnknown('plugin')
104
148
 
105
149
    def test_plugins_from_different_dirs_can_demand_load(self):
 
150
        self.assertFalse('bzrlib.plugins.pluginone' in sys.modules)
 
151
        self.assertFalse('bzrlib.plugins.plugintwo' in sys.modules)
106
152
        # This test tests that having two plugins in different
107
153
        # directories with different names allows them both to be loaded, when
108
154
        # we do a direct import statement.
109
155
        # Determine a file name we can use which is also a valid attribute
110
156
        # for accessing in activeattributes. - we cannot give import parameters.
111
157
        tempattribute = "different-dirs"
112
 
        self.failIf(tempattribute in self.activeattributes)
 
158
        self.assertFalse(tempattribute in self.activeattributes)
113
159
        # set a place for the plugins to record their loading, and at the same
114
160
        # time validate that the location the plugins should record to is
115
161
        # valid and correct.
116
162
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
117
163
            [tempattribute] = []
118
 
        self.failUnless(tempattribute in self.activeattributes)
 
164
        self.assertTrue(tempattribute in self.activeattributes)
119
165
        # create two plugin directories
120
166
        os.mkdir('first')
121
167
        os.mkdir('second')
122
 
        # write plugins that will record when they are loaded in the 
 
168
        # write plugins that will record when they are loaded in the
123
169
        # tempattribute list.
124
170
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
125
171
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
140
186
 
141
187
        oldpath = bzrlib.plugins.__path__
142
188
        try:
 
189
            self.assertFalse('bzrlib.plugins.pluginone' in sys.modules)
 
190
            self.assertFalse('bzrlib.plugins.plugintwo' in sys.modules)
143
191
            bzrlib.plugins.__path__ = ['first', 'second']
144
192
            exec "import bzrlib.plugins.pluginone"
145
193
            self.assertEqual(['first'], self.activeattributes[tempattribute])
149
197
        finally:
150
198
            # remove the plugin 'plugin'
151
199
            del self.activeattributes[tempattribute]
152
 
            if getattr(bzrlib.plugins, 'pluginone', None):
153
 
                del bzrlib.plugins.pluginone
154
 
            if getattr(bzrlib.plugins, 'plugintwo', None):
155
 
                del bzrlib.plugins.plugintwo
156
 
        self.failIf(getattr(bzrlib.plugins, 'pluginone', None))
157
 
        self.failIf(getattr(bzrlib.plugins, 'plugintwo', None))
 
200
            self._unregister_plugin('pluginone')
 
201
            self._unregister_plugin('plugintwo')
 
202
        self.assertPluginUnknown('pluginone')
 
203
        self.assertPluginUnknown('plugintwo')
158
204
 
159
205
    def test_plugins_can_load_from_directory_with_trailing_slash(self):
160
206
        # This test tests that a plugin can load from a directory when the
161
207
        # directory in the path has a trailing slash.
162
208
        # check the plugin is not loaded already
163
 
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
 
209
        self.assertPluginUnknown('ts_plugin')
164
210
        tempattribute = "trailing-slash"
165
 
        self.failIf(tempattribute in self.activeattributes)
 
211
        self.assertFalse(tempattribute in self.activeattributes)
166
212
        # set a place for the plugin to record its loading, and at the same
167
213
        # time validate that the location the plugin should record to is
168
214
        # valid and correct.
169
215
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
170
216
            [tempattribute] = []
171
 
        self.failUnless(tempattribute in self.activeattributes)
 
217
        self.assertTrue(tempattribute in self.activeattributes)
172
218
        # create a directory for the plugin
173
219
        os.mkdir('plugin_test')
174
 
        # write a plugin that will record when its loaded in the 
 
220
        # write a plugin that will record when its loaded in the
175
221
        # tempattribute list.
176
222
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
177
223
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
187
233
            bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
188
234
            self.assertEqual(['plugin'], self.activeattributes[tempattribute])
189
235
        finally:
190
 
            # remove the plugin 'plugin'
191
236
            del self.activeattributes[tempattribute]
192
 
            if getattr(bzrlib.plugins, 'ts_plugin', None):
193
 
                del bzrlib.plugins.ts_plugin
194
 
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
195
 
 
196
 
    def test_plugin_with_bad_name_does_not_load(self):
197
 
        # Create badly-named plugin
198
 
        file('bzr-bad plugin-name..py', 'w').close()
199
 
 
 
237
            self._unregister_plugin('ts_plugin')
 
238
        self.assertPluginUnknown('ts_plugin')
 
239
 
 
240
    def load_and_capture(self, name):
 
241
        """Load plugins from '.' capturing the output.
 
242
 
 
243
        :param name: The name of the plugin.
 
244
        :return: A string with the log from the plugin loading call.
 
245
        """
200
246
        # Capture output
201
247
        stream = StringIO()
202
 
        handler = logging.StreamHandler(stream)
203
 
        log = logging.getLogger('bzr')
204
 
        log.addHandler(handler)
205
 
 
206
 
        bzrlib.plugin.load_from_dir('.')
207
 
 
208
 
        # Stop capturing output
209
 
        handler.flush()
210
 
        handler.close()
211
 
        log.removeHandler(handler)
212
 
 
213
 
        self.assertContainsRe(stream.getvalue(),
 
248
        try:
 
249
            handler = logging.StreamHandler(stream)
 
250
            log = logging.getLogger('bzr')
 
251
            log.addHandler(handler)
 
252
            try:
 
253
                try:
 
254
                    bzrlib.plugin.load_from_path(['.'])
 
255
                finally:
 
256
                    if 'bzrlib.plugins.%s' % name in sys.modules:
 
257
                        del sys.modules['bzrlib.plugins.%s' % name]
 
258
                    if getattr(bzrlib.plugins, name, None):
 
259
                        delattr(bzrlib.plugins, name)
 
260
            finally:
 
261
                # Stop capturing output
 
262
                handler.flush()
 
263
                handler.close()
 
264
                log.removeHandler(handler)
 
265
            return stream.getvalue()
 
266
        finally:
 
267
            stream.close()
 
268
 
 
269
    def test_plugin_with_bad_api_version_reports(self):
 
270
        """Try loading a plugin that requests an unsupported api.
 
271
        
 
272
        Observe that it records the problem but doesn't complain on stderr.
 
273
 
 
274
        See https://bugs.launchpad.net/bzr/+bug/704195
 
275
        """
 
276
        self.overrideAttr(plugin, 'plugin_warnings', {})
 
277
        name = 'wants100.py'
 
278
        f = file(name, 'w')
 
279
        try:
 
280
            f.write("import bzrlib.api\n"
 
281
                "bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
 
282
        finally:
 
283
            f.close()
 
284
        log = self.load_and_capture(name)
 
285
        self.assertNotContainsRe(log,
 
286
            r"It requested API version")
 
287
        self.assertEquals(
 
288
            ['wants100'],
 
289
            plugin.plugin_warnings.keys())
 
290
        self.assertContainsRe(
 
291
            plugin.plugin_warnings['wants100'][0],
 
292
            r"It requested API version")
 
293
 
 
294
    def test_plugin_with_bad_name_does_not_load(self):
 
295
        # The file name here invalid for a python module.
 
296
        name = 'bzr-bad plugin-name..py'
 
297
        file(name, 'w').close()
 
298
        log = self.load_and_capture(name)
 
299
        self.assertContainsRe(log,
214
300
            r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
215
301
            "because the file path isn't a valid module name; try renaming "
216
302
            "it to 'bad_plugin_name_'\.")
217
303
 
218
 
        stream.close()
219
 
 
220
 
 
221
 
class TestPlugins(TestCaseInTempDir):
 
304
 
 
305
class TestPlugins(BaseTestPlugins):
222
306
 
223
307
    def setup_plugin(self, source=""):
224
308
        # This test tests a new plugin appears in bzrlib.plugin.plugins().
225
309
        # check the plugin is not loaded already
226
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
310
        self.assertPluginUnknown('plugin')
227
311
        # write a plugin that _cannot_ fail to load.
228
 
        file('plugin.py', 'w').write(source + '\n')
 
312
        with file('plugin.py', 'w') as f: f.write(source + '\n')
229
313
        self.addCleanup(self.teardown_plugin)
230
 
        bzrlib.plugin.load_from_path(['.'])
231
 
    
 
314
        plugin.load_from_path(['.'])
 
315
 
232
316
    def teardown_plugin(self):
233
 
        # remove the plugin 'plugin'
234
 
        if 'bzrlib.plugins.plugin' in sys.modules:
235
 
            del sys.modules['bzrlib.plugins.plugin']
236
 
        if getattr(bzrlib.plugins, 'plugin', None):
237
 
            del bzrlib.plugins.plugin
238
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
317
        self._unregister_plugin('plugin')
 
318
        self.assertPluginUnknown('plugin')
239
319
 
240
320
    def test_plugin_appears_in_plugins(self):
241
321
        self.setup_plugin()
242
 
        self.failUnless('plugin' in bzrlib.plugin.plugins())
243
 
        self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
244
 
        plugins = bzrlib.plugin.plugins()
245
 
        plugin = plugins['plugin']
246
 
        self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
247
 
        self.assertEqual(bzrlib.plugins.plugin, plugin.module)
 
322
        self.assertPluginKnown('plugin')
 
323
        p = plugin.plugins()['plugin']
 
324
        self.assertIsInstance(p, bzrlib.plugin.PlugIn)
 
325
        self.assertEqual(p.module, plugins.plugin)
248
326
 
249
327
    def test_trivial_plugin_get_path(self):
250
328
        self.setup_plugin()
251
 
        plugins = bzrlib.plugin.plugins()
252
 
        plugin = plugins['plugin']
 
329
        p = plugin.plugins()['plugin']
253
330
        plugin_path = self.test_dir + '/plugin.py'
254
 
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
 
331
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
255
332
 
256
333
    def test_plugin_get_path_py_not_pyc(self):
257
 
        self.setup_plugin()         # after first import there will be plugin.pyc
 
334
        # first import creates plugin.pyc
 
335
        self.setup_plugin()
258
336
        self.teardown_plugin()
259
 
        bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
260
 
        plugins = bzrlib.plugin.plugins()
261
 
        plugin = plugins['plugin']
 
337
        plugin.load_from_path(['.']) # import plugin.pyc
 
338
        p = plugin.plugins()['plugin']
262
339
        plugin_path = self.test_dir + '/plugin.py'
263
 
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
 
340
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
264
341
 
265
342
    def test_plugin_get_path_pyc_only(self):
266
 
        self.setup_plugin()         # after first import there will be plugin.pyc
 
343
        # first import creates plugin.pyc (or plugin.pyo depending on __debug__)
 
344
        self.setup_plugin()
267
345
        self.teardown_plugin()
268
346
        os.unlink(self.test_dir + '/plugin.py')
269
 
        bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
270
 
        plugins = bzrlib.plugin.plugins()
271
 
        plugin = plugins['plugin']
 
347
        plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
 
348
        p = plugin.plugins()['plugin']
272
349
        if __debug__:
273
350
            plugin_path = self.test_dir + '/plugin.pyc'
274
351
        else:
275
352
            plugin_path = self.test_dir + '/plugin.pyo'
276
 
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
 
353
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
277
354
 
278
355
    def test_no_test_suite_gives_None_for_test_suite(self):
279
356
        self.setup_plugin()
280
 
        plugin = bzrlib.plugin.plugins()['plugin']
281
 
        self.assertEqual(None, plugin.test_suite())
 
357
        p = plugin.plugins()['plugin']
 
358
        self.assertEqual(None, p.test_suite())
282
359
 
283
360
    def test_test_suite_gives_test_suite_result(self):
284
361
        source = """def test_suite(): return 'foo'"""
285
362
        self.setup_plugin(source)
286
 
        plugin = bzrlib.plugin.plugins()['plugin']
287
 
        self.assertEqual('foo', plugin.test_suite())
 
363
        p = plugin.plugins()['plugin']
 
364
        self.assertEqual('foo', p.test_suite())
288
365
 
289
366
    def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
290
367
        self.setup_plugin()
291
 
        loader = TestUtil.TestLoader()
292
 
        plugin = bzrlib.plugin.plugins()['plugin']
293
 
        self.assertEqual(None, plugin.load_plugin_tests(loader))
 
368
        loader = tests.TestUtil.TestLoader()
 
369
        p = plugin.plugins()['plugin']
 
370
        self.assertEqual(None, p.load_plugin_tests(loader))
294
371
 
295
372
    def test_load_plugin_tests_gives_load_plugin_tests_result(self):
296
373
        source = """
297
374
def load_tests(standard_tests, module, loader):
298
375
    return 'foo'"""
299
376
        self.setup_plugin(source)
300
 
        loader = TestUtil.TestLoader()
301
 
        plugin = bzrlib.plugin.plugins()['plugin']
302
 
        self.assertEqual('foo', plugin.load_plugin_tests(loader))
 
377
        loader = tests.TestUtil.TestLoader()
 
378
        p = plugin.plugins()['plugin']
 
379
        self.assertEqual('foo', p.load_plugin_tests(loader))
 
380
 
 
381
    def check_version_info(self, expected, source='', name='plugin'):
 
382
        self.setup_plugin(source)
 
383
        self.assertEqual(expected, plugin.plugins()[name].version_info())
303
384
 
304
385
    def test_no_version_info(self):
305
 
        self.setup_plugin()
306
 
        plugin = bzrlib.plugin.plugins()['plugin']
307
 
        self.assertEqual(None, plugin.version_info())
 
386
        self.check_version_info(None)
308
387
 
309
388
    def test_with_version_info(self):
310
 
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
311
 
        plugin = bzrlib.plugin.plugins()['plugin']
312
 
        self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
 
389
        self.check_version_info((1, 2, 3, 'dev', 4),
 
390
                                "version_info = (1, 2, 3, 'dev', 4)")
313
391
 
314
392
    def test_short_version_info_gets_padded(self):
315
393
        # the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
316
394
        # so we adapt it
317
 
        self.setup_plugin("version_info = (1, 2, 3)")
318
 
        plugin = bzrlib.plugin.plugins()['plugin']
319
 
        self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
 
395
        self.check_version_info((1, 2, 3, 'final', 0),
 
396
                                "version_info = (1, 2, 3)")
 
397
 
 
398
    def check_version(self, expected, source=None, name='plugin'):
 
399
        self.setup_plugin(source)
 
400
        self.assertEqual(expected, plugins[name].__version__)
320
401
 
321
402
    def test_no_version_info___version__(self):
322
403
        self.setup_plugin()
323
404
        plugin = bzrlib.plugin.plugins()['plugin']
324
405
        self.assertEqual("unknown", plugin.__version__)
325
406
 
326
 
    def test___version__with_version_info(self):
 
407
    def test_str__version__with_version_info(self):
 
408
        self.setup_plugin("version_info = '1.2.3'")
 
409
        plugin = bzrlib.plugin.plugins()['plugin']
 
410
        self.assertEqual("1.2.3", plugin.__version__)
 
411
 
 
412
    def test_noniterable__version__with_version_info(self):
 
413
        self.setup_plugin("version_info = (1)")
 
414
        plugin = bzrlib.plugin.plugins()['plugin']
 
415
        self.assertEqual("1", plugin.__version__)
 
416
 
 
417
    def test_1__version__with_version_info(self):
 
418
        self.setup_plugin("version_info = (1,)")
 
419
        plugin = bzrlib.plugin.plugins()['plugin']
 
420
        self.assertEqual("1", plugin.__version__)
 
421
 
 
422
    def test_1_2__version__with_version_info(self):
 
423
        self.setup_plugin("version_info = (1, 2)")
 
424
        plugin = bzrlib.plugin.plugins()['plugin']
 
425
        self.assertEqual("1.2", plugin.__version__)
 
426
 
 
427
    def test_1_2_3__version__with_version_info(self):
 
428
        self.setup_plugin("version_info = (1, 2, 3)")
 
429
        plugin = bzrlib.plugin.plugins()['plugin']
 
430
        self.assertEqual("1.2.3", plugin.__version__)
 
431
 
 
432
    def test_candidate__version__with_version_info(self):
 
433
        self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
 
434
        plugin = bzrlib.plugin.plugins()['plugin']
 
435
        self.assertEqual("1.2.3rc1", plugin.__version__)
 
436
 
 
437
    def test_dev__version__with_version_info(self):
 
438
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
 
439
        plugin = bzrlib.plugin.plugins()['plugin']
 
440
        self.assertEqual("1.2.3dev", plugin.__version__)
 
441
 
 
442
    def test_dev_fallback__version__with_version_info(self):
327
443
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
328
444
        plugin = bzrlib.plugin.plugins()['plugin']
329
445
        self.assertEqual("1.2.3dev4", plugin.__version__)
330
446
 
331
447
    def test_final__version__with_version_info(self):
332
 
        self.setup_plugin("version_info = (1, 2, 3, 'final', 4)")
 
448
        self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
333
449
        plugin = bzrlib.plugin.plugins()['plugin']
334
450
        self.assertEqual("1.2.3", plugin.__version__)
335
451
 
336
 
 
337
 
class TestPluginHelp(TestCaseInTempDir):
 
452
    def test_final_fallback__version__with_version_info(self):
 
453
        self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
 
454
        plugin = bzrlib.plugin.plugins()['plugin']
 
455
        self.assertEqual("1.2.3.2", plugin.__version__)
 
456
 
 
457
 
 
458
class TestPluginHelp(tests.TestCaseInTempDir):
338
459
 
339
460
    def split_help_commands(self):
340
461
        help = {}
341
462
        current = None
342
 
        for line in self.run_bzr('help commands')[0].splitlines():
 
463
        out, err = self.run_bzr('--no-plugins help commands')
 
464
        for line in out.splitlines():
343
465
            if not line.startswith(' '):
344
466
                current = line.split()[0]
345
467
            help[current] = help.get(current, '') + line
368
490
    def test_plugin_help_shows_plugin(self):
369
491
        # Create a test plugin
370
492
        os.mkdir('plugin_test')
371
 
        f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
372
 
        f.write(PLUGIN_TEXT)
 
493
        f = open(osutils.pathjoin('plugin_test', 'myplug.py'), 'w')
 
494
        f.write("""\
 
495
from bzrlib import commands
 
496
class cmd_myplug(commands.Command):
 
497
    __doc__ = '''Just a simple test plugin.'''
 
498
    aliases = ['mplg']
 
499
    def run(self):
 
500
        print 'Hello from my plugin'
 
501
 
 
502
"""
 
503
)
373
504
        f.close()
374
505
 
375
506
        try:
382
513
            self.assertContainsRe(help, '\[myplug\]')
383
514
        finally:
384
515
            # unregister command
385
 
            if bzrlib.commands.plugin_cmds.get('myplug', None):
386
 
                del bzrlib.commands.plugin_cmds['myplug']
 
516
            if 'myplug' in bzrlib.commands.plugin_cmds:
 
517
                bzrlib.commands.plugin_cmds.remove('myplug')
387
518
            # remove the plugin 'myplug'
388
519
            if getattr(bzrlib.plugins, 'myplug', None):
389
520
                delattr(bzrlib.plugins, 'myplug')
390
521
 
391
522
 
392
 
class TestPluginFromZip(TestCaseInTempDir):
393
 
 
394
 
    def make_zipped_plugin(self, zip_name, filename):
395
 
        z = zipfile.ZipFile(zip_name, 'w')
396
 
        z.writestr(filename, PLUGIN_TEXT)
397
 
        z.close()
398
 
 
399
 
    def check_plugin_load(self, zip_name, plugin_name):
400
 
        self.assertFalse(plugin_name in dir(bzrlib.plugins),
401
 
                         'Plugin already loaded')
402
 
        old_path = bzrlib.plugins.__path__
403
 
        try:
404
 
            # this is normally done by load_plugins -> set_plugins_path
405
 
            bzrlib.plugins.__path__ = [zip_name]
406
 
            self.applyDeprecated(one_three,
407
 
                bzrlib.plugin.load_from_zip, zip_name)
408
 
            self.assertTrue(plugin_name in dir(bzrlib.plugins),
409
 
                            'Plugin is not loaded')
410
 
        finally:
411
 
            # unregister plugin
412
 
            if getattr(bzrlib.plugins, plugin_name, None):
413
 
                delattr(bzrlib.plugins, plugin_name)
414
 
                del sys.modules['bzrlib.plugins.' + plugin_name]
415
 
            bzrlib.plugins.__path__ = old_path
416
 
 
417
 
    def test_load_module(self):
418
 
        self.make_zipped_plugin('./test.zip', 'ziplug.py')
419
 
        self.check_plugin_load('./test.zip', 'ziplug')
420
 
 
421
 
    def test_load_package(self):
422
 
        self.make_zipped_plugin('./test.zip', 'ziplug/__init__.py')
423
 
        self.check_plugin_load('./test.zip', 'ziplug')
424
 
 
425
 
 
426
 
class TestSetPluginsPath(TestCase):
427
 
    
428
 
    def test_set_plugins_path(self):
429
 
        """set_plugins_path should set the module __path__ correctly."""
430
 
        old_path = bzrlib.plugins.__path__
431
 
        try:
432
 
            bzrlib.plugins.__path__ = []
433
 
            expected_path = bzrlib.plugin.set_plugins_path()
434
 
            self.assertEqual(expected_path, bzrlib.plugins.__path__)
435
 
        finally:
436
 
            bzrlib.plugins.__path__ = old_path
437
 
 
438
 
    def test_set_plugins_path_with_trailing_slashes(self):
439
 
        """set_plugins_path should set the module __path__ based on
440
 
        BZR_PLUGIN_PATH after removing all trailing slashes."""
441
 
        old_path = bzrlib.plugins.__path__
442
 
        old_env = os.environ.get('BZR_PLUGIN_PATH')
443
 
        try:
444
 
            bzrlib.plugins.__path__ = []
445
 
            os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
446
 
                "second/\\/\\/"
447
 
            bzrlib.plugin.set_plugins_path()
448
 
            # We expect our nominated paths to have all path-seps removed,
449
 
            # and this is testing only that.
450
 
            expected_path = ['first', 'second']
451
 
            self.assertEqual(expected_path,
452
 
                bzrlib.plugins.__path__[:len(expected_path)])
453
 
        finally:
454
 
            bzrlib.plugins.__path__ = old_path
455
 
            if old_env is not None:
456
 
                os.environ['BZR_PLUGIN_PATH'] = old_env
457
 
            else:
458
 
                del os.environ['BZR_PLUGIN_PATH']
459
 
 
460
 
 
461
523
class TestHelpIndex(tests.TestCase):
462
524
    """Tests for the PluginsHelpIndex class."""
463
525
 
553
615
    def test_get_help_text_with_additional_see_also(self):
554
616
        mod = FakeModule('two lines of help\nand more', 'demo')
555
617
        topic = plugin.ModuleHelpTopic(mod)
556
 
        self.assertEqual("two lines of help\nand more\nSee also: bar, foo\n",
557
 
            topic.get_help_text(['foo', 'bar']))
 
618
        self.assertEqual("two lines of help\nand more\n\n:See also: bar, foo\n",
 
619
                         topic.get_help_text(['foo', 'bar']))
558
620
 
559
621
    def test_get_help_topic(self):
560
622
        """The help topic for a plugin is its module name."""
561
623
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.demo')
562
624
        topic = plugin.ModuleHelpTopic(mod)
563
625
        self.assertEqual('demo', topic.get_help_topic())
564
 
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
 
626
        mod = FakeModule('two lines of help\nand more',
 
627
                         'bzrlib.plugins.foo_bar')
565
628
        topic = plugin.ModuleHelpTopic(mod)
566
629
        self.assertEqual('foo_bar', topic.get_help_topic())
 
630
 
 
631
 
 
632
class TestLoadFromPath(tests.TestCaseInTempDir):
 
633
 
 
634
    def setUp(self):
 
635
        super(TestLoadFromPath, self).setUp()
 
636
        # Change bzrlib.plugin to think no plugins have been loaded yet.
 
637
        self.overrideAttr(bzrlib.plugins, '__path__', [])
 
638
        self.overrideAttr(plugin, '_loaded', False)
 
639
 
 
640
        # Monkey-patch load_from_path to stop it from actually loading anything.
 
641
        self.overrideAttr(plugin, 'load_from_path', lambda dirs: None)
 
642
 
 
643
    def test_set_plugins_path_with_args(self):
 
644
        plugin.set_plugins_path(['a', 'b'])
 
645
        self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
 
646
 
 
647
    def test_set_plugins_path_defaults(self):
 
648
        plugin.set_plugins_path()
 
649
        self.assertEqual(plugin.get_standard_plugins_path(),
 
650
                         bzrlib.plugins.__path__)
 
651
 
 
652
    def test_get_standard_plugins_path(self):
 
653
        path = plugin.get_standard_plugins_path()
 
654
        for directory in path:
 
655
            self.assertNotContainsRe(directory, r'\\/$')
 
656
        try:
 
657
            from distutils.sysconfig import get_python_lib
 
658
        except ImportError:
 
659
            pass
 
660
        else:
 
661
            if sys.platform != 'win32':
 
662
                python_lib = get_python_lib()
 
663
                for directory in path:
 
664
                    if directory.startswith(python_lib):
 
665
                        break
 
666
                else:
 
667
                    self.fail('No path to global plugins')
 
668
 
 
669
    def test_get_standard_plugins_path_env(self):
 
670
        self.overrideEnv('BZR_PLUGIN_PATH', 'foo/')
 
671
        path = plugin.get_standard_plugins_path()
 
672
        for directory in path:
 
673
            self.assertNotContainsRe(directory, r'\\/$')
 
674
 
 
675
    def test_load_plugins(self):
 
676
        plugin.load_plugins(['.'])
 
677
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
 
678
        # subsequent loads are no-ops
 
679
        plugin.load_plugins(['foo'])
 
680
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
 
681
 
 
682
    def test_load_plugins_default(self):
 
683
        plugin.load_plugins()
 
684
        path = plugin.get_standard_plugins_path()
 
685
        self.assertEqual(path, bzrlib.plugins.__path__)
 
686
 
 
687
 
 
688
class TestEnvPluginPath(tests.TestCase):
 
689
 
 
690
    def setUp(self):
 
691
        super(TestEnvPluginPath, self).setUp()
 
692
        self.overrideAttr(plugin, 'DEFAULT_PLUGIN_PATH', None)
 
693
 
 
694
        self.user = plugin.get_user_plugin_path()
 
695
        self.site = plugin.get_site_plugin_path()
 
696
        self.core = plugin.get_core_plugin_path()
 
697
 
 
698
    def _list2paths(self, *args):
 
699
        paths = []
 
700
        for p in args:
 
701
            plugin._append_new_path(paths, p)
 
702
        return paths
 
703
 
 
704
    def _set_path(self, *args):
 
705
        path = os.pathsep.join(self._list2paths(*args))
 
706
        self.overrideEnv('BZR_PLUGIN_PATH', path)
 
707
 
 
708
    def check_path(self, expected_dirs, setting_dirs):
 
709
        if setting_dirs:
 
710
            self._set_path(*setting_dirs)
 
711
        actual = plugin.get_standard_plugins_path()
 
712
        self.assertEquals(self._list2paths(*expected_dirs), actual)
 
713
 
 
714
    def test_default(self):
 
715
        self.check_path([self.user, self.core, self.site],
 
716
                        None)
 
717
 
 
718
    def test_adhoc_policy(self):
 
719
        self.check_path([self.user, self.core, self.site],
 
720
                        ['+user', '+core', '+site'])
 
721
 
 
722
    def test_fallback_policy(self):
 
723
        self.check_path([self.core, self.site, self.user],
 
724
                        ['+core', '+site', '+user'])
 
725
 
 
726
    def test_override_policy(self):
 
727
        self.check_path([self.user, self.site, self.core],
 
728
                        ['+user', '+site', '+core'])
 
729
 
 
730
    def test_disable_user(self):
 
731
        self.check_path([self.core, self.site], ['-user'])
 
732
 
 
733
    def test_disable_user_twice(self):
 
734
        # Ensures multiple removals don't left cruft
 
735
        self.check_path([self.core, self.site], ['-user', '-user'])
 
736
 
 
737
    def test_duplicates_are_removed(self):
 
738
        self.check_path([self.user, self.core, self.site],
 
739
                        ['+user', '+user'])
 
740
        # And only the first reference is kept (since the later references will
 
741
        # only produce '<plugin> already loaded' mutters)
 
742
        self.check_path([self.user, self.core, self.site],
 
743
                        ['+user', '+user', '+core',
 
744
                         '+user', '+site', '+site',
 
745
                         '+core'])
 
746
 
 
747
    def test_disable_overrides_enable(self):
 
748
        self.check_path([self.core, self.site], ['-user', '+user'])
 
749
 
 
750
    def test_disable_core(self):
 
751
        self.check_path([self.site], ['-core'])
 
752
        self.check_path([self.user, self.site], ['+user', '-core'])
 
753
 
 
754
    def test_disable_site(self):
 
755
        self.check_path([self.core], ['-site'])
 
756
        self.check_path([self.user, self.core], ['-site', '+user'])
 
757
 
 
758
    def test_override_site(self):
 
759
        self.check_path(['mysite', self.user, self.core],
 
760
                        ['mysite', '-site', '+user'])
 
761
        self.check_path(['mysite', self.core],
 
762
                        ['mysite', '-site'])
 
763
 
 
764
    def test_override_core(self):
 
765
        self.check_path(['mycore', self.user, self.site],
 
766
                        ['mycore', '-core', '+user', '+site'])
 
767
        self.check_path(['mycore', self.site],
 
768
                        ['mycore', '-core'])
 
769
 
 
770
    def test_my_plugin_only(self):
 
771
        self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
 
772
 
 
773
    def test_my_plugin_first(self):
 
774
        self.check_path(['myplugin', self.core, self.site, self.user],
 
775
                        ['myplugin', '+core', '+site', '+user'])
 
776
 
 
777
    def test_bogus_references(self):
 
778
        self.check_path(['+foo', '-bar', self.core, self.site],
 
779
                        ['+foo', '-bar'])
 
780
 
 
781
 
 
782
class TestDisablePlugin(BaseTestPlugins):
 
783
 
 
784
    def setUp(self):
 
785
        super(TestDisablePlugin, self).setUp()
 
786
        self.create_plugin_package('test_foo')
 
787
        # Make sure we don't pollute the plugins namespace
 
788
        self.overrideAttr(plugins, '__path__')
 
789
        # Be paranoid in case a test fail
 
790
        self.addCleanup(self._unregister_plugin, 'test_foo')
 
791
 
 
792
    def test_cannot_import(self):
 
793
        self.overrideEnv('BZR_DISABLE_PLUGINS', 'test_foo')
 
794
        plugin.set_plugins_path(['.'])
 
795
        try:
 
796
            import bzrlib.plugins.test_foo
 
797
        except ImportError:
 
798
            pass
 
799
        self.assertPluginUnknown('test_foo')
 
800
 
 
801
    def test_regular_load(self):
 
802
        self.overrideAttr(plugin, '_loaded', False)
 
803
        plugin.load_plugins(['.'])
 
804
        self.assertPluginKnown('test_foo')
 
805
        self.assertDocstring("This is the doc for test_foo",
 
806
                             bzrlib.plugins.test_foo)
 
807
 
 
808
    def test_not_loaded(self):
 
809
        self.warnings = []
 
810
        def captured_warning(*args, **kwargs):
 
811
            self.warnings.append((args, kwargs))
 
812
        self.overrideAttr(trace, 'warning', captured_warning)
 
813
        # Reset the flag that protect against double loading
 
814
        self.overrideAttr(plugin, '_loaded', False)
 
815
        self.overrideEnv('BZR_DISABLE_PLUGINS', 'test_foo')
 
816
        plugin.load_plugins(['.'])
 
817
        self.assertPluginUnknown('test_foo')
 
818
        # Make sure we don't warn about the plugin ImportError since this has
 
819
        # been *requested* by the user.
 
820
        self.assertLength(0, self.warnings)
 
821
 
 
822
 
 
823
 
 
824
class TestLoadPluginAtSyntax(tests.TestCase):
 
825
 
 
826
    def _get_paths(self, paths):
 
827
        return plugin._get_specific_plugin_paths(paths)
 
828
 
 
829
    def test_empty(self):
 
830
        self.assertEquals([], self._get_paths(None))
 
831
        self.assertEquals([], self._get_paths(''))
 
832
 
 
833
    def test_one_path(self):
 
834
        self.assertEquals([('b', 'man')], self._get_paths('b@man'))
 
835
 
 
836
    def test_bogus_path(self):
 
837
        # We need a '@'
 
838
        self.assertRaises(errors.BzrCommandError, self._get_paths, 'batman')
 
839
        # Too much '@' isn't good either
 
840
        self.assertRaises(errors.BzrCommandError, self._get_paths,
 
841
                          'batman@mobile@cave')
 
842
        # An empty description probably indicates a problem
 
843
        self.assertRaises(errors.BzrCommandError, self._get_paths,
 
844
                          os.pathsep.join(['batman@cave', '', 'robin@mobile']))
 
845
 
 
846
 
 
847
class TestLoadPluginAt(BaseTestPlugins):
 
848
 
 
849
    def setUp(self):
 
850
        super(TestLoadPluginAt, self).setUp()
 
851
        # Make sure we don't pollute the plugins namespace
 
852
        self.overrideAttr(plugins, '__path__')
 
853
        # Reset the flag that protect against double loading
 
854
        self.overrideAttr(plugin, '_loaded', False)
 
855
        # Create the same plugin in two directories
 
856
        self.create_plugin_package('test_foo', dir='non-standard-dir')
 
857
        # The "normal" directory, we use 'standard' instead of 'plugins' to
 
858
        # avoid depending on the precise naming.
 
859
        self.create_plugin_package('test_foo', dir='standard/test_foo')
 
860
        # All the tests will load the 'test_foo' plugin from various locations
 
861
        self.addCleanup(self._unregister_plugin, 'test_foo')
 
862
        # Unfortunately there's global cached state for the specific
 
863
        # registered paths.
 
864
        self.addCleanup(plugin.PluginImporter.reset)
 
865
 
 
866
    def assertTestFooLoadedFrom(self, path):
 
867
        self.assertPluginKnown('test_foo')
 
868
        self.assertDocstring('This is the doc for test_foo',
 
869
                             bzrlib.plugins.test_foo)
 
870
        self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
 
871
 
 
872
    def test_regular_load(self):
 
873
        plugin.load_plugins(['standard'])
 
874
        self.assertTestFooLoadedFrom('standard/test_foo')
 
875
 
 
876
    def test_import(self):
 
877
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
878
        plugin.set_plugins_path(['standard'])
 
879
        try:
 
880
            import bzrlib.plugins.test_foo
 
881
        except ImportError:
 
882
            pass
 
883
        self.assertTestFooLoadedFrom('non-standard-dir')
 
884
 
 
885
    def test_loading(self):
 
886
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
887
        plugin.load_plugins(['standard'])
 
888
        self.assertTestFooLoadedFrom('non-standard-dir')
 
889
 
 
890
    def test_compiled_loaded(self):
 
891
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
892
        plugin.load_plugins(['standard'])
 
893
        self.assertTestFooLoadedFrom('non-standard-dir')
 
894
        self.assertIsSameRealPath('non-standard-dir/__init__.py',
 
895
                                  bzrlib.plugins.test_foo.__file__)
 
896
 
 
897
        # Try importing again now that the source has been compiled
 
898
        self._unregister_plugin('test_foo')
 
899
        plugin._loaded = False
 
900
        plugin.load_plugins(['standard'])
 
901
        self.assertTestFooLoadedFrom('non-standard-dir')
 
902
        if __debug__:
 
903
            suffix = 'pyc'
 
904
        else:
 
905
            suffix = 'pyo'
 
906
        self.assertIsSameRealPath('non-standard-dir/__init__.%s' % suffix,
 
907
                                  bzrlib.plugins.test_foo.__file__)
 
908
 
 
909
    def test_submodule_loading(self):
 
910
        # We create an additional directory under the one for test_foo
 
911
        self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
 
912
        self.addCleanup(self._unregister_plugin_submodule,
 
913
                        'test_foo', 'test_bar')
 
914
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
915
        plugin.set_plugins_path(['standard'])
 
916
        import bzrlib.plugins.test_foo
 
917
        self.assertEqual('bzrlib.plugins.test_foo',
 
918
                         bzrlib.plugins.test_foo.__package__)
 
919
        import bzrlib.plugins.test_foo.test_bar
 
920
        self.assertIsSameRealPath('non-standard-dir/test_bar/__init__.py',
 
921
                                  bzrlib.plugins.test_foo.test_bar.__file__)
 
922
 
 
923
    def test_relative_submodule_loading(self):
 
924
        self.create_plugin_package('test_foo', dir='another-dir', source='''
 
925
import test_bar
 
926
''')
 
927
        # We create an additional directory under the one for test_foo
 
928
        self.create_plugin_package('test_bar', dir='another-dir/test_bar')
 
929
        self.addCleanup(self._unregister_plugin_submodule,
 
930
                        'test_foo', 'test_bar')
 
931
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@another-dir')
 
932
        plugin.set_plugins_path(['standard'])
 
933
        import bzrlib.plugins.test_foo
 
934
        self.assertEqual('bzrlib.plugins.test_foo',
 
935
                         bzrlib.plugins.test_foo.__package__)
 
936
        self.assertIsSameRealPath('another-dir/test_bar/__init__.py',
 
937
                                  bzrlib.plugins.test_foo.test_bar.__file__)
 
938
 
 
939
    def test_loading_from___init__only(self):
 
940
        # We rename the existing __init__.py file to ensure that we don't load
 
941
        # a random file
 
942
        init = 'non-standard-dir/__init__.py'
 
943
        random = 'non-standard-dir/setup.py'
 
944
        os.rename(init, random)
 
945
        self.addCleanup(os.rename, random, init)
 
946
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
947
        plugin.load_plugins(['standard'])
 
948
        self.assertPluginUnknown('test_foo')
 
949
 
 
950
    def test_loading_from_specific_file(self):
 
951
        plugin_dir = 'non-standard-dir'
 
952
        plugin_file_name = 'iamtestfoo.py'
 
953
        plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
 
954
        source = '''\
 
955
"""This is the doc for %s"""
 
956
dir_source = '%s'
 
957
''' % ('test_foo', plugin_path)
 
958
        self.create_plugin('test_foo', source=source,
 
959
                           dir=plugin_dir, file_name=plugin_file_name)
 
960
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@%s' % plugin_path)
 
961
        plugin.load_plugins(['standard'])
 
962
        self.assertTestFooLoadedFrom(plugin_path)
 
963
 
 
964
 
 
965
class TestDescribePlugins(BaseTestPlugins):
 
966
 
 
967
    def test_describe_plugins(self):
 
968
        class DummyModule(object):
 
969
            __doc__ = 'Hi there'
 
970
        class DummyPlugin(object):
 
971
            __version__ = '0.1.0'
 
972
            module = DummyModule()
 
973
        def dummy_plugins():
 
974
            return { 'good': DummyPlugin() }
 
975
        self.overrideAttr(plugin, 'plugin_warnings',
 
976
            {'bad': ['Failed to load (just testing)']})
 
977
        self.overrideAttr(plugin, 'plugins', dummy_plugins)
 
978
        self.assertEquals("""\
 
979
bad (failed to load)
 
980
  ** Failed to load (just testing)
 
981
 
 
982
good 0.1.0
 
983
  Hi there
 
984
 
 
985
""", ''.join(plugin.describe_plugins()))