← 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: Andrew Bennetts
  • Date: 2008-12-12 01:17:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3899.
  • Revision ID: andrew.bennetts@canonical.com-20081212011704-m5208objzpfsjar7
https://launchpad.net/bugs/307327
Remove broken debugging cruft, and some unused imports.

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
import zipfile
27
28
 
28
 
import bzrlib
29
 
from bzrlib import (
30
 
    osutils,
31
 
    plugin,
32
 
    plugins,
33
 
    tests,
34
 
    trace,
 
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,
35
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
# TODO: Write a test for plugin decoration of commands.
39
53
 
40
 
class TestPluginMixin(object):
41
 
 
42
 
    def create_plugin(self, name, source=None, dir='.', file_name=None):
43
 
        if source is None:
44
 
            source = '''\
45
 
"""This is the doc for %s"""
46
 
''' % (name)
47
 
        if file_name is None:
48
 
            file_name = name + '.py'
49
 
        # 'source' must not fail to load
50
 
        path = osutils.pathjoin(dir, file_name)
51
 
        f = open(path, 'w')
52
 
        self.addCleanup(os.unlink, path)
53
 
        try:
54
 
            f.write(source + '\n')
55
 
        finally:
56
 
            f.close()
57
 
 
58
 
    def create_plugin_package(self, name, dir=None, source=None):
59
 
        if dir is None:
60
 
            dir = name
61
 
        if source is None:
62
 
            source = '''\
63
 
"""This is the doc for %s"""
64
 
dir_source = '%s'
65
 
''' % (name, dir)
66
 
        os.makedirs(dir)
67
 
        def cleanup():
68
 
            # Workaround lazy import random? madness
69
 
            osutils.rmtree(dir)
70
 
        self.addCleanup(cleanup)
71
 
        self.create_plugin(name, source, dir,
72
 
                           file_name='__init__.py')
73
 
 
74
 
    def _unregister_plugin(self, name):
75
 
        """Remove the plugin from sys.modules and the bzrlib namespace."""
76
 
        py_name = 'bzrlib.plugins.%s' % name
77
 
        if py_name in sys.modules:
78
 
            del sys.modules[py_name]
79
 
        if getattr(bzrlib.plugins, name, None) is not None:
80
 
            delattr(bzrlib.plugins, name)
81
 
 
82
 
    def assertPluginUnknown(self, name):
83
 
        self.failIf(getattr(bzrlib.plugins, name, None) is not None)
84
 
        self.failIf('bzrlib.plugins.%s' % name in sys.modules)
85
 
 
86
 
    def assertPluginKnown(self, name):
87
 
        self.failUnless(getattr(bzrlib.plugins, name, None) is not None)
88
 
        self.failUnless('bzrlib.plugins.%s' % name in sys.modules)
89
 
 
90
 
 
91
 
class TestLoadingPlugins(tests.TestCaseInTempDir, TestPluginMixin):
 
54
class TestLoadingPlugins(TestCaseInTempDir):
92
55
 
93
56
    activeattributes = {}
94
57
 
102
65
        # set a place for the plugins to record their loading, and at the same
103
66
        # time validate that the location the plugins should record to is
104
67
        # valid and correct.
105
 
        self.__class__.activeattributes [tempattribute] = []
 
68
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
 
69
            [tempattribute] = []
106
70
        self.failUnless(tempattribute in self.activeattributes)
107
71
        # create two plugin directories
108
72
        os.mkdir('first')
109
73
        os.mkdir('second')
110
 
        # write a plugin that will record when its loaded in the
 
74
        # write a plugin that will record when its loaded in the 
111
75
        # tempattribute list.
112
76
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
113
77
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
132
96
        finally:
133
97
            # remove the plugin 'plugin'
134
98
            del self.activeattributes[tempattribute]
135
 
            self._unregister_plugin('plugin')
136
 
        self.assertPluginUnknown('plugin')
 
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))
137
104
 
138
105
    def test_plugins_from_different_dirs_can_demand_load(self):
139
 
        self.failIf('bzrlib.plugins.pluginone' in sys.modules)
140
 
        self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
141
106
        # This test tests that having two plugins in different
142
107
        # directories with different names allows them both to be loaded, when
143
108
        # we do a direct import statement.
154
119
        # create two plugin directories
