150
116
# remove the plugin 'plugin'
151
117
del self.activeattributes[tempattribute]
152
if getattr(bzrlib.plugins, 'pluginone', None):
153
del bzrlib.plugins.pluginone
154
if getattr(bzrlib.plugins, 'plugintwo', None):
155
del bzrlib.plugins.plugintwo
156
self.failIf(getattr(bzrlib.plugins, 'pluginone', None))
157
self.failIf(getattr(bzrlib.plugins, 'plugintwo', None))
159
def test_plugins_can_load_from_directory_with_trailing_slash(self):
160
# This test tests that a plugin can load from a directory when the
161
# directory in the path has a trailing slash.
162
# check the plugin is not loaded already
163
self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
164
tempattribute = "trailing-slash"
165
self.failIf(tempattribute in self.activeattributes)
166
# set a place for the plugin to record its loading, and at the same
167
# time validate that the location the plugin should record to is
169
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
171
self.failUnless(tempattribute in self.activeattributes)
172
# create a directory for the plugin
173
os.mkdir('plugin_test')
174
# write a plugin that will record when its loaded in the
175
# tempattribute list.
176
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
177
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
179
outfile = open(os.path.join('plugin_test', 'ts_plugin.py'), 'w')
181
outfile.write(template % (tempattribute, 'plugin'))
187
bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
188
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
190
# remove the plugin 'plugin'
191
del self.activeattributes[tempattribute]
192
if getattr(bzrlib.plugins, 'ts_plugin', None):
193
del bzrlib.plugins.ts_plugin
194
self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
196
def load_and_capture(self, name):
197
"""Load plugins from '.' capturing the output.
199
:param name: The name of the plugin.
200
:return: A string with the log from the plugin loading call.
205
handler = logging.StreamHandler(stream)
206
log = logging.getLogger('bzr')
207
log.addHandler(handler)
210
bzrlib.plugin.load_from_path(['.'])
212
if 'bzrlib.plugins.%s' % name in sys.modules:
213
del sys.modules['bzrlib.plugins.%s' % name]
214
if getattr(bzrlib.plugins, name, None):
215
delattr(bzrlib.plugins, name)
217
# Stop capturing output
220
log.removeHandler(handler)
221
return stream.getvalue()
225
def test_plugin_with_bad_api_version_reports(self):
226
# This plugin asks for bzrlib api version 1.0.0, which is not supported
231
f.write("import bzrlib.api\n"
232
"bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
236
log = self.load_and_capture(name)
237
self.assertContainsRe(log,
238
r"It requested API version")
240
def test_plugin_with_bad_name_does_not_load(self):
241
# The file name here invalid for a python module.
242
name = 'bzr-bad plugin-name..py'
243
file(name, 'w').close()
244
log = self.load_and_capture(name)
245
self.assertContainsRe(log,
246
r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
247
"because the file path isn't a valid module name; try renaming "
248
"it to 'bad_plugin_name_'\.")
251
class TestPlugins(TestCaseInTempDir):
253
def setup_plugin(self, source=""):
254
# This test tests a new plugin appears in bzrlib.plugin.plugins().
118
if getattr(bzrlib.plugins, 'plugin', None):
119
del bzrlib.plugins.plugin
120
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
123
class TestAllPlugins(TestCaseInTempDir):
125
def test_plugin_appears_in_all_plugins(self):
126
# This test tests a new plugin appears in bzrlib.plugin.all_plugins().
255
127
# check the plugin is not loaded already
256
128
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
257
129
# write a plugin that _cannot_ fail to load.
258
file('plugin.py', 'w').write(source + '\n')
259
self.addCleanup(self.teardown_plugin)
260
bzrlib.plugin.load_from_path(['.'])
262
def teardown_plugin(self):
263
# remove the plugin 'plugin'
264
if 'bzrlib.plugins.plugin' in sys.modules:
265
del sys.modules['bzrlib.plugins.plugin']
266
if getattr(bzrlib.plugins, 'plugin', None):
267
del bzrlib.plugins.plugin
130
print >> file('plugin.py', 'w'), ""
132
bzrlib.plugin.load_from_path(['.'])
133
self.failUnless('plugin' in bzrlib.plugin.all_plugins())
134
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
135
self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
136
bzrlib.plugins.plugin)
138
# remove the plugin 'plugin'
139
if 'bzrlib.plugins.plugin' in sys.modules:
140
del sys.modules['bzrlib.plugins.plugin']
141
if getattr(bzrlib.plugins, 'plugin', None):
142
del bzrlib.plugins.plugin
268
143
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
270
def test_plugin_appears_in_plugins(self):
272
self.failUnless('plugin' in bzrlib.plugin.plugins())
273
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
274
plugins = bzrlib.plugin.plugins()
275
plugin = plugins['plugin']
276
self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
277
self.assertEqual(bzrlib.plugins.plugin, plugin.module)
279
def test_trivial_plugin_get_path(self):
281
plugins = bzrlib.plugin.plugins()
282
plugin = plugins['plugin']
283
plugin_path = self.test_dir + '/plugin.py'
284
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
286
def test_plugin_get_path_py_not_pyc(self):
287
self.setup_plugin() # after first import there will be plugin.pyc
288
self.teardown_plugin()
289
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
290
plugins = bzrlib.plugin.plugins()
291
plugin = plugins['plugin']
292
plugin_path = self.test_dir + '/plugin.py'
293
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
295
def test_plugin_get_path_pyc_only(self):
296
self.setup_plugin() # after first import there will be plugin.pyc
297
self.teardown_plugin()
298
os.unlink(self.test_dir + '/plugin.py')
299
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
300
plugins = bzrlib.plugin.plugins()
301
plugin = plugins['plugin']
303
plugin_path = self.test_dir + '/plugin.pyc'
305
plugin_path = self.test_dir + '/plugin.pyo'
306
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
308
def test_no_test_suite_gives_None_for_test_suite(self):
310
plugin = bzrlib.plugin.plugins()['plugin']
311
self.assertEqual(None, plugin.test_suite())
313
def test_test_suite_gives_test_suite_result(self):
314
source = """def test_suite(): return 'foo'"""
315
self.setup_plugin(source)
316
plugin = bzrlib.plugin.plugins()['plugin']
317
self.assertEqual('foo', plugin.test_suite())
319
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
321
loader = TestUtil.TestLoader()
322
plugin = bzrlib.plugin.plugins()['plugin']
323
self.assertEqual(None, plugin.load_plugin_tests(loader))
325
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
327
def load_tests(standard_tests, module, loader):
329
self.setup_plugin(source)
330
loader = TestUtil.TestLoader()
331
plugin = bzrlib.plugin.plugins()['plugin']
332
self.assertEqual('foo', plugin.load_plugin_tests(loader))
334
def test_no_version_info(self):
336
plugin = bzrlib.plugin.plugins()['plugin']
337
self.assertEqual(None, plugin.version_info())
339
def test_with_version_info(self):
340
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
341
plugin = bzrlib.plugin.plugins()['plugin']
342
self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
344
def test_short_version_info_gets_padded(self):
345
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
347
self.setup_plugin("version_info = (1, 2, 3)")
348
plugin = bzrlib.plugin.plugins()['plugin']
349
self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
351
def test_no_version_info___version__(self):
353
plugin = bzrlib.plugin.plugins()['plugin']
354
self.assertEqual("unknown", plugin.__version__)
356
def test_str__version__with_version_info(self):
357
self.setup_plugin("version_info = '1.2.3'")
358
plugin = bzrlib.plugin.plugins()['plugin']
359
self.assertEqual("1.2.3", plugin.__version__)
361
def test_noniterable__version__with_version_info(self):
362
self.setup_plugin("version_info = (1)")
363
plugin = bzrlib.plugin.plugins()['plugin']
364
self.assertEqual("1", plugin.__version__)
366
def test_1__version__with_version_info(self):
367
self.setup_plugin("version_info = (1,)")
368
plugin = bzrlib.plugin.plugins()['plugin']
369
self.assertEqual("1", plugin.__version__)
371
def test_1_2__version__with_version_info(self):
372
self.setup_plugin("version_info = (1, 2)")
373
plugin = bzrlib.plugin.plugins()['plugin']
374
self.assertEqual("1.2", plugin.__version__)
376
def test_1_2_3__version__with_version_info(self):
377
self.setup_plugin("version_info = (1, 2, 3)")
378
plugin = bzrlib.plugin.plugins()['plugin']
379
self.assertEqual("1.2.3", plugin.__version__)
381
def test_candidate__version__with_version_info(self):
382
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
383
plugin = bzrlib.plugin.plugins()['plugin']
384
self.assertEqual("1.2.3rc1", plugin.__version__)
386
def test_dev__version__with_version_info(self):
387
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
388
plugin = bzrlib.plugin.plugins()['plugin']
389
self.assertEqual("1.2.3dev", plugin.__version__)
391
def test_dev_fallback__version__with_version_info(self):
392
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
393
plugin = bzrlib.plugin.plugins()['plugin']
394
self.assertEqual("1.2.3.dev.4", plugin.__version__)
396
def test_final__version__with_version_info(self):
397
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
398
plugin = bzrlib.plugin.plugins()['plugin']
399
self.assertEqual("1.2.3", plugin.__version__)
402
146
class TestPluginHelp(TestCaseInTempDir):
404
148
def split_help_commands(self):
407
out, err = self.run_bzr('--no-plugins help commands')
408
for line in out.splitlines():
151
for line in self.capture('help commands').splitlines():
409
152
if not line.startswith(' '):
410
153
current = line.split()[0]
411
154
help[current] = help.get(current, '') + line
630
345
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
631
346
topic = plugin.ModuleHelpTopic(mod)
632
347
self.assertEqual('foo_bar', topic.get_help_topic())
635
def clear_plugins(test_case):
636
# Save the attributes that we're about to monkey-patch.
637
old_plugins_path = bzrlib.plugins.__path__
638
old_loaded = plugin._loaded
639
old_load_from_path = plugin.load_from_path
640
# Change bzrlib.plugin to think no plugins have been loaded yet.
641
bzrlib.plugins.__path__ = []
642
plugin._loaded = False
643
# Monkey-patch load_from_path to stop it from actually loading anything.
644
def load_from_path(dirs):
646
plugin.load_from_path = load_from_path
647
def restore_plugins():
648
bzrlib.plugins.__path__ = old_plugins_path
649
plugin._loaded = old_loaded
650
plugin.load_from_path = old_load_from_path
651
test_case.addCleanup(restore_plugins)
654
class TestPluginPaths(tests.TestCase):
656
def test_set_plugins_path_with_args(self):
658
plugin.set_plugins_path(['a', 'b'])
659
self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
661
def test_set_plugins_path_defaults(self):
663
plugin.set_plugins_path()
664
self.assertEqual(plugin.get_standard_plugins_path(),
665
bzrlib.plugins.__path__)
667
def test_get_standard_plugins_path(self):
668
path = plugin.get_standard_plugins_path()
669
self.assertEqual(plugin.get_default_plugin_path(), path[0])
670
for directory in path:
671
self.assertNotContainsRe(r'\\/$', directory)
673
from distutils.sysconfig import get_python_lib
677
if sys.platform != 'win32':
678
python_lib = get_python_lib()
679
for directory in path:
680
if directory.startswith(python_lib):
683
self.fail('No path to global plugins')
685
def test_get_standard_plugins_path_env(self):
686
os.environ['BZR_PLUGIN_PATH'] = 'foo/'
687
self.assertEqual('foo', plugin.get_standard_plugins_path()[0])
690
class TestLoadPlugins(tests.TestCaseInTempDir):
692
def test_load_plugins(self):
694
plugin.load_plugins(['.'])
695
self.assertEqual(bzrlib.plugins.__path__, ['.'])
696
# subsequent loads are no-ops
697
plugin.load_plugins(['foo'])
698
self.assertEqual(bzrlib.plugins.__path__, ['.'])
700
def test_load_plugins_default(self):
702
plugin.load_plugins()
703
path = plugin.get_standard_plugins_path()
704
self.assertEqual(path, bzrlib.plugins.__path__)