← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_plugins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

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