155
120
        os.mkdir('first')
156
121
        os.mkdir('second')
157
 
        # write plugins that will record when they are loaded in the
 
122
        # write plugins that will record when they are loaded in the 
158
123
        # tempattribute list.
159
124
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
160
125
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
175
140
 
176
141
        oldpath = bzrlib.plugins.__path__
177
142
        try:
178
 
            self.failIf('bzrlib.plugins.pluginone' in sys.modules)
179
 
            self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
180
143
            bzrlib.plugins.__path__ = ['first', 'second']
181
144
            exec "import bzrlib.plugins.pluginone"
182
145
            self.assertEqual(['first'], self.activeattributes[tempattribute])
186
149
        finally:
187
150
            # remove the plugin 'plugin'
188
151
            del self.activeattributes[tempattribute]
189
 
            self._unregister_plugin('pluginone')
190
 
            self._unregister_plugin('plugintwo')
191
 
        self.assertPluginUnknown('pluginone')
192
 
        self.assertPluginUnknown('plugintwo')
 
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))
193
158
 
194
159
    def test_plugins_can_load_from_directory_with_trailing_slash(self):
195
160
        # This test tests that a plugin can load from a directory when the
196
161
        # directory in the path has a trailing slash.
197
162
        # check the plugin is not loaded already
198
 
        self.assertPluginUnknown('ts_plugin')
 
163
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
199
164
        tempattribute = "trailing-slash"
200
165
        self.failIf(tempattribute in self.activeattributes)
201
166
        # set a place for the plugin to record its loading, and at the same
206
171
        self.failUnless(tempattribute in self.activeattributes)
207
172
        # create a directory for the plugin
208
173
        os.mkdir('plugin_test')
209
 
        # write a plugin that will record when its loaded in the
 
174
        # write a plugin that will record when its loaded in the 
210
175
        # tempattribute list.
211
176
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
212
177
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
222
187
            bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
223
188
            self.assertEqual(['plugin'], self.activeattributes[tempattribute])
224
189
        finally:
 
190
            # remove the plugin 'plugin'
225
191
            del self.activeattributes[tempattribute]
226
 
            self._unregister_plugin('ts_plugin')
227
 
        self.assertPluginUnknown('ts_plugin')
 
192
            if getattr(bzrlib.plugins, 'ts_plugin', None):
 
193
                del bzrlib.plugins.ts_plugin
 
194
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
228
195
 
229
196
    def load_and_capture(self, name):
230
197
        """Load plugins from '.' capturing the output.
231
 
 
 
198
        
232
199
        :param name: The name of the plugin.
233
200
        :return: A string with the log from the plugin loading call.
234
201
        """
254
221
            return stream.getvalue()
255
222
        finally:
256
223
            stream.close()
257
 
 
 
224
    
258
225
    def test_plugin_with_bad_api_version_reports(self):
259
226
        # This plugin asks for bzrlib api version 1.0.0, which is not supported
260
227
        # anymore.
281
248
            "it to 'bad_plugin_name_'\.")
282
249
 
283
250
 
284
 
class TestPlugins(tests.TestCaseInTempDir, TestPluginMixin):
 
251
class TestPlugins(TestCaseInTempDir):
285
252
 
286
253
    def setup_plugin(self, source=""):
287
254
        # This test tests a new plugin appears in bzrlib.plugin.plugins().
288
255
        # check the plugin is not loaded already
289
 
        self.assertPluginUnknown('plugin')
 
256
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
290
257
        # write a plugin that _cannot_ fail to load.
291
258
        file('plugin.py', 'w').write(source + '\n')
292
259
        self.addCleanup(self.teardown_plugin)
293
 
        plugin.load_from_path(['.'])
294
 
 
 
260
        bzrlib.plugin.load_from_path(['.'])
 
261
    
295
262
    def teardown_plugin(self):
296
 
        self._unregister_plugin('plugin')
297
 
        self.assertPluginUnknown('plugin')
 
263
        # remove the plugin 'plugin'
 
264
        if 'bzrlib.plugins.plugin' in sys.modules:
 
265
            del sys.modules['bzrlib.plugins.plugin']
 
266
        if getattr(bzrlib.plugins, 'plugin', None):
 
267
            del bzrlib.plugins.plugin
 
