149
116
# remove the plugin 'plugin'
150
117
del self.activeattributes[tempattribute]
151
if getattr(bzrlib.plugins, 'pluginone', None):
152
del bzrlib.plugins.pluginone
153
if getattr(bzrlib.plugins, 'plugintwo', None):
154
del bzrlib.plugins.plugintwo
155
self.failIf(getattr(bzrlib.plugins, 'pluginone', None))
156
self.failIf(getattr(bzrlib.plugins, 'plugintwo', None))
158
def test_plugins_can_load_from_directory_with_trailing_slash(self):
159
# This test tests that a plugin can load from a directory when the
160
# directory in the path has a trailing slash.
161
# check the plugin is not loaded already
162
self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
163
tempattribute = "trailing-slash"
164
self.failIf(tempattribute in self.activeattributes)
165
# set a place for the plugin to record its loading, and at the same
166
# time validate that the location the plugin should record to is
168
bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
170
self.failUnless(tempattribute in self.activeattributes)
171
# create a directory for the plugin
172
os.mkdir('plugin_test')
173
# write a plugin that will record when its loaded in the
174
# tempattribute list.
175
template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
176
"TestLoadingPlugins.activeattributes[%r].append('%s')\n")
178
outfile = open(os.path.join('plugin_test', 'ts_plugin.py'), 'w')
180
outfile.write(template % (tempattribute, 'plugin'))
186
bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
187
self.assertEqual(['plugin'], self.activeattributes[tempattribute])
189
# remove the plugin 'plugin'
190
del self.activeattributes[tempattribute]
191
if getattr(bzrlib.plugins, 'ts_plugin', None):
192
del bzrlib.plugins.ts_plugin
193
self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
195
def load_and_capture(self, name):
196
"""Load plugins from '.' capturing the output.
198
:param name: The name of the plugin.
199
:return: A string with the log from the plugin loading call.
204
handler = logging.StreamHandler(stream)
205
log = logging.getLogger('bzr')
206
log.addHandler(handler)
209
bzrlib.plugin.load_from_path(['.'])
211
if 'bzrlib.plugins.%s' % name in sys.modules:
212
del sys.modules['bzrlib.plugins.%s' % name]
213
if getattr(bzrlib.plugins, name, None):
214
delattr(bzrlib.plugins, name)
216
# Stop capturing output
219
log.removeHandler(handler)
220
return stream.getvalue()
224
def test_plugin_with_bad_api_version_reports(self):
225
# This plugin asks for bzrlib api version 1.0.0, which is not supported
230
f.write("import bzrlib.api\n"
231
"bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
235
log = self.load_and_capture(name)
236
self.assertContainsRe(log,
237
r"It requested API version")
239
def test_plugin_with_bad_name_does_not_load(self):
240
# The file name here invalid for a python module.
241
name = 'bzr-bad plugin-name..py'
242
file(name, 'w').close()
243
log = self.load_and_capture(name)
244
self.assertContainsRe(log,
245
r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
246
"because the file path isn't a valid module name; try renaming "
247
"it to 'bad_plugin_name_'\.")
250
class TestPlugins(TestCaseInTempDir):
252
def setup_plugin(self, source=""):
253
# 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().
254
127
# check the plugin is not loaded already
255
128
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
256
129
# write a plugin that _cannot_ fail to load.
257
file('plugin.py', 'w').write(source + '\n')
258
self.addCleanup(self.teardown_plugin)
259
bzrlib.plugin.load_from_path(['.'])
261
def teardown_plugin(self):
262
# remove the plugin 'plugin'
263
if 'bzrlib.plugins.plugin' in sys.modules:
264
del sys.modules['bzrlib.plugins.plugin']
265
if getattr(bzrlib.plugins, 'plugin', None):
266
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
267
143
self.failIf(getattr(bzrlib.plugins, 'plugin', None))
269
def test_plugin_appears_in_plugins(self):
271
self.failUnless('plugin' in bzrlib.plugin.plugins())
272
self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
273
plugins = bzrlib.plugin.plugins()
274
plugin = plugins['plugin']
275
self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
276
self.assertEqual(bzrlib.plugins.plugin, plugin.module)
278
def test_trivial_plugin_get_path(self):
280
plugins = bzrlib.plugin.plugins()
281
plugin = plugins['plugin']
282
plugin_path = self.test_dir + '/plugin.py'
283
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
285
def test_plugin_get_path_py_not_pyc(self):
286
self.setup_plugin() # after first import there will be plugin.pyc
287
self.teardown_plugin()
288
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
289
plugins = bzrlib.plugin.plugins()
290
plugin = plugins['plugin']
291
plugin_path = self.test_dir + '/plugin.py'
292
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
294
def test_plugin_get_path_pyc_only(self):
295
self.setup_plugin() # after first import there will be plugin.pyc
296
self.teardown_plugin()
297
os.unlink(self.test_dir + '/plugin.py')
298
bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
299
plugins = bzrlib.plugin.plugins()
300
plugin = plugins['plugin']
302
plugin_path = self.test_dir + '/plugin.pyc'
304
plugin_path = self.test_dir + '/plugin.pyo'
305
self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
307
def test_no_test_suite_gives_None_for_test_suite(self):
309
plugin = bzrlib.plugin.plugins()['plugin']
310
self.assertEqual(None, plugin.test_suite())
312
def test_test_suite_gives_test_suite_result(self):
313
source = """def test_suite(): return 'foo'"""
314
self.setup_plugin(source)
315
plugin = bzrlib.plugin.plugins()['plugin']
316
self.assertEqual('foo', plugin.test_suite())
318
def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
320
loader = TestUtil.TestLoader()
321
plugin = bzrlib.plugin.plugins()['plugin']
322
self.assertEqual(None, plugin.load_plugin_tests(loader))
324
def test_load_plugin_tests_gives_load_plugin_tests_result(self):
326
def load_tests(standard_tests, module, loader):
328
self.setup_plugin(source)
329
loader = TestUtil.TestLoader()
330
plugin = bzrlib.plugin.plugins()['plugin']
331
self.assertEqual('foo', plugin.load_plugin_tests(loader))
333
def test_no_version_info(self):
335
plugin = bzrlib.plugin.plugins()['plugin']
336
self.assertEqual(None, plugin.version_info())
338
def test_with_version_info(self):
339
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
340
plugin = bzrlib.plugin.plugins()['plugin']
341
self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
343
def test_short_version_info_gets_padded(self):
344
# the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
346
self.setup_plugin("version_info = (1, 2, 3)")
347
plugin = bzrlib.plugin.plugins()['plugin']
348
self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
350
def test_no_version_info___version__(self):
352
plugin = bzrlib.plugin.plugins()['plugin']
353
self.assertEqual("unknown", plugin.__version__)
355
def test_str__version__with_version_info(self):
356
self.setup_plugin("version_info = '1.2.3'")
357
plugin = bzrlib.plugin.plugins()['plugin']
358
self.assertEqual("1.2.3", plugin.__version__)
360
def test_noniterable__version__with_version_info(self):
361
self.setup_plugin("version_info = (1)")
362
plugin = bzrlib.plugin.plugins()['plugin']
363
self.assertEqual("1", plugin.__version__)
365
def test_1__version__with_version_info(self):
366
self.setup_plugin("version_info = (1,)")
367
plugin = bzrlib.plugin.plugins()['plugin']
368
self.assertEqual("1", plugin.__version__)
370
def test_1_2__version__with_version_info(self):
371
self.setup_plugin("version_info = (1, 2)")
372
plugin = bzrlib.plugin.plugins()['plugin']
373
self.assertEqual("1.2", plugin.__version__)
375
def test_1_2_3__version__with_version_info(self):
376
self.setup_plugin("version_info = (1, 2, 3)")
377
plugin = bzrlib.plugin.plugins()['plugin']
378
self.assertEqual("1.2.3", plugin.__version__)
380
def test_candidate__version__with_version_info(self):
381
self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
382
plugin = bzrlib.plugin.plugins()['plugin']
383
self.assertEqual("1.2.3rc1", plugin.__version__)
385
def test_dev__version__with_version_info(self):
386
self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
387
plugin = bzrlib.plugin.plugins()['plugin']
388
self.assertEqual("1.2.3dev", plugin.__version__)
390
def test_dev_fallback__version__with_version_info(self):
391
self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
392
plugin = bzrlib.plugin.plugins()['plugin']
393
self.assertEqual("1.2.3.dev.4", plugin.__version__)
395
def test_final__version__with_version_info(self):
396
self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
397
plugin = bzrlib.plugin.plugins()['plugin']
398
self.assertEqual("1.2.3", plugin.__version__)
401
146
class TestPluginHelp(TestCaseInTempDir):
403
148
def split_help_commands(self):
406
out, err = self.run_bzr('--no-plugins help commands')
407
for line in out.splitlines():
151
for line in self.run_bzr('help commands')[0].splitlines():
408
152
if not line.startswith(' '):
409
153
current = line.split()[0]
410
154
help[current] = help.get(current, '') + line
595
350
mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
596
351
topic = plugin.ModuleHelpTopic(mod)
597
352
self.assertEqual('foo_bar', topic.get_help_topic())
600
def clear_plugins(test_case):
601
# Save the attributes that we're about to monkey-patch.
602
old_plugins_path = bzrlib.plugins.__path__
603
old_loaded = plugin._loaded
604
old_load_from_path = plugin.load_from_path
605
# Change bzrlib.plugin to think no plugins have been loaded yet.
606
bzrlib.plugins.__path__ = []
607
plugin._loaded = False
608
# Monkey-patch load_from_path to stop it from actually loading anything.
609
def load_from_path(dirs):
611
plugin.load_from_path = load_from_path
612
def restore_plugins():
613
bzrlib.plugins.__path__ = old_plugins_path
614
plugin._loaded = old_loaded
615
plugin.load_from_path = old_load_from_path
616
test_case.addCleanup(restore_plugins)
619
class TestPluginPaths(tests.TestCase):
621
def test_set_plugins_path_with_args(self):
623
plugin.set_plugins_path(['a', 'b'])
624
self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
626
def test_set_plugins_path_defaults(self):
628
plugin.set_plugins_path()
629
self.assertEqual(plugin.get_standard_plugins_path(),
630
bzrlib.plugins.__path__)
632
def test_get_standard_plugins_path(self):
633
path = plugin.get_standard_plugins_path()
634
self.assertEqual(plugin.get_default_plugin_path(), path[0])
635
for directory in path:
636
self.assertNotContainsRe(r'\\/$', directory)
638
from distutils.sysconfig import get_python_lib
642
if sys.platform != 'win32':
643
python_lib = get_python_lib()
644
for directory in path:
645
if directory.startswith(python_lib):
648
self.fail('No path to global plugins')
650
def test_get_standard_plugins_path_env(self):
651
os.environ['BZR_PLUGIN_PATH'] = 'foo/'
652
self.assertEqual('foo', plugin.get_standard_plugins_path()[0])
655
class TestLoadPlugins(tests.TestCaseInTempDir):
657
def test_load_plugins(self):
659
plugin.load_plugins(['.'])
660
self.assertEqual(bzrlib.plugins.__path__, ['.'])
661
# subsequent loads are no-ops
662
plugin.load_plugins(['foo'])
663
self.assertEqual(bzrlib.plugins.__path__, ['.'])
665
def test_load_plugins_default(self):
667
plugin.load_plugins()
668
path = plugin.get_standard_plugins_path()
669
self.assertEqual(path, bzrlib.plugins.__path__)