← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_plugins.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_plugins.py
20
20
# affects the global state of the process.  See bzrlib/plugins.py for more
21
21
# comments.
22
22
 
 
23
import logging
23
24
import os
24
25
from StringIO import StringIO
25
26
import sys
30
31
import bzrlib.plugins
31
32
import bzrlib.commands
32
33
import bzrlib.help
33
 
from bzrlib.symbol_versioning import zero_ninetyone
34
 
from bzrlib.tests import TestCase, TestCaseInTempDir
 
34
from bzrlib.symbol_versioning import one_three
 
35
from bzrlib.tests import (
 
36
    TestCase,
 
37
    TestCaseInTempDir,
 
38
    TestUtil,
 
39
    )
35
40
from bzrlib.osutils import pathjoin, abspath, normpath
36
41
 
37
42
 
188
193
                del bzrlib.plugins.ts_plugin
189
194
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
190
195
 
191
 
 
192
 
class TestAllPlugins(TestCaseInTempDir):
193
 
 
194
 
    def test_plugin_appears_in_all_plugins(self):
195
 
        # This test tests a new plugin appears in bzrlib.plugin.all_plugins().
196
 
        # check the plugin is not loaded already
197
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
198
 
        # write a plugin that _cannot_ fail to load.
199
 
        file('plugin.py', 'w').write("\n")
200
 
        try:
201
 
            bzrlib.plugin.load_from_path(['.'])
202
 
            all_plugins = self.applyDeprecated(zero_ninetyone,
203
 
                bzrlib.plugin.all_plugins)
204
 
            self.failUnless('plugin' in all_plugins)
205
 
            self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
206
 
            self.assertEqual(all_plugins['plugin'], bzrlib.plugins.plugin)
207
 
        finally:
208
 
            # remove the plugin 'plugin'
209
 
            if 'bzrlib.plugins.plugin' in sys.modules:
210
 
                del sys.modules['bzrlib.plugins.plugin']
211
 
            if getattr(bzrlib.plugins, 'plugin', None):
212
 
                del bzrlib.plugins.plugin
213
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
196
    def test_plugin_with_bad_name_does_not_load(self):
 
197
        # Create badly-named plugin
 
198
        file('bzr-bad plugin-name..py', 'w').close()
 
199
 
 
200
        # Capture output
 
201
        stream = StringIO()
 
202
        handler = logging.StreamHandler(stream)
 
203
        log = logging.getLogger('bzr')
 
204
        log.addHandler(handler)
 
205
 
 
206
        bzrlib.plugin.load_from_dir('.')
 
207
 
 
208
        # Stop capturing output
 
209
        handler.flush()
 
210
        handler.close()
 
211
        log.removeHandler(handler)
 
212
 
 
213
        self.assertContainsRe(stream.getvalue(),
 
214
            r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
 
215
            "because the file path isn't a valid module name; try renaming "
 
216
            "it to 'bad_plugin_name_'\.")
 
217
 
 
218
        stream.close()
214
219
 
215
220
 
216
221
class TestPlugins(TestCaseInTempDir):
248
253
        plugin_path = self.test_dir + '/plugin.py'
249
254
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
250
255
 
 
256
    def test_plugin_get_path_py_not_pyc(self):
 
257
        self.setup_plugin()         # after first import there will be plugin.pyc
 
258
        self.teardown_plugin()
 
259
        bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
 
260
        plugins = bzrlib.plugin.plugins()
 
261
        plugin = plugins['plugin']
 
262
        plugin_path = self.test_dir + '/plugin.py'
 
263
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
 
264
 
 
265
    def test_plugin_get_path_pyc_only(self):
 
266
        self.setup_plugin()         # after first import there will be plugin.pyc
 
267
        self.teardown_plugin()
 
268
        os.unlink(self.test_dir + '/plugin.py')
 
269
        bzrlib.plugin.load_from_path(['.']) # import plugin.pyc
 
270
        plugins = bzrlib.plugin.plugins()
 
271
        plugin = plugins['plugin']
 
272
        if __debug__:
 
273
            plugin_path = self.test_dir + '/plugin.pyc'
 
274
        else:
 
275
            plugin_path = self.test_dir + '/plugin.pyo'
 
276
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
 
277
 
251
278
    def test_no_test_suite_gives_None_for_test_suite(self):
252
279
        self.setup_plugin()
253
280
        plugin = bzrlib.plugin.plugins()['plugin']
259
286
        plugin = bzrlib.plugin.plugins()['plugin']
260
287
        self.assertEqual('foo', plugin.test_suite())
261
288
 
 
289
    def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
 
290
        self.setup_plugin()
 
291
        loader = TestUtil.TestLoader()
 
292
        plugin = bzrlib.plugin.plugins()['plugin']
 
293
        self.assertEqual(None, plugin.load_plugin_tests(loader))
 
294
 
 
295
    def test_load_plugin_tests_gives_load_plugin_tests_result(self):
 
296
        source = """
 
297
def load_tests(standard_tests, module, loader):
 
298
    return 'foo'"""
 
299
        self.setup_plugin(source)
 
300
        loader = TestUtil.TestLoader()
 
301
        plugin = bzrlib.plugin.plugins()['plugin']
 
302
        self.assertEqual('foo', plugin.load_plugin_tests(loader))
 
303
 
262
304
    def test_no_version_info(self):
263
305
        self.setup_plugin()
264
306
        plugin = bzrlib.plugin.plugins()['plugin']
361
403
        try:
362
404
            # this is normally done by load_plugins -> set_plugins_path
363
405
            bzrlib.plugins.__path__ = [zip_name]
364
 
            bzrlib.plugin.load_from_zip(zip_name)
 
406
            self.applyDeprecated(one_three,
 
407
                bzrlib.plugin.load_from_zip, zip_name)
365
408
            self.assertTrue(plugin_name in dir(bzrlib.plugins),
366
409
                            'Plugin is not loaded')
367
410
        finally:
394
437
 
395
438
    def test_set_plugins_path_with_trailing_slashes(self):
396
439
        """set_plugins_path should set the module __path__ based on
397
 
        BZR_PLUGIN_PATH."""
 
440
        BZR_PLUGIN_PATH after removing all trailing slashes."""
398
441
        old_path = bzrlib.plugins.__path__
399
442
        old_env = os.environ.get('BZR_PLUGIN_PATH')
400
443
        try:
402
445
            os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
403
446
                "second/\\/\\/"
404
447
            bzrlib.plugin.set_plugins_path()
405
 
            expected_path = ['first', 'second',
406
 
                os.path.dirname(bzrlib.plugins.__file__)]
407
 
            self.assertEqual(expected_path, bzrlib.plugins.__path__)
 
448
            # We expect our nominated paths to have all path-seps removed,
 
449
            # and this is testing only that.
 
450
            expected_path = ['first', 'second']
 
451
            self.assertEqual(expected_path,
 
452
                bzrlib.plugins.__path__[:len(expected_path)])
408
453
        finally:
409
454
            bzrlib.plugins.__path__ = old_path
410
 
            if old_env != None:
 
455
            if old_env is not None:
411
456
                os.environ['BZR_PLUGIN_PATH'] = old_env
412
457
            else:
413
458
                del os.environ['BZR_PLUGIN_PATH']
414
459
 
 
460
 
415
461
class TestHelpIndex(tests.TestCase):
416
462
    """Tests for the PluginsHelpIndex class."""
417
463