268
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
298
269
 
299
270
    def test_plugin_appears_in_plugins(self):
300
271
        self.setup_plugin()
301
 
        self.assertPluginKnown('plugin')
302
 
        p = plugin.plugins()['plugin']
303
 
        self.assertIsInstance(p, bzrlib.plugin.PlugIn)
304
 
        self.assertEqual(p.module, plugins.plugin)
 
272
        self.failUnless('plugin' in bzrlib.plugin.plugins())
 
273
        self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
 
274
        plugins = bzrlib.plugin.plugins()
 
275
        plugin = plugins['plugin']
 
276
        self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
 
277
        self.assertEqual(bzrlib.plugins.plugin, plugin.module)
305
278
 
306
279
    def test_trivial_plugin_get_path(self):
307
280
        self.setup_plugin()
308
 
        p = plugin.plugins()['plugin']
 
281
        plugins = bzrlib.plugin.plugins()
 
282
        plugin = plugins['plugin']
309
283
        plugin_path = self.test_dir + '/plugin.py'
310
 
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
284
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
311
285
 
312
286
    def test_plugin_get_path_py_not_pyc(self):
313
 
        # first import creates plugin.pyc
314
 
        self.setup_plugin()
 
287
        self.setup_plugin()         # after first import there will be plugin.pyc
315
288
        self.teardown_plugin()
316
 
        plugin.load_from_path(['.']) # import plugin.pyc
317
 
        p = plugin.plugins()['plugin']
 
289
        bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
 
290
        plugins = bzrlib.plugin.plugins()
 
291
        plugin = plugins['plugin']
318
292
        plugin_path = self.test_dir + '/plugin.py'
319
 
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
293
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
320
294
 
321
295
    def test_plugin_get_path_pyc_only(self):
322
 
        # first import creates plugin.pyc (or plugin.pyo depending on __debug__)
323
 
        self.setup_plugin()
 
296
        self.setup_plugin()         # after first import there will be plugin.pyc
324
297
        self.teardown_plugin()
325
298
        os.unlink(self.test_dir + '/plugin.py')
326
 
        plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
327
 
        p = plugin.plugins()['plugin']
 
299
        bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
 
300
        plugins = bzrlib.plugin.plugins()
 
301
        plugin = plugins['plugin']
328
302
        if __debug__:
329
303
            plugin_path = self.test_dir + '/plugin.pyc'
330
304
        else:
331
305
            plugin_path = self.test_dir + '/plugin.pyo'
332
 
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
306
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
333
307
 
334
308
    def test_no_test_suite_gives_None_for_test_suite(self):
335
309
        self.setup_plugin()
336
 
        p = plugin.plugins()['plugin']
337
 
        self.assertEqual(None, p.test_suite())
 
310
        plugin = bzrlib.plugin.plugins()['plugin']
 
311
        self.assertEqual(None, plugin.test_suite())
338
312
 
339
313
    def test_test_suite_gives_test_suite_result(self):
340
314
        source = """def test_suite(): return 'foo'"""
341
315
        self.setup_plugin(source)
342
 
        p = plugin.plugins()['plugin']
343
 
        self.assertEqual('foo', p.test_suite())
 
316
        plugin = bzrlib.plugin.plugins()['plugin']
 
317
        self.assertEqual('foo', plugin.test_suite())
344
318
 
345
319
    def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
346
320
        self.setup_plugin()
347
 
        loader = tests.TestUtil.TestLoader()
348
 
        p = plugin.plugins()['plugin']
349
 
        self.assertEqual(None, p.load_plugin_tests(loader))
 
321
        loader = TestUtil.TestLoader()
 
322
        plugin = bzrlib.plugin.plugins()['plugin']
 
323
        self.assertEqual(None, plugin.load_plugin_tests(loader))
350
324
 
351
325
    def test_load_plugin_tests_gives_load_plugin_tests_result(self):
352
326
        source = """
353
327
def load_tests(standard_tests, module, loader):
354
328
    return 'foo'"""
355
329
        self.setup_plugin(source)
356
 
        loader = tests.TestUtil.TestLoader()
357
 
        p = plugin.plugins()['plugin']
358
 
        self.assertEqual('foo', p.load_plugin_tests(loader))
359
 
 
360
 
    def check_version_info(self, expected, source='', name='plugin'):
361
 
        self.setup_plugin(source)
362
 
        self.assertEqual(expected, plugin.plugins()[name].version_info())
 
330
        loader = TestUtil.TestLoader()
 
331
        plugin = bzrlib.plugin.plugins()['plugin']
 
332
        self.assertEqual('foo', plugin.load_plugin_tests(loader))
363
333
 
364
334
    def test_no_version_info(self):
365
 
        self.check_version_info(None)
 
335
        self.setup_plugin()
 
336
        plugin = bzrlib.plugin.plugins()['plugin']
 
337
        self.assertEqual(None, plugin.version_info())
366
338
 
367
339
    def test_with_version_info(self):
368
 
        self.check_version_info((1, 2, 3, 'dev', 4),
369
 
                                "version_info = (1, 2, 3, 'dev', 4)")
 
340
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
 
341
        plugin = bzrlib.plugin.plugins()['plugin']
 
342
        self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
370
343
 
371
344
    def test_short_version_info_gets_padded(self):
372
345
        # the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
373
346
        # so we adapt it
374
 
        self.check_version_info((1, 2, 3, 'final', 0),
375
 
                                "version_info = (1, 2, 3)")
376
 
 
377
 
    def check_version(self, expected, source=None, name='plugin'):
378
 
        self.setup_plugin(source)
379
 
        self.assertEqual(expected, plugins[name].__version__)
 
347
        self.setup_plugin("version_info = (1, 2, 3)")
 
348
        plugin = bzrlib.plugin.plugins()['plugin']
 
349
        self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
380
350
 
381
351
    def test_no_version_info___version__(self):
382
352
        self.setup_plugin()
421
391
    def test_dev_fallback__version__with_version_info(self):
422
392
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
423
393
        plugin = bzrlib.plugin.plugins()['plugin']
424
 
        self.assertEqual("1.2.3dev4", plugin.__version__)
 
394
        self.assertEqual("1.2.3.dev.4", plugin.__version__)
425
395
 
426
396
    def test_final__version__with_version_info(self):
427
397
        self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
428
398
        plugin = bzrlib.plugin.plugins()['plugin']
429
399
        self.assertEqual("1.2.3", plugin.__version__)
430
400
 
431
 
    def test_final_fallback__version__with_version_info(self):
432
 
        self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
433
 
        plugin = bzrlib.plugin.plugins()['plugin']
434
 
        self.assertEqual("1.2.3.final.2", plugin.__version__)
435
 
 
436
 
 
437
 
class TestPluginHelp(tests.TestCaseInTempDir):
 
401
 
 
402
class TestPluginHelp(TestCaseInTempDir):
438
403
 
439
404
    def split_help_commands(self):
440
405
        help = {}
441
406
        current = None
442
 
        out, err = self.run_bzr('--no-plugins help commands')
443
 
        for line in out.splitlines():
 
407
        for line in self.run_bzr('help commands')[0].splitlines():
444
408
            if not line.startswith(' '):
445
409
                current = line.split()[0]
446
410
            help[current] = help.get(current, '') + line
469
433
    def test_plugin_help_shows_plugin(self):
470
434
        # Create a test plugin
471
435
        os.mkdir('plugin_test')
472
 
        f = open(osutils.pathjoin('plugin_test', 'myplug.py'), 'w')
473
 
        f.write("""\
474
 
from bzrlib import commands
475
 
class cmd_myplug(commands.Command):
476
 
    __doc__ = '''Just a simple test plugin.'''
477
 
    aliases = ['mplg']
478
 
    def run(self):
479
 
        print 'Hello from my plugin'
480
 
 
481
 
"""
482
 
)
 
436
        f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
 
437
        f.write(PLUGIN_TEXT)
483
438
        f.close()
484
439
 
485
440
        try:
499
454
                delattr(bzrlib.plugins, 'myplug')
500
455
 
501
456
 
 
457
class TestPluginFromZip(TestCaseInTempDir):
 
458
 
 
459
    def make_zipped_plugin(self, zip_name, filename):
 
460
        z = zipfile.ZipFile(zip_name, 'w')
 
461
        z.writestr(filename, PLUGIN_TEXT)
 
462
        z.close()
 
463
 
 
464
    def check_plugin_load(self, zip_name, plugin_name):
 
