1
# Copyright (C) 2005-2012, 2016 Canonical Ltd
2
# Copyright (C) 2017-2018 Breezy developers
1
# Copyright (C) 2005 by Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
"""Tests for plugins"""
20
# XXX: There are no plugin tests at the moment because the plugin module
21
# affects the global state of the process. See bzrlib/plugins.py for more
32
from ..tests.features import pkg_resources_feature
33
from ..sixish import (
25
from StringIO import StringIO
29
import bzrlib.commands
31
from bzrlib.tests import TestCaseInTempDir
32
from bzrlib.osutils import pathjoin, abspath
34
class PluginTest(TestCaseInTempDir):
35
"""Create an external plugin and test loading."""
36
# def test_plugin_loading(self):
37
# orig_help = self.run_bzr_captured('bzr help commands')[0]
38
# os.mkdir('plugin_test')
39
# f = open(pathjoin('plugin_test', 'myplug.py'), 'wt')
40
# f.write(PLUGIN_TEXT)
42
# newhelp = self.run_bzr_captured('bzr help commands')[0]
43
# assert newhelp.startswith('You have been overridden\n')
44
# # We added a line, but the rest should work
45
# assert newhelp[25:] == help
47
# assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
49
# shutil.rmtree('plugin_test')
52
# os.environ['BZRPLUGINPATH'] = abspath('plugin_test')
53
# help = backtick('bzr help commands')
54
# assert help.find('myplug') != -1
55
# assert help.find('Just a simple test plugin.') != -1
58
# assert backtick('bzr myplug') == 'Hello from my plugin\n'
59
# assert backtick('bzr mplg') == 'Hello from my plugin\n'
61
# f = open(pathjoin('plugin_test', 'override.py'), 'wb')
62
# f.write("""import bzrlib, bzrlib.commands
63
# class cmd_commit(bzrlib.commands.cmd_commit):
64
# '''Commit changes into a new revision.'''
65
# def run(self, *args, **kwargs):
66
# print "I'm sorry dave, you can't do that"
68
# class cmd_help(bzrlib.commands.cmd_help):
69
# '''Show help on a command or other topic.'''
70
# def run(self, *args, **kwargs):
71
# print "You have been overridden"
72
# bzrlib.commands.cmd_help.run(self, *args, **kwargs)
77
import bzrlib.commands
78
class cmd_myplug(bzrlib.commands.Command):
79
'''Just a simple test plugin.'''
82
print 'Hello from my plugin'
39
85
# TODO: Write a test for plugin decoration of commands.
41
invalidate_caches = getattr(importlib, "invalidate_caches", lambda: None)
44
class BaseTestPlugins(tests.TestCaseInTempDir):
45
"""TestCase that isolates plugin imports and cleans up on completion."""
48
super(BaseTestPlugins, self).setUp()
49
self.module_name = "breezy.testingplugins"
50
self.module_prefix = self.module_name + "."
51
self.module = types.ModuleType(self.module_name)
53
self.overrideAttr(plugin, "_MODULE_PREFIX", self.module_prefix)
54
self.overrideAttr(breezy, "testingplugins", self.module)
56
sys.modules[self.module_name] = self.module
57
self.addCleanup(self._unregister_all)
58
self.addCleanup(self._unregister_finder)
63
"""Remove all global testing state and clean up module."""
64
# GZ 2017-06-02: Ideally don't do this, write new test or generate
65
# bytecode by other mechanism.
66
self.log("resetting plugin testing context")
67
self._unregister_all()
68
self._unregister_finder()
69
sys.modules[self.module_name] = self.module
70
for name in list(self.module.__dict__):
72
delattr(self.module, name)
76
def update_module_paths(self, paths):
77
paths = plugin.extend_path(paths, self.module_name)
78
self.module.__path__ = paths
79
self.log("using %r", paths)
82
def load_with_paths(self, paths):
83
self.log("loading plugins!")
84
plugin.load_plugins(self.update_module_paths(paths), state=self)
86
def create_plugin(self, name, source=None, dir='.', file_name=None):
89
"""This is the doc for %s"""
92
file_name = name + '.py'
93
# 'source' must not fail to load
94
path = osutils.pathjoin(dir, file_name)
95
with open(path, 'w') as f:
96
f.write(source + '\n')
98
def create_plugin_package(self, name, dir=None, source=None):
103
"""This is the doc for %s"""
107
self.create_plugin(name, source, dir,
108
file_name='__init__.py')
110
def promote_cache(self, directory):
111
"""Move bytecode files out of __pycache__ in given directory."""
112
cache_dir = os.path.join(directory, '__pycache__')
113
if os.path.isdir(cache_dir):
114
for name in os.listdir(cache_dir):
115
magicless_name = '.'.join(name.split('.')[0::name.count('.')])
116
rel = osutils.relpath(self.test_dir, cache_dir)
117
self.log("moving %s in %s to %s", name, rel, magicless_name)
118
os.rename(os.path.join(cache_dir, name),
119
os.path.join(directory, magicless_name))
121
def _unregister_finder(self):
122
"""Removes any test copies of _PluginsAtFinder from sys.meta_path."""
123
idx = len(sys.meta_path)
126
finder = sys.meta_path[idx]
127
if getattr(finder, "prefix", "") == self.module_prefix:
128
self.log("removed %r from sys.meta_path", finder)
129
sys.meta_path.pop(idx)
131
def _unregister_all(self):
132
"""Remove all plugins in the test namespace from sys.modules."""
133
for name in list(sys.modules):
134
if name.startswith(self.module_prefix) or name == self.module_name:
135
self.log("removed %s from sys.modules", name)
136
del sys.modules[name]
138
def assertPluginModules(self, plugin_dict):
140
dict((k[len(self.module_prefix):], sys.modules[k])
141
for k in sys.modules if k.startswith(self.module_prefix)),
144
def assertPluginUnknown(self, name):
145
self.assertTrue(getattr(self.module, name, None) is None)
146
self.assertFalse(self.module_prefix + name in sys.modules)
148
def assertPluginKnown(self, name):
149
self.assertTrue(getattr(self.module, name, None) is not None)
150
self.assertTrue(self.module_prefix + name in sys.modules)
153
class TestLoadingPlugins(BaseTestPlugins):
87
class TestOneNamedPluginOnly(TestCaseInTempDir):
155
89
activeattributes = {}
157
91
def test_plugins_with_the_same_name_are_not_loaded(self):
158
# This test tests that having two plugins in different directories does
159
# not result in both being loaded when they have the same name. get a
160
# file name we can use which is also a valid attribute for accessing in
161
# activeattributes. - we cannot give import parameters.
163
self.assertFalse(tempattribute in self.activeattributes)
164
# set a place for the plugins to record their loading, and at the same
165
# time validate that the location the plugins should record to is
167
self.__class__.activeattributes[tempattribute] = []
168
self.assertTrue(tempattribute in self.activeattributes)
169
# create two plugin directories
172
# write a plugin that will record when its loaded in the
173
# tempattribute list.
174
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
175
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
177
with open(os.path.join('first', 'plugin.py'), 'w') as outfile:
178
outfile.write(template % (tempattribute, 'first'))
181
with open(os.path.join('second', 'plugin.py'), 'w') as outfile:
182
outfile.write(template % (tempattribute, 'second'))
186
self.load_with_paths(['first', 'second'])
187
self.assertEqual(['first'], self.activeattributes[tempattribute])
189
del self.activeattributes[tempattribute]
191
def test_plugins_from_different_dirs_can_demand_load(self):
192
self.assertFalse('breezy.plugins.pluginone' in sys.modules)
193
self.assertFalse('breezy.plugins.plugintwo' in sys.modules)
194
92
# This test tests that having two plugins in different
195
# directories with different names allows them both to be loaded, when
196
# we do a direct import statement.
197
# Determine a file name we can use which is also a valid attribute
93
# directories does not result in both being loaded.
94
# get a file name we can use which is also a valid attribute
198
95
# for accessing in activeattributes. - we cannot give import parameters.
199
tempattribute = "different-dirs"
200
self.assertFalse(tempattribute in self.activeattributes)
97
self.failIf(tempattribute in self.activeattributes)
201
98
# set a place for the plugins to record their loading, and at the same
202
99
# time validate that the location the plugins should record to is
203
100
# valid and correct.
204
breezy.tests.test_plugins.TestLoadingPlugins.activeattributes[tempattribute] = [
206
self.assertTrue(tempattribute in self.activeattributes)
101
bzrlib.tests.test_plugins.TestOneNamedPluginOnly.activeattributes \
103
self.failUnless(tempattribute in self.activeattributes)
207
104
# create two plugin directories
208
105
os.mkdir('first')
209
106
os.mkdir('second')
210
# write plugins that will record when they are loaded in the
107
# write a plugin that will record when its loaded in the
211
108
# tempattribute list.
212
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
213
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
215
with open(os.path.join('first', 'pluginone.py'), 'w') as outfile:
216
outfile.write(template % (tempattribute, 'first'))
219
with open(os.path.join('second', 'plugintwo.py'), 'w') as outfile:
220
outfile.write(template % (tempattribute, 'second'))
109
template = ("from bzrlib.tests.test_plugins import TestOneNamedPluginOnly\n"
110
"TestOneNamedPluginOnly.activeattributes[%r].append('%s')\n")
111
print >> file(os.path.join('first', 'plugin.py'), 'w'), template % (tempattribute, 'first')
112
print >> file(os.path.join('second', 'plugin.py'), 'w'), template % (tempattribute, 'second')
224
self.assertPluginUnknown('pluginone')
225
self.assertPluginUnknown('plugintwo')
226
self.update_module_paths(['first', 'second'])
227
exec("import %spluginone" % self.module_prefix)
114
bzrlib.plugin.load_from_dirs(['first', 'second'])
228
115
self.assertEqual(['first'], self.activeattributes[tempattribute])
229
exec("import %splugintwo" % self.module_prefix)
230
self.assertEqual(['first', 'second'],
231
self.activeattributes[tempattribute])
117
# remove the plugin 'plugin'
233
118
del self.activeattributes[tempattribute]
235
def test_plugins_can_load_from_directory_with_trailing_slash(self):
236
# This test tests that a plugin can load from a directory when the
237
# directory in the path has a trailing slash.
119
if getattr(bzrlib.plugins, 'plugin', None):
120
del bzrlib.plugins.plugin
121
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
124
class TestAllPlugins(TestCaseInTempDir):
126
def test_plugin_appears_in_all_plugins(self):
127
# This test tests a new plugin appears in bzrlib.plugin.all_plugins().
238
128
# check the plugin is not loaded already
239
self.assertPluginUnknown('ts_plugin')
240
tempattribute = "trailing-slash"
241
self.assertFalse(tempattribute in self.activeattributes)
242
# set a place for the plugin to record its loading, and at the same
243
# time validate that the location the plugin should record to is
245
breezy.tests.test_plugins.TestLoadingPlugins.activeattributes[tempattribute] = [
247
self.assertTrue(tempattribute in self.activeattributes)
248
# create a directory for the plugin
129
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
130
# write a plugin that _cannot_ fail to load.
131
print >> file('plugin.py', 'w'), ""
133
bzrlib.plugin.load_from_dirs(['.'])
134
self.failUnless('plugin' in bzrlib.plugin.all_plugins())
135
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
136
self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
137
bzrlib.plugins.plugin)
139
# remove the plugin '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 line.startswith('bzr '):
152
current = line.split()[1]
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():
165
bzrlib.help.help_on_command(cmd_name, help)
166
except NotImplementedError:
167
# some commands have no help
171
self.assertNotContainsRe(help.read(), 'From plugin "[^"]*"')
173
if help in help_commands.keys():
174
# some commands are hidden
175
help = help_commands[cmd_name]
176
self.assertNotContainsRe(help, 'From plugin "[^"]*"')
178
def test_plugin_help_shows_plugin(self):
179
# Create a test plugin
249
180
os.mkdir('plugin_test')
250
# write a plugin that will record when its loaded in the
251
# tempattribute list.
252
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
253
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
255
with open(os.path.join('plugin_test', 'ts_plugin.py'), 'w') as outfile:
256
outfile.write(template % (tempattribute, 'plugin'))
260
self.load_with_paths(['plugin_test' + os.sep])
261
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
262
self.assertPluginKnown('ts_plugin')
264
del self.activeattributes[tempattribute]
266
def load_and_capture(self, name):
267
"""Load plugins from '.' capturing the output.
269
:param name: The name of the plugin.
270
:return: A string with the log from the plugin loading call.
275
handler = logging.StreamHandler(stream)
276
log = logging.getLogger('brz')
277
log.addHandler(handler)
279
self.load_with_paths(['.'])
281
# Stop capturing output
284
log.removeHandler(handler)
285
return stream.getvalue()
289
def test_plugin_with_bad_api_version_reports(self):
290
"""Try loading a plugin that requests an unsupported api.
292
Observe that it records the problem but doesn't complain on stderr.
294
See https://bugs.launchpad.net/bzr/+bug/704195
297
with open(name, 'w') as f:
298
f.write("import breezy\n"
299
"from breezy.errors import IncompatibleVersion\n"
300
"raise IncompatibleVersion(breezy, [(1, 0, 0)], (0, 0, 5))\n")
301
log = self.load_and_capture(name)
302
self.assertNotContainsRe(log,
303
r"It supports breezy version")
304
self.assertEqual({'wants100'}, viewkeys(self.plugin_warnings))
305
self.assertContainsRe(
306
self.plugin_warnings['wants100'][0],
307
r"It supports breezy version")
309
def test_plugin_with_bad_name_does_not_load(self):
310
# The file name here invalid for a python module.
311
name = 'brz-bad plugin-name..py'
312
open(name, 'w').close()
313
log = self.load_and_capture(name)
314
self.assertContainsRe(log,
315
r"Unable to load 'brz-bad plugin-name\.' in '\.' as a plugin "
316
"because the file path isn't a valid module name; try renaming "
317
"it to 'bad_plugin_name_'\\.")
320
class TestPlugins(BaseTestPlugins):
322
def setup_plugin(self, source=""):
323
# This test tests a new plugin appears in breezy.plugin.plugins().
324
# check the plugin is not loaded already
325
self.assertPluginUnknown('plugin')
326
# write a plugin that _cannot_ fail to load.
327
with open('plugin.py', 'w') as f:
328
f.write(source + '\n')
329
self.load_with_paths(['.'])
331
def test_plugin_loaded(self):
332
self.assertPluginUnknown('plugin')
333
self.assertIs(None, breezy.plugin.get_loaded_plugin('plugin'))
335
p = breezy.plugin.get_loaded_plugin('plugin')
336
self.assertIsInstance(p, breezy.plugin.PlugIn)
337
self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
339
def test_plugin_loaded_disabled(self):
340
self.assertPluginUnknown('plugin')
341
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'plugin')
343
self.assertIs(None, breezy.plugin.get_loaded_plugin('plugin'))
345
def test_plugin_appears_in_plugins(self):
347
self.assertPluginKnown('plugin')
348
p = self.plugins['plugin']
349
self.assertIsInstance(p, breezy.plugin.PlugIn)
350
self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
352
def test_trivial_plugin_get_path(self):
354
p = self.plugins['plugin']
355
plugin_path = self.test_dir + '/plugin.py'
356
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
358
def test_plugin_get_path_py_not_pyc(self):
359
# first import creates plugin.pyc
361
self.promote_cache(self.test_dir)
363
self.load_with_paths(['.']) # import plugin.pyc
364
p = plugin.plugins()['plugin']
365
plugin_path = self.test_dir + '/plugin.py'
366
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
368
def test_plugin_get_path_pyc_only(self):
369
# first import creates plugin.pyc (or plugin.pyo depending on __debug__)
371
os.unlink(self.test_dir + '/plugin.py')
372
self.promote_cache(self.test_dir)
374
self.load_with_paths(['.']) # import plugin.pyc (or .pyo)
375
p = plugin.plugins()['plugin']
376
plugin_path = self.test_dir + '/plugin' + plugin.COMPILED_EXT
377
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
379
def test_no_test_suite_gives_None_for_test_suite(self):
381
p = plugin.plugins()['plugin']
382
self.assertEqual(None, p.test_suite())
384
def test_test_suite_gives_test_suite_result(self):
385
source = """def test_suite(): return 'foo'"""
386
self.setup_plugin(source)
387
p = plugin.plugins()['plugin']
388
self.assertEqual('foo', p.test_suite())
390
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
392
loader = tests.TestUtil.TestLoader()
393
p = plugin.plugins()['plugin']
394
self.assertEqual(None, p.load_plugin_tests(loader))
396
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
398
def load_tests(loader, standard_tests, pattern):
400
self.setup_plugin(source)
401
loader = tests.TestUtil.TestLoader()
402
p = plugin.plugins()['plugin']
403
self.assertEqual('foo', p.load_plugin_tests(loader))
405
def check_version_info(self, expected, source='', name='plugin'):
406
self.setup_plugin(source)
407
self.assertEqual(expected, plugin.plugins()[name].version_info())
409
def test_no_version_info(self):
410
self.check_version_info(None)
412
def test_with_version_info(self):
413
self.check_version_info((1, 2, 3, 'dev', 4),
414
"version_info = (1, 2, 3, 'dev', 4)")
416
def test_short_version_info_gets_padded(self):
417
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
419
self.check_version_info((1, 2, 3, 'final', 0),
420
"version_info = (1, 2, 3)")
422
def check_version(self, expected, source=None, name='plugin'):
423
self.setup_plugin(source)
424
self.assertEqual(expected, plugins[name].__version__)
426
def test_no_version_info___version__(self):
428
plugin = breezy.plugin.plugins()['plugin']
429
self.assertEqual("unknown", plugin.__version__)
431
def test_str__version__with_version_info(self):
432
self.setup_plugin("version_info = '1.2.3'")
433
plugin = breezy.plugin.plugins()['plugin']
434
self.assertEqual("1.2.3", plugin.__version__)
436
def test_noniterable__version__with_version_info(self):
437
self.setup_plugin("version_info = (1)")
438
plugin = breezy.plugin.plugins()['plugin']
439
self.assertEqual("1", plugin.__version__)
441
def test_1__version__with_version_info(self):
442
self.setup_plugin("version_info = (1,)")
443
plugin = breezy.plugin.plugins()['plugin']
444
self.assertEqual("1", plugin.__version__)
446
def test_1_2__version__with_version_info(self):
447
self.setup_plugin("version_info = (1, 2)")
448
plugin = breezy.plugin.plugins()['plugin']
449
self.assertEqual("1.2", plugin.__version__)
451
def test_1_2_3__version__with_version_info(self):
452
self.setup_plugin("version_info = (1, 2, 3)")
453
plugin = breezy.plugin.plugins()['plugin']
454
self.assertEqual("1.2.3", plugin.__version__)
456
def test_candidate__version__with_version_info(self):
457
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
458
plugin = breezy.plugin.plugins()['plugin']
459
self.assertEqual("1.2.3rc1", plugin.__version__)
461
def test_dev__version__with_version_info(self):
462
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
463
plugin = breezy.plugin.plugins()['plugin']
464
self.assertEqual("1.2.3dev", plugin.__version__)
466
def test_dev_fallback__version__with_version_info(self):
467
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
468
plugin = breezy.plugin.plugins()['plugin']
469
self.assertEqual("1.2.3dev4", plugin.__version__)
471
def test_final__version__with_version_info(self):
472
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
473
plugin = breezy.plugin.plugins()['plugin']
474
self.assertEqual("1.2.3", plugin.__version__)
476
def test_final_fallback__version__with_version_info(self):
477
self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
478
plugin = breezy.plugin.plugins()['plugin']
479
self.assertEqual("1.2.3.2", plugin.__version__)
482
class TestHelpIndex(tests.TestCase):
483
"""Tests for the PluginsHelpIndex class."""
485
def test_default_constructable(self):
486
index = plugin.PluginsHelpIndex()
488
def test_get_topics_None(self):
489
"""Searching for None returns an empty list."""
490
index = plugin.PluginsHelpIndex()
491
self.assertEqual([], index.get_topics(None))
493
def test_get_topics_for_plugin(self):
494
"""Searching for plugin name gets its docstring."""
495
index = plugin.PluginsHelpIndex()
496
# make a new plugin here for this test, even if we're run with
498
self.assertFalse('breezy.plugins.demo_module' in sys.modules)
499
demo_module = FakeModule('', 'breezy.plugins.demo_module')
500
sys.modules['breezy.plugins.demo_module'] = demo_module
502
topics = index.get_topics('demo_module')
503
self.assertEqual(1, len(topics))
504
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
505
self.assertEqual(demo_module, topics[0].module)
507
del sys.modules['breezy.plugins.demo_module']
509
def test_get_topics_no_topic(self):
510
"""Searching for something that is not a plugin returns []."""
511
# test this by using a name that cannot be a plugin - its not
512
# a valid python identifier.
513
index = plugin.PluginsHelpIndex()
514
self.assertEqual([], index.get_topics('nothing by this name'))
516
def test_prefix(self):
517
"""PluginsHelpIndex has a prefix of 'plugins/'."""
518
index = plugin.PluginsHelpIndex()
519
self.assertEqual('plugins/', index.prefix)
521
def test_get_plugin_topic_with_prefix(self):
522
"""Searching for plugins/demo_module returns help."""
523
index = plugin.PluginsHelpIndex()
524
self.assertFalse('breezy.plugins.demo_module' in sys.modules)
525
demo_module = FakeModule('', 'breezy.plugins.demo_module')
526
sys.modules['breezy.plugins.demo_module'] = demo_module
528
topics = index.get_topics('plugins/demo_module')
529
self.assertEqual(1, len(topics))
530
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
531
self.assertEqual(demo_module, topics[0].module)
533
del sys.modules['breezy.plugins.demo_module']
536
class FakeModule(object):
537
"""A fake module to test with."""
539
def __init__(self, doc, name):
544
class TestModuleHelpTopic(tests.TestCase):
545
"""Tests for the ModuleHelpTopic class."""
547
def test_contruct(self):
548
"""Construction takes the module to document."""
549
mod = FakeModule('foo', 'foo')
550
topic = plugin.ModuleHelpTopic(mod)
551
self.assertEqual(mod, topic.module)
553
def test_get_help_text_None(self):
554
"""A ModuleHelpTopic returns the docstring for get_help_text."""
555
mod = FakeModule(None, 'demo')
556
topic = plugin.ModuleHelpTopic(mod)
557
self.assertEqual("Plugin 'demo' has no docstring.\n",
558
topic.get_help_text())
560
def test_get_help_text_no_carriage_return(self):
561
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
562
mod = FakeModule('one line of help', 'demo')
563
topic = plugin.ModuleHelpTopic(mod)
564
self.assertEqual("one line of help\n",
565
topic.get_help_text())
567
def test_get_help_text_carriage_return(self):
568
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
569
mod = FakeModule('two lines of help\nand more\n', 'demo')
570
topic = plugin.ModuleHelpTopic(mod)
571
self.assertEqual("two lines of help\nand more\n",
572
topic.get_help_text())
574
def test_get_help_text_with_additional_see_also(self):
575
mod = FakeModule('two lines of help\nand more', 'demo')
576
topic = plugin.ModuleHelpTopic(mod)
578
"two lines of help\nand more\n\n:See also: bar, foo\n",
579
topic.get_help_text(['foo', 'bar']))
581
def test_get_help_topic(self):
582
"""The help topic for a plugin is its module name."""
583
mod = FakeModule('two lines of help\nand more', 'breezy.plugins.demo')
584
topic = plugin.ModuleHelpTopic(mod)
585
self.assertEqual('demo', topic.get_help_topic())
586
mod = FakeModule('two lines of help\nand more',
587
'breezy.plugins.foo_bar')
588
topic = plugin.ModuleHelpTopic(mod)
589
self.assertEqual('foo_bar', topic.get_help_topic())
592
class TestEnvPluginPath(tests.TestCase):
597
entrypoints = "ENTRYPOINTS"
599
def check_path(self, expected_dirs, setting_dirs):
600
if setting_dirs is None:
601
del os.environ['BRZ_PLUGIN_PATH']
603
os.environ['BRZ_PLUGIN_PATH'] = os.pathsep.join(setting_dirs)
604
actual = [(p if t == 'path' else t.upper())
605
for p, t in plugin._env_plugin_path()]
606
self.assertEqual(expected_dirs, actual)
608
def test_default(self):
609
self.check_path([self.user, self.core, self.site], None)
611
def test_adhoc_policy(self):
612
self.check_path([self.user, self.core, self.site],
613
['+user', '+core', '+site'])
615
def test_fallback_policy(self):
616
self.check_path([self.core, self.site, self.user],
617
['+core', '+site', '+user'])
619
def test_override_policy(self):
620
self.check_path([self.user, self.site, self.core],
621
['+user', '+site', '+core'])
623
def test_enable_entrypoints(self):
624
self.check_path([self.user, self.core, self.site, self.entrypoints],
625
['+user', '+core', '+site', '+entrypoints'])
627
def test_disable_user(self):
628
self.check_path([self.core, self.site], ['-user'])
630
def test_disable_user_twice(self):
631
# Ensures multiple removals don't left cruft
632
self.check_path([self.core, self.site], ['-user', '-user'])
634
def test_duplicates_are_removed(self):
635
self.check_path([self.user, self.core, self.site],
637
# And only the first reference is kept (since the later references will
638
# only produce '<plugin> already loaded' mutters)
639
self.check_path([self.user, self.core, self.site],
640
['+user', '+user', '+core',
641
'+user', '+site', '+site',
644
def test_disable_overrides_enable(self):
645
self.check_path([self.core, self.site], ['-user', '+user'])
647
def test_disable_core(self):
648
self.check_path([self.site], ['-core'])
649
self.check_path([self.user, self.site], ['+user', '-core'])
651
def test_disable_site(self):
652
self.check_path([self.core], ['-site'])
653
self.check_path([self.user, self.core], ['-site', '+user'])
655
def test_override_site(self):
656
self.check_path(['mysite', self.user, self.core],
657
['mysite', '-site', '+user'])
658
self.check_path(['mysite', self.core],
661
def test_override_core(self):
662
self.check_path(['mycore', self.user, self.site],
663
['mycore', '-core', '+user', '+site'])
664
self.check_path(['mycore', self.site],
667
def test_my_plugin_only(self):
670
['myplugin', '-user', '-core', '-site', '-entrypoints'])
672
def test_my_plugin_first(self):
673
self.check_path(['myplugin', self.core, self.site, self.user],
674
['myplugin', '+core', '+site', '+user'])
676
def test_bogus_references(self):
677
self.check_path(['+foo', '-bar', self.core, self.site],
681
class TestDisablePlugin(BaseTestPlugins):
683
def test_cannot_import(self):
684
self.create_plugin_package('works')
685
self.create_plugin_package('fails')
686
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'fails')
687
self.update_module_paths(["."])
688
import breezy.testingplugins.works as works
690
import breezy.testingplugins.fails as fails
694
self.fail("Loaded blocked plugin: " + repr(fails))
695
self.assertPluginModules({'fails': None, 'works': works})
697
def test_partial_imports(self):
698
self.create_plugin('good')
699
self.create_plugin('bad')
700
self.create_plugin_package('ugly')
701
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'bad:ugly')
702
self.load_with_paths(['.'])
703
self.assertEqual({'good'}, viewkeys(self.plugins))
704
self.assertPluginModules({
705
'good': self.plugins['good'].module,
709
# Ensure there are no warnings about plugins not being imported as
710
# the user has explictly requested they be disabled.
711
self.assertNotContainsRe(self.get_log(), r"Unable to load plugin")
714
class TestEnvDisablePlugins(tests.TestCase):
716
def _get_names(self, env_value):
717
os.environ['BRZ_DISABLE_PLUGINS'] = env_value
718
return plugin._env_disable_plugins()
720
def test_unset(self):
721
self.assertEqual([], plugin._env_disable_plugins())
723
def test_empty(self):
724
self.assertEqual([], self._get_names(''))
726
def test_single(self):
727
self.assertEqual(['single'], self._get_names('single'))
729
def test_multi(self):
730
expected = ['one', 'two']
731
self.assertEqual(expected, self._get_names(os.pathsep.join(expected)))
733
def test_mixed(self):
734
value = os.pathsep.join(['valid', 'in-valid'])
735
self.assertEqual(['valid'], self._get_names(value))
736
self.assertContainsRe(
738
r"Invalid name 'in-valid' in BRZ_DISABLE_PLUGINS=" + repr(value))
741
class TestEnvPluginsAt(tests.TestCase):
743
def _get_paths(self, env_value):
744
os.environ['BRZ_PLUGINS_AT'] = env_value
745
return plugin._env_plugins_at()
747
def test_empty(self):
748
self.assertEqual([], plugin._env_plugins_at())
749
self.assertEqual([], self._get_paths(''))
751
def test_one_path(self):
752
self.assertEqual([('b', 'man')], self._get_paths('b@man'))
754
def test_multiple(self):
756
[('tools', 'bzr-tools'), ('p', 'play.py')],
757
self._get_paths(os.pathsep.join(('tools@bzr-tools', 'p@play.py'))))
759
def test_many_at(self):
761
[('church', 'StMichael@Plea@Norwich')],
762
self._get_paths('church@StMichael@Plea@Norwich'))
764
def test_only_py(self):
765
self.assertEqual([('test', './test.py')], self._get_paths('./test.py'))
767
def test_only_package(self):
768
self.assertEqual([('py', '/opt/b/py')], self._get_paths('/opt/b/py'))
770
def test_bad_name(self):
771
self.assertEqual([], self._get_paths('/usr/local/bzr-git'))
772
self.assertContainsRe(
774
r"Invalid name 'bzr-git' in BRZ_PLUGINS_AT='/usr/local/bzr-git'")
777
class TestLoadPluginAt(BaseTestPlugins):
780
super(TestLoadPluginAt, self).setUp()
781
# Create the same plugin in two directories
782
self.create_plugin_package('test_foo', dir='non-standard-dir')
783
# The "normal" directory, we use 'standard' instead of 'plugins' to
784
# avoid depending on the precise naming.
785
self.create_plugin_package('test_foo', dir='standard/test_foo')
787
def assertTestFooLoadedFrom(self, path):
788
self.assertPluginKnown('test_foo')
789
self.assertDocstring('This is the doc for test_foo',
790
self.module.test_foo)
791
self.assertEqual(path, self.module.test_foo.dir_source)
793
def test_regular_load(self):
794
self.load_with_paths(['standard'])
795
self.assertTestFooLoadedFrom('standard/test_foo')
797
def test_import(self):
798
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
799
self.update_module_paths(['standard'])
800
import breezy.testingplugins.test_foo
801
self.assertTestFooLoadedFrom('non-standard-dir')
803
def test_loading(self):
804
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
805
self.load_with_paths(['standard'])
806
self.assertTestFooLoadedFrom('non-standard-dir')
808
def test_loading_other_name(self):
809
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
810
os.rename('standard/test_foo', 'standard/test_bar')
811
self.load_with_paths(['standard'])
812
self.assertTestFooLoadedFrom('non-standard-dir')
814
def test_compiled_loaded(self):
815
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
816
self.load_with_paths(['standard'])
817
self.assertTestFooLoadedFrom('non-standard-dir')
818
self.assertIsSameRealPath('non-standard-dir/__init__.py',
819
self.module.test_foo.__file__)
821
# Try importing again now that the source has been compiled
822
os.remove('non-standard-dir/__init__.py')
823
self.promote_cache('non-standard-dir')
825
self.load_with_paths(['standard'])
826
self.assertTestFooLoadedFrom('non-standard-dir')
827
suffix = plugin.COMPILED_EXT
828
self.assertIsSameRealPath('non-standard-dir/__init__' + suffix,
829
self.module.test_foo.__file__)
831
def test_submodule_loading(self):
832
# We create an additional directory under the one for test_foo
833
self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
834
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
835
self.update_module_paths(['standard'])
836
import breezy.testingplugins.test_foo # noqa: F401
837
self.assertEqual(self.module_prefix + 'test_foo',
838
self.module.test_foo.__package__)
839
import breezy.testingplugins.test_foo.test_bar # noqa: F401
840
self.assertIsSameRealPath('non-standard-dir/test_bar/__init__.py',
841
self.module.test_foo.test_bar.__file__)
843
def test_relative_submodule_loading(self):
844
self.create_plugin_package('test_foo', dir='another-dir', source='''
845
from . import test_bar
847
# We create an additional directory under the one for test_foo
848
self.create_plugin_package('test_bar', dir='another-dir/test_bar')
849
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@another-dir')
850
self.update_module_paths(['standard'])
851
import breezy.testingplugins.test_foo # noqa: F401
852
self.assertEqual(self.module_prefix + 'test_foo',
853
self.module.test_foo.__package__)
854
self.assertIsSameRealPath('another-dir/test_bar/__init__.py',
855
self.module.test_foo.test_bar.__file__)
857
def test_loading_from___init__only(self):
858
# We rename the existing __init__.py file to ensure that we don't load
860
init = 'non-standard-dir/__init__.py'
861
random = 'non-standard-dir/setup.py'
862
os.rename(init, random)
863
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
864
self.load_with_paths(['standard'])
865
self.assertPluginUnknown('test_foo')
867
def test_loading_from_specific_file(self):
868
plugin_dir = 'non-standard-dir'
869
plugin_file_name = 'iamtestfoo.py'
870
plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
872
"""This is the doc for %s"""
874
''' % ('test_foo', plugin_path)
875
self.create_plugin('test_foo', source=source,
876
dir=plugin_dir, file_name=plugin_file_name)
877
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@%s' % plugin_path)
878
self.load_with_paths(['standard'])
879
self.assertTestFooLoadedFrom(plugin_path)
882
class TestDescribePlugins(BaseTestPlugins):
884
def test_describe_plugins(self):
885
class DummyModule(object):
888
class DummyPlugin(object):
889
__version__ = '0.1.0'
890
module = DummyModule()
891
self.plugin_warnings = {'bad': ['Failed to load (just testing)']}
892
self.plugins = {'good': DummyPlugin()}
893
self.assertEqual("""\
895
** Failed to load (just testing)
900
""", ''.join(plugin.describe_plugins(state=self)))
903
class DummyPlugin(object):
907
class TestLoadEnvPlugin(BaseTestPlugins):
909
_test_needs_features = [pkg_resources_feature]
911
def setup_plugin(self, source=""):
912
# This test tests a new plugin appears in breezy.plugin.plugins().
913
# check the plugin is not loaded already
914
self.assertPluginUnknown('plugin')
915
# write a plugin that _cannot_ fail to load.
917
d = pkg_resources.Distribution(__file__)
918
ep = pkg_resources.EntryPoint.parse(
919
'plugin = ' + __name__ + ':DummyPlugin', dist=d)
920
d._ep_map = {'breezy.plugin': {'plugin': ep}}
921
pkg_resources.working_set.add(d, 'plugin', replace=True)
922
eps = list(pkg_resources.iter_entry_points('breezy.plugin'))
923
self.assertEqual(['plugin'], [ep.name for ep in eps])
924
self.load_with_paths(['.'])
925
self.addCleanup(d._ep_map.clear)
927
def test_plugin_loaded(self):
928
self.assertPluginUnknown('plugin')
929
self.overrideEnv('BRZ_PLUGIN_PATH', '+entrypoints')
931
p = self.plugins['plugin']
932
self.assertIsInstance(p, breezy.plugin.PlugIn)
933
self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
935
def test_plugin_loaded_disabled(self):
936
self.assertPluginUnknown('plugin')
937
self.overrideEnv('BRZ_PLUGIN_PATH', '+entrypoints')
938
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'plugin')
940
self.assertNotIn('plugin', self.plugins)
181
f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
187
bzrlib.plugin.load_from_dirs(['plugin_test'])
188
bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
189
help = self.capture('help myplug')
190
self.assertContainsRe(help, 'From plugin "myplug"')
191
help = self.split_help_commands()['myplug']
192
self.assertContainsRe(help, 'From plugin "myplug"')
194
# remove the plugin 'plugin'
195
if getattr(bzrlib.plugins, 'plugin', None):
196
del bzrlib.plugins.plugin
added
removed
bzrlib/tests/test_plugins.py
