193
193
del bzrlib.plugins.ts_plugin
194
194
self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
196
def test_plugin_with_bad_name_does_not_load(self):
197
# Create badly-named plugin
198
file('bzr-bad plugin-name..py', 'w').close()
196
def load_and_capture(self, name):
197
"""Load plugins from '.' capturing the output.
199
:param name: The name of the plugin.
200
:return: A string with the log from the plugin loading call.
201
203
stream = StringIO()
202
handler = logging.StreamHandler(stream)
203
log = logging.getLogger('bzr')
204
log.addHandler(handler)
206
bzrlib.plugin.load_from_dir('.')
208
# Stop capturing output
211
log.removeHandler(handler)
213
self.assertContainsRe(stream.getvalue(),
205
handler = logging.StreamHandler(stream)
206
log = logging.getLogger('bzr')
207
log.addHandler(handler)
210
bzrlib.plugin.load_from_path(['.'])
212
if 'bzrlib.plugins.%s' % name in sys.modules:
213
del sys.modules['bzrlib.plugins.%s' % name]
214
if getattr(bzrlib.plugins, name, None):
215
delattr(bzrlib.plugins, name)
217
# Stop capturing output
220
log.removeHandler(handler)
221
return stream.getvalue()
225
def test_plugin_with_bad_api_version_reports(self):
226
# This plugin asks for bzrlib api version 1.0.0, which is not supported
231
f.write("import bzrlib.api\n"
232
"bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
236
log = self.load_and_capture(name)
237
self.assertContainsRe(log,
238
r"It requested API version")
240
def test_plugin_with_bad_name_does_not_load(self):
241
# The file name here invalid for a python module.
242
name = 'bzr-bad plugin-name..py'
243
file(name, 'w').close()
244
log = self.load_and_capture(name)
245
self.assertContainsRe(log,
214
246
r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
215
247
"because the file path isn't a valid module name; try renaming "
216
248
"it to 'bad_plugin_name_'\.")
221
251
class TestPlugins(TestCaseInTempDir):
323
353
plugin = bzrlib.plugin.plugins()['plugin']
324
354
self.assertEqual("unknown", plugin.__version__)
326
def test___version__with_version_info(self):
356
def test_str__version__with_version_info(self):
357
self.setup_plugin("version_info = '1.2.3'")
358
plugin = bzrlib.plugin.plugins()['plugin']
359
self.assertEqual("1.2.3", plugin.__version__)
361
def test_noniterable__version__with_version_info(self):
362
self.setup_plugin("version_info = (1)")
363
plugin = bzrlib.plugin.plugins()['plugin']
364
self.assertEqual("1", plugin.__version__)
366
def test_1__version__with_version_info(self):
367
self.setup_plugin("version_info = (1,)")
368
plugin = bzrlib.plugin.plugins()['plugin']
369
self.assertEqual("1", plugin.__version__)
371
def test_1_2__version__with_version_info(self):
372
self.setup_plugin("version_info = (1, 2)")
373
plugin = bzrlib.plugin.plugins()['plugin']
374
self.assertEqual("1.2", plugin.__version__)
376
def test_1_2_3__version__with_version_info(self):
377
self.setup_plugin("version_info = (1, 2, 3)")
378
plugin = bzrlib.plugin.plugins()['plugin']
379
self.assertEqual("1.2.3", plugin.__version__)
381
def test_candidate__version__with_version_info(self):
382
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
383
plugin = bzrlib.plugin.plugins()['plugin']
384
self.assertEqual("1.2.3rc1", plugin.__version__)
386
def test_dev__version__with_version_info(self):
387
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
388
plugin = bzrlib.plugin.plugins()['plugin']
389
self.assertEqual("1.2.3dev", plugin.__version__)
391
def test_dev_fallback__version__with_version_info(self):
327
392
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
328
393
plugin = bzrlib.plugin.plugins()['plugin']
329
self.assertEqual("1.2.3dev4", plugin.__version__)
394
self.assertEqual("1.2.3.dev.4", plugin.__version__)
331
396
def test_final__version__with_version_info(self):
332
self.setup_plugin("version_info = (1, 2, 3, 'final', 4)")
397
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
333
398
plugin = bzrlib.plugin.plugins()['plugin']
334
399
self.assertEqual("1.2.3", plugin.__version__)
382
447
self.assertContainsRe(help, '\[myplug\]')
384
449
# unregister command
385
if bzrlib.commands.plugin_cmds.get('myplug', None):
386
del bzrlib.commands.plugin_cmds['myplug']
450
if 'myplug' in bzrlib.commands.plugin_cmds:
451
bzrlib.commands.plugin_cmds.remove('myplug')
387
452
# remove the plugin 'myplug'
388
453
if getattr(bzrlib.plugins, 'myplug', None):
389
454
delattr(bzrlib.plugins, 'myplug')
445
510
os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
447
512
bzrlib.plugin.set_plugins_path()
448
expected_path = ['first', 'second',
449
os.path.dirname(bzrlib.plugins.__file__)]
513
# We expect our nominated paths to have all path-seps removed,
514
# and this is testing only that.
515
expected_path = ['first', 'second']
450
516
self.assertEqual(expected_path,
451
517
bzrlib.plugins.__path__[:len(expected_path)])
563
629
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
564
630
topic = plugin.ModuleHelpTopic(mod)
565
631
self.assertEqual('foo_bar', topic.get_help_topic())
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)
644
class TestPluginPaths(tests.TestCase):
646
def test_set_plugins_path_with_args(self):
648
plugin.set_plugins_path(['a', 'b'])
649
self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
651
def test_set_plugins_path_defaults(self):
653
plugin.set_plugins_path()
654
self.assertEqual(plugin.get_standard_plugins_path(),
655
bzrlib.plugins.__path__)
657
def test_get_standard_plugins_path(self):
658
path = plugin.get_standard_plugins_path()
659
self.assertEqual(plugin.get_default_plugin_path(), path[0])
660
for directory in path:
661
self.assertNotContainsRe(r'\\/$', directory)
663
from distutils.sysconfig import get_python_lib
667
if sys.platform != 'win32':
668
python_lib = get_python_lib()
669
for directory in path:
670
if directory.startswith(python_lib):
673
self.fail('No path to global plugins')
675
def test_get_standard_plugins_path_env(self):
676
os.environ['BZR_PLUGIN_PATH'] = 'foo/'
677
self.assertEqual('foo', plugin.get_standard_plugins_path()[0])
680
class TestLoadPlugins(tests.TestCaseInTempDir):
682
def test_load_plugins(self):
684
plugin.load_plugins(['.'])
685
self.assertEqual(bzrlib.plugins.__path__, ['.'])
686
# subsequent loads are no-ops
687
plugin.load_plugins(['foo'])
688
self.assertEqual(bzrlib.plugins.__path__, ['.'])
690
def test_load_plugins_default(self):
692
plugin.load_plugins()
693
path = plugin.get_standard_plugins_path()
694
self.assertEqual(path, bzrlib.plugins.__path__)