465
        self.assertFalse(plugin_name in dir(bzrlib.plugins),
 
466
                         'Plugin already loaded')
 
467
        old_path = bzrlib.plugins.__path__
 
468
        try:
 
469
            # this is normally done by load_plugins -> set_plugins_path
 
470
            bzrlib.plugins.__path__ = [zip_name]
 
471
            self.applyDeprecated(one_three,
 
472
                bzrlib.plugin.load_from_zip, zip_name)
 
473
            self.assertTrue(plugin_name in dir(bzrlib.plugins),
 
474
                            'Plugin is not loaded')
 
475
        finally:
 
476
            # unregister plugin
 
477
            if getattr(bzrlib.plugins, plugin_name, None):
 
478
                delattr(bzrlib.plugins, plugin_name)
 
479
                del sys.modules['bzrlib.plugins.' + plugin_name]
 
480
            bzrlib.plugins.__path__ = old_path
 
481
 
 
482
    def test_load_module(self):
 
483
        self.make_zipped_plugin('./test.zip', 'ziplug.py')
 
484
        self.check_plugin_load('./test.zip', 'ziplug')
 
485
 
 
486
    def test_load_package(self):
 
487
        self.make_zipped_plugin('./test.zip', 'ziplug/__init__.py')
 
488
        self.check_plugin_load('./test.zip', 'ziplug')
 
489
 
 
490
 
 
491
class TestSetPluginsPath(TestCase):
 
492
    
 
493
    def test_set_plugins_path(self):
 
494
        """set_plugins_path should set the module __path__ correctly."""
 
495
        old_path = bzrlib.plugins.__path__
 
496
        try:
 
497
            bzrlib.plugins.__path__ = []
 
498
            expected_path = bzrlib.plugin.set_plugins_path()
 
499
            self.assertEqual(expected_path, bzrlib.plugins.__path__)
 
500
        finally:
 
501
            bzrlib.plugins.__path__ = old_path
 
502
 
 
503
    def test_set_plugins_path_with_trailing_slashes(self):
 
504
        """set_plugins_path should set the module __path__ based on
 
505
        BZR_PLUGIN_PATH after removing all trailing slashes."""
 
506
        old_path = bzrlib.plugins.__path__
 
507
        old_env = os.environ.get('BZR_PLUGIN_PATH')
 
508
        try:
 
509
            bzrlib.plugins.__path__ = []
 
510
            os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
 
511
                "second/\\/\\/"
 
512
            bzrlib.plugin.set_plugins_path()
 
513
            # We expect our nominated paths to have all path-seps removed,
 
514
            # and this is testing only that.
 
515
            expected_path = ['first', 'second']
 
516
            self.assertEqual(expected_path,
 
517
                bzrlib.plugins.__path__[:len(expected_path)])
 
518
        finally:
 
519
            bzrlib.plugins.__path__ = old_path
 
520
            if old_env is not None:
 
521
                os.environ['BZR_PLUGIN_PATH'] = old_env
 
522
            else:
 
523
                del os.environ['BZR_PLUGIN_PATH']
 
524
 
 
525
 
502
526
class TestHelpIndex(tests.TestCase):
503
527
    """Tests for the PluginsHelpIndex class."""
504
528
 
607
631
        self.assertEqual('foo_bar', topic.get_help_topic())
608
632
 
609
633
 
610
 
class TestLoadFromPath(tests.TestCaseInTempDir):
611
 
 
612
 
    def setUp(self):
613
 
        super(TestLoadFromPath, self).setUp()
614
 
        # Change bzrlib.plugin to think no plugins have been loaded yet.
615
 
        self.overrideAttr(bzrlib.plugins, '__path__', [])
616
 
        self.overrideAttr(plugin, '_loaded', False)
617
 
 
618
 
        # Monkey-patch load_from_path to stop it from actually loading anything.
619
 
        self.overrideAttr(plugin, 'load_from_path', lambda dirs: None)
 
634
def clear_plugins(test_case):
 
635
    old_plugins_path = bzrlib.plugins.__path__
 
636
    bzrlib.plugins.__path__ = []
 
637
    plugin._loaded = False
 
638
    def restore_plugins():
 
639
        bzrlib.plugins.__path__ = old_plugins_path
 
640
        plugin._loaded = False
 
641
    test_case.addCleanup(restore_plugins)
 
642
 
 
643
 
 
644
class TestPluginPaths(tests.TestCase):
620
645
 
621
646
    def test_set_plugins_path_with_args(self):
 
647
        clear_plugins(self)
622
648
        plugin.set_plugins_path(['a', 'b'])
623
649
        self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
624
650
 
625
651
    def test_set_plugins_path_defaults(self):
 
652
        clear_plugins(self)
626
653
        plugin.set_plugins_path()
627
654
        self.assertEqual(plugin.get_standard_plugins_path(),
628
655
                         bzrlib.plugins.__path__)
629
656
 
630
657
    def test_get_standard_plugins_path(self):
631
658
        path = plugin.get_standard_plugins_path()
 
659
        self.assertEqual(plugin.get_default_plugin_path(), path[0])
632
660
        for directory in path:
633
 
            self.assertNotContainsRe(directory, r'\\/$')
 
661
            self.assertNotContainsRe(r'\\/$', directory)
634
662
        try:
635
663
            from distutils.sysconfig import get_python_lib
636
664
        except ImportError:
646
674
 
647
675
    def test_get_standard_plugins_path_env(self):
648
676
        os.environ['BZR_PLUGIN_PATH'] = 'foo/'
649
 
        path = plugin.get_standard_plugins_path()
650
 
        for directory in path:
651
 
            self.assertNotContainsRe(directory, r'\\/$')
 
677
        self.assertEqual('foo', plugin.get_standard_plugins_path()[0])
 
678
 
 
679
 
 
680
class TestLoadPlugins(tests.TestCaseInTempDir):
652
681
 
653
682
    def test_load_plugins(self):
 
683
        clear_plugins(self)
654
684
        plugin.load_plugins(['.'])
655
685
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
656
686
        # subsequent loads are no-ops
658
688
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
659
689
 
660
690
    def test_load_plugins_default(self):
 
691
        clear_plugins(self)
661
692
        plugin.load_plugins()
662
693
        path = plugin.get_standard_plugins_path()
663
694
        self.assertEqual(path, bzrlib.plugins.__path__)
664
 
 
665
 
 
666
 
class TestEnvPluginPath(tests.TestCase):
667
 
 
668
 
    def setUp(self):
669
 
        super(TestEnvPluginPath, self).setUp()
670
 
        self.overrideAttr(plugin, 'DEFAULT_PLUGIN_PATH', None)
671
 
 
672
 
        self.user = plugin.get_user_plugin_path()
673
 
        self.site = plugin.get_site_plugin_path()
674
 
        self.core = plugin.get_core_plugin_path()
675
 
 
676
 
    def _list2paths(self, *args):
677
 
        paths = []
678
 
        for p in args:
679
 
            plugin._append_new_path(paths, p)
680
 
        return paths
681
 
 
682
 
    def _set_path(self, *args):
683
 
        path = os.pathsep.join(self._list2paths(*args))
684
 
        osutils.set_or_unset_env('BZR_PLUGIN_PATH', path)
685
 
 
686
 
    def check_path(self, expected_dirs, setting_dirs):
687
 
        if setting_dirs:
688
 
            self._set_path(*setting_dirs)
689
 
        actual = plugin.get_standard_plugins_path()
690
 
        self.assertEquals(self._list2paths(*expected_dirs), actual)
691
 
 
692
 
    def test_default(self):
693
 
        self.check_path([self.user, self.core, self.site],
694
 
                        None)
695
 
 
696
 
    def test_adhoc_policy(self):
697
 
        self.check_path([self.user, self.core, self.site],
698
 
                        ['+user', '+core', '+site'])
699
 
 
700
 
    def test_fallback_policy(self):
701
 
        self.check_path([self.core, self.site, self.user],
702
 
                        ['+core', '+site', '+user'])
703
 
 
704
 
    def test_override_policy(self):
705
 
        self.check_path([self.user, self.site, self.core],
706
 
                        ['+user', '+site', '+core'])
707
 
 
708
 
    def test_disable_user(self):
709
 
        self.check_path([self.core, self.site], ['-user'])
710
 
 
711
 
    def test_disable_user_twice(self):
712
 
        # Ensures multiple removals don't left cruft
