1
# Copyright (C) 2005-2012, 2016 Canonical Ltd, 2017 Breezy developers
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for plugins"""
33
from ..sixish import (
40
# TODO: Write a test for plugin decoration of commands.
42
invalidate_caches = getattr(importlib, "invalidate_caches", lambda: None)
45
class BaseTestPlugins(tests.TestCaseInTempDir):
46
"""TestCase that isolates plugin imports and cleans up on completion."""
49
super(BaseTestPlugins, self).setUp()
50
self.module_name = "breezy.testingplugins"
51
self.module_prefix = self.module_name + "."
52
self.module = imp.new_module(self.module_name)
54
self.overrideAttr(plugin, "_MODULE_PREFIX", self.module_prefix)
55
self.overrideAttr(breezy, "testingplugins", self.module)
57
sys.modules[self.module_name] = self.module
58
self.addCleanup(self._unregister_all)
59
self.addCleanup(self._unregister_finder)
64
"""Remove all global testing state and clean up module."""
65
# GZ 2017-06-02: Ideally don't do this, write new test or generate
66
# bytecode by other mechanism.
67
self.log("resetting plugin testing context")
68
self._unregister_all()
69
self._unregister_finder()
70
sys.modules[self.module_name] = self.module
71
for name in list(self.module.__dict__):
73
delattr(self.module, name)
77
def update_module_paths(self, paths):
78
paths = plugin.extend_path(paths, self.module_name)
79
self.module.__path__ = paths
80
self.log("using %r", paths)
83
def load_with_paths(self, paths):
84
self.log("loading plugins!")
85
plugin.load_plugins(self.update_module_paths(paths), state=self)
87
def create_plugin(self, name, source=None, dir='.', file_name=None):
90
"""This is the doc for %s"""
93
file_name = name + '.py'
94
# 'source' must not fail to load
95
path = osutils.pathjoin(dir, file_name)
96
with open(path, 'w') as f:
97
f.write(source + '\n')
99
def create_plugin_package(self, name, dir=None, source=None):
104
"""This is the doc for %s"""
108
self.create_plugin(name, source, dir,
109
file_name='__init__.py')
111
def promote_cache(self, directory):
112
"""Move bytecode files out of __pycache__ in given directory."""
113
cache_dir = os.path.join(directory, '__pycache__')
114
if os.path.isdir(cache_dir):
115
for name in os.listdir(cache_dir):
116
magicless_name = '.'.join(name.split('.')[0::name.count('.')])
117
rel = osutils.relpath(self.test_dir, cache_dir)
118
self.log("moving %s in %s to %s", name, rel, magicless_name)
119
os.rename(os.path.join(cache_dir, name),
120
os.path.join(directory, magicless_name))
122
def _unregister_finder(self):
123
"""Removes any test copies of _PluginsAtFinder from sys.meta_path."""
124
idx = len(sys.meta_path)
127
finder = sys.meta_path[idx]
128
if getattr(finder, "prefix", "") == self.module_prefix:
129
self.log("removed %r from sys.meta_path", finder)
130
sys.meta_path.pop(idx)
132
def _unregister_all(self):
133
"""Remove all plugins in the test namespace from sys.modules."""
134
for name in list(sys.modules):
135
if name.startswith(self.module_prefix) or name == self.module_name:
136
self.log("removed %s from sys.modules", name)
137
del sys.modules[name]
139
def assertPluginModules(self, plugin_dict):
141
dict((k[len(self.module_prefix):], sys.modules[k])
142
for k in sys.modules if k.startswith(self.module_prefix)),
145
def assertPluginUnknown(self, name):
146
self.assertTrue(getattr(self.module, name, None) is None)
147
self.assertFalse(self.module_prefix + name in sys.modules)
149
def assertPluginKnown(self, name):
150
self.assertTrue(getattr(self.module, name, None) is not None)
151
self.assertTrue(self.module_prefix + name in sys.modules)
154
class TestLoadingPlugins(BaseTestPlugins):
156
activeattributes = {}
158
def test_plugins_with_the_same_name_are_not_loaded(self):
159
# This test tests that having two plugins in different directories does
160
# not result in both being loaded when they have the same name. get a
161
# file name we can use which is also a valid attribute for accessing in
162
# activeattributes. - we cannot give import parameters.
164
self.assertFalse(tempattribute in self.activeattributes)
165
# set a place for the plugins to record their loading, and at the same
166
# time validate that the location the plugins should record to is
168
self.__class__.activeattributes [tempattribute] = []
169
self.assertTrue(tempattribute in self.activeattributes)
170
# create two plugin directories
173
# write a plugin that will record when its loaded in the
174
# tempattribute list.
175
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
176
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
178
with open(os.path.join('first', 'plugin.py'), 'w') as outfile:
179
outfile.write(template % (tempattribute, 'first'))
182
with open(os.path.join('second', 'plugin.py'), 'w') as outfile:
183
outfile.write(template % (tempattribute, 'second'))
187
self.load_with_paths(['first', 'second'])
188
self.assertEqual(['first'], self.activeattributes[tempattribute])
190
del self.activeattributes[tempattribute]
192
def test_plugins_from_different_dirs_can_demand_load(self):
193
self.assertFalse('breezy.plugins.pluginone' in sys.modules)
194
self.assertFalse('breezy.plugins.plugintwo' in sys.modules)
195
# This test tests that having two plugins in different
196
# directories with different names allows them both to be loaded, when
197
# we do a direct import statement.
198
# Determine a file name we can use which is also a valid attribute
199
# for accessing in activeattributes. - we cannot give import parameters.
200
tempattribute = "different-dirs"
201
self.assertFalse(tempattribute in self.activeattributes)
202
# set a place for the plugins to record their loading, and at the same
203
# time validate that the location the plugins should record to is
205
breezy.tests.test_plugins.TestLoadingPlugins.activeattributes \
207
self.assertTrue(tempattribute in self.activeattributes)
208
# create two plugin directories
211
# write plugins that will record when they are loaded in the
212
# tempattribute list.
213
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
214
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
216
with open(os.path.join('first', 'pluginone.py'), 'w') as outfile:
217
outfile.write(template % (tempattribute, 'first'))
220
with open(os.path.join('second', 'plugintwo.py'), 'w') as outfile:
221
outfile.write(template % (tempattribute, 'second'))
225
self.assertPluginUnknown('pluginone')
226
self.assertPluginUnknown('plugintwo')
227
self.update_module_paths(['first', 'second'])
228
exec("import %spluginone" % self.module_prefix)
229
self.assertEqual(['first'], self.activeattributes[tempattribute])
230
exec("import %splugintwo" % self.module_prefix)
231
self.assertEqual(['first', 'second'],
232
self.activeattributes[tempattribute])
234
del self.activeattributes[tempattribute]
236
def test_plugins_can_load_from_directory_with_trailing_slash(self):
237
# This test tests that a plugin can load from a directory when the
238
# directory in the path has a trailing slash.
239
# check the plugin is not loaded already
240
self.assertPluginUnknown('ts_plugin')
241
tempattribute = "trailing-slash"
242
self.assertFalse(tempattribute in self.activeattributes)
243
# set a place for the plugin to record its loading, and at the same
244
# time validate that the location the plugin should record to is
246
breezy.tests.test_plugins.TestLoadingPlugins.activeattributes \
248
self.assertTrue(tempattribute in self.activeattributes)
249
# create a directory for the plugin
250
os.mkdir('plugin_test')
251
# write a plugin that will record when its loaded in the
252
# tempattribute list.
253
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
254
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
256
with open(os.path.join('plugin_test', 'ts_plugin.py'), 'w') as outfile:
257
outfile.write(template % (tempattribute, 'plugin'))
261
self.load_with_paths(['plugin_test'+os.sep])
262
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
263
self.assertPluginKnown('ts_plugin')
265
del self.activeattributes[tempattribute]
267
def load_and_capture(self, name):
268
"""Load plugins from '.' capturing the output.
270
:param name: The name of the plugin.
271
:return: A string with the log from the plugin loading call.
276
handler = logging.StreamHandler(stream)
277
log = logging.getLogger('brz')
278
log.addHandler(handler)
280
self.load_with_paths(['.'])
282
# Stop capturing output
285
log.removeHandler(handler)
286
return stream.getvalue()
290
def test_plugin_with_bad_api_version_reports(self):
291
"""Try loading a plugin that requests an unsupported api.
293
Observe that it records the problem but doesn't complain on stderr.
295
See https://bugs.launchpad.net/bzr/+bug/704195
298
with open(name, 'w') as f:
299
f.write("import breezy.api\n"
300
"breezy.api.require_any_api(breezy, [(1, 0, 0)])\n")
301
log = self.load_and_capture(name)
302
self.assertNotContainsRe(log,
303
r"It requested API version")
304
self.assertEqual({'wants100'}, viewkeys(self.plugin_warnings))
305
self.assertContainsRe(
306
self.plugin_warnings['wants100'][0],
307
r"It requested API 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: f.write(source + '\n')
328
self.load_with_paths(['.'])
330
def test_plugin_appears_in_plugins(self):
332
self.assertPluginKnown('plugin')
333
p = self.plugins['plugin']
334
self.assertIsInstance(p, breezy.plugin.PlugIn)
335
self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
337
def test_trivial_plugin_get_path(self):
339
p = self.plugins['plugin']
340
plugin_path = self.test_dir + '/plugin.py'
341
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
343
def test_plugin_get_path_py_not_pyc(self):
344
# first import creates plugin.pyc
346
self.promote_cache(self.test_dir)
348
self.load_with_paths(['.']) # import plugin.pyc
349
p = plugin.plugins()['plugin']
350
plugin_path = self.test_dir + '/plugin.py'
351
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
353
def test_plugin_get_path_pyc_only(self):
354
# first import creates plugin.pyc (or plugin.pyo depending on __debug__)
356
os.unlink(self.test_dir + '/plugin.py')
357
self.promote_cache(self.test_dir)
359
self.load_with_paths(['.']) # import plugin.pyc (or .pyo)
360
p = plugin.plugins()['plugin']
361
plugin_path = self.test_dir + '/plugin' + plugin.COMPILED_EXT
362
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
364
def test_no_test_suite_gives_None_for_test_suite(self):
366
p = plugin.plugins()['plugin']
367
self.assertEqual(None, p.test_suite())
369
def test_test_suite_gives_test_suite_result(self):
370
source = """def test_suite(): return 'foo'"""
371
self.setup_plugin(source)
372
p = plugin.plugins()['plugin']
373
self.assertEqual('foo', p.test_suite())
375
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
377
loader = tests.TestUtil.TestLoader()
378
p = plugin.plugins()['plugin']
379
self.assertEqual(None, p.load_plugin_tests(loader))
381
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
383
def load_tests(loader, standard_tests, pattern):
385
self.setup_plugin(source)
386
loader = tests.TestUtil.TestLoader()
387
p = plugin.plugins()['plugin']
388
self.assertEqual('foo', p.load_plugin_tests(loader))
390
def check_version_info(self, expected, source='', name='plugin'):
391
self.setup_plugin(source)
392
self.assertEqual(expected, plugin.plugins()[name].version_info())
394
def test_no_version_info(self):
395
self.check_version_info(None)
397
def test_with_version_info(self):
398
self.check_version_info((1, 2, 3, 'dev', 4),
399
"version_info = (1, 2, 3, 'dev', 4)")
401
def test_short_version_info_gets_padded(self):
402
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
404
self.check_version_info((1, 2, 3, 'final', 0),
405
"version_info = (1, 2, 3)")
407
def check_version(self, expected, source=None, name='plugin'):
408
self.setup_plugin(source)
409
self.assertEqual(expected, plugins[name].__version__)
411
def test_no_version_info___version__(self):
413
plugin = breezy.plugin.plugins()['plugin']
414
self.assertEqual("unknown", plugin.__version__)
416
def test_str__version__with_version_info(self):
417
self.setup_plugin("version_info = '1.2.3'")
418
plugin = breezy.plugin.plugins()['plugin']
419
self.assertEqual("1.2.3", plugin.__version__)
421
def test_noniterable__version__with_version_info(self):
422
self.setup_plugin("version_info = (1)")
423
plugin = breezy.plugin.plugins()['plugin']
424
self.assertEqual("1", plugin.__version__)
426
def test_1__version__with_version_info(self):
427
self.setup_plugin("version_info = (1,)")
428
plugin = breezy.plugin.plugins()['plugin']
429
self.assertEqual("1", plugin.__version__)
431
def test_1_2__version__with_version_info(self):
432
self.setup_plugin("version_info = (1, 2)")
433
plugin = breezy.plugin.plugins()['plugin']
434
self.assertEqual("1.2", plugin.__version__)
436
def test_1_2_3__version__with_version_info(self):
437
self.setup_plugin("version_info = (1, 2, 3)")
438
plugin = breezy.plugin.plugins()['plugin']
439
self.assertEqual("1.2.3", plugin.__version__)
441
def test_candidate__version__with_version_info(self):
442
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
443
plugin = breezy.plugin.plugins()['plugin']
444
self.assertEqual("1.2.3rc1", plugin.__version__)
446
def test_dev__version__with_version_info(self):
447
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
448
plugin = breezy.plugin.plugins()['plugin']
449
self.assertEqual("1.2.3dev", plugin.__version__)
451
def test_dev_fallback__version__with_version_info(self):
452
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
453
plugin = breezy.plugin.plugins()['plugin']
454
self.assertEqual("1.2.3dev4", plugin.__version__)
456
def test_final__version__with_version_info(self):
457
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
458
plugin = breezy.plugin.plugins()['plugin']
459
self.assertEqual("1.2.3", plugin.__version__)
461
def test_final_fallback__version__with_version_info(self):
462
self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
463
plugin = breezy.plugin.plugins()['plugin']
464
self.assertEqual("1.2.3.2", plugin.__version__)
467
# GZ 2017-06-02: Move this suite to blackbox, as it's what it actually is.
468
class TestPluginHelp(BaseTestPlugins):
470
def split_help_commands(self):
473
out, err = self.run_bzr('--no-plugins help commands')
474
for line in out.splitlines():
475
if not line.startswith(' '):
476
current = line.split()[0]
477
help[current] = help.get(current, '') + line
481
def test_plugin_help_builtins_unaffected(self):
482
# Check we don't get false positives
483
help_commands = self.split_help_commands()
484
for cmd_name in breezy.commands.builtin_command_names():
485
if cmd_name in breezy.commands.plugin_command_names():
488
help = breezy.commands.get_cmd_object(cmd_name).get_help_text()
489
except NotImplementedError:
490
# some commands have no help
493
self.assertNotContainsRe(help, 'plugin "[^"]*"')
495
if cmd_name in help_commands:
496
# some commands are hidden
497
help = help_commands[cmd_name]
498
self.assertNotContainsRe(help, 'plugin "[^"]*"')
500
def test_plugin_help_shows_plugin(self):
501
# Create a test plugin
502
os.mkdir('plugin_test')
504
"from breezy import commands\n"
505
"class cmd_myplug(commands.Command):\n"
506
" __doc__ = '''Just a simple test plugin.'''\n"
507
" aliases = ['mplg']\n"
509
" print ('Hello from my plugin')\n"
511
self.create_plugin('myplug', source, 'plugin_test')
514
self.load_with_paths(['plugin_test'])
515
myplug = self.plugins['myplug'].module
516
breezy.commands.register_command(myplug.cmd_myplug)
517
self.addCleanup(breezy.commands.plugin_cmds.remove, 'myplug')
518
help = self.run_bzr('help myplug')[0]
519
self.assertContainsRe(help, 'plugin "myplug"')
520
help = self.split_help_commands()['myplug']
521
self.assertContainsRe(help, '\[myplug\]')
524
class TestHelpIndex(tests.TestCase):
525
"""Tests for the PluginsHelpIndex class."""
527
def test_default_constructable(self):
528
index = plugin.PluginsHelpIndex()
530
def test_get_topics_None(self):
531
"""Searching for None returns an empty list."""
532
index = plugin.PluginsHelpIndex()
533
self.assertEqual([], index.get_topics(None))
535
def test_get_topics_for_plugin(self):
536
"""Searching for plugin name gets its docstring."""
537
index = plugin.PluginsHelpIndex()
538
# make a new plugin here for this test, even if we're run with
540
self.assertFalse('breezy.plugins.demo_module' in sys.modules)
541
demo_module = FakeModule('', 'breezy.plugins.demo_module')
542
sys.modules['breezy.plugins.demo_module'] = demo_module
544
topics = index.get_topics('demo_module')
545
self.assertEqual(1, len(topics))
546
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
547
self.assertEqual(demo_module, topics[0].module)
549
del sys.modules['breezy.plugins.demo_module']
551
def test_get_topics_no_topic(self):
552
"""Searching for something that is not a plugin returns []."""
553
# test this by using a name that cannot be a plugin - its not
554
# a valid python identifier.
555
index = plugin.PluginsHelpIndex()
556
self.assertEqual([], index.get_topics('nothing by this name'))
558
def test_prefix(self):
559
"""PluginsHelpIndex has a prefix of 'plugins/'."""
560
index = plugin.PluginsHelpIndex()
561
self.assertEqual('plugins/', index.prefix)
563
def test_get_plugin_topic_with_prefix(self):
564
"""Searching for plugins/demo_module returns help."""
565
index = plugin.PluginsHelpIndex()
566
self.assertFalse('breezy.plugins.demo_module' in sys.modules)
567
demo_module = FakeModule('', 'breezy.plugins.demo_module')
568
sys.modules['breezy.plugins.demo_module'] = demo_module
570
topics = index.get_topics('plugins/demo_module')
571
self.assertEqual(1, len(topics))
572
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
573
self.assertEqual(demo_module, topics[0].module)
575
del sys.modules['breezy.plugins.demo_module']
578
class FakeModule(object):
579
"""A fake module to test with."""
581
def __init__(self, doc, name):
586
class TestModuleHelpTopic(tests.TestCase):
587
"""Tests for the ModuleHelpTopic class."""
589
def test_contruct(self):
590
"""Construction takes the module to document."""
591
mod = FakeModule('foo', 'foo')
592
topic = plugin.ModuleHelpTopic(mod)
593
self.assertEqual(mod, topic.module)
595
def test_get_help_text_None(self):
596
"""A ModuleHelpTopic returns the docstring for get_help_text."""
597
mod = FakeModule(None, 'demo')
598
topic = plugin.ModuleHelpTopic(mod)
599
self.assertEqual("Plugin 'demo' has no docstring.\n",
600
topic.get_help_text())
602
def test_get_help_text_no_carriage_return(self):
603
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
604
mod = FakeModule('one line of help', 'demo')
605
topic = plugin.ModuleHelpTopic(mod)
606
self.assertEqual("one line of help\n",
607
topic.get_help_text())
609
def test_get_help_text_carriage_return(self):
610
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
611
mod = FakeModule('two lines of help\nand more\n', 'demo')
612
topic = plugin.ModuleHelpTopic(mod)
613
self.assertEqual("two lines of help\nand more\n",
614
topic.get_help_text())
616
def test_get_help_text_with_additional_see_also(self):
617
mod = FakeModule('two lines of help\nand more', 'demo')
618
topic = plugin.ModuleHelpTopic(mod)
619
self.assertEqual("two lines of help\nand more\n\n:See also: bar, foo\n",
620
topic.get_help_text(['foo', 'bar']))
622
def test_get_help_topic(self):
623
"""The help topic for a plugin is its module name."""
624
mod = FakeModule('two lines of help\nand more', 'breezy.plugins.demo')
625
topic = plugin.ModuleHelpTopic(mod)
626
self.assertEqual('demo', topic.get_help_topic())
627
mod = FakeModule('two lines of help\nand more',
628
'breezy.plugins.foo_bar')
629
topic = plugin.ModuleHelpTopic(mod)
630
self.assertEqual('foo_bar', topic.get_help_topic())
633
class TestEnvPluginPath(tests.TestCase):
639
def check_path(self, expected_dirs, setting_dirs):
640
if setting_dirs is None:
641
del os.environ['BRZ_PLUGIN_PATH']
643
os.environ['BRZ_PLUGIN_PATH'] = os.pathsep.join(setting_dirs)
644
actual = [(p if t == 'path' else t.upper())
645
for p, t in plugin._env_plugin_path()]
646
self.assertEqual(expected_dirs, actual)
648
def test_default(self):
649
self.check_path([self.user, self.core, self.site],
652
def test_adhoc_policy(self):
653
self.check_path([self.user, self.core, self.site],
654
['+user', '+core', '+site'])
656
def test_fallback_policy(self):
657
self.check_path([self.core, self.site, self.user],
658
['+core', '+site', '+user'])
660
def test_override_policy(self):
661
self.check_path([self.user, self.site, self.core],
662
['+user', '+site', '+core'])
664
def test_disable_user(self):
665
self.check_path([self.core, self.site], ['-user'])
667
def test_disable_user_twice(self):
668
# Ensures multiple removals don't left cruft
669
self.check_path([self.core, self.site], ['-user', '-user'])
671
def test_duplicates_are_removed(self):
672
self.check_path([self.user, self.core, self.site],
674
# And only the first reference is kept (since the later references will
675
# only produce '<plugin> already loaded' mutters)
676
self.check_path([self.user, self.core, self.site],
677
['+user', '+user', '+core',
678
'+user', '+site', '+site',
681
def test_disable_overrides_enable(self):
682
self.check_path([self.core, self.site], ['-user', '+user'])
684
def test_disable_core(self):
685
self.check_path([self.site], ['-core'])
686
self.check_path([self.user, self.site], ['+user', '-core'])
688
def test_disable_site(self):
689
self.check_path([self.core], ['-site'])
690
self.check_path([self.user, self.core], ['-site', '+user'])
692
def test_override_site(self):
693
self.check_path(['mysite', self.user, self.core],
694
['mysite', '-site', '+user'])
695
self.check_path(['mysite', self.core],
698
def test_override_core(self):
699
self.check_path(['mycore', self.user, self.site],
700
['mycore', '-core', '+user', '+site'])
701
self.check_path(['mycore', self.site],
704
def test_my_plugin_only(self):
705
self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
707
def test_my_plugin_first(self):
708
self.check_path(['myplugin', self.core, self.site, self.user],
709
['myplugin', '+core', '+site', '+user'])
711
def test_bogus_references(self):
712
self.check_path(['+foo', '-bar', self.core, self.site],
716
class TestDisablePlugin(BaseTestPlugins):
718
def test_cannot_import(self):
719
self.create_plugin_package('works')
720
self.create_plugin_package('fails')
721
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'fails')
722
self.update_module_paths(["."])
723
import breezy.testingplugins.works as works
725
import breezy.testingplugins.fails as fails
729
self.fail("Loaded blocked plugin: " + repr(fails))
730
self.assertPluginModules({'fails': None, 'works': works})
732
def test_partial_imports(self):
733
self.create_plugin('good')
734
self.create_plugin('bad')
735
self.create_plugin_package('ugly')
736
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'bad:ugly')
737
self.load_with_paths(['.'])
738
self.assertEqual({'good'}, viewkeys(self.plugins))
739
self.assertPluginModules({
740
'good': self.plugins['good'].module,
744
# Ensure there are no warnings about plugins not being imported as
745
# the user has explictly requested they be disabled.
746
self.assertNotContainsRe(self.get_log(), r"Unable to load plugin")
749
class TestEnvDisablePlugins(tests.TestCase):
751
def _get_names(self, env_value):
752
os.environ['BRZ_DISABLE_PLUGINS'] = env_value
753
return plugin._env_disable_plugins()
755
def test_unset(self):
756
self.assertEqual([], plugin._env_disable_plugins())
758
def test_empty(self):
759
self.assertEqual([], self._get_names(''))
761
def test_single(self):
762
self.assertEqual(['single'], self._get_names('single'))
764
def test_multi(self):
765
expected = ['one', 'two']
766
self.assertEqual(expected, self._get_names(os.pathsep.join(expected)))
768
def test_mixed(self):
769
value = os.pathsep.join(['valid', 'in-valid'])
770
self.assertEqual(['valid'], self._get_names(value))
771
self.assertContainsRe(self.get_log(),
772
r"Invalid name 'in-valid' in BRZ_DISABLE_PLUGINS=" + repr(value))
775
class TestEnvPluginsAt(tests.TestCase):
777
def _get_paths(self, env_value):
778
os.environ['BRZ_PLUGINS_AT'] = env_value
779
return plugin._env_plugins_at()
781
def test_empty(self):
782
self.assertEqual([], plugin._env_plugins_at())
783
self.assertEqual([], self._get_paths(''))
785
def test_one_path(self):
786
self.assertEqual([('b', 'man')], self._get_paths('b@man'))
788
def test_multiple(self):
790
[('tools', 'bzr-tools'), ('p', 'play.py')],
791
self._get_paths(os.pathsep.join(('tools@bzr-tools', 'p@play.py'))))
793
def test_many_at(self):
795
[('church', 'StMichael@Plea@Norwich')],
796
self._get_paths('church@StMichael@Plea@Norwich'))
798
def test_only_py(self):
799
self.assertEqual([('test', './test.py')], self._get_paths('./test.py'))
801
def test_only_package(self):
802
self.assertEqual([('py', '/opt/b/py')], self._get_paths('/opt/b/py'))
804
def test_bad_name(self):
805
self.assertEqual([], self._get_paths('/usr/local/bzr-git'))
806
self.assertContainsRe(self.get_log(),
807
r"Invalid name 'bzr-git' in BRZ_PLUGINS_AT='/usr/local/bzr-git'")
810
class TestLoadPluginAt(BaseTestPlugins):
813
super(TestLoadPluginAt, self).setUp()
814
# Create the same plugin in two directories
815
self.create_plugin_package('test_foo', dir='non-standard-dir')
816
# The "normal" directory, we use 'standard' instead of 'plugins' to
817
# avoid depending on the precise naming.
818
self.create_plugin_package('test_foo', dir='standard/test_foo')
820
def assertTestFooLoadedFrom(self, path):
821
self.assertPluginKnown('test_foo')
822
self.assertDocstring('This is the doc for test_foo',
823
self.module.test_foo)
824
self.assertEqual(path, self.module.test_foo.dir_source)
826
def test_regular_load(self):
827
self.load_with_paths(['standard'])
828
self.assertTestFooLoadedFrom('standard/test_foo')
830
def test_import(self):
831
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
832
self.update_module_paths(['standard'])
833
import breezy.testingplugins.test_foo
834
self.assertTestFooLoadedFrom('non-standard-dir')
836
def test_loading(self):
837
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
838
self.load_with_paths(['standard'])
839
self.assertTestFooLoadedFrom('non-standard-dir')
841
def test_loading_other_name(self):
842
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
843
os.rename('standard/test_foo', 'standard/test_bar')
844
self.load_with_paths(['standard'])
845
self.assertTestFooLoadedFrom('non-standard-dir')
847
def test_compiled_loaded(self):
848
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
849
self.load_with_paths(['standard'])
850
self.assertTestFooLoadedFrom('non-standard-dir')
851
self.assertIsSameRealPath('non-standard-dir/__init__.py',
852
self.module.test_foo.__file__)
854
# Try importing again now that the source has been compiled
855
os.remove('non-standard-dir/__init__.py')
856
self.promote_cache('non-standard-dir')
858
self.load_with_paths(['standard'])
859
self.assertTestFooLoadedFrom('non-standard-dir')
860
suffix = plugin.COMPILED_EXT
861
self.assertIsSameRealPath('non-standard-dir/__init__' + suffix,
862
self.module.test_foo.__file__)
864
def test_submodule_loading(self):
865
# We create an additional directory under the one for test_foo
866
self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
867
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
868
self.update_module_paths(['standard'])
869
import breezy.testingplugins.test_foo
870
self.assertEqual(self.module_prefix + 'test_foo',
871
self.module.test_foo.__package__)
872
import breezy.testingplugins.test_foo.test_bar
873
self.assertIsSameRealPath('non-standard-dir/test_bar/__init__.py',
874
self.module.test_foo.test_bar.__file__)
876
def test_relative_submodule_loading(self):
877
self.create_plugin_package('test_foo', dir='another-dir', source='''
878
from . import test_bar
880
# We create an additional directory under the one for test_foo
881
self.create_plugin_package('test_bar', dir='another-dir/test_bar')
882
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@another-dir')
883
self.update_module_paths(['standard'])
884
import breezy.testingplugins.test_foo
885
self.assertEqual(self.module_prefix + 'test_foo',
886
self.module.test_foo.__package__)
887
self.assertIsSameRealPath('another-dir/test_bar/__init__.py',
888
self.module.test_foo.test_bar.__file__)
890
def test_loading_from___init__only(self):
891
# We rename the existing __init__.py file to ensure that we don't load
893
init = 'non-standard-dir/__init__.py'
894
random = 'non-standard-dir/setup.py'
895
os.rename(init, random)
896
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
897
self.load_with_paths(['standard'])
898
self.assertPluginUnknown('test_foo')
900
def test_loading_from_specific_file(self):
901
plugin_dir = 'non-standard-dir'
902
plugin_file_name = 'iamtestfoo.py'
903
plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
905
"""This is the doc for %s"""
907
''' % ('test_foo', plugin_path)
908
self.create_plugin('test_foo', source=source,
909
dir=plugin_dir, file_name=plugin_file_name)
910
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@%s' % plugin_path)
911
self.load_with_paths(['standard'])
912
self.assertTestFooLoadedFrom(plugin_path)
915
class TestDescribePlugins(BaseTestPlugins):
917
def test_describe_plugins(self):
918
class DummyModule(object):
920
class DummyPlugin(object):
921
__version__ = '0.1.0'
922
module = DummyModule()
923
self.plugin_warnings = {'bad': ['Failed to load (just testing)']}
924
self.plugins = {'good': DummyPlugin()}
925
self.assertEqual("""\
927
** Failed to load (just testing)
932
""", ''.join(plugin.describe_plugins(state=self)))
added
removed
breezy/tests/test_plugins.py
