1
# Copyright (C) 2005 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
24
from StringIO import StringIO
30
import bzrlib.commands
32
from bzrlib.tests import TestCase, TestCaseInTempDir
33
from bzrlib.osutils import pathjoin, abspath
37
import bzrlib.commands
38
class cmd_myplug(bzrlib.commands.Command):
39
'''Just a simple test plugin.'''
42
print 'Hello from my plugin'
45
# TODO: Write a test for plugin decoration of commands.
47
class TestLoadingPlugins(TestCaseInTempDir):
51
def test_plugins_with_the_same_name_are_not_loaded(self):
52
# This test tests that having two plugins in different directories does
53
# not result in both being loaded when they have the same name. get a
54
# file name we can use which is also a valid attribute for accessing in
55
# activeattributes. - we cannot give import parameters.
57
self.failIf(tempattribute in self.activeattributes)
58
# set a place for the plugins to record their loading, and at the same
59
# time validate that the location the plugins should record to is
61
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
63
self.failUnless(tempattribute in self.activeattributes)
64
# create two plugin directories
67
# write a plugin that will record when its loaded in the
69
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
70
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
71
print >> file(os.path.join('first', 'plugin.py'), 'w'), template % (tempattribute, 'first')
72
print >> file(os.path.join('second', 'plugin.py'), 'w'), template % (tempattribute, 'second')
74
bzrlib.plugin.load_from_path(['first', 'second'])
75
self.assertEqual(['first'], self.activeattributes[tempattribute])
77
# remove the plugin 'plugin'
78
del self.activeattributes[tempattribute]
79
if getattr(bzrlib.plugins, 'plugin', None):
80
del bzrlib.plugins.plugin
81
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
83
def test_plugins_from_different_dirs_can_demand_load(self):
84
# This test tests that having two plugins in different
85
# directories with different names allows them both to be loaded, when
86
# we do a direct import statement.
87
# Determine a file name we can use which is also a valid attribute
88
# for accessing in activeattributes. - we cannot give import parameters.
89
tempattribute = "different-dirs"
90
self.failIf(tempattribute in self.activeattributes)
91
# set a place for the plugins to record their loading, and at the same
92
# time validate that the location the plugins should record to is
94
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
96
self.failUnless(tempattribute in self.activeattributes)
97
# create two plugin directories
100
# write plugins that will record when they are loaded in the
101
# tempattribute list.
102
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
103
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
104
print >> file(os.path.join('first', 'pluginone.py'), 'w'), template % (tempattribute, 'first')
105
print >> file(os.path.join('second', 'plugintwo.py'), 'w'), template % (tempattribute, 'second')
106
oldpath = bzrlib.plugins.__path__
108
bzrlib.plugins.__path__ = ['first', 'second']
109
exec "import bzrlib.plugins.pluginone"
110
self.assertEqual(['first'], self.activeattributes[tempattribute])
111
exec "import bzrlib.plugins.plugintwo"
112
self.assertEqual(['first', 'second'],
113
self.activeattributes[tempattribute])
115
# remove the plugin 'plugin'
116
del self.activeattributes[tempattribute]
117
if getattr(bzrlib.plugins, 'plugin', None):
118
del bzrlib.plugins.plugin
119
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
122
class TestAllPlugins(TestCaseInTempDir):
124
def test_plugin_appears_in_all_plugins(self):
125
# This test tests a new plugin appears in bzrlib.plugin.all_plugins().
126
# check the plugin is not loaded already
127
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
128
# write a plugin that _cannot_ fail to load.
129
print >> file('plugin.py', 'w'), ""
131
bzrlib.plugin.load_from_path(['.'])
132
self.failUnless('plugin' in bzrlib.plugin.all_plugins())
133
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
134
self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
135
bzrlib.plugins.plugin)
137
# remove the plugin 'plugin'
138
if 'bzrlib.plugins.plugin' in sys.modules:
139
del sys.modules['bzrlib.plugins.plugin']
140
if getattr(bzrlib.plugins, 'plugin', None):
141
del bzrlib.plugins.plugin
142
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
145
class TestPluginHelp(TestCaseInTempDir):
147
def split_help_commands(self):
150
for line in self.capture('help commands').splitlines():
151
if not line.startswith(' '):
152
current = line.split()[0]
153
help[current] = help.get(current, '') + line
157
def test_plugin_help_builtins_unaffected(self):
158
# Check we don't get false positives
159
help_commands = self.split_help_commands()
160
for cmd_name in bzrlib.commands.builtin_command_names():
161
if cmd_name in bzrlib.commands.plugin_command_names():
164
help = bzrlib.commands.get_cmd_object(cmd_name).get_help_text()
165
except NotImplementedError:
166
# some commands have no help
169
self.assertNotContainsRe(help, 'From plugin "[^"]*"')
171
if cmd_name in help_commands.keys():
172
# some commands are hidden
173
help = help_commands[cmd_name]
174
self.assertNotContainsRe(help, 'From plugin "[^"]*"')
176
def test_plugin_help_shows_plugin(self):
177
# Create a test plugin
178
os.mkdir('plugin_test')
179
f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
185
bzrlib.plugin.load_from_path(['plugin_test'])
186
bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
187
help = self.capture('help myplug')
188
self.assertContainsRe(help, 'From plugin "myplug"')
189
help = self.split_help_commands()['myplug']
190
self.assertContainsRe(help, '\[myplug\]')
193
if bzrlib.commands.plugin_cmds.get('myplug', None):
194
del bzrlib.commands.plugin_cmds['myplug']
195
# remove the plugin 'myplug'
196
if getattr(bzrlib.plugins, 'myplug', None):
197
delattr(bzrlib.plugins, 'myplug')
200
class TestPluginFromZip(TestCaseInTempDir):
202
def make_zipped_plugin(self, zip_name, filename):
203
z = zipfile.ZipFile(zip_name, 'w')
204
z.writestr(filename, PLUGIN_TEXT)
207
def check_plugin_load(self, zip_name, plugin_name):
208
self.assertFalse(plugin_name in dir(bzrlib.plugins),
209
'Plugin already loaded')
211
bzrlib.plugin.load_from_zip(zip_name)
212
self.assertTrue(plugin_name in dir(bzrlib.plugins),
213
'Plugin is not loaded')
216
if getattr(bzrlib.plugins, plugin_name, None):
217
delattr(bzrlib.plugins, plugin_name)
219
def test_load_module(self):
220
self.make_zipped_plugin('./test.zip', 'ziplug.py')
221
self.check_plugin_load('./test.zip', 'ziplug')
223
def test_load_package(self):
224
self.make_zipped_plugin('./test.zip', 'ziplug/__init__.py')
225
self.check_plugin_load('./test.zip', 'ziplug')
228
class TestSetPluginsPath(TestCase):
230
def test_set_plugins_path(self):
231
"""set_plugins_path should set the module __path__ correctly."""
232
old_path = bzrlib.plugins.__path__
234
bzrlib.plugins.__path__ = []
235
expected_path = bzrlib.plugin.set_plugins_path()
236
self.assertEqual(expected_path, bzrlib.plugins.__path__)
238
bzrlib.plugins.__path__ = old_path
added
removed
bzrlib/tests/test_plugins.py