713
 
        self.check_path([self.core, self.site], ['-user', '-user'])
714
 
 
715
 
    def test_duplicates_are_removed(self):
716
 
        self.check_path([self.user, self.core, self.site],
717
 
                        ['+user', '+user'])
718
 
        # And only the first reference is kept (since the later references will
719
 
        # only produce '<plugin> already loaded' mutters)
720
 
        self.check_path([self.user, self.core, self.site],
721
 
                        ['+user', '+user', '+core',
722
 
                         '+user', '+site', '+site',
723
 
                         '+core'])
724
 
 
725
 
    def test_disable_overrides_enable(self):
726
 
        self.check_path([self.core, self.site], ['-user', '+user'])
727
 
 
728
 
    def test_disable_core(self):
729
 
        self.check_path([self.site], ['-core'])
730
 
        self.check_path([self.user, self.site], ['+user', '-core'])
731
 
 
732
 
    def test_disable_site(self):
733
 
        self.check_path([self.core], ['-site'])
734
 
        self.check_path([self.user, self.core], ['-site', '+user'])
735
 
 
736
 
    def test_override_site(self):
737
 
        self.check_path(['mysite', self.user, self.core],
738
 
                        ['mysite', '-site', '+user'])
739
 
        self.check_path(['mysite', self.core],
740
 
                        ['mysite', '-site'])
741
 
 
742
 
    def test_override_core(self):
743
 
        self.check_path(['mycore', self.user, self.site],
744
 
                        ['mycore', '-core', '+user', '+site'])
745
 
        self.check_path(['mycore', self.site],
746
 
                        ['mycore', '-core'])
747
 
 
748
 
    def test_my_plugin_only(self):
749
 
        self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
750
 
 
751
 
    def test_my_plugin_first(self):
752
 
        self.check_path(['myplugin', self.core, self.site, self.user],
753
 
                        ['myplugin', '+core', '+site', '+user'])
754
 
 
755
 
    def test_bogus_references(self):
756
 
        self.check_path(['+foo', '-bar', self.core, self.site],
757
 
                        ['+foo', '-bar'])
758
 
 
759
 
 
760
 
class TestDisablePlugin(tests.TestCaseInTempDir, TestPluginMixin):
761
 
 
762
 
    def setUp(self):
763
 
        super(TestDisablePlugin, self).setUp()
764
 
        self.create_plugin_package('test_foo')
765
 
        # Make sure we don't pollute the plugins namespace
766
 
        self.overrideAttr(plugins, '__path__')
767
 
        # Be paranoid in case a test fail
768
 
        self.addCleanup(self._unregister_plugin, 'test_foo')
769
 
 
770
 
    def test_cannot_import(self):
771
 
        osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
772
 
        plugin.set_plugins_path(['.'])
773
 
        try:
774
 
            import bzrlib.plugins.test_foo
775
 
        except ImportError:
776
 
            pass
777
 
        self.assertPluginUnknown('test_foo')
778
 
 
779
 
    def test_regular_load(self):
780
 
        self.overrideAttr(plugin, '_loaded', False)
781
 
        plugin.load_plugins(['.'])
782
 
        self.assertPluginKnown('test_foo')
783
 
        self.assertDocstring("This is the doc for test_foo",
784
 
                             bzrlib.plugins.test_foo)
785
 
 
786
 
    def test_not_loaded(self):
787
 
        self.warnings = []
788
 
        def captured_warning(*args, **kwargs):
789
 
            self.warnings.append((args, kwargs))
790
 
        self.overrideAttr(trace, 'warning', captured_warning)
791
 
        # Reset the flag that protect against double loading
792
 
        self.overrideAttr(plugin, '_loaded', False)
793
 
        osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
794
 
        plugin.load_plugins(['.'])
795
 
        self.assertPluginUnknown('test_foo')
796
 
        # Make sure we don't warn about the plugin ImportError since this has
797
 
        # been *requested* by the user.
798
 
        self.assertLength(0, self.warnings)
799
 
 
800
 
 
801
 
class TestLoadPluginAt(tests.TestCaseInTempDir, TestPluginMixin):
802
 
 
803
 
    def setUp(self):
804
 
        super(TestLoadPluginAt, self).setUp()
805
 
        # Make sure we don't pollute the plugins namespace
