1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
# Copyright (C) 2005, 2007 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Tests for plugins"""
# XXX: There are no plugin tests at the moment because the plugin module
# affects the global state of the process. See bzrlib/plugins.py for more
# comments.
import os
from StringIO import StringIO
import sys
import zipfile
from bzrlib import plugin, tests
import bzrlib.plugin
import bzrlib.plugins
import bzrlib.commands
import bzrlib.help
from bzrlib.tests import TestCase, TestCaseInTempDir
from bzrlib.osutils import pathjoin, abspath
PLUGIN_TEXT = """\
import bzrlib.commands
class cmd_myplug(bzrlib.commands.Command):
'''Just a simple test plugin.'''
aliases = ['mplg']
def run(self):
print 'Hello from my plugin'
"""
# TODO: Write a test for plugin decoration of commands.
class TestLoadingPlugins(TestCaseInTempDir):
activeattributes = {}
def test_plugins_with_the_same_name_are_not_loaded(self):
# This test tests that having two plugins in different directories does
# not result in both being loaded when they have the same name. get a
# file name we can use which is also a valid attribute for accessing in
# activeattributes. - we cannot give import parameters.
tempattribute = "0"
self.failIf(tempattribute in self.activeattributes)
# set a place for the plugins to record their loading, and at the same
# time validate that the location the plugins should record to is
# valid and correct.
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
[tempattribute] = []
self.failUnless(tempattribute in self.activeattributes)
# create two plugin directories
os.mkdir('first')
os.mkdir('second')
# write a plugin that will record when its loaded in the
# tempattribute list.
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
print >> file(os.path.join('first', 'plugin.py'), 'w'), template % (tempattribute, 'first')
print >> file(os.path.join('second', 'plugin.py'), 'w'), template % (tempattribute, 'second')
try:
bzrlib.plugin.load_from_path(['first', 'second'])
self.assertEqual(['first'], self.activeattributes[tempattribute])
finally:
# remove the plugin 'plugin'
del self.activeattributes[tempattribute]
if getattr(bzrlib.plugins, 'plugin', None):
del bzrlib.plugins.plugin
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
def test_plugins_from_different_dirs_can_demand_load(self):
# This test tests that having two plugins in different
# directories with different names allows them both to be loaded, when
# we do a direct import statement.
# Determine a file name we can use which is also a valid attribute
# for accessing in activeattributes. - we cannot give import parameters.
tempattribute = "different-dirs"
self.failIf(tempattribute in self.activeattributes)
# set a place for the plugins to record their loading, and at the same
# time validate that the location the plugins should record to is
# valid and correct.
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
[tempattribute] = []
self.failUnless(tempattribute in self.activeattributes)
# create two plugin directories
os.mkdir('first')
os.mkdir('second')
# write plugins that will record when they are loaded in the
# tempattribute list.
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
print >> file(os.path.join('first', 'pluginone.py'), 'w'), template % (tempattribute, 'first')
print >> file(os.path.join('second', 'plugintwo.py'), 'w'), template % (tempattribute, 'second')
oldpath = bzrlib.plugins.__path__
try:
bzrlib.plugins.__path__ = ['first', 'second']
exec "import bzrlib.plugins.pluginone"
self.assertEqual(['first'], self.activeattributes[tempattribute])
exec "import bzrlib.plugins.plugintwo"
self.assertEqual(['first', 'second'],
self.activeattributes[tempattribute])
finally:
# remove the plugin 'plugin'
del self.activeattributes[tempattribute]
if getattr(bzrlib.plugins, 'plugin', None):
del bzrlib.plugins.plugin
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
class TestAllPlugins(TestCaseInTempDir):
def test_plugin_appears_in_all_plugins(self):
# This test tests a new plugin appears in bzrlib.plugin.all_plugins().
# check the plugin is not loaded already
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
# write a plugin that _cannot_ fail to load.
print >> file('plugin.py', 'w'), ""
try:
bzrlib.plugin.load_from_path(['.'])
self.failUnless('plugin' in bzrlib.plugin.all_plugins())
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
bzrlib.plugins.plugin)
finally:
# remove the plugin 'plugin'
if 'bzrlib.plugins.plugin' in sys.modules:
del sys.modules['bzrlib.plugins.plugin']
if getattr(bzrlib.plugins, 'plugin', None):
del bzrlib.plugins.plugin
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
class TestPluginHelp(TestCaseInTempDir):
def split_help_commands(self):
help = {}
current = None
for line in self.run_bzr('help commands')[0].splitlines():
if not line.startswith(' '):
current = line.split()[0]
help[current] = help.get(current, '') + line
return help
def test_plugin_help_builtins_unaffected(self):
# Check we don't get false positives
help_commands = self.split_help_commands()
for cmd_name in bzrlib.commands.builtin_command_names():
if cmd_name in bzrlib.commands.plugin_command_names():
continue
try:
help = bzrlib.commands.get_cmd_object(cmd_name).get_help_text()
except NotImplementedError:
# some commands have no help
pass
else:
self.assertNotContainsRe(help, 'plugin "[^"]*"')
if cmd_name in help_commands.keys():
# some commands are hidden
help = help_commands[cmd_name]
self.assertNotContainsRe(help, 'plugin "[^"]*"')
def test_plugin_help_shows_plugin(self):
# Create a test plugin
os.mkdir('plugin_test')
f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
f.write(PLUGIN_TEXT)
f.close()
try:
# Check its help
bzrlib.plugin.load_from_path(['plugin_test'])
bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
help = self.run_bzr('help myplug')[0]
self.assertContainsRe(help, 'plugin "myplug"')
help = self.split_help_commands()['myplug']
self.assertContainsRe(help, '\[myplug\]')
finally:
# unregister command
if bzrlib.commands.plugin_cmds.get('myplug', None):
del bzrlib.commands.plugin_cmds['myplug']
# remove the plugin 'myplug'
if getattr(bzrlib.plugins, 'myplug', None):
delattr(bzrlib.plugins, 'myplug')
class TestPluginFromZip(TestCaseInTempDir):
def make_zipped_plugin(self, zip_name, filename):
z = zipfile.ZipFile(zip_name, 'w')
z.writestr(filename, PLUGIN_TEXT)
z.close()
def check_plugin_load(self, zip_name, plugin_name):
self.assertFalse(plugin_name in dir(bzrlib.plugins),
'Plugin already loaded')
old_path = bzrlib.plugins.__path__
try:
# this is normally done by load_plugins -> set_plugins_path
bzrlib.plugins.__path__ = [zip_name]
bzrlib.plugin.load_from_zip(zip_name)
self.assertTrue(plugin_name in dir(bzrlib.plugins),
'Plugin is not loaded')
finally:
# unregister plugin
if getattr(bzrlib.plugins, plugin_name, None):
delattr(bzrlib.plugins, plugin_name)
del sys.modules['bzrlib.plugins.' + plugin_name]
bzrlib.plugins.__path__ = old_path
def test_load_module(self):
self.make_zipped_plugin('./test.zip', 'ziplug.py')
self.check_plugin_load('./test.zip', 'ziplug')
def test_load_package(self):
self.make_zipped_plugin('./test.zip', 'ziplug/__init__.py')
self.check_plugin_load('./test.zip', 'ziplug')
class TestSetPluginsPath(TestCase):
def test_set_plugins_path(self):
"""set_plugins_path should set the module __path__ correctly."""
old_path = bzrlib.plugins.__path__
try:
bzrlib.plugins.__path__ = []
expected_path = bzrlib.plugin.set_plugins_path()
self.assertEqual(expected_path, bzrlib.plugins.__path__)
finally:
bzrlib.plugins.__path__ = old_path
class TestHelpIndex(tests.TestCase):
"""Tests for the PluginsHelpIndex class."""
def test_default_constructable(self):
index = plugin.PluginsHelpIndex()
def test_get_topics_None(self):
"""Searching for None returns an empty list."""
index = plugin.PluginsHelpIndex()
self.assertEqual([], index.get_topics(None))
def test_get_topics_for_plugin(self):
"""Searching for plugin name gets its docstring."""
index = plugin.PluginsHelpIndex()
# make a new plugin here for this test, even if we're run with
# --no-plugins
self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
sys.modules['bzrlib.plugins.demo_module'] = demo_module
try:
topics = index.get_topics('demo_module')
self.assertEqual(1, len(topics))
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
self.assertEqual(demo_module, topics[0].module)
finally:
del sys.modules['bzrlib.plugins.demo_module']
def test_get_topics_no_topic(self):
"""Searching for something that is not a plugin returns []."""
# test this by using a name that cannot be a plugin - its not
# a valid python identifier.
index = plugin.PluginsHelpIndex()
self.assertEqual([], index.get_topics('nothing by this name'))
def test_prefix(self):
"""PluginsHelpIndex has a prefix of 'plugins/'."""
index = plugin.PluginsHelpIndex()
self.assertEqual('plugins/', index.prefix)
def test_get_plugin_topic_with_prefix(self):
"""Searching for plugins/demo_module returns help."""
index = plugin.PluginsHelpIndex()
self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
sys.modules['bzrlib.plugins.demo_module'] = demo_module
try:
topics = index.get_topics('plugins/demo_module')
self.assertEqual(1, len(topics))
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
self.assertEqual(demo_module, topics[0].module)
finally:
del sys.modules['bzrlib.plugins.demo_module']
class FakeModule(object):
"""A fake module to test with."""
def __init__(self, doc, name):
self.__doc__ = doc
self.__name__ = name
class TestModuleHelpTopic(tests.TestCase):
"""Tests for the ModuleHelpTopic class."""
def test_contruct(self):
"""Construction takes the module to document."""
mod = FakeModule('foo', 'foo')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual(mod, topic.module)
def test_get_help_text_None(self):
"""A ModuleHelpTopic returns the docstring for get_help_text."""
mod = FakeModule(None, 'demo')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual("Plugin 'demo' has no docstring.\n",
topic.get_help_text())
def test_get_help_text_no_carriage_return(self):
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
mod = FakeModule('one line of help', 'demo')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual("one line of help\n",
topic.get_help_text())
def test_get_help_text_carriage_return(self):
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
mod = FakeModule('two lines of help\nand more\n', 'demo')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual("two lines of help\nand more\n",
topic.get_help_text())
def test_get_help_text_with_additional_see_also(self):
mod = FakeModule('two lines of help\nand more', 'demo')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual("two lines of help\nand more\nSee also: bar, foo\n",
topic.get_help_text(['foo', 'bar']))
def test_get_help_topic(self):
"""The help topic for a plugin is its module name."""
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.demo')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual('demo', topic.get_help_topic())
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
topic = plugin.ModuleHelpTopic(mod)
self.assertEqual('foo_bar', topic.get_help_topic())
|