80
79
if getattr(bzrlib.plugins, name, None) is not None:
81
80
delattr(bzrlib.plugins, name)
83
def _unregister_plugin_submodule(self, plugin_name, submodule_name):
84
"""Remove the submodule from sys.modules and the bzrlib namespace."""
85
py_name = 'bzrlib.plugins.%s.%s' % (plugin_name, submodule_name)
86
if py_name in sys.modules:
87
del sys.modules[py_name]
88
plugin = getattr(bzrlib.plugins, plugin_name, None)
89
if plugin is not None:
90
if getattr(plugin, submodule_name, None) is not None:
91
delattr(plugin, submodule_name)
93
82
def assertPluginUnknown(self, name):
94
83
self.failIf(getattr(bzrlib.plugins, name, None) is not None)
95
84
self.failIf('bzrlib.plugins.%s' % name in sys.modules)
485
474
from bzrlib import commands
486
475
class cmd_myplug(commands.Command):
487
__doc__ = '''Just a simple test plugin.'''
476
'''Just a simple test plugin.'''
488
477
aliases = ['mplg']
490
479
print 'Hello from my plugin'
791
780
self.overrideAttr(plugin, '_loaded', False)
792
781
plugin.load_plugins(['.'])
793
782
self.assertPluginKnown('test_foo')
794
self.assertDocstring("This is the doc for test_foo",
795
bzrlib.plugins.test_foo)
783
self.assertEqual("This is the doc for test_foo",
784
bzrlib.plugins.test_foo.__doc__)
797
786
def test_not_loaded(self):
798
787
self.warnings = []
809
798
self.assertLength(0, self.warnings)
812
class TestLoadPluginAtSyntax(tests.TestCase):
814
def _get_paths(self, paths):
815
return plugin._get_specific_plugin_paths(paths)
817
def test_empty(self):
818
self.assertEquals([], self._get_paths(None))
819
self.assertEquals([], self._get_paths(''))
821
def test_one_path(self):
822
self.assertEquals([('b', 'man')], self._get_paths('b@man'))
824
def test_bogus_path(self):
826
self.assertRaises(errors.BzrCommandError, self._get_paths, 'batman')
827
# Too much '@' isn't good either
828
self.assertRaises(errors.BzrCommandError, self._get_paths,
829
'batman@mobile@cave')
830
# An empty description probably indicates a problem
831
self.assertRaises(errors.BzrCommandError, self._get_paths,
832
os.pathsep.join(['batman@cave', '', 'robin@mobile']))
835
801
class TestLoadPluginAt(tests.TestCaseInTempDir, TestPluginMixin):
838
804
super(TestLoadPluginAt, self).setUp()
839
805
# Make sure we don't pollute the plugins namespace
840
806
self.overrideAttr(plugins, '__path__')
807
# Be paranoid in case a test fail
808
self.addCleanup(self._unregister_plugin, 'test_foo')
841
809
# Reset the flag that protect against double loading
842
810
self.overrideAttr(plugin, '_loaded', False)
843
811
# Create the same plugin in two directories
845
813
# The "normal" directory, we use 'standard' instead of 'plugins' to
846
814
# avoid depending on the precise naming.
847
815
self.create_plugin_package('test_foo', dir='standard/test_foo')
848
# All the tests will load the 'test_foo' plugin from various locations
849
self.addCleanup(self._unregister_plugin, 'test_foo')
851
817
def assertTestFooLoadedFrom(self, path):
852
818
self.assertPluginKnown('test_foo')
853
self.assertDocstring('This is the doc for test_foo',
854
bzrlib.plugins.test_foo)
819
self.assertEqual('This is the doc for test_foo',
820
bzrlib.plugins.test_foo.__doc__)
855
821
self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
857
823
def test_regular_load(self):
876
842
osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
877
843
plugin.load_plugins(['standard'])
878
844
self.assertTestFooLoadedFrom('non-standard-dir')
879
self.assertIsSameRealPath('non-standard-dir/__init__.py',
880
bzrlib.plugins.test_foo.__file__)
845
self.assertEqual('non-standard-dir/__init__.py',
846
bzrlib.plugins.test_foo.__file__)
882
848
# Try importing again now that the source has been compiled
883
849
self._unregister_plugin('test_foo')
891
self.assertIsSameRealPath('non-standard-dir/__init__.%s' % suffix,
892
bzrlib.plugins.test_foo.__file__)
857
self.assertEqual('non-standard-dir/__init__.%s' % suffix,
858
bzrlib.plugins.test_foo.__file__)
894
860
def test_submodule_loading(self):
895
861
# We create an additional directory under the one for test_foo
896
862
self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
897
self.addCleanup(self._unregister_plugin_submodule,
898
'test_foo', 'test_bar')
899
863
osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
900
864
plugin.set_plugins_path(['standard'])
901
865
import bzrlib.plugins.test_foo
902
866
self.assertEqual('bzrlib.plugins.test_foo',
903
867
bzrlib.plugins.test_foo.__package__)
904
868
import bzrlib.plugins.test_foo.test_bar
905
self.assertIsSameRealPath('non-standard-dir/test_bar/__init__.py',
906
bzrlib.plugins.test_foo.test_bar.__file__)
908
def test_relative_submodule_loading(self):
909
self.create_plugin_package('test_foo', dir='another-dir', source='''
912
# We create an additional directory under the one for test_foo
913
self.create_plugin_package('test_bar', dir='another-dir/test_bar')
914
self.addCleanup(self._unregister_plugin_submodule,
915
'test_foo', 'test_bar')
916
osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@another-dir')
917
plugin.set_plugins_path(['standard'])
918
import bzrlib.plugins.test_foo
919
self.assertEqual('bzrlib.plugins.test_foo',
920
bzrlib.plugins.test_foo.__package__)
921
self.assertIsSameRealPath('another-dir/test_bar/__init__.py',
922
bzrlib.plugins.test_foo.test_bar.__file__)
869
self.assertEqual('non-standard-dir/test_bar/__init__.py',
870
bzrlib.plugins.test_foo.test_bar.__file__)
924
872
def test_loading_from___init__only(self):
925
873
# We rename the existing __init__.py file to ensure that we don't load