806
 
        self.overrideAttr(plugins, '__path__')
807
 
        # Be paranoid in case a test fail
808
 
        self.addCleanup(self._unregister_plugin, 'test_foo')
809
 
        # Reset the flag that protect against double loading
810
 
        self.overrideAttr(plugin, '_loaded', False)
811
 
        # Create the same plugin in two directories
812
 
        self.create_plugin_package('test_foo', dir='non-standard-dir')
813
 
        # The "normal" directory, we use 'standard' instead of 'plugins' to
814
 
        # avoid depending on the precise naming.
815
 
        self.create_plugin_package('test_foo', dir='standard/test_foo')
816
 
 
817
 
    def assertTestFooLoadedFrom(self, path):
818
 
        self.assertPluginKnown('test_foo')
819
 
        self.assertDocstring('This is the doc for test_foo',
820
 
                             bzrlib.plugins.test_foo)
821
 
        self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
822
 
 
823
 
    def test_regular_load(self):
824
 
        plugin.load_plugins(['standard'])
825
 
        self.assertTestFooLoadedFrom('standard/test_foo')
826
 
 
827
 
    def test_import(self):
828
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
829
 
        plugin.set_plugins_path(['standard'])
830
 
        try:
831
 
            import bzrlib.plugins.test_foo
832
 
        except ImportError:
833
 
            pass
834
 
        self.assertTestFooLoadedFrom('non-standard-dir')
835
 
 
836
 
    def test_loading(self):
837
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
838
 
        plugin.load_plugins(['standard'])
839
 
        self.assertTestFooLoadedFrom('non-standard-dir')
840
 
 
841
 
    def test_compiled_loaded(self):
842
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
843
 
        plugin.load_plugins(['standard'])
844
 
        self.assertTestFooLoadedFrom('non-standard-dir')
845
 
        self.assertEqual('non-standard-dir/__init__.py',
846
 
                         bzrlib.plugins.test_foo.__file__)
847
 
 
848
 
        # Try importing again now that the source has been compiled
849
 
        self._unregister_plugin('test_foo')
850
 
        plugin._loaded = False
851
 
        plugin.load_plugins(['standard'])
852
 
        self.assertTestFooLoadedFrom('non-standard-dir')
853
 
        if __debug__:
854
 
            suffix = 'pyc'
855
 
        else:
856
 
            suffix = 'pyo'
857
 
        self.assertEqual('non-standard-dir/__init__.%s' % suffix,
858
 
                         bzrlib.plugins.test_foo.__file__)
859
 
 
860
 
    def test_submodule_loading(self):
861
 
        # We create an additional directory under the one for test_foo
862
 
        self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
863
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
864
 
        plugin.set_plugins_path(['standard'])
865
 
        import bzrlib.plugins.test_foo
866
 
        self.assertEqual('bzrlib.plugins.test_foo',
867
 
                         bzrlib.plugins.test_foo.__package__)
868
 
        import bzrlib.plugins.test_foo.test_bar
869
 
        self.assertEqual('non-standard-dir/test_bar/__init__.py',
870
 
                         bzrlib.plugins.test_foo.test_bar.__file__)
871
 
 
872
 
    def test_loading_from___init__only(self):
873
 
        # We rename the existing __init__.py file to ensure that we don't load
874
 
        # a random file
875
 
        init = 'non-standard-dir/__init__.py'
876
 
        random = 'non-standard-dir/setup.py'
877
 
        os.rename(init, random)
878
 
        self.addCleanup(os.rename, random, init)
879
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
880
 
        plugin.load_plugins(['standard'])
881
 
        self.assertPluginUnknown('test_foo')
882
 
 
883
 
    def test_loading_from_specific_file(self):
884
 
        plugin_dir = 'non-standard-dir'
885
 
        plugin_file_name = 'iamtestfoo.py'
886
 
        plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
887
 
        source = '''\
888
 
"""This is the doc for %s"""
889
 
dir_source = '%s'
890
 
''' % ('test_foo', plugin_path)
891
 
        self.create_plugin('test_foo', source=source,
892
 
                           dir=plugin_dir, file_name=plugin_file_name)
893
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@%s' % plugin_path)
894
 
        plugin.load_plugins(['standard'])
895
 
        self.assertTestFooLoadedFrom(plugin_path)