1
# Copyright (C) 2005, 2007 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
18
"""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
25
from StringIO import StringIO
29
from bzrlib import plugin, tests
32
import bzrlib.commands
34
from bzrlib.symbol_versioning import one_three
35
from bzrlib.tests import (
40
from bzrlib.osutils import pathjoin, abspath, normpath
44
import bzrlib.commands
45
class cmd_myplug(bzrlib.commands.Command):
46
'''Just a simple test plugin.'''
49
print 'Hello from my plugin'
52
# TODO: Write a test for plugin decoration of commands.
54
class TestLoadingPlugins(TestCaseInTempDir):
58
def test_plugins_with_the_same_name_are_not_loaded(self):
59
# This test tests that having two plugins in different directories does
60
# not result in both being loaded when they have the same name. get a
61
# file name we can use which is also a valid attribute for accessing in
62
# activeattributes. - we cannot give import parameters.
64
self.failIf(tempattribute in self.activeattributes)
65
# set a place for the plugins to record their loading, and at the same
66
# time validate that the location the plugins should record to is
68
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
70
self.failUnless(tempattribute in self.activeattributes)
71
# create two plugin directories
74
# write a plugin that will record when its loaded in the
76
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
77
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
79
outfile = open(os.path.join('first', 'plugin.py'), 'w')
81
outfile.write(template % (tempattribute, 'first'))
86
outfile = open(os.path.join('second', 'plugin.py'), 'w')
88
outfile.write(template % (tempattribute, 'second'))
94
bzrlib.plugin.load_from_path(['first', 'second'])
95
self.assertEqual(['first'], self.activeattributes[tempattribute])
97
# remove the plugin 'plugin'
98
del self.activeattributes[tempattribute]
99
if 'bzrlib.plugins.plugin' in sys.modules:
100
del sys.modules['bzrlib.plugins.plugin']
101
if getattr(bzrlib.plugins, 'plugin', None):
102
del bzrlib.plugins.plugin
103
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
105
def test_plugins_from_different_dirs_can_demand_load(self):
106
# This test tests that having two plugins in different
107
# directories with different names allows them both to be loaded, when
108
# we do a direct import statement.
109
# Determine a file name we can use which is also a valid attribute
110
# for accessing in activeattributes. - we cannot give import parameters.
111
tempattribute = "different-dirs"
112
self.failIf(tempattribute in self.activeattributes)
113
# set a place for the plugins to record their loading, and at the same
114
# time validate that the location the plugins should record to is
116
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
118
self.failUnless(tempattribute in self.activeattributes)
119
# create two plugin directories
122
# write plugins that will record when they are loaded in the
123
# tempattribute list.
124
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
125
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
127
outfile = open(os.path.join('first', 'pluginone.py'), 'w')
129
outfile.write(template % (tempattribute, 'first'))
134
outfile = open(os.path.join('second', 'plugintwo.py'), 'w')
136
outfile.write(template % (tempattribute, 'second'))
141
oldpath = bzrlib.plugins.__path__
143
bzrlib.plugins.__path__ = ['first', 'second']
144
exec "import bzrlib.plugins.pluginone"
145
self.assertEqual(['first'], self.activeattributes[tempattribute])
146
exec "import bzrlib.plugins.plugintwo"
147
self.assertEqual(['first', 'second'],
148
self.activeattributes[tempattribute])
150
# remove the plugin 'plugin'
151
del self.activeattributes[tempattribute]
152
if getattr(bzrlib.plugins, 'pluginone', None):
153
del bzrlib.plugins.pluginone
154
if getattr(bzrlib.plugins, 'plugintwo', None):
155
del bzrlib.plugins.plugintwo
156
self.failIf(getattr(bzrlib.plugins, 'pluginone', None))
157
self.failIf(getattr(bzrlib.plugins, 'plugintwo', None))
159
def test_plugins_can_load_from_directory_with_trailing_slash(self):
160
# This test tests that a plugin can load from a directory when the
161
# directory in the path has a trailing slash.
162
# check the plugin is not loaded already
163
self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
164
tempattribute = "trailing-slash"
165
self.failIf(tempattribute in self.activeattributes)
166
# set a place for the plugin to record its loading, and at the same
167
# time validate that the location the plugin should record to is
169
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
171
self.failUnless(tempattribute in self.activeattributes)
172
# create a directory for the plugin
173
os.mkdir('plugin_test')
174
# write a plugin that will record when its loaded in the
175
# tempattribute list.
176
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
177
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
179
outfile = open(os.path.join('plugin_test', 'ts_plugin.py'), 'w')
181
outfile.write(template % (tempattribute, 'plugin'))
187
bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
188
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
190
# remove the plugin 'plugin'
191
del self.activeattributes[tempattribute]
192
if getattr(bzrlib.plugins, 'ts_plugin', None):
193
del bzrlib.plugins.ts_plugin
194
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()
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(),
214
r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
215
"because the file path isn't a valid module name; try renaming "
216
"it to 'bad_plugin_name_'\.")
221
class TestPlugins(TestCaseInTempDir):
223
def setup_plugin(self, source=""):
224
# This test tests a new plugin appears in bzrlib.plugin.plugins().
225
# check the plugin is not loaded already
226
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
227
# write a plugin that _cannot_ fail to load.
228
file('plugin.py', 'w').write(source + '\n')
229
self.addCleanup(self.teardown_plugin)
230
bzrlib.plugin.load_from_path(['.'])
232
def teardown_plugin(self):
233
# remove the plugin 'plugin'
234
if 'bzrlib.plugins.plugin' in sys.modules:
235
del sys.modules['bzrlib.plugins.plugin']
236
if getattr(bzrlib.plugins, 'plugin', None):
237
del bzrlib.plugins.plugin
238
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
240
def test_plugin_appears_in_plugins(self):
242
self.failUnless('plugin' in bzrlib.plugin.plugins())
243
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
244
plugins = bzrlib.plugin.plugins()
245
plugin = plugins['plugin']
246
self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
247
self.assertEqual(bzrlib.plugins.plugin, plugin.module)
249
def test_trivial_plugin_get_path(self):
251
plugins = bzrlib.plugin.plugins()
252
plugin = plugins['plugin']
253
plugin_path = self.test_dir + '/plugin.py'
254
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
256
def test_plugin_get_path_py_not_pyc(self):
257
self.setup_plugin() # after first import there will be plugin.pyc
258
self.teardown_plugin()
259
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
260
plugins = bzrlib.plugin.plugins()
261
plugin = plugins['plugin']
262
plugin_path = self.test_dir + '/plugin.py'
263
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
265
def test_plugin_get_path_pyc_only(self):
266
self.setup_plugin() # after first import there will be plugin.pyc
267
self.teardown_plugin()
268
os.unlink(self.test_dir + '/plugin.py')
269
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
270
plugins = bzrlib.plugin.plugins()
271
plugin = plugins['plugin']
273
plugin_path = self.test_dir + '/plugin.pyc'
275
plugin_path = self.test_dir + '/plugin.pyo'
276
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
278
def test_no_test_suite_gives_None_for_test_suite(self):
280
plugin = bzrlib.plugin.plugins()['plugin']
281
self.assertEqual(None, plugin.test_suite())
283
def test_test_suite_gives_test_suite_result(self):
284
source = """def test_suite(): return 'foo'"""
285
self.setup_plugin(source)
286
plugin = bzrlib.plugin.plugins()['plugin']
287
self.assertEqual('foo', plugin.test_suite())
289
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
291
loader = TestUtil.TestLoader()
292
plugin = bzrlib.plugin.plugins()['plugin']
293
self.assertEqual(None, plugin.load_plugin_tests(loader))
295
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
297
def load_tests(standard_tests, module, loader):
299
self.setup_plugin(source)
300
loader = TestUtil.TestLoader()
301
plugin = bzrlib.plugin.plugins()['plugin']
302
self.assertEqual('foo', plugin.load_plugin_tests(loader))
304
def test_no_version_info(self):
306
plugin = bzrlib.plugin.plugins()['plugin']
307
self.assertEqual(None, plugin.version_info())
309
def test_with_version_info(self):
310
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
311
plugin = bzrlib.plugin.plugins()['plugin']
312
self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
314
def test_short_version_info_gets_padded(self):
315
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
317
self.setup_plugin("version_info = (1, 2, 3)")
318
plugin = bzrlib.plugin.plugins()['plugin']
319
self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
321
def test_no_version_info___version__(self):
323
plugin = bzrlib.plugin.plugins()['plugin']
324
self.assertEqual("unknown", plugin.__version__)
326
def test___version__with_version_info(self):
327
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
328
plugin = bzrlib.plugin.plugins()['plugin']
329
self.assertEqual("1.2.3dev4", plugin.__version__)
331
def test_final__version__with_version_info(self):
332
self.setup_plugin("version_info = (1, 2, 3, 'final', 4)")
333
plugin = bzrlib.plugin.plugins()['plugin']
334
self.assertEqual("1.2.3", plugin.__version__)
337
class TestPluginHelp(TestCaseInTempDir):
339
def split_help_commands(self):
342
for line in self.run_bzr('help commands')[0].splitlines():
343
if not line.startswith(' '):
344
current = line.split()[0]
345
help[current] = help.get(current, '') + line
349
def test_plugin_help_builtins_unaffected(self):
350
# Check we don't get false positives
351
help_commands = self.split_help_commands()
352
for cmd_name in bzrlib.commands.builtin_command_names():
353
if cmd_name in bzrlib.commands.plugin_command_names():
356
help = bzrlib.commands.get_cmd_object(cmd_name).get_help_text()
357
except NotImplementedError:
358
# some commands have no help
361
self.assertNotContainsRe(help, 'plugin "[^"]*"')
363
if cmd_name in help_commands.keys():
364
# some commands are hidden
365
help = help_commands[cmd_name]
366
self.assertNotContainsRe(help, 'plugin "[^"]*"')
368
def test_plugin_help_shows_plugin(self):
369
# Create a test plugin
370
os.mkdir('plugin_test')
371
f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
22
# **************************************************
24
# **************************************************
33
from bzrlib.selftest import TestCaseInTempDir
36
class PluginTest(TestCaseInTempDir):
37
"""Create an external plugin and test loading."""
38
def test_plugin_loading(self):
41
orig_help = self.backtick('bzr help commands') # No plugins yet
42
os.mkdir('plugin_test')
43
f = open(os.path.join('plugin_test', 'myplug.py'), 'wt')
372
44
f.write(PLUGIN_TEXT)
377
bzrlib.plugin.load_from_path(['plugin_test'])
378
bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
379
help = self.run_bzr('help myplug')[0]
380
self.assertContainsRe(help, 'plugin "myplug"')
381
help = self.split_help_commands()['myplug']
382
self.assertContainsRe(help, '\[myplug\]')
385
if bzrlib.commands.plugin_cmds.get('myplug', None):
386
del bzrlib.commands.plugin_cmds['myplug']
387
# remove the plugin 'myplug'
388
if getattr(bzrlib.plugins, 'myplug', None):
389
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
class TestSetPluginsPath(TestCase):
428
def test_set_plugins_path(self):
429
"""set_plugins_path should set the module __path__ correctly."""
430
old_path = bzrlib.plugins.__path__
432
bzrlib.plugins.__path__ = []
433
expected_path = bzrlib.plugin.set_plugins_path()
434
self.assertEqual(expected_path, bzrlib.plugins.__path__)
436
bzrlib.plugins.__path__ = old_path
438
def test_set_plugins_path_with_trailing_slashes(self):
439
"""set_plugins_path should set the module __path__ based on
441
old_path = bzrlib.plugins.__path__
442
old_env = os.environ.get('BZR_PLUGIN_PATH')
444
bzrlib.plugins.__path__ = []
445
os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
447
bzrlib.plugin.set_plugins_path()
448
expected_path = ['first', 'second',
449
os.path.dirname(bzrlib.plugins.__file__)]
450
self.assertEqual(expected_path,
451
bzrlib.plugins.__path__[:len(expected_path)])
453
bzrlib.plugins.__path__ = old_path
454
if old_env is not None:
455
os.environ['BZR_PLUGIN_PATH'] = old_env
457
del os.environ['BZR_PLUGIN_PATH']
460
class TestHelpIndex(tests.TestCase):
461
"""Tests for the PluginsHelpIndex class."""
463
def test_default_constructable(self):
464
index = plugin.PluginsHelpIndex()
466
def test_get_topics_None(self):
467
"""Searching for None returns an empty list."""
468
index = plugin.PluginsHelpIndex()
469
self.assertEqual([], index.get_topics(None))
471
def test_get_topics_for_plugin(self):
472
"""Searching for plugin name gets its docstring."""
473
index = plugin.PluginsHelpIndex()
474
# make a new plugin here for this test, even if we're run with
476
self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
477
demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
478
sys.modules['bzrlib.plugins.demo_module'] = demo_module
480
topics = index.get_topics('demo_module')
481
self.assertEqual(1, len(topics))
482
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
483
self.assertEqual(demo_module, topics[0].module)
485
del sys.modules['bzrlib.plugins.demo_module']
487
def test_get_topics_no_topic(self):
488
"""Searching for something that is not a plugin returns []."""
489
# test this by using a name that cannot be a plugin - its not
490
# a valid python identifier.
491
index = plugin.PluginsHelpIndex()
492
self.assertEqual([], index.get_topics('nothing by this name'))
494
def test_prefix(self):
495
"""PluginsHelpIndex has a prefix of 'plugins/'."""
496
index = plugin.PluginsHelpIndex()
497
self.assertEqual('plugins/', index.prefix)
499
def test_get_plugin_topic_with_prefix(self):
500
"""Searching for plugins/demo_module returns help."""
501
index = plugin.PluginsHelpIndex()
502
self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
503
demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
504
sys.modules['bzrlib.plugins.demo_module'] = demo_module
506
topics = index.get_topics('plugins/demo_module')
507
self.assertEqual(1, len(topics))
508
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
509
self.assertEqual(demo_module, topics[0].module)
511
del sys.modules['bzrlib.plugins.demo_module']
514
class FakeModule(object):
515
"""A fake module to test with."""
517
def __init__(self, doc, name):
522
class TestModuleHelpTopic(tests.TestCase):
523
"""Tests for the ModuleHelpTopic class."""
525
def test_contruct(self):
526
"""Construction takes the module to document."""
527
mod = FakeModule('foo', 'foo')
528
topic = plugin.ModuleHelpTopic(mod)
529
self.assertEqual(mod, topic.module)
531
def test_get_help_text_None(self):
532
"""A ModuleHelpTopic returns the docstring for get_help_text."""
533
mod = FakeModule(None, 'demo')
534
topic = plugin.ModuleHelpTopic(mod)
535
self.assertEqual("Plugin 'demo' has no docstring.\n",
536
topic.get_help_text())
538
def test_get_help_text_no_carriage_return(self):
539
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
540
mod = FakeModule('one line of help', 'demo')
541
topic = plugin.ModuleHelpTopic(mod)
542
self.assertEqual("one line of help\n",
543
topic.get_help_text())
545
def test_get_help_text_carriage_return(self):
546
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
547
mod = FakeModule('two lines of help\nand more\n', 'demo')
548
topic = plugin.ModuleHelpTopic(mod)
549
self.assertEqual("two lines of help\nand more\n",
550
topic.get_help_text())
552
def test_get_help_text_with_additional_see_also(self):
553
mod = FakeModule('two lines of help\nand more', 'demo')
554
topic = plugin.ModuleHelpTopic(mod)
555
self.assertEqual("two lines of help\nand more\nSee also: bar, foo\n",
556
topic.get_help_text(['foo', 'bar']))
558
def test_get_help_topic(self):
559
"""The help topic for a plugin is its module name."""
560
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.demo')
561
topic = plugin.ModuleHelpTopic(mod)
562
self.assertEqual('demo', topic.get_help_topic())
563
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
564
topic = plugin.ModuleHelpTopic(mod)
565
self.assertEqual('foo_bar', topic.get_help_topic())
47
newhelp = backtick('bzr help commands')
48
assert newhelp.startswith('You have been overridden\n')
49
# We added a line, but the rest should work
50
assert newhelp[25:] == help
52
assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
54
shutil.rmtree('plugin_test')
60
# """import bzrlib, bzrlib.commands
61
# class cmd_myplug(bzrlib.commands.Command):
62
# '''Just a simple test plugin.'''
65
# print 'Hello from my plugin'
69
# os.environ['BZRPLUGINPATH'] = os.path.abspath('plugin_test')
70
# help = backtick('bzr help commands')
71
# assert help.find('myplug') != -1
72
# assert help.find('Just a simple test plugin.') != -1
75
# assert backtick('bzr myplug') == 'Hello from my plugin\n'
76
# assert backtick('bzr mplg') == 'Hello from my plugin\n'
78
# f = open(os.path.join('plugin_test', 'override.py'), 'wb')
79
# f.write("""import bzrlib, bzrlib.commands
80
# class cmd_commit(bzrlib.commands.cmd_commit):
81
# '''Commit changes into a new revision.'''
82
# def run(self, *args, **kwargs):
83
# print "I'm sorry dave, you can't do that"
85
# class cmd_help(bzrlib.commands.cmd_help):
86
# '''Show help on a command or other topic.'''
87
# def run(self, *args, **kwargs):
88
# print "You have been overridden"
89
# bzrlib.commands.cmd_help.run(self, *args, **kwargs)
added
removed
bzrlib/selftest/plugins.py
