20
20
# affects the global state of the process. See bzrlib/plugins.py for more
23
from cStringIO import StringIO
25
from StringIO import StringIO
29
29
from bzrlib import (
36
import bzrlib.commands
38
from bzrlib.tests import (
43
from bzrlib.osutils import pathjoin, abspath, normpath
47
import bzrlib.commands
48
class cmd_myplug(bzrlib.commands.Command):
49
'''Just a simple test plugin.'''
52
print 'Hello from my plugin'
55
38
# TODO: Write a test for plugin decoration of commands.
57
class TestLoadingPlugins(TestCaseInTempDir):
40
class TestPluginMixin(object):
42
def create_plugin(self, name, source=None, dir='.', file_name=None):
45
"""This is the doc for %s"""
48
file_name = name + '.py'
49
# 'source' must not fail to load
50
path = osutils.pathjoin(dir, file_name)
52
self.addCleanup(os.unlink, path)
54
f.write(source + '\n')
58
def create_plugin_package(self, name, dir=None, source=None):
63
"""This is the doc for %s"""
68
# Workaround lazy import random? madness
70
self.addCleanup(cleanup)
71
self.create_plugin(name, source, dir,
72
file_name='__init__.py')
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)
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)
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)
91
class TestLoadingPlugins(tests.TestCaseInTempDir, TestPluginMixin):
59
93
activeattributes = {}
251
281
"it to 'bad_plugin_name_'\.")
254
class TestPlugins(TestCaseInTempDir):
284
class TestPlugins(tests.TestCaseInTempDir, TestPluginMixin):
256
286
def setup_plugin(self, source=""):
257
287
# This test tests a new plugin appears in bzrlib.plugin.plugins().
258
288
# check the plugin is not loaded already
259
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
289
self.assertPluginUnknown('plugin')
260
290
# write a plugin that _cannot_ fail to load.
261
291
file('plugin.py', 'w').write(source + '\n')
262
292
self.addCleanup(self.teardown_plugin)
263
bzrlib.plugin.load_from_path(['.'])
293
plugin.load_from_path(['.'])
265
295
def teardown_plugin(self):
266
# remove the plugin 'plugin'
267
if 'bzrlib.plugins.plugin' in sys.modules:
268
del sys.modules['bzrlib.plugins.plugin']
269
if getattr(bzrlib.plugins, 'plugin', None):
270
del bzrlib.plugins.plugin
271
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
296
self._unregister_plugin('plugin')
297
self.assertPluginUnknown('plugin')
273
299
def test_plugin_appears_in_plugins(self):
274
300
self.setup_plugin()
275
self.failUnless('plugin' in bzrlib.plugin.plugins())
276
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
277
plugins = bzrlib.plugin.plugins()
278
plugin = plugins['plugin']
279
self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
280
self.assertEqual(bzrlib.plugins.plugin, plugin.module)
301
self.assertPluginKnown('plugin')
302
p = plugin.plugins()['plugin']
303
self.assertIsInstance(p, bzrlib.plugin.PlugIn)
304
self.assertEqual(p.module, plugins.plugin)
282
306
def test_trivial_plugin_get_path(self):
283
307
self.setup_plugin()
284
plugins = bzrlib.plugin.plugins()
285
plugin = plugins['plugin']
308
p = plugin.plugins()['plugin']
286
309
plugin_path = self.test_dir + '/plugin.py'
287
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
310
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
289
312
def test_plugin_get_path_py_not_pyc(self):
290
self.setup_plugin() # after first import there will be plugin.pyc
313
# first import creates plugin.pyc
291
315
self.teardown_plugin()
292
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
293
plugins = bzrlib.plugin.plugins()
294
plugin = plugins['plugin']
316
plugin.load_from_path(['.']) # import plugin.pyc
317
p = plugin.plugins()['plugin']
295
318
plugin_path = self.test_dir + '/plugin.py'
296
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
319
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
298
321
def test_plugin_get_path_pyc_only(self):
299
self.setup_plugin() # after first import there will be plugin.pyc
322
# first import creates plugin.pyc (or plugin.pyo depending on __debug__)
300
324
self.teardown_plugin()
301
325
os.unlink(self.test_dir + '/plugin.py')
302
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
303
plugins = bzrlib.plugin.plugins()
304
plugin = plugins['plugin']
326
plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
327
p = plugin.plugins()['plugin']
306
329
plugin_path = self.test_dir + '/plugin.pyc'
308
331
plugin_path = self.test_dir + '/plugin.pyo'
309
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
332
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
311
334
def test_no_test_suite_gives_None_for_test_suite(self):
312
335
self.setup_plugin()
313
plugin = bzrlib.plugin.plugins()['plugin']
314
self.assertEqual(None, plugin.test_suite())
336
p = plugin.plugins()['plugin']
337
self.assertEqual(None, p.test_suite())
316
339
def test_test_suite_gives_test_suite_result(self):
317
340
source = """def test_suite(): return 'foo'"""
318
341
self.setup_plugin(source)
319
plugin = bzrlib.plugin.plugins()['plugin']
320
self.assertEqual('foo', plugin.test_suite())
342
p = plugin.plugins()['plugin']
343
self.assertEqual('foo', p.test_suite())
322
345
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
323
346
self.setup_plugin()
324
loader = TestUtil.TestLoader()
325
plugin = bzrlib.plugin.plugins()['plugin']
326
self.assertEqual(None, plugin.load_plugin_tests(loader))
347
loader = tests.TestUtil.TestLoader()
348
p = plugin.plugins()['plugin']
349
self.assertEqual(None, p.load_plugin_tests(loader))
328
351
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
330
353
def load_tests(standard_tests, module, loader):
332
355
self.setup_plugin(source)
333
loader = TestUtil.TestLoader()
334
plugin = bzrlib.plugin.plugins()['plugin']
335
self.assertEqual('foo', plugin.load_plugin_tests(loader))
356
loader = tests.TestUtil.TestLoader()
357
p = plugin.plugins()['plugin']
358
self.assertEqual('foo', p.load_plugin_tests(loader))
360
def check_version_info(self, expected, source='', name='plugin'):
361
self.setup_plugin(source)
362
self.assertEqual(expected, plugin.plugins()[name].version_info())
337
364
def test_no_version_info(self):
339
plugin = bzrlib.plugin.plugins()['plugin']
340
self.assertEqual(None, plugin.version_info())
365
self.check_version_info(None)
342
367
def test_with_version_info(self):
343
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
344
plugin = bzrlib.plugin.plugins()['plugin']
345
self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
368
self.check_version_info((1, 2, 3, 'dev', 4),
369
"version_info = (1, 2, 3, 'dev', 4)")
347
371
def test_short_version_info_gets_padded(self):
348
372
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
350
self.setup_plugin("version_info = (1, 2, 3)")
351
plugin = bzrlib.plugin.plugins()['plugin']
352
self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
374
self.check_version_info((1, 2, 3, 'final', 0),
375
"version_info = (1, 2, 3)")
377
def check_version(self, expected, source=None, name='plugin'):
378
self.setup_plugin(source)
379
self.assertEqual(expected, plugins[name].__version__)
354
381
def test_no_version_info___version__(self):
355
382
self.setup_plugin()
719
755
def test_bogus_references(self):
720
756
self.check_path(['+foo', '-bar', self.core, self.site],
721
757
['+foo', '-bar'])
760
class TestDisablePlugin(tests.TestCaseInTempDir, TestPluginMixin):
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')
770
def test_cannot_import(self):
771
osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
772
plugin.set_plugins_path(['.'])
774
import bzrlib.plugins.test_foo
777
self.assertPluginUnknown('test_foo')
779
def test_regular_load(self):
780
self.overrideAttr(plugin, '_loaded', False)
781
plugin.load_plugins(['.'])
782
self.assertPluginKnown('test_foo')
783
self.assertEqual("This is the doc for test_foo",
784
bzrlib.plugins.test_foo.__doc__)
786
def test_not_loaded(self):
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)
801
class TestLoadPluginAt(tests.TestCaseInTempDir, TestPluginMixin):
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')
817
def assertTestFooLoadedFrom(self, path):
818
self.assertPluginKnown('test_foo')
819
self.assertEqual('This is the doc for test_foo',
820
bzrlib.plugins.test_foo.__doc__)
821
self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
823
def test_regular_load(self):
824
plugin.load_plugins(['standard'])
825
self.assertTestFooLoadedFrom('standard/test_foo')
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'])
831
import bzrlib.plugins.test_foo
834
self.assertTestFooLoadedFrom('non-standard-dir')
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')
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__)
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')
857
self.assertEqual('non-standard-dir/__init__.%s' % suffix,
858
bzrlib.plugins.test_foo.__file__)
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__)
872
def test_loading_from___init__only(self):
873
# We rename the existing __init__.py file to ensure that we don't load
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')
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)
888
"""This is the doc for %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)