1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for plugins"""
19
# XXX: There are no plugin tests at the moment because the plugin module
20
# affects the global state of the process. See bzrlib/plugins.py for more
23
from cStringIO import StringIO
38
# TODO: Write a test for plugin decoration of commands.
40
class TestPluginMixin(object):
42
def create_plugin(self, name, source='', dir='.', file_name=None):
44
file_name = name + '.py'
45
# 'source' must not fail to load
46
path = osutils.pathjoin(dir, file_name)
48
self.addCleanup(os.unlink, path)
50
f.write(source + '\n')
54
def create_plugin_package(self, name, source='', dir='.'):
55
plugin_dir = osutils.pathjoin(dir, name)
57
self.addCleanup(osutils.rmtree, plugin_dir)
58
self.create_plugin(name, source, dir=plugin_dir,
59
file_name='__init__.py')
61
def _unregister_plugin(self, name):
62
"""Remove the plugin from sys.modules and the bzrlib namespace."""
63
py_name = 'bzrlib.plugins.%s' % name
64
if py_name in sys.modules:
65
del sys.modules[py_name]
66
if getattr(bzrlib.plugins, name, None) is not None:
67
delattr(bzrlib.plugins, name)
69
def assertPluginUnknown(self, name):
70
self.failIf(getattr(bzrlib.plugins, name, None) is not None)
71
self.failIf('bzrlib.plugins.%s' % name in sys.modules)
73
def assertPluginKnown(self, name):
74
self.failUnless(getattr(bzrlib.plugins, name, None) is not None)
75
self.failUnless('bzrlib.plugins.%s' % name in sys.modules)
78
class TestLoadingPlugins(tests.TestCaseInTempDir, TestPluginMixin):
82
def test_plugins_with_the_same_name_are_not_loaded(self):
83
# This test tests that having two plugins in different directories does
84
# not result in both being loaded when they have the same name. get a
85
# file name we can use which is also a valid attribute for accessing in
86
# activeattributes. - we cannot give import parameters.
88
self.failIf(tempattribute in self.activeattributes)
89
# set a place for the plugins to record their loading, and at the same
90
# time validate that the location the plugins should record to is
92
self.__class__.activeattributes [tempattribute] = []
93
self.failUnless(tempattribute in self.activeattributes)
94
# create two plugin directories
97
# write a plugin that will record when its loaded in the
99
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
100
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
102
outfile = open(os.path.join('first', 'plugin.py'), 'w')
104
outfile.write(template % (tempattribute, 'first'))
109
outfile = open(os.path.join('second', 'plugin.py'), 'w')
111
outfile.write(template % (tempattribute, 'second'))
117
bzrlib.plugin.load_from_path(['first', 'second'])
118
self.assertEqual(['first'], self.activeattributes[tempattribute])
120
# remove the plugin 'plugin'
121
del self.activeattributes[tempattribute]
122
self._unregister_plugin('plugin')
123
self.assertPluginUnknown('plugin')
125
def test_plugins_from_different_dirs_can_demand_load(self):
126
self.failIf('bzrlib.plugins.pluginone' in sys.modules)
127
self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
128
# This test tests that having two plugins in different
129
# directories with different names allows them both to be loaded, when
130
# we do a direct import statement.
131
# Determine a file name we can use which is also a valid attribute
132
# for accessing in activeattributes. - we cannot give import parameters.
133
tempattribute = "different-dirs"
134
self.failIf(tempattribute in self.activeattributes)
135
# set a place for the plugins to record their loading, and at the same
136
# time validate that the location the plugins should record to is
138
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
140
self.failUnless(tempattribute in self.activeattributes)
141
# create two plugin directories
144
# write plugins that will record when they are loaded in the
145
# tempattribute list.
146
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
147
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
149
outfile = open(os.path.join('first', 'pluginone.py'), 'w')
151
outfile.write(template % (tempattribute, 'first'))
156
outfile = open(os.path.join('second', 'plugintwo.py'), 'w')
158
outfile.write(template % (tempattribute, 'second'))
163
oldpath = bzrlib.plugins.__path__
165
self.failIf('bzrlib.plugins.pluginone' in sys.modules)
166
self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
167
bzrlib.plugins.__path__ = ['first', 'second']
168
exec "import bzrlib.plugins.pluginone"
169
self.assertEqual(['first'], self.activeattributes[tempattribute])
170
exec "import bzrlib.plugins.plugintwo"
171
self.assertEqual(['first', 'second'],
172
self.activeattributes[tempattribute])
174
# remove the plugin 'plugin'
175
del self.activeattributes[tempattribute]
176
self._unregister_plugin('pluginone')
177
self._unregister_plugin('plugintwo')
178
self.assertPluginUnknown('pluginone')
179
self.assertPluginUnknown('plugintwo')
181
def test_plugins_can_load_from_directory_with_trailing_slash(self):
182
# This test tests that a plugin can load from a directory when the
183
# directory in the path has a trailing slash.
184
# check the plugin is not loaded already
185
self.assertPluginUnknown('ts_plugin')
186
tempattribute = "trailing-slash"
187
self.failIf(tempattribute in self.activeattributes)
188
# set a place for the plugin to record its loading, and at the same
189
# time validate that the location the plugin should record to is
191
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
193
self.failUnless(tempattribute in self.activeattributes)
194
# create a directory for the plugin
195
os.mkdir('plugin_test')
196
# write a plugin that will record when its loaded in the
197
# tempattribute list.
198
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
199
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
201
outfile = open(os.path.join('plugin_test', 'ts_plugin.py'), 'w')
203
outfile.write(template % (tempattribute, 'plugin'))
209
bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
210
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
212
del self.activeattributes[tempattribute]
213
self._unregister_plugin('ts_plugin')
214
self.assertPluginUnknown('ts_plugin')
216
def load_and_capture(self, name):
217
"""Load plugins from '.' capturing the output.
219
:param name: The name of the plugin.
220
:return: A string with the log from the plugin loading call.
225
handler = logging.StreamHandler(stream)
226
log = logging.getLogger('bzr')
227
log.addHandler(handler)
230
bzrlib.plugin.load_from_path(['.'])
232
if 'bzrlib.plugins.%s' % name in sys.modules:
233
del sys.modules['bzrlib.plugins.%s' % name]
234
if getattr(bzrlib.plugins, name, None):
235
delattr(bzrlib.plugins, name)
237
# Stop capturing output
240
log.removeHandler(handler)
241
return stream.getvalue()
245
def test_plugin_with_bad_api_version_reports(self):
246
# This plugin asks for bzrlib api version 1.0.0, which is not supported
251
f.write("import bzrlib.api\n"
252
"bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
256
log = self.load_and_capture(name)
257
self.assertContainsRe(log,
258
r"It requested API version")
260
def test_plugin_with_bad_name_does_not_load(self):
261
# The file name here invalid for a python module.
262
name = 'bzr-bad plugin-name..py'
263
file(name, 'w').close()
264
log = self.load_and_capture(name)
265
self.assertContainsRe(log,
266
r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
267
"because the file path isn't a valid module name; try renaming "
268
"it to 'bad_plugin_name_'\.")
271
class TestPlugins(tests.TestCaseInTempDir, TestPluginMixin):
273
def setup_plugin(self, source=""):
274
# This test tests a new plugin appears in bzrlib.plugin.plugins().
275
# check the plugin is not loaded already
276
self.assertPluginUnknown('plugin')
277
# write a plugin that _cannot_ fail to load.
278
file('plugin.py', 'w').write(source + '\n')
279
self.addCleanup(self.teardown_plugin)
280
plugin.load_from_path(['.'])
282
def teardown_plugin(self):
283
self._unregister_plugin('plugin')
284
self.assertPluginUnknown('plugin')
286
def test_plugin_appears_in_plugins(self):
288
self.assertPluginKnown('plugin')
289
p = plugin.plugins()['plugin']
290
self.assertIsInstance(p, bzrlib.plugin.PlugIn)
291
self.assertEqual(p.module, plugins.plugin)
293
def test_trivial_plugin_get_path(self):
295
p = plugin.plugins()['plugin']
296
plugin_path = self.test_dir + '/plugin.py'
297
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
299
def test_plugin_get_path_py_not_pyc(self):
300
# first import creates plugin.pyc
302
self.teardown_plugin()
303
plugin.load_from_path(['.']) # import plugin.pyc
304
p = plugin.plugins()['plugin']
305
plugin_path = self.test_dir + '/plugin.py'
306
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
308
def test_plugin_get_path_pyc_only(self):
309
# first import creates plugin.pyc (or plugin.pyo depending on __debug__)
311
self.teardown_plugin()
312
os.unlink(self.test_dir + '/plugin.py')
313
plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
314
p = plugin.plugins()['plugin']
316
plugin_path = self.test_dir + '/plugin.pyc'
318
plugin_path = self.test_dir + '/plugin.pyo'
319
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
321
def test_no_test_suite_gives_None_for_test_suite(self):
323
p = plugin.plugins()['plugin']
324
self.assertEqual(None, p.test_suite())
326
def test_test_suite_gives_test_suite_result(self):
327
source = """def test_suite(): return 'foo'"""
328
self.setup_plugin(source)
329
p = plugin.plugins()['plugin']
330
self.assertEqual('foo', p.test_suite())
332
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
334
loader = tests.TestUtil.TestLoader()
335
p = plugin.plugins()['plugin']
336
self.assertEqual(None, p.load_plugin_tests(loader))
338
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
340
def load_tests(standard_tests, module, loader):
342
self.setup_plugin(source)
343
loader = tests.TestUtil.TestLoader()
344
p = plugin.plugins()['plugin']
345
self.assertEqual('foo', p.load_plugin_tests(loader))
347
def check_version_info(self, expected, source='', name='plugin'):
348
self.setup_plugin(source)
349
self.assertEqual(expected, plugin.plugins()[name].version_info())
351
def test_no_version_info(self):
352
self.check_version_info(None)
354
def test_with_version_info(self):
355
self.check_version_info((1, 2, 3, 'dev', 4),
356
"version_info = (1, 2, 3, 'dev', 4)")
358
def test_short_version_info_gets_padded(self):
359
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
361
self.check_version_info((1, 2, 3, 'final', 0),
362
"version_info = (1, 2, 3)")
364
def check_version(self, expected, source=None, name='plugin'):
365
self.setup_plugin(source)
366
self.assertEqual(expected, plugins[name].__version__)
368
def test_no_version_info___version__(self):
370
plugin = bzrlib.plugin.plugins()['plugin']
371
self.assertEqual("unknown", plugin.__version__)
373
def test_str__version__with_version_info(self):
374
self.setup_plugin("version_info = '1.2.3'")
375
plugin = bzrlib.plugin.plugins()['plugin']
376
self.assertEqual("1.2.3", plugin.__version__)
378
def test_noniterable__version__with_version_info(self):
379
self.setup_plugin("version_info = (1)")
380
plugin = bzrlib.plugin.plugins()['plugin']
381
self.assertEqual("1", plugin.__version__)
383
def test_1__version__with_version_info(self):
384
self.setup_plugin("version_info = (1,)")
385
plugin = bzrlib.plugin.plugins()['plugin']
386
self.assertEqual("1", plugin.__version__)
388
def test_1_2__version__with_version_info(self):
389
self.setup_plugin("version_info = (1, 2)")
390
plugin = bzrlib.plugin.plugins()['plugin']
391
self.assertEqual("1.2", plugin.__version__)
393
def test_1_2_3__version__with_version_info(self):
394
self.setup_plugin("version_info = (1, 2, 3)")
395
plugin = bzrlib.plugin.plugins()['plugin']
396
self.assertEqual("1.2.3", plugin.__version__)
398
def test_candidate__version__with_version_info(self):
399
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
400
plugin = bzrlib.plugin.plugins()['plugin']
401
self.assertEqual("1.2.3rc1", plugin.__version__)
403
def test_dev__version__with_version_info(self):
404
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
405
plugin = bzrlib.plugin.plugins()['plugin']
406
self.assertEqual("1.2.3dev", plugin.__version__)
408
def test_dev_fallback__version__with_version_info(self):
409
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
410
plugin = bzrlib.plugin.plugins()['plugin']
411
self.assertEqual("1.2.3dev4", plugin.__version__)
413
def test_final__version__with_version_info(self):
414
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
415
plugin = bzrlib.plugin.plugins()['plugin']
416
self.assertEqual("1.2.3", plugin.__version__)
418
def test_final_fallback__version__with_version_info(self):
419
self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
420
plugin = bzrlib.plugin.plugins()['plugin']
421
self.assertEqual("1.2.3.final.2", plugin.__version__)
424
class TestPluginHelp(tests.TestCaseInTempDir):
426
def split_help_commands(self):
429
out, err = self.run_bzr('--no-plugins help commands')
430
for line in out.splitlines():
431
if not line.startswith(' '):
432
current = line.split()[0]
433
help[current] = help.get(current, '') + line
437
def test_plugin_help_builtins_unaffected(self):
438
# Check we don't get false positives
439
help_commands = self.split_help_commands()
440
for cmd_name in bzrlib.commands.builtin_command_names():
441
if cmd_name in bzrlib.commands.plugin_command_names():
444
help = bzrlib.commands.get_cmd_object(cmd_name).get_help_text()
445
except NotImplementedError:
446
# some commands have no help
449
self.assertNotContainsRe(help, 'plugin "[^"]*"')
451
if cmd_name in help_commands.keys():
452
# some commands are hidden
453
help = help_commands[cmd_name]
454
self.assertNotContainsRe(help, 'plugin "[^"]*"')
456
def test_plugin_help_shows_plugin(self):
457
# Create a test plugin
458
os.mkdir('plugin_test')
459
f = open(osutils.pathjoin('plugin_test', 'myplug.py'), 'w')
461
from bzrlib import commands
462
class cmd_myplug(commands.Command):
463
'''Just a simple test plugin.'''
466
print 'Hello from my plugin'
474
bzrlib.plugin.load_from_path(['plugin_test'])
475
bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
476
help = self.run_bzr('help myplug')[0]
477
self.assertContainsRe(help, 'plugin "myplug"')
478
help = self.split_help_commands()['myplug']
479
self.assertContainsRe(help, '\[myplug\]')
482
if 'myplug' in bzrlib.commands.plugin_cmds:
483
bzrlib.commands.plugin_cmds.remove('myplug')
484
# remove the plugin 'myplug'
485
if getattr(bzrlib.plugins, 'myplug', None):
486
delattr(bzrlib.plugins, 'myplug')
489
class TestHelpIndex(tests.TestCase):
490
"""Tests for the PluginsHelpIndex class."""
492
def test_default_constructable(self):
493
index = plugin.PluginsHelpIndex()
495
def test_get_topics_None(self):
496
"""Searching for None returns an empty list."""
497
index = plugin.PluginsHelpIndex()
498
self.assertEqual([], index.get_topics(None))
500
def test_get_topics_for_plugin(self):
501
"""Searching for plugin name gets its docstring."""
502
index = plugin.PluginsHelpIndex()
503
# make a new plugin here for this test, even if we're run with
505
self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
506
demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
507
sys.modules['bzrlib.plugins.demo_module'] = demo_module
509
topics = index.get_topics('demo_module')
510
self.assertEqual(1, len(topics))
511
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
512
self.assertEqual(demo_module, topics[0].module)
514
del sys.modules['bzrlib.plugins.demo_module']
516
def test_get_topics_no_topic(self):
517
"""Searching for something that is not a plugin returns []."""
518
# test this by using a name that cannot be a plugin - its not
519
# a valid python identifier.
520
index = plugin.PluginsHelpIndex()
521
self.assertEqual([], index.get_topics('nothing by this name'))
523
def test_prefix(self):
524
"""PluginsHelpIndex has a prefix of 'plugins/'."""
525
index = plugin.PluginsHelpIndex()
526
self.assertEqual('plugins/', index.prefix)
528
def test_get_plugin_topic_with_prefix(self):
529
"""Searching for plugins/demo_module returns help."""
530
index = plugin.PluginsHelpIndex()
531
self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
532
demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
533
sys.modules['bzrlib.plugins.demo_module'] = demo_module
535
topics = index.get_topics('plugins/demo_module')
536
self.assertEqual(1, len(topics))
537
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
538
self.assertEqual(demo_module, topics[0].module)
540
del sys.modules['bzrlib.plugins.demo_module']
543
class FakeModule(object):
544
"""A fake module to test with."""
546
def __init__(self, doc, name):
551
class TestModuleHelpTopic(tests.TestCase):
552
"""Tests for the ModuleHelpTopic class."""
554
def test_contruct(self):
555
"""Construction takes the module to document."""
556
mod = FakeModule('foo', 'foo')
557
topic = plugin.ModuleHelpTopic(mod)
558
self.assertEqual(mod, topic.module)
560
def test_get_help_text_None(self):
561
"""A ModuleHelpTopic returns the docstring for get_help_text."""
562
mod = FakeModule(None, 'demo')
563
topic = plugin.ModuleHelpTopic(mod)
564
self.assertEqual("Plugin 'demo' has no docstring.\n",
565
topic.get_help_text())
567
def test_get_help_text_no_carriage_return(self):
568
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
569
mod = FakeModule('one line of help', 'demo')
570
topic = plugin.ModuleHelpTopic(mod)
571
self.assertEqual("one line of help\n",
572
topic.get_help_text())
574
def test_get_help_text_carriage_return(self):
575
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
576
mod = FakeModule('two lines of help\nand more\n', 'demo')
577
topic = plugin.ModuleHelpTopic(mod)
578
self.assertEqual("two lines of help\nand more\n",
579
topic.get_help_text())
581
def test_get_help_text_with_additional_see_also(self):
582
mod = FakeModule('two lines of help\nand more', 'demo')
583
topic = plugin.ModuleHelpTopic(mod)
584
self.assertEqual("two lines of help\nand more\nSee also: bar, foo\n",
585
topic.get_help_text(['foo', 'bar']))
587
def test_get_help_topic(self):
588
"""The help topic for a plugin is its module name."""
589
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.demo')
590
topic = plugin.ModuleHelpTopic(mod)
591
self.assertEqual('demo', topic.get_help_topic())
592
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
593
topic = plugin.ModuleHelpTopic(mod)
594
self.assertEqual('foo_bar', topic.get_help_topic())
597
class TestLoadFromPath(tests.TestCaseInTempDir):
600
super(TestLoadFromPath, self).setUp()
601
# Change bzrlib.plugin to think no plugins have been loaded yet.
602
self.overrideAttr(bzrlib.plugins, '__path__', [])
603
self.overrideAttr(plugin, '_loaded', False)
605
# Monkey-patch load_from_path to stop it from actually loading anything.
606
self.overrideAttr(plugin, 'load_from_path', lambda dirs: None)
608
def test_set_plugins_path_with_args(self):
609
plugin.set_plugins_path(['a', 'b'])
610
self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
612
def test_set_plugins_path_defaults(self):
613
plugin.set_plugins_path()
614
self.assertEqual(plugin.get_standard_plugins_path(),
615
bzrlib.plugins.__path__)
617
def test_get_standard_plugins_path(self):
618
path = plugin.get_standard_plugins_path()
619
for directory in path:
620
self.assertNotContainsRe(directory, r'\\/$')
622
from distutils.sysconfig import get_python_lib
626
if sys.platform != 'win32':
627
python_lib = get_python_lib()
628
for directory in path:
629
if directory.startswith(python_lib):
632
self.fail('No path to global plugins')
634
def test_get_standard_plugins_path_env(self):
635
os.environ['BZR_PLUGIN_PATH'] = 'foo/'
636
path = plugin.get_standard_plugins_path()
637
for directory in path:
638
self.assertNotContainsRe(directory, r'\\/$')
640
def test_load_plugins(self):
641
plugin.load_plugins(['.'])
642
self.assertEqual(bzrlib.plugins.__path__, ['.'])
643
# subsequent loads are no-ops
644
plugin.load_plugins(['foo'])
645
self.assertEqual(bzrlib.plugins.__path__, ['.'])
647
def test_load_plugins_default(self):
648
plugin.load_plugins()
649
path = plugin.get_standard_plugins_path()
650
self.assertEqual(path, bzrlib.plugins.__path__)
653
class TestEnvPluginPath(tests.TestCase):
656
super(TestEnvPluginPath, self).setUp()
657
self.overrideAttr(plugin, 'DEFAULT_PLUGIN_PATH', None)
659
self.user = plugin.get_user_plugin_path()
660
self.site = plugin.get_site_plugin_path()
661
self.core = plugin.get_core_plugin_path()
663
def _list2paths(self, *args):
666
plugin._append_new_path(paths, p)
669
def _set_path(self, *args):
670
path = os.pathsep.join(self._list2paths(*args))
671
osutils.set_or_unset_env('BZR_PLUGIN_PATH', path)
673
def check_path(self, expected_dirs, setting_dirs):
675
self._set_path(*setting_dirs)
676
actual = plugin.get_standard_plugins_path()
677
self.assertEquals(self._list2paths(*expected_dirs), actual)
679
def test_default(self):
680
self.check_path([self.user, self.core, self.site],
683
def test_adhoc_policy(self):
684
self.check_path([self.user, self.core, self.site],
685
['+user', '+core', '+site'])
687
def test_fallback_policy(self):
688
self.check_path([self.core, self.site, self.user],
689
['+core', '+site', '+user'])
691
def test_override_policy(self):
692
self.check_path([self.user, self.site, self.core],
693
['+user', '+site', '+core'])
695
def test_disable_user(self):
696
self.check_path([self.core, self.site], ['-user'])
698
def test_disable_user_twice(self):
699
# Ensures multiple removals don't left cruft
700
self.check_path([self.core, self.site], ['-user', '-user'])
702
def test_duplicates_are_removed(self):
703
self.check_path([self.user, self.core, self.site],
705
# And only the first reference is kept (since the later references will
706
# only produce '<plugin> already loaded' mutters)
707
self.check_path([self.user, self.core, self.site],
708
['+user', '+user', '+core',
709
'+user', '+site', '+site',
712
def test_disable_overrides_enable(self):
713
self.check_path([self.core, self.site], ['-user', '+user'])
715
def test_disable_core(self):
716
self.check_path([self.site], ['-core'])
717
self.check_path([self.user, self.site], ['+user', '-core'])
719
def test_disable_site(self):
720
self.check_path([self.core], ['-site'])
721
self.check_path([self.user, self.core], ['-site', '+user'])
723
def test_override_site(self):
724
self.check_path(['mysite', self.user, self.core],
725
['mysite', '-site', '+user'])
726
self.check_path(['mysite', self.core],
729
def test_override_core(self):
730
self.check_path(['mycore', self.user, self.site],
731
['mycore', '-core', '+user', '+site'])
732
self.check_path(['mycore', self.site],
735
def test_my_plugin_only(self):
736
self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
738
def test_my_plugin_first(self):
739
self.check_path(['myplugin', self.core, self.site, self.user],
740
['myplugin', '+core', '+site', '+user'])
742
def test_bogus_references(self):
743
self.check_path(['+foo', '-bar', self.core, self.site],
747
class TestDisablePlugin(tests.TestCaseInTempDir, TestPluginMixin):
750
super(TestDisablePlugin, self).setUp()
751
self.create_plugin_package('test_foo')
752
# Make sure we don't pollute the plugins namespace
753
self.overrideAttr(plugins, '__path__')
754
# Be paranoid in case a test fail
755
self.addCleanup(self._unregister_plugin, 'test_foo')
757
def test_cannot_import(self):
758
osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
759
plugin.set_plugins_path(['.'])
761
import bzrlib.plugins.test_foo
764
self.assertPluginUnknown('test_foo')
766
def test_regular_load(self):
767
self.overrideAttr(plugin, '_loaded', False)
768
plugin.load_plugins(['.'])
769
self.assertPluginKnown('test_foo')
771
def test_not_loaded(self):
773
def captured_warning(*args, **kwargs):
774
self.warnings.append((args, kwargs))
775
self.overrideAttr(trace, 'warning', captured_warning)
776
self.overrideAttr(plugin, '_loaded', False)
777
osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
778
plugin.load_plugins(plugin.set_plugins_path(['.']))
779
self.assertPluginUnknown('test_foo')
780
# Make sure we don't warn about the plugin ImportError since this has
781
# been *requested* by the user.
782
self.assertLength(0, self.warnings)
added
removed
bzrlib/tests/test_plugins.py
