193
192
del bzrlib.plugins.ts_plugin
194
193
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()
195
def load_and_capture(self, name):
196
"""Load plugins from '.' capturing the output.
198
:param name: The name of the plugin.
199
:return: A string with the log from the plugin loading call.
201
202
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(),
204
handler = logging.StreamHandler(stream)
205
log = logging.getLogger('bzr')
206
log.addHandler(handler)
209
bzrlib.plugin.load_from_path(['.'])
211
if 'bzrlib.plugins.%s' % name in sys.modules:
212
del sys.modules['bzrlib.plugins.%s' % name]
213
if getattr(bzrlib.plugins, name, None):
214
delattr(bzrlib.plugins, name)
216
# Stop capturing output
219
log.removeHandler(handler)
220
return stream.getvalue()
224
def test_plugin_with_bad_api_version_reports(self):
225
# This plugin asks for bzrlib api version 1.0.0, which is not supported
230
f.write("import bzrlib.api\n"
231
"bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
235
log = self.load_and_capture(name)
236
self.assertContainsRe(log,
237
r"It requested API version")
239
def test_plugin_with_bad_name_does_not_load(self):
240
# The file name here invalid for a python module.
241
name = 'bzr-bad plugin-name..py'
242
file(name, 'w').close()
243
log = self.load_and_capture(name)
244
self.assertContainsRe(log,
214
245
r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
215
246
"because the file path isn't a valid module name; try renaming "
216
247
"it to 'bad_plugin_name_'\.")
221
250
class TestPlugins(TestCaseInTempDir):
323
352
plugin = bzrlib.plugin.plugins()['plugin']
324
353
self.assertEqual("unknown", plugin.__version__)
326
def test___version__with_version_info(self):
355
def test_str__version__with_version_info(self):
356
self.setup_plugin("version_info = '1.2.3'")
357
plugin = bzrlib.plugin.plugins()['plugin']
358
self.assertEqual("1.2.3", plugin.__version__)
360
def test_noniterable__version__with_version_info(self):
361
self.setup_plugin("version_info = (1)")
362
plugin = bzrlib.plugin.plugins()['plugin']
363
self.assertEqual("1", plugin.__version__)
365
def test_1__version__with_version_info(self):
366
self.setup_plugin("version_info = (1,)")
367
plugin = bzrlib.plugin.plugins()['plugin']
368
self.assertEqual("1", plugin.__version__)
370
def test_1_2__version__with_version_info(self):
371
self.setup_plugin("version_info = (1, 2)")
372
plugin = bzrlib.plugin.plugins()['plugin']
373
self.assertEqual("1.2", plugin.__version__)
375
def test_1_2_3__version__with_version_info(self):
376
self.setup_plugin("version_info = (1, 2, 3)")
377
plugin = bzrlib.plugin.plugins()['plugin']
378
self.assertEqual("1.2.3", plugin.__version__)
380
def test_candidate__version__with_version_info(self):
381
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
382
plugin = bzrlib.plugin.plugins()['plugin']
383
self.assertEqual("1.2.3rc1", plugin.__version__)
385
def test_dev__version__with_version_info(self):
386
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
387
plugin = bzrlib.plugin.plugins()['plugin']
388
self.assertEqual("1.2.3dev", plugin.__version__)
390
def test_dev_fallback__version__with_version_info(self):
327
391
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
328
392
plugin = bzrlib.plugin.plugins()['plugin']
329
self.assertEqual("1.2.3dev4", plugin.__version__)
393
self.assertEqual("1.2.3.dev.4", plugin.__version__)
331
395
def test_final__version__with_version_info(self):
332
self.setup_plugin("version_info = (1, 2, 3, 'final', 4)")
396
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
333
397
plugin = bzrlib.plugin.plugins()['plugin']
334
398
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')
392
class TestPluginFromZip(TestCaseInTempDir):
394
def make_zipped_plugin(self, zip_name, filename):
395
z = zipfile.ZipFile(zip_name, 'w')
396
z.writestr(filename, PLUGIN_TEXT)
399
def check_plugin_load(self, zip_name, plugin_name):
400
self.assertFalse(plugin_name in dir(bzrlib.plugins),
401
'Plugin already loaded')
402
old_path = bzrlib.plugins.__path__
404
# this is normally done by load_plugins -> set_plugins_path
405
bzrlib.plugins.__path__ = [zip_name]
406
self.applyDeprecated(one_three,
407
bzrlib.plugin.load_from_zip, zip_name)
408
self.assertTrue(plugin_name in dir(bzrlib.plugins),
409
'Plugin is not loaded')
412
if getattr(bzrlib.plugins, plugin_name, None):
413
delattr(bzrlib.plugins, plugin_name)
414
del sys.modules['bzrlib.plugins.' + plugin_name]
415
bzrlib.plugins.__path__ = old_path
417
def test_load_module(self):
418
self.make_zipped_plugin('./test.zip', 'ziplug.py')
419
self.check_plugin_load('./test.zip', 'ziplug')
421
def test_load_package(self):
422
self.make_zipped_plugin('./test.zip', 'ziplug/__init__.py')
423
self.check_plugin_load('./test.zip', 'ziplug')
426
457
class TestSetPluginsPath(TestCase):
428
459
def test_set_plugins_path(self):
429
460
"""set_plugins_path should set the module __path__ correctly."""
430
461
old_path = bzrlib.plugins.__path__
445
476
os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
447
478
bzrlib.plugin.set_plugins_path()
448
expected_path = ['first', 'second',
449
os.path.dirname(bzrlib.plugins.__file__)]
479
# We expect our nominated paths to have all path-seps removed,
480
# and this is testing only that.
481
expected_path = ['first', 'second']
450
482
self.assertEqual(expected_path,
451
483
bzrlib.plugins.__path__[:len(expected_path)])
563
595
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
564
596
topic = plugin.ModuleHelpTopic(mod)
565
597
self.assertEqual('foo_bar', topic.get_help_topic())
600
def clear_plugins(test_case):
601
# Save the attributes that we're about to monkey-patch.
602
old_plugins_path = bzrlib.plugins.__path__
603
old_loaded = plugin._loaded
604
old_load_from_path = plugin.load_from_path
605
# Change bzrlib.plugin to think no plugins have been loaded yet.
606
bzrlib.plugins.__path__ = []
607
plugin._loaded = False
608
# Monkey-patch load_from_path to stop it from actually loading anything.
609
def load_from_path(dirs):
611
plugin.load_from_path = load_from_path
612
def restore_plugins():
613
bzrlib.plugins.__path__ = old_plugins_path
614
plugin._loaded = old_loaded
615
plugin.load_from_path = old_load_from_path
616
test_case.addCleanup(restore_plugins)
619
class TestPluginPaths(tests.TestCase):
621
def test_set_plugins_path_with_args(self):
623
plugin.set_plugins_path(['a', 'b'])
624
self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
626
def test_set_plugins_path_defaults(self):
628
plugin.set_plugins_path()
629
self.assertEqual(plugin.get_standard_plugins_path(),
630
bzrlib.plugins.__path__)
632
def test_get_standard_plugins_path(self):
633
path = plugin.get_standard_plugins_path()
634
self.assertEqual(plugin.get_default_plugin_path(), path[0])
635
for directory in path:
636
self.assertNotContainsRe(r'\\/$', directory)
638
from distutils.sysconfig import get_python_lib
642
if sys.platform != 'win32':
643
python_lib = get_python_lib()
644
for directory in path:
645
if directory.startswith(python_lib):
648
self.fail('No path to global plugins')
650
def test_get_standard_plugins_path_env(self):
651
os.environ['BZR_PLUGIN_PATH'] = 'foo/'
652
self.assertEqual('foo', plugin.get_standard_plugins_path()[0])
655
class TestLoadPlugins(tests.TestCaseInTempDir):
657
def test_load_plugins(self):
659
plugin.load_plugins(['.'])
660
self.assertEqual(bzrlib.plugins.__path__, ['.'])
661
# subsequent loads are no-ops
662
plugin.load_plugins(['foo'])
663
self.assertEqual(bzrlib.plugins.__path__, ['.'])
665
def test_load_plugins_default(self):
667
plugin.load_plugins()
668
path = plugin.get_standard_plugins_path()
669
self.assertEqual(path, bzrlib.plugins.__path__)