1
# Copyright (C) 2005-2012, 2016 Canonical Ltd
2
# Copyright (C) 2017-2018 Breezy developers
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Tests for plugins"""
32
from ..sixish import (
38
# TODO: Write a test for plugin decoration of commands.
40
invalidate_caches = getattr(importlib, "invalidate_caches", lambda: None)
43
class BaseTestPlugins(tests.TestCaseInTempDir):
44
"""TestCase that isolates plugin imports and cleans up on completion."""
47
super(BaseTestPlugins, self).setUp()
48
self.module_name = "breezy.testingplugins"
49
self.module_prefix = self.module_name + "."
50
self.module = types.ModuleType(self.module_name)
52
self.overrideAttr(plugin, "_MODULE_PREFIX", self.module_prefix)
53
self.overrideAttr(breezy, "testingplugins", self.module)
55
sys.modules[self.module_name] = self.module
56
self.addCleanup(self._unregister_all)
57
self.addCleanup(self._unregister_finder)
62
"""Remove all global testing state and clean up module."""
63
# GZ 2017-06-02: Ideally don't do this, write new test or generate
64
# bytecode by other mechanism.
65
self.log("resetting plugin testing context")
66
self._unregister_all()
67
self._unregister_finder()
68
sys.modules[self.module_name] = self.module
69
for name in list(self.module.__dict__):
71
delattr(self.module, name)
75
def update_module_paths(self, paths):
76
paths = plugin.extend_path(paths, self.module_name)
77
self.module.__path__ = paths
78
self.log("using %r", paths)
81
def load_with_paths(self, paths):
82
self.log("loading plugins!")
83
plugin.load_plugins(self.update_module_paths(paths), state=self)
85
def create_plugin(self, name, source=None, dir='.', file_name=None):
88
"""This is the doc for %s"""
91
file_name = name + '.py'
92
# 'source' must not fail to load
93
path = osutils.pathjoin(dir, file_name)
94
with open(path, 'w') as f:
95
f.write(source + '\n')
97
def create_plugin_package(self, name, dir=None, source=None):
102
"""This is the doc for %s"""
106
self.create_plugin(name, source, dir,
107
file_name='__init__.py')
109
def promote_cache(self, directory):
110
"""Move bytecode files out of __pycache__ in given directory."""
111
cache_dir = os.path.join(directory, '__pycache__')
112
if os.path.isdir(cache_dir):
113
for name in os.listdir(cache_dir):
114
magicless_name = '.'.join(name.split('.')[0::name.count('.')])
115
rel = osutils.relpath(self.test_dir, cache_dir)
116
self.log("moving %s in %s to %s", name, rel, magicless_name)
117
os.rename(os.path.join(cache_dir, name),
118
os.path.join(directory, magicless_name))
120
def _unregister_finder(self):
121
"""Removes any test copies of _PluginsAtFinder from sys.meta_path."""
122
idx = len(sys.meta_path)
125
finder = sys.meta_path[idx]
126
if getattr(finder, "prefix", "") == self.module_prefix:
127
self.log("removed %r from sys.meta_path", finder)
128
sys.meta_path.pop(idx)
130
def _unregister_all(self):
131
"""Remove all plugins in the test namespace from sys.modules."""
132
for name in list(sys.modules):
133
if name.startswith(self.module_prefix) or name == self.module_name:
134
self.log("removed %s from sys.modules", name)
135
del sys.modules[name]
137
def assertPluginModules(self, plugin_dict):
139
dict((k[len(self.module_prefix):], sys.modules[k])
140
for k in sys.modules if k.startswith(self.module_prefix)),
143
def assertPluginUnknown(self, name):
144
self.assertTrue(getattr(self.module, name, None) is None)
145
self.assertFalse(self.module_prefix + name in sys.modules)
147
def assertPluginKnown(self, name):
148
self.assertTrue(getattr(self.module, name, None) is not None)
149
self.assertTrue(self.module_prefix + name in sys.modules)
152
class TestLoadingPlugins(BaseTestPlugins):
154
activeattributes = {}
156
def test_plugins_with_the_same_name_are_not_loaded(self):
157
# This test tests that having two plugins in different directories does
158
# not result in both being loaded when they have the same name. get a
159
# file name we can use which is also a valid attribute for accessing in
160
# activeattributes. - we cannot give import parameters.
162
self.assertFalse(tempattribute in self.activeattributes)
163
# set a place for the plugins to record their loading, and at the same
164
# time validate that the location the plugins should record to is
166
self.__class__.activeattributes[tempattribute] = []
167
self.assertTrue(tempattribute in self.activeattributes)
168
# create two plugin directories
171
# write a plugin that will record when its loaded in the
172
# tempattribute list.
173
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
174
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
176
with open(os.path.join('first', 'plugin.py'), 'w') as outfile:
177
outfile.write(template % (tempattribute, 'first'))
180
with open(os.path.join('second', 'plugin.py'), 'w') as outfile:
181
outfile.write(template % (tempattribute, 'second'))
185
self.load_with_paths(['first', 'second'])
186
self.assertEqual(['first'], self.activeattributes[tempattribute])
188
del self.activeattributes[tempattribute]
190
def test_plugins_from_different_dirs_can_demand_load(self):
191
self.assertFalse('breezy.plugins.pluginone' in sys.modules)
192
self.assertFalse('breezy.plugins.plugintwo' in sys.modules)
193
# This test tests that having two plugins in different
194
# directories with different names allows them both to be loaded, when
195
# we do a direct import statement.
196
# Determine a file name we can use which is also a valid attribute
197
# for accessing in activeattributes. - we cannot give import parameters.
198
tempattribute = "different-dirs"
199
self.assertFalse(tempattribute in self.activeattributes)
200
# set a place for the plugins to record their loading, and at the same
201
# time validate that the location the plugins should record to is
203
breezy.tests.test_plugins.TestLoadingPlugins.activeattributes[tempattribute] = [
205
self.assertTrue(tempattribute in self.activeattributes)
206
# create two plugin directories
209
# write plugins that will record when they are loaded in the
210
# tempattribute list.
211
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
212
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
214
with open(os.path.join('first', 'pluginone.py'), 'w') as outfile:
215
outfile.write(template % (tempattribute, 'first'))
218
with open(os.path.join('second', 'plugintwo.py'), 'w') as outfile:
219
outfile.write(template % (tempattribute, 'second'))
223
self.assertPluginUnknown('pluginone')
224
self.assertPluginUnknown('plugintwo')
225
self.update_module_paths(['first', 'second'])
226
exec("import %spluginone" % self.module_prefix)
227
self.assertEqual(['first'], self.activeattributes[tempattribute])
228
exec("import %splugintwo" % self.module_prefix)
229
self.assertEqual(['first', 'second'],
230
self.activeattributes[tempattribute])
232
del self.activeattributes[tempattribute]
234
def test_plugins_can_load_from_directory_with_trailing_slash(self):
235
# This test tests that a plugin can load from a directory when the
236
# directory in the path has a trailing slash.
237
# check the plugin is not loaded already
238
self.assertPluginUnknown('ts_plugin')
239
tempattribute = "trailing-slash"
240
self.assertFalse(tempattribute in self.activeattributes)
241
# set a place for the plugin to record its loading, and at the same
242
# time validate that the location the plugin should record to is
244
breezy.tests.test_plugins.TestLoadingPlugins.activeattributes[tempattribute] = [
246
self.assertTrue(tempattribute in self.activeattributes)
247
# create a directory for the plugin
248
os.mkdir('plugin_test')
249
# write a plugin that will record when its loaded in the
250
# tempattribute list.
251
template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
252
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
254
with open(os.path.join('plugin_test', 'ts_plugin.py'), 'w') as outfile:
255
outfile.write(template % (tempattribute, 'plugin'))
259
self.load_with_paths(['plugin_test' + os.sep])
260
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
261
self.assertPluginKnown('ts_plugin')
263
del self.activeattributes[tempattribute]
265
def load_and_capture(self, name):
266
"""Load plugins from '.' capturing the output.
268
:param name: The name of the plugin.
269
:return: A string with the log from the plugin loading call.
274
handler = logging.StreamHandler(stream)
275
log = logging.getLogger('brz')
276
log.addHandler(handler)
278
self.load_with_paths(['.'])
280
# Stop capturing output
283
log.removeHandler(handler)
284
return stream.getvalue()
288
def test_plugin_with_bad_api_version_reports(self):
289
"""Try loading a plugin that requests an unsupported api.
291
Observe that it records the problem but doesn't complain on stderr.
293
See https://bugs.launchpad.net/bzr/+bug/704195
296
with open(name, 'w') as f:
297
f.write("import breezy\n"
298
"from breezy.errors import IncompatibleVersion\n"
299
"raise IncompatibleVersion(breezy, [(1, 0, 0)], (0, 0, 5))\n")
300
log = self.load_and_capture(name)
301
self.assertNotContainsRe(log,
302
r"It supports breezy version")
303
self.assertEqual({'wants100'}, viewkeys(self.plugin_warnings))
304
self.assertContainsRe(
305
self.plugin_warnings['wants100'][0],
306
r"It supports breezy version")
308
def test_plugin_with_bad_name_does_not_load(self):
309
# The file name here invalid for a python module.
310
name = 'brz-bad plugin-name..py'
311
open(name, 'w').close()
312
log = self.load_and_capture(name)
313
self.assertContainsRe(log,
314
r"Unable to load 'brz-bad plugin-name\.' in '\.' as a plugin "
315
"because the file path isn't a valid module name; try renaming "
316
"it to 'bad_plugin_name_'\\.")
319
class TestPlugins(BaseTestPlugins):
321
def setup_plugin(self, source=""):
322
# This test tests a new plugin appears in breezy.plugin.plugins().
323
# check the plugin is not loaded already
324
self.assertPluginUnknown('plugin')
325
# write a plugin that _cannot_ fail to load.
326
with open('plugin.py', 'w') as f:
327
f.write(source + '\n')
328
self.load_with_paths(['.'])
330
def test_plugin_loaded(self):
331
self.assertPluginUnknown('plugin')
332
self.assertIs(None, breezy.plugin.get_loaded_plugin('plugin'))
334
p = breezy.plugin.get_loaded_plugin('plugin')
335
self.assertIsInstance(p, breezy.plugin.PlugIn)
336
self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
338
def test_plugin_loaded_disabled(self):
339
self.assertPluginUnknown('plugin')
340
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'plugin')
342
self.assertIs(None, breezy.plugin.get_loaded_plugin('plugin'))
344
def test_plugin_appears_in_plugins(self):
346
self.assertPluginKnown('plugin')
347
p = self.plugins['plugin']
348
self.assertIsInstance(p, breezy.plugin.PlugIn)
349
self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
351
def test_trivial_plugin_get_path(self):
353
p = self.plugins['plugin']
354
plugin_path = self.test_dir + '/plugin.py'
355
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
357
def test_plugin_get_path_py_not_pyc(self):
358
# first import creates plugin.pyc
360
self.promote_cache(self.test_dir)
362
self.load_with_paths(['.']) # import plugin.pyc
363
p = plugin.plugins()['plugin']
364
plugin_path = self.test_dir + '/plugin.py'
365
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
367
def test_plugin_get_path_pyc_only(self):
368
# first import creates plugin.pyc (or plugin.pyo depending on __debug__)
370
os.unlink(self.test_dir + '/plugin.py')
371
self.promote_cache(self.test_dir)
373
self.load_with_paths(['.']) # import plugin.pyc (or .pyo)
374
p = plugin.plugins()['plugin']
375
plugin_path = self.test_dir + '/plugin' + plugin.COMPILED_EXT
376
self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
378
def test_no_test_suite_gives_None_for_test_suite(self):
380
p = plugin.plugins()['plugin']
381
self.assertEqual(None, p.test_suite())
383
def test_test_suite_gives_test_suite_result(self):
384
source = """def test_suite(): return 'foo'"""
385
self.setup_plugin(source)
386
p = plugin.plugins()['plugin']
387
self.assertEqual('foo', p.test_suite())
389
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
391
loader = tests.TestUtil.TestLoader()
392
p = plugin.plugins()['plugin']
393
self.assertEqual(None, p.load_plugin_tests(loader))
395
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
397
def load_tests(loader, standard_tests, pattern):
399
self.setup_plugin(source)
400
loader = tests.TestUtil.TestLoader()
401
p = plugin.plugins()['plugin']
402
self.assertEqual('foo', p.load_plugin_tests(loader))
404
def check_version_info(self, expected, source='', name='plugin'):
405
self.setup_plugin(source)
406
self.assertEqual(expected, plugin.plugins()[name].version_info())
408
def test_no_version_info(self):
409
self.check_version_info(None)
411
def test_with_version_info(self):
412
self.check_version_info((1, 2, 3, 'dev', 4),
413
"version_info = (1, 2, 3, 'dev', 4)")
415
def test_short_version_info_gets_padded(self):
416
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
418
self.check_version_info((1, 2, 3, 'final', 0),
419
"version_info = (1, 2, 3)")
421
def check_version(self, expected, source=None, name='plugin'):
422
self.setup_plugin(source)
423
self.assertEqual(expected, plugins[name].__version__)
425
def test_no_version_info___version__(self):
427
plugin = breezy.plugin.plugins()['plugin']
428
self.assertEqual("unknown", plugin.__version__)
430
def test_str__version__with_version_info(self):
431
self.setup_plugin("version_info = '1.2.3'")
432
plugin = breezy.plugin.plugins()['plugin']
433
self.assertEqual("1.2.3", plugin.__version__)
435
def test_noniterable__version__with_version_info(self):
436
self.setup_plugin("version_info = (1)")
437
plugin = breezy.plugin.plugins()['plugin']
438
self.assertEqual("1", plugin.__version__)
440
def test_1__version__with_version_info(self):
441
self.setup_plugin("version_info = (1,)")
442
plugin = breezy.plugin.plugins()['plugin']
443
self.assertEqual("1", plugin.__version__)
445
def test_1_2__version__with_version_info(self):
446
self.setup_plugin("version_info = (1, 2)")
447
plugin = breezy.plugin.plugins()['plugin']
448
self.assertEqual("1.2", plugin.__version__)
450
def test_1_2_3__version__with_version_info(self):
451
self.setup_plugin("version_info = (1, 2, 3)")
452
plugin = breezy.plugin.plugins()['plugin']
453
self.assertEqual("1.2.3", plugin.__version__)
455
def test_candidate__version__with_version_info(self):
456
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
457
plugin = breezy.plugin.plugins()['plugin']
458
self.assertEqual("1.2.3rc1", plugin.__version__)
460
def test_dev__version__with_version_info(self):
461
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
462
plugin = breezy.plugin.plugins()['plugin']
463
self.assertEqual("1.2.3dev", plugin.__version__)
465
def test_dev_fallback__version__with_version_info(self):
466
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
467
plugin = breezy.plugin.plugins()['plugin']
468
self.assertEqual("1.2.3dev4", plugin.__version__)
470
def test_final__version__with_version_info(self):
471
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
472
plugin = breezy.plugin.plugins()['plugin']
473
self.assertEqual("1.2.3", plugin.__version__)
475
def test_final_fallback__version__with_version_info(self):
476
self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
477
plugin = breezy.plugin.plugins()['plugin']
478
self.assertEqual("1.2.3.2", plugin.__version__)
481
class TestHelpIndex(tests.TestCase):
482
"""Tests for the PluginsHelpIndex class."""
484
def test_default_constructable(self):
485
index = plugin.PluginsHelpIndex()
487
def test_get_topics_None(self):
488
"""Searching for None returns an empty list."""
489
index = plugin.PluginsHelpIndex()
490
self.assertEqual([], index.get_topics(None))
492
def test_get_topics_for_plugin(self):
493
"""Searching for plugin name gets its docstring."""
494
index = plugin.PluginsHelpIndex()
495
# make a new plugin here for this test, even if we're run with
497
self.assertFalse('breezy.plugins.demo_module' in sys.modules)
498
demo_module = FakeModule('', 'breezy.plugins.demo_module')
499
sys.modules['breezy.plugins.demo_module'] = demo_module
501
topics = index.get_topics('demo_module')
502
self.assertEqual(1, len(topics))
503
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
504
self.assertEqual(demo_module, topics[0].module)
506
del sys.modules['breezy.plugins.demo_module']
508
def test_get_topics_no_topic(self):
509
"""Searching for something that is not a plugin returns []."""
510
# test this by using a name that cannot be a plugin - its not
511
# a valid python identifier.
512
index = plugin.PluginsHelpIndex()
513
self.assertEqual([], index.get_topics('nothing by this name'))
515
def test_prefix(self):
516
"""PluginsHelpIndex has a prefix of 'plugins/'."""
517
index = plugin.PluginsHelpIndex()
518
self.assertEqual('plugins/', index.prefix)
520
def test_get_plugin_topic_with_prefix(self):
521
"""Searching for plugins/demo_module returns help."""
522
index = plugin.PluginsHelpIndex()
523
self.assertFalse('breezy.plugins.demo_module' in sys.modules)
524
demo_module = FakeModule('', 'breezy.plugins.demo_module')
525
sys.modules['breezy.plugins.demo_module'] = demo_module
527
topics = index.get_topics('plugins/demo_module')
528
self.assertEqual(1, len(topics))
529
self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
530
self.assertEqual(demo_module, topics[0].module)
532
del sys.modules['breezy.plugins.demo_module']
535
class FakeModule(object):
536
"""A fake module to test with."""
538
def __init__(self, doc, name):
543
class TestModuleHelpTopic(tests.TestCase):
544
"""Tests for the ModuleHelpTopic class."""
546
def test_contruct(self):
547
"""Construction takes the module to document."""
548
mod = FakeModule('foo', 'foo')
549
topic = plugin.ModuleHelpTopic(mod)
550
self.assertEqual(mod, topic.module)
552
def test_get_help_text_None(self):
553
"""A ModuleHelpTopic returns the docstring for get_help_text."""
554
mod = FakeModule(None, 'demo')
555
topic = plugin.ModuleHelpTopic(mod)
556
self.assertEqual("Plugin 'demo' has no docstring.\n",
557
topic.get_help_text())
559
def test_get_help_text_no_carriage_return(self):
560
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
561
mod = FakeModule('one line of help', 'demo')
562
topic = plugin.ModuleHelpTopic(mod)
563
self.assertEqual("one line of help\n",
564
topic.get_help_text())
566
def test_get_help_text_carriage_return(self):
567
"""ModuleHelpTopic.get_help_text adds a \n if needed."""
568
mod = FakeModule('two lines of help\nand more\n', 'demo')
569
topic = plugin.ModuleHelpTopic(mod)
570
self.assertEqual("two lines of help\nand more\n",
571
topic.get_help_text())
573
def test_get_help_text_with_additional_see_also(self):
574
mod = FakeModule('two lines of help\nand more', 'demo')
575
topic = plugin.ModuleHelpTopic(mod)
577
"two lines of help\nand more\n\n:See also: bar, foo\n",
578
topic.get_help_text(['foo', 'bar']))
580
def test_get_help_topic(self):
581
"""The help topic for a plugin is its module name."""
582
mod = FakeModule('two lines of help\nand more', 'breezy.plugins.demo')
583
topic = plugin.ModuleHelpTopic(mod)
584
self.assertEqual('demo', topic.get_help_topic())
585
mod = FakeModule('two lines of help\nand more',
586
'breezy.plugins.foo_bar')
587
topic = plugin.ModuleHelpTopic(mod)
588
self.assertEqual('foo_bar', topic.get_help_topic())
591
class TestEnvPluginPath(tests.TestCase):
597
def check_path(self, expected_dirs, setting_dirs):
598
if setting_dirs is None:
599
del os.environ['BRZ_PLUGIN_PATH']
601
os.environ['BRZ_PLUGIN_PATH'] = os.pathsep.join(setting_dirs)
602
actual = [(p if t == 'path' else t.upper())
603
for p, t in plugin._env_plugin_path()]
604
self.assertEqual(expected_dirs, actual)
606
def test_default(self):
607
self.check_path([self.user, self.core, self.site],
610
def test_adhoc_policy(self):
611
self.check_path([self.user, self.core, self.site],
612
['+user', '+core', '+site'])
614
def test_fallback_policy(self):
615
self.check_path([self.core, self.site, self.user],
616
['+core', '+site', '+user'])
618
def test_override_policy(self):
619
self.check_path([self.user, self.site, self.core],
620
['+user', '+site', '+core'])
622
def test_disable_user(self):
623
self.check_path([self.core, self.site], ['-user'])
625
def test_disable_user_twice(self):
626
# Ensures multiple removals don't left cruft
627
self.check_path([self.core, self.site], ['-user', '-user'])
629
def test_duplicates_are_removed(self):
630
self.check_path([self.user, self.core, self.site],
632
# And only the first reference is kept (since the later references will
633
# only produce '<plugin> already loaded' mutters)
634
self.check_path([self.user, self.core, self.site],
635
['+user', '+user', '+core',
636
'+user', '+site', '+site',
639
def test_disable_overrides_enable(self):
640
self.check_path([self.core, self.site], ['-user', '+user'])
642
def test_disable_core(self):
643
self.check_path([self.site], ['-core'])
644
self.check_path([self.user, self.site], ['+user', '-core'])
646
def test_disable_site(self):
647
self.check_path([self.core], ['-site'])
648
self.check_path([self.user, self.core], ['-site', '+user'])
650
def test_override_site(self):
651
self.check_path(['mysite', self.user, self.core],
652
['mysite', '-site', '+user'])
653
self.check_path(['mysite', self.core],
656
def test_override_core(self):
657
self.check_path(['mycore', self.user, self.site],
658
['mycore', '-core', '+user', '+site'])
659
self.check_path(['mycore', self.site],
662
def test_my_plugin_only(self):
663
self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
665
def test_my_plugin_first(self):
666
self.check_path(['myplugin', self.core, self.site, self.user],
667
['myplugin', '+core', '+site', '+user'])
669
def test_bogus_references(self):
670
self.check_path(['+foo', '-bar', self.core, self.site],
674
class TestDisablePlugin(BaseTestPlugins):
676
def test_cannot_import(self):
677
self.create_plugin_package('works')
678
self.create_plugin_package('fails')
679
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'fails')
680
self.update_module_paths(["."])
681
import breezy.testingplugins.works as works
683
import breezy.testingplugins.fails as fails
687
self.fail("Loaded blocked plugin: " + repr(fails))
688
self.assertPluginModules({'fails': None, 'works': works})
690
def test_partial_imports(self):
691
self.create_plugin('good')
692
self.create_plugin('bad')
693
self.create_plugin_package('ugly')
694
self.overrideEnv('BRZ_DISABLE_PLUGINS', 'bad:ugly')
695
self.load_with_paths(['.'])
696
self.assertEqual({'good'}, viewkeys(self.plugins))
697
self.assertPluginModules({
698
'good': self.plugins['good'].module,
702
# Ensure there are no warnings about plugins not being imported as
703
# the user has explictly requested they be disabled.
704
self.assertNotContainsRe(self.get_log(), r"Unable to load plugin")
707
class TestEnvDisablePlugins(tests.TestCase):
709
def _get_names(self, env_value):
710
os.environ['BRZ_DISABLE_PLUGINS'] = env_value
711
return plugin._env_disable_plugins()
713
def test_unset(self):
714
self.assertEqual([], plugin._env_disable_plugins())
716
def test_empty(self):
717
self.assertEqual([], self._get_names(''))
719
def test_single(self):
720
self.assertEqual(['single'], self._get_names('single'))
722
def test_multi(self):
723
expected = ['one', 'two']
724
self.assertEqual(expected, self._get_names(os.pathsep.join(expected)))
726
def test_mixed(self):
727
value = os.pathsep.join(['valid', 'in-valid'])
728
self.assertEqual(['valid'], self._get_names(value))
729
self.assertContainsRe(
731
r"Invalid name 'in-valid' in BRZ_DISABLE_PLUGINS=" + repr(value))
734
class TestEnvPluginsAt(tests.TestCase):
736
def _get_paths(self, env_value):
737
os.environ['BRZ_PLUGINS_AT'] = env_value
738
return plugin._env_plugins_at()
740
def test_empty(self):
741
self.assertEqual([], plugin._env_plugins_at())
742
self.assertEqual([], self._get_paths(''))
744
def test_one_path(self):
745
self.assertEqual([('b', 'man')], self._get_paths('b@man'))
747
def test_multiple(self):
749
[('tools', 'bzr-tools'), ('p', 'play.py')],
750
self._get_paths(os.pathsep.join(('tools@bzr-tools', 'p@play.py'))))
752
def test_many_at(self):
754
[('church', 'StMichael@Plea@Norwich')],
755
self._get_paths('church@StMichael@Plea@Norwich'))
757
def test_only_py(self):
758
self.assertEqual([('test', './test.py')], self._get_paths('./test.py'))
760
def test_only_package(self):
761
self.assertEqual([('py', '/opt/b/py')], self._get_paths('/opt/b/py'))
763
def test_bad_name(self):
764
self.assertEqual([], self._get_paths('/usr/local/bzr-git'))
765
self.assertContainsRe(
767
r"Invalid name 'bzr-git' in BRZ_PLUGINS_AT='/usr/local/bzr-git'")
770
class TestLoadPluginAt(BaseTestPlugins):
773
super(TestLoadPluginAt, self).setUp()
774
# Create the same plugin in two directories
775
self.create_plugin_package('test_foo', dir='non-standard-dir')
776
# The "normal" directory, we use 'standard' instead of 'plugins' to
777
# avoid depending on the precise naming.
778
self.create_plugin_package('test_foo', dir='standard/test_foo')
780
def assertTestFooLoadedFrom(self, path):
781
self.assertPluginKnown('test_foo')
782
self.assertDocstring('This is the doc for test_foo',
783
self.module.test_foo)
784
self.assertEqual(path, self.module.test_foo.dir_source)
786
def test_regular_load(self):
787
self.load_with_paths(['standard'])
788
self.assertTestFooLoadedFrom('standard/test_foo')
790
def test_import(self):
791
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
792
self.update_module_paths(['standard'])
793
import breezy.testingplugins.test_foo
794
self.assertTestFooLoadedFrom('non-standard-dir')
796
def test_loading(self):
797
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
798
self.load_with_paths(['standard'])
799
self.assertTestFooLoadedFrom('non-standard-dir')
801
def test_loading_other_name(self):
802
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
803
os.rename('standard/test_foo', 'standard/test_bar')
804
self.load_with_paths(['standard'])
805
self.assertTestFooLoadedFrom('non-standard-dir')
807
def test_compiled_loaded(self):
808
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
809
self.load_with_paths(['standard'])
810
self.assertTestFooLoadedFrom('non-standard-dir')
811
self.assertIsSameRealPath('non-standard-dir/__init__.py',
812
self.module.test_foo.__file__)
814
# Try importing again now that the source has been compiled
815
os.remove('non-standard-dir/__init__.py')
816
self.promote_cache('non-standard-dir')
818
self.load_with_paths(['standard'])
819
self.assertTestFooLoadedFrom('non-standard-dir')
820
suffix = plugin.COMPILED_EXT
821
self.assertIsSameRealPath('non-standard-dir/__init__' + suffix,
822
self.module.test_foo.__file__)
824
def test_submodule_loading(self):
825
# We create an additional directory under the one for test_foo
826
self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
827
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
828
self.update_module_paths(['standard'])
829
import breezy.testingplugins.test_foo # noqa: F401
830
self.assertEqual(self.module_prefix + 'test_foo',
831
self.module.test_foo.__package__)
832
import breezy.testingplugins.test_foo.test_bar # noqa: F401
833
self.assertIsSameRealPath('non-standard-dir/test_bar/__init__.py',
834
self.module.test_foo.test_bar.__file__)
836
def test_relative_submodule_loading(self):
837
self.create_plugin_package('test_foo', dir='another-dir', source='''
838
from . import test_bar
840
# We create an additional directory under the one for test_foo
841
self.create_plugin_package('test_bar', dir='another-dir/test_bar')
842
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@another-dir')
843
self.update_module_paths(['standard'])
844
import breezy.testingplugins.test_foo # noqa: F401
845
self.assertEqual(self.module_prefix + 'test_foo',
846
self.module.test_foo.__package__)
847
self.assertIsSameRealPath('another-dir/test_bar/__init__.py',
848
self.module.test_foo.test_bar.__file__)
850
def test_loading_from___init__only(self):
851
# We rename the existing __init__.py file to ensure that we don't load
853
init = 'non-standard-dir/__init__.py'
854
random = 'non-standard-dir/setup.py'
855
os.rename(init, random)
856
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
857
self.load_with_paths(['standard'])
858
self.assertPluginUnknown('test_foo')
860
def test_loading_from_specific_file(self):
861
plugin_dir = 'non-standard-dir'
862
plugin_file_name = 'iamtestfoo.py'
863
plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
865
"""This is the doc for %s"""
867
''' % ('test_foo', plugin_path)
868
self.create_plugin('test_foo', source=source,
869
dir=plugin_dir, file_name=plugin_file_name)
870
self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@%s' % plugin_path)
871
self.load_with_paths(['standard'])
872
self.assertTestFooLoadedFrom(plugin_path)
875
class TestDescribePlugins(BaseTestPlugins):
877
def test_describe_plugins(self):
878
class DummyModule(object):
881
class DummyPlugin(object):
882
__version__ = '0.1.0'
883
module = DummyModule()
884
self.plugin_warnings = {'bad': ['Failed to load (just testing)']}
885
self.plugins = {'good': DummyPlugin()}
886
self.assertEqual("""\
888
** Failed to load (just testing)
893
""", ''.join(plugin.describe_plugins(state=self)))
added
removed
breezy/tests/test_plugins.py
