← 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: Vincent Ladeuil
  • Date: 2007-11-24 14:20:59 UTC
  • mto: (3928.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 3929.
  • Revision ID: v.ladeuil+lp@free.fr-20071124142059-2114qtsgfdv8g9p1
Ssl files needed for the test https server.

* bzrlib/tests/ssl_certs/create_ssls.py: 
Script to create the ssl keys and certificates.

* bzrlib/tests/ssl_certs/server.crt: 
Server certificate signed by the certificate authority.

* bzrlib/tests/ssl_certs/server.csr: 
Server certificate signing request.

* bzrlib/tests/ssl_certs/server_without_pass.key: 
Server key usable without password.

* bzrlib/tests/ssl_certs/server_with_pass.key: 
Server key.

* bzrlib/tests/ssl_certs/ca.key: 
Certificate authority private key.

* bzrlib/tests/ssl_certs/ca.crt: 
Certificate authority certificate.

* bzrlib/tests/ssl_certs/__init__.py: 
Provide access to ssl files (keys and certificates). 

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_plugins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tests for plugins"""
18
18
 
20
20
# affects the global state of the process.  See bzrlib/plugins.py for more
21
21
# comments.
22
22
 
23
 
from cStringIO import StringIO
24
23
import logging
25
24
import os
 
25
from StringIO import StringIO
26
26
import sys
27
 
 
28
 
import bzrlib
29
 
from bzrlib import (
30
 
    osutils,
31
 
    plugin,
32
 
    plugins,
33
 
    tests,
34
 
    trace,
35
 
    )
36
 
 
 
27
import zipfile
 
28
 
 
29
from bzrlib import plugin, tests
 
30
import bzrlib.plugin
 
31
import bzrlib.plugins
 
32
import bzrlib.commands
 
33
import bzrlib.help
 
34
from bzrlib.symbol_versioning import zero_ninetyone
 
35
from bzrlib.tests import TestCase, TestCaseInTempDir
 
36
from bzrlib.osutils import pathjoin, abspath, normpath
 
37
 
 
38
 
 
39
PLUGIN_TEXT = """\
 
40
import bzrlib.commands
 
41
class cmd_myplug(bzrlib.commands.Command):
 
42
    '''Just a simple test plugin.'''
 
43
    aliases = ['mplg']
 
44
    def run(self):
 
45
        print 'Hello from my plugin'
 
46
"""
37
47
 
38
48
# TODO: Write a test for plugin decoration of commands.
39
49
 
40
 
class TestPluginMixin(object):
41
 
 
42
 
    def create_plugin(self, name, source=None, dir='.', file_name=None):
43
 
        if source is None:
44
 
            source = '''\
45
 
"""This is the doc for %s"""
46
 
''' % (name)
47
 
        if file_name is None:
48
 
            file_name = name + '.py'
49
 
        # 'source' must not fail to load
50
 
        path = osutils.pathjoin(dir, file_name)
51
 
        f = open(path, 'w')
52
 
        self.addCleanup(os.unlink, path)
53
 
        try:
54
 
            f.write(source + '\n')
55
 
        finally:
56
 
            f.close()
57
 
 
58
 
    def create_plugin_package(self, name, dir=None, source=None):
59
 
        if dir is None:
60
 
            dir = name
61
 
        if source is None:
62
 
            source = '''\
63
 
"""This is the doc for %s"""
64
 
dir_source = '%s'
65
 
''' % (name, dir)
66
 
        os.makedirs(dir)
67
 
        def cleanup():
68
 
            # Workaround lazy import random? madness
69
 
            osutils.rmtree(dir)
70
 
        self.addCleanup(cleanup)
71
 
        self.create_plugin(name, source, dir,
72
 
                           file_name='__init__.py')
73
 
 
74
 
    def _unregister_plugin(self, name):
75
 
        """Remove the plugin from sys.modules and the bzrlib namespace."""
76
 
        py_name = 'bzrlib.plugins.%s' % name
77
 
        if py_name in sys.modules:
78
 
            del sys.modules[py_name]
79
 
        if getattr(bzrlib.plugins, name, None) is not None:
80
 
            delattr(bzrlib.plugins, name)
81
 
 
82
 
    def assertPluginUnknown(self, name):
83
 
        self.failIf(getattr(bzrlib.plugins, name, None) is not None)
84
 
        self.failIf('bzrlib.plugins.%s' % name in sys.modules)
85
 
 
86
 
    def assertPluginKnown(self, name):
87
 
        self.failUnless(getattr(bzrlib.plugins, name, None) is not None)
88
 
        self.failUnless('bzrlib.plugins.%s' % name in sys.modules)
89
 
 
90
 
 
91
 
class TestLoadingPlugins(tests.TestCaseInTempDir, TestPluginMixin):
 
50
class TestLoadingPlugins(TestCaseInTempDir):
92
51
 
93
52
    activeattributes = {}
94
53
 
102
61
        # set a place for the plugins to record their loading, and at the same
103
62
        # time validate that the location the plugins should record to is
104
63
        # valid and correct.
105
 
        self.__class__.activeattributes [tempattribute] = []
 
64
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
 
65
            [tempattribute] = []
106
66
        self.failUnless(tempattribute in self.activeattributes)
107
67
        # create two plugin directories
108
68
        os.mkdir('first')
109
69
        os.mkdir('second')
110
 
        # write a plugin that will record when its loaded in the
 
70
        # write a plugin that will record when its loaded in the 
111
71
        # tempattribute list.
112
72
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
113
73
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
132
92
        finally:
133
93
            # remove the plugin 'plugin'
134
94
            del self.activeattributes[tempattribute]
135
 
            self._unregister_plugin('plugin')
136
 
        self.assertPluginUnknown('plugin')
 
95
            if 'bzrlib.plugins.plugin' in sys.modules:
 
96
                del sys.modules['bzrlib.plugins.plugin']
 
97
            if getattr(bzrlib.plugins, 'plugin', None):
 
98
                del bzrlib.plugins.plugin
 
99
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
137
100
 
138
101
    def test_plugins_from_different_dirs_can_demand_load(self):
139
 
        self.failIf('bzrlib.plugins.pluginone' in sys.modules)
140
 
        self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
141
102
        # This test tests that having two plugins in different
142
103
        # directories with different names allows them both to be loaded, when
143
104
        # we do a direct import statement.
154
115
        # create two plugin directories
155
116
        os.mkdir('first')
156
117
        os.mkdir('second')
157
 
        # write plugins that will record when they are loaded in the
 
118
        # write plugins that will record when they are loaded in the 
158
119
        # tempattribute list.
159
120
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
160
121
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
175
136
 
176
137
        oldpath = bzrlib.plugins.__path__
177
138
        try:
178
 
            self.failIf('bzrlib.plugins.pluginone' in sys.modules)
179
 
            self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
180
139
            bzrlib.plugins.__path__ = ['first', 'second']
181
140
            exec "import bzrlib.plugins.pluginone"
182
141
            self.assertEqual(['first'], self.activeattributes[tempattribute])
186
145
        finally:
187
146
            # remove the plugin 'plugin'
188
147
            del self.activeattributes[tempattribute]
189
 
            self._unregister_plugin('pluginone')
190
 
            self._unregister_plugin('plugintwo')
191
 
        self.assertPluginUnknown('pluginone')
192
 
        self.assertPluginUnknown('plugintwo')
 
148
            if getattr(bzrlib.plugins, 'pluginone', None):
 
149
                del bzrlib.plugins.pluginone
 
150
            if getattr(bzrlib.plugins, 'plugintwo', None):
 
151
                del bzrlib.plugins.plugintwo
 
152
        self.failIf(getattr(bzrlib.plugins, 'pluginone', None))
 
153
        self.failIf(getattr(bzrlib.plugins, 'plugintwo', None))
193
154
 
194
155
    def test_plugins_can_load_from_directory_with_trailing_slash(self):
195
156
        # This test tests that a plugin can load from a directory when the
196
157
        # directory in the path has a trailing slash.
197
158
        # check the plugin is not loaded already
198
 
        self.assertPluginUnknown('ts_plugin')
 
159
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
199
160
        tempattribute = "trailing-slash"
200
161
        self.failIf(tempattribute in self.activeattributes)
201
162
        # set a place for the plugin to record its loading, and at the same
206
167
        self.failUnless(tempattribute in self.activeattributes)
207
168
        # create a directory for the plugin
208
169
        os.mkdir('plugin_test')
209
 
        # write a plugin that will record when its loaded in the
 
170
        # write a plugin that will record when its loaded in the 
210
171
        # tempattribute list.
211
172
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
212
173
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
222
183
            bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
223
184
            self.assertEqual(['plugin'], self.activeattributes[tempattribute])
224
185
        finally:
 
186
            # remove the plugin 'plugin'
225
187
            del self.activeattributes[tempattribute]
226
 
            self._unregister_plugin('ts_plugin')
227
 
        self.assertPluginUnknown('ts_plugin')
228
 
 
229
 
    def load_and_capture(self, name):
230
 
        """Load plugins from '.' capturing the output.
231
 
 
232
 
        :param name: The name of the plugin.
233
 
        :return: A string with the log from the plugin loading call.
234
 
        """
 
188
            if getattr(bzrlib.plugins, 'ts_plugin', None):
 
189
                del bzrlib.plugins.ts_plugin
 
190
        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))
 
191
 
 
192
    def test_plugin_with_bad_name_does_not_load(self):
 
193
        # Create badly-named plugin
 
194
        file('bad plugin-name..py', 'w').close()
 
195
 
235
196
        # Capture output
236
197
        stream = StringIO()
237
 
        try:
238
 
            handler = logging.StreamHandler(stream)
239
 
            log = logging.getLogger('bzr')
240
 
            log.addHandler(handler)
241
 
            try:
242
 
                try:
243
 
                    bzrlib.plugin.load_from_path(['.'])
244
 
                finally:
245
 
                    if 'bzrlib.plugins.%s' % name in sys.modules:
246
 
                        del sys.modules['bzrlib.plugins.%s' % name]
247
 
                    if getattr(bzrlib.plugins, name, None):
248
 
                        delattr(bzrlib.plugins, name)
249
 
            finally:
250
 
                # Stop capturing output
251
 
                handler.flush()
252
 
                handler.close()
253
 
                log.removeHandler(handler)
254
 
            return stream.getvalue()
255
 
        finally:
256
 
            stream.close()
257
 
 
258
 
    def test_plugin_with_bad_api_version_reports(self):
259
 
        # This plugin asks for bzrlib api version 1.0.0, which is not supported
260
 
        # anymore.
261
 
        name = 'wants100.py'
262
 
        f = file(name, 'w')
263
 
        try:
264
 
            f.write("import bzrlib.api\n"
265
 
                "bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
266
 
        finally:
267
 
            f.close()
268
 
 
269
 
        log = self.load_and_capture(name)
270
 
        self.assertContainsRe(log,
271
 
            r"It requested API version")
272
 
 
273
 
    def test_plugin_with_bad_name_does_not_load(self):
274
 
        # The file name here invalid for a python module.
275
 
        name = 'bzr-bad plugin-name..py'
276
 
        file(name, 'w').close()
277
 
        log = self.load_and_capture(name)
278
 
        self.assertContainsRe(log,
279
 
            r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
280
 
            "because the file path isn't a valid module name; try renaming "
281
 
            "it to 'bad_plugin_name_'\.")
282
 
 
283
 
 
284
 
class TestPlugins(tests.TestCaseInTempDir, TestPluginMixin):
 
198
        handler = logging.StreamHandler(stream)
 
199
        log = logging.getLogger('bzr')
 
200
        log.addHandler(handler)
 
201
 
 
202
        bzrlib.plugin.load_from_dir('.')
 
203
 
 
204
        # Stop capturing output
 
205
        handler.flush()
 
206
        handler.close()
 
207
        log.removeHandler(handler)
 
208
 
 
209
        self.assertContainsRe(stream.getvalue(),
 
210
            r"Unable to load 'bad plugin-name\.' in '\.' as a plugin because"
 
211
            " file path isn't a valid module name; try renaming it to"
 
212
            " 'bad_plugin_name_'\.")
 
213
 
 
214
        stream.close()
 
215
 
 
216
 
 
217
class TestAllPlugins(TestCaseInTempDir):
 
218
 
 
219
    def test_plugin_appears_in_all_plugins(self):
 
220
        # This test tests a new plugin appears in bzrlib.plugin.all_plugins().
 
221
        # check the plugin is not loaded already
 
222
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
223
        # write a plugin that _cannot_ fail to load.
 
224
        file('plugin.py', 'w').write("\n")
 
225
        try:
 
226
            bzrlib.plugin.load_from_path(['.'])
 
227
            all_plugins = self.applyDeprecated(zero_ninetyone,
 
228
                bzrlib.plugin.all_plugins)
 
229
            self.failUnless('plugin' in all_plugins)
 
230
            self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
 
231
            self.assertEqual(all_plugins['plugin'], bzrlib.plugins.plugin)
 
232
        finally:
 
233
            # remove the plugin 'plugin'
 
234
            if 'bzrlib.plugins.plugin' in sys.modules:
 
235
                del sys.modules['bzrlib.plugins.plugin']
 
236
            if getattr(bzrlib.plugins, 'plugin', None):
 
237
                del bzrlib.plugins.plugin
 
238
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
239
 
 
240
 
 
241
class TestPlugins(TestCaseInTempDir):
285
242
 
286
243
    def setup_plugin(self, source=""):
287
244
        # This test tests a new plugin appears in bzrlib.plugin.plugins().
288
245
        # check the plugin is not loaded already
289
 
        self.assertPluginUnknown('plugin')
 
246
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
290
247
        # write a plugin that _cannot_ fail to load.
291
248
        file('plugin.py', 'w').write(source + '\n')
292
249
        self.addCleanup(self.teardown_plugin)
293
 
        plugin.load_from_path(['.'])
294
 
 
 
250
        bzrlib.plugin.load_from_path(['.'])
 
251
    
295
252
    def teardown_plugin(self):
296
 
        self._unregister_plugin('plugin')
297
 
        self.assertPluginUnknown('plugin')
 
253
        # remove the plugin 'plugin'
 
254
        if 'bzrlib.plugins.plugin' in sys.modules:
 
255
            del sys.modules['bzrlib.plugins.plugin']
 
256
        if getattr(bzrlib.plugins, 'plugin', None):
 
257
            del bzrlib.plugins.plugin
 
258
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
298
259
 
299
260
    def test_plugin_appears_in_plugins(self):
300
261
        self.setup_plugin()
301
 
        self.assertPluginKnown('plugin')
302
 
        p = plugin.plugins()['plugin']
303
 
        self.assertIsInstance(p, bzrlib.plugin.PlugIn)
304
 
        self.assertEqual(p.module, plugins.plugin)
 
262
        self.failUnless('plugin' in bzrlib.plugin.plugins())
 
263
        self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
 
264
        plugins = bzrlib.plugin.plugins()
 
265
        plugin = plugins['plugin']
 
266
        self.assertIsInstance(plugin, bzrlib.plugin.PlugIn)
 
267
        self.assertEqual(bzrlib.plugins.plugin, plugin.module)
305
268
 
306
269
    def test_trivial_plugin_get_path(self):
307
270
        self.setup_plugin()
308
 
        p = plugin.plugins()['plugin']
309
 
        plugin_path = self.test_dir + '/plugin.py'
310
 
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
311
 
 
312
 
    def test_plugin_get_path_py_not_pyc(self):
313
 
        # first import creates plugin.pyc
314
 
        self.setup_plugin()
315
 
        self.teardown_plugin()
316
 
        plugin.load_from_path(['.']) # import plugin.pyc
317
 
        p = plugin.plugins()['plugin']
318
 
        plugin_path = self.test_dir + '/plugin.py'
319
 
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
320
 
 
321
 
    def test_plugin_get_path_pyc_only(self):
322
 
        # first import creates plugin.pyc (or plugin.pyo depending on __debug__)
323
 
        self.setup_plugin()
324
 
        self.teardown_plugin()
325
 
        os.unlink(self.test_dir + '/plugin.py')
326
 
        plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
327
 
        p = plugin.plugins()['plugin']
328
 
        if __debug__:
329
 
            plugin_path = self.test_dir + '/plugin.pyc'
330
 
        else:
331
 
            plugin_path = self.test_dir + '/plugin.pyo'
332
 
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
271
        plugins = bzrlib.plugin.plugins()
 
272
        plugin = plugins['plugin']
 
273
        plugin_path = self.test_dir + '/plugin.py'
 
274
        self.assertIsSameRealPath(plugin_path, normpath(plugin.path()))
333
275
 
334
276
    def test_no_test_suite_gives_None_for_test_suite(self):
335
277
        self.setup_plugin()
336
 
        p = plugin.plugins()['plugin']
337
 
        self.assertEqual(None, p.test_suite())
 
278
        plugin = bzrlib.plugin.plugins()['plugin']
 
279
        self.assertEqual(None, plugin.test_suite())
338
280
 
339
281
    def test_test_suite_gives_test_suite_result(self):
340
282
        source = """def test_suite(): return 'foo'"""
341
283
        self.setup_plugin(source)
342
 
        p = plugin.plugins()['plugin']
343
 
        self.assertEqual('foo', p.test_suite())
344
 
 
345
 
    def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
346
 
        self.setup_plugin()
347
 
        loader = tests.TestUtil.TestLoader()
348
 
        p = plugin.plugins()['plugin']
349
 
        self.assertEqual(None, p.load_plugin_tests(loader))
350
 
 
351
 
    def test_load_plugin_tests_gives_load_plugin_tests_result(self):
352
 
        source = """
353
 
def load_tests(standard_tests, module, loader):
354
 
    return 'foo'"""
355
 
        self.setup_plugin(source)
356
 
        loader = tests.TestUtil.TestLoader()
357
 
        p = plugin.plugins()['plugin']
358
 
        self.assertEqual('foo', p.load_plugin_tests(loader))
359
 
 
360
 
    def check_version_info(self, expected, source='', name='plugin'):
361
 
        self.setup_plugin(source)
362
 
        self.assertEqual(expected, plugin.plugins()[name].version_info())
 
284
        plugin = bzrlib.plugin.plugins()['plugin']
 
285
        self.assertEqual('foo', plugin.test_suite())
363
286
 
364
287
    def test_no_version_info(self):
365
 
        self.check_version_info(None)
 
288
        self.setup_plugin()
 
289
        plugin = bzrlib.plugin.plugins()['plugin']
 
290
        self.assertEqual(None, plugin.version_info())
366
291
 
367
292
    def test_with_version_info(self):
368
 
        self.check_version_info((1, 2, 3, 'dev', 4),
369
 
                                "version_info = (1, 2, 3, 'dev', 4)")
 
293
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
 
294
        plugin = bzrlib.plugin.plugins()['plugin']
 
295
        self.assertEqual((1, 2, 3, 'dev', 4), plugin.version_info())
370
296
 
371
297
    def test_short_version_info_gets_padded(self):
372
298
        # the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
373
299
        # so we adapt it
374
 
        self.check_version_info((1, 2, 3, 'final', 0),
375
 
                                "version_info = (1, 2, 3)")
376
 
 
377
 
    def check_version(self, expected, source=None, name='plugin'):
378
 
        self.setup_plugin(source)
379
 
        self.assertEqual(expected, plugins[name].__version__)
 
300
        self.setup_plugin("version_info = (1, 2, 3)")
 
301
        plugin = bzrlib.plugin.plugins()['plugin']
 
302
        self.assertEqual((1, 2, 3, 'final', 0), plugin.version_info())
380
303
 
381
304
    def test_no_version_info___version__(self):
382
305
        self.setup_plugin()
383
306
        plugin = bzrlib.plugin.plugins()['plugin']
384
307
        self.assertEqual("unknown", plugin.__version__)
385
308
 
386
 
    def test_str__version__with_version_info(self):
387
 
        self.setup_plugin("version_info = '1.2.3'")
388
 
        plugin = bzrlib.plugin.plugins()['plugin']
389
 
        self.assertEqual("1.2.3", plugin.__version__)
390
 
 
391
 
    def test_noniterable__version__with_version_info(self):
392
 
        self.setup_plugin("version_info = (1)")
393
 
        plugin = bzrlib.plugin.plugins()['plugin']
394
 
        self.assertEqual("1", plugin.__version__)
395
 
 
396
 
    def test_1__version__with_version_info(self):
397
 
        self.setup_plugin("version_info = (1,)")
398
 
        plugin = bzrlib.plugin.plugins()['plugin']
399
 
        self.assertEqual("1", plugin.__version__)
400
 
 
401
 
    def test_1_2__version__with_version_info(self):
402
 
        self.setup_plugin("version_info = (1, 2)")
403
 
        plugin = bzrlib.plugin.plugins()['plugin']
404
 
        self.assertEqual("1.2", plugin.__version__)
405
 
 
406
 
    def test_1_2_3__version__with_version_info(self):
407
 
        self.setup_plugin("version_info = (1, 2, 3)")
408
 
        plugin = bzrlib.plugin.plugins()['plugin']
409
 
        self.assertEqual("1.2.3", plugin.__version__)
410
 
 
411
 
    def test_candidate__version__with_version_info(self):
412
 
        self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
413
 
        plugin = bzrlib.plugin.plugins()['plugin']
414
 
        self.assertEqual("1.2.3rc1", plugin.__version__)
415
 
 
416
 
    def test_dev__version__with_version_info(self):
417
 
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
418
 
        plugin = bzrlib.plugin.plugins()['plugin']
419
 
        self.assertEqual("1.2.3dev", plugin.__version__)
420
 
 
421
 
    def test_dev_fallback__version__with_version_info(self):
 
309
    def test___version__with_version_info(self):
422
310
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
423
311
        plugin = bzrlib.plugin.plugins()['plugin']
424
312
        self.assertEqual("1.2.3dev4", plugin.__version__)
425
313
 
426
314
    def test_final__version__with_version_info(self):
427
 
        self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
 
315
        self.setup_plugin("version_info = (1, 2, 3, 'final', 4)")
428
316
        plugin = bzrlib.plugin.plugins()['plugin']
429
317
        self.assertEqual("1.2.3", plugin.__version__)
430
318
 
431
 
    def test_final_fallback__version__with_version_info(self):
432
 
        self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
433
 
        plugin = bzrlib.plugin.plugins()['plugin']
434
 
        self.assertEqual("1.2.3.final.2", plugin.__version__)
435
 
 
436
 
 
437
 
class TestPluginHelp(tests.TestCaseInTempDir):
 
319
 
 
320
class TestPluginHelp(TestCaseInTempDir):
438
321
 
439
322
    def split_help_commands(self):
440
323
        help = {}
441
324
        current = None
442
 
        out, err = self.run_bzr('--no-plugins help commands')
443
 
        for line in out.splitlines():
 
325
        for line in self.run_bzr('help commands')[0].splitlines():
444
326
            if not line.startswith(' '):
445
327
                current = line.split()[0]
446
328
            help[current] = help.get(current, '') + line
469
351
    def test_plugin_help_shows_plugin(self):
470
352
        # Create a test plugin
471
353
        os.mkdir('plugin_test')
472
 
        f = open(osutils.pathjoin('plugin_test', 'myplug.py'), 'w')
473
 
        f.write("""\
474
 
from bzrlib import commands
475
 
class cmd_myplug(commands.Command):
476
 
    __doc__ = '''Just a simple test plugin.'''
477
 
    aliases = ['mplg']
478
 
    def run(self):
479
 
        print 'Hello from my plugin'
480
 
 
481
 
"""
482
 
)
 
354
        f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
 
355
        f.write(PLUGIN_TEXT)
483
356
        f.close()
484
357
 
485
358
        try:
492
365
            self.assertContainsRe(help, '\[myplug\]')
493
366
        finally:
494
367
            # unregister command
495
 
            if 'myplug' in bzrlib.commands.plugin_cmds:
496
 
                bzrlib.commands.plugin_cmds.remove('myplug')
 
368
            if bzrlib.commands.plugin_cmds.get('myplug', None):
 
369
                del bzrlib.commands.plugin_cmds['myplug']
497
370
            # remove the plugin 'myplug'
498
371
            if getattr(bzrlib.plugins, 'myplug', None):
499
372
                delattr(bzrlib.plugins, 'myplug')
500
373
 
501
374
 
 
375
class TestPluginFromZip(TestCaseInTempDir):
 
376
 
 
377
    def make_zipped_plugin(self, zip_name, filename):
 
378
        z = zipfile.ZipFile(zip_name, 'w')
 
379
        z.writestr(filename, PLUGIN_TEXT)
 
380
        z.close()
 
381
 
 
382
    def check_plugin_load(self, zip_name, plugin_name):
 
383
        self.assertFalse(plugin_name in dir(bzrlib.plugins),
 
384
                         'Plugin already loaded')
 
385
        old_path = bzrlib.plugins.__path__
 
386
        try:
 
387
            # this is normally done by load_plugins -> set_plugins_path
 
388
            bzrlib.plugins.__path__ = [zip_name]
 
389
            bzrlib.plugin.load_from_zip(zip_name)
 
390
            self.assertTrue(plugin_name in dir(bzrlib.plugins),
 
391
                            'Plugin is not loaded')
 
392
        finally:
 
393
            # unregister plugin
 
394
            if getattr(bzrlib.plugins, plugin_name, None):
 
395
                delattr(bzrlib.plugins, plugin_name)
 
396
                del sys.modules['bzrlib.plugins.' + plugin_name]
 
397
            bzrlib.plugins.__path__ = old_path
 
398
 
 
399
    def test_load_module(self):
 
400
        self.make_zipped_plugin('./test.zip', 'ziplug.py')
 
401
        self.check_plugin_load('./test.zip', 'ziplug')
 
402
 
 
403
    def test_load_package(self):
 
404
        self.make_zipped_plugin('./test.zip', 'ziplug/__init__.py')
 
405
        self.check_plugin_load('./test.zip', 'ziplug')
 
406
 
 
407
 
 
408
class TestSetPluginsPath(TestCase):
 
409
    
 
410
    def test_set_plugins_path(self):
 
411
        """set_plugins_path should set the module __path__ correctly."""
 
412
        old_path = bzrlib.plugins.__path__
 
413
        try:
 
414
            bzrlib.plugins.__path__ = []
 
415
            expected_path = bzrlib.plugin.set_plugins_path()
 
416
            self.assertEqual(expected_path, bzrlib.plugins.__path__)
 
417
        finally:
 
418
            bzrlib.plugins.__path__ = old_path
 
419
 
 
420
    def test_set_plugins_path_with_trailing_slashes(self):
 
421
        """set_plugins_path should set the module __path__ based on
 
422
        BZR_PLUGIN_PATH."""
 
423
        old_path = bzrlib.plugins.__path__
 
424
        old_env = os.environ.get('BZR_PLUGIN_PATH')
 
425
        try:
 
426
            bzrlib.plugins.__path__ = []
 
427
            os.environ['BZR_PLUGIN_PATH'] = "first\\//\\" + os.pathsep + \
 
428
                "second/\\/\\/"
 
429
            bzrlib.plugin.set_plugins_path()
 
430
            expected_path = ['first', 'second',
 
431
                os.path.dirname(bzrlib.plugins.__file__)]
 
432
            self.assertEqual(expected_path, bzrlib.plugins.__path__)
 
433
        finally:
 
434
            bzrlib.plugins.__path__ = old_path
 
435
            if old_env != None:
 
436
                os.environ['BZR_PLUGIN_PATH'] = old_env
 
437
            else:
 
438
                del os.environ['BZR_PLUGIN_PATH']
 
439
 
502
440
class TestHelpIndex(tests.TestCase):
503
441
    """Tests for the PluginsHelpIndex class."""
504
442
 
605
543
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
606
544
        topic = plugin.ModuleHelpTopic(mod)
607
545
        self.assertEqual('foo_bar', topic.get_help_topic())
608
 
 
609
 
 
610
 
class TestLoadFromPath(tests.TestCaseInTempDir):
611
 
 
612
 
    def setUp(self):
613
 
        super(TestLoadFromPath, self).setUp()
614
 
        # Change bzrlib.plugin to think no plugins have been loaded yet.
615
 
        self.overrideAttr(bzrlib.plugins, '__path__', [])
616
 
        self.overrideAttr(plugin, '_loaded', False)
617
 
 
618
 
        # Monkey-patch load_from_path to stop it from actually loading anything.
619
 
        self.overrideAttr(plugin, 'load_from_path', lambda dirs: None)
620
 
 
621
 
    def test_set_plugins_path_with_args(self):
622
 
        plugin.set_plugins_path(['a', 'b'])
623
 
        self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
624
 
 
625
 
    def test_set_plugins_path_defaults(self):
626
 
        plugin.set_plugins_path()
627
 
        self.assertEqual(plugin.get_standard_plugins_path(),
628
 
                         bzrlib.plugins.__path__)
629
 
 
630
 
    def test_get_standard_plugins_path(self):
631
 
        path = plugin.get_standard_plugins_path()
632
 
        for directory in path:
633
 
            self.assertNotContainsRe(directory, r'\\/$')
634
 
        try:
635
 
            from distutils.sysconfig import get_python_lib
636
 
        except ImportError:
637
 
            pass
638
 
        else:
639
 
            if sys.platform != 'win32':
640
 
                python_lib = get_python_lib()
641
 
                for directory in path:
642
 
                    if directory.startswith(python_lib):
643
 
                        break
644
 
                else:
645
 
                    self.fail('No path to global plugins')
646
 
 
647
 
    def test_get_standard_plugins_path_env(self):
648
 
        os.environ['BZR_PLUGIN_PATH'] = 'foo/'
649
 
        path = plugin.get_standard_plugins_path()
650
 
        for directory in path:
651
 
            self.assertNotContainsRe(directory, r'\\/$')
652
 
 
653
 
    def test_load_plugins(self):
654
 
        plugin.load_plugins(['.'])
655
 
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
656
 
        # subsequent loads are no-ops
657
 
        plugin.load_plugins(['foo'])
658
 
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
659
 
 
660
 
    def test_load_plugins_default(self):
661
 
        plugin.load_plugins()
662
 
        path = plugin.get_standard_plugins_path()
663
 
        self.assertEqual(path, bzrlib.plugins.__path__)
664
 
 
665
 
 
666
 
class TestEnvPluginPath(tests.TestCase):
667
 
 
668
 
    def setUp(self):
669
 
        super(TestEnvPluginPath, self).setUp()
670
 
        self.overrideAttr(plugin, 'DEFAULT_PLUGIN_PATH', None)
671
 
 
672
 
        self.user = plugin.get_user_plugin_path()
673
 
        self.site = plugin.get_site_plugin_path()
674
 
        self.core = plugin.get_core_plugin_path()
675
 
 
676
 
    def _list2paths(self, *args):
677
 
        paths = []
678
 
        for p in args:
679
 
            plugin._append_new_path(paths, p)
680
 
        return paths
681
 
 
682
 
    def _set_path(self, *args):
683
 
        path = os.pathsep.join(self._list2paths(*args))
684
 
        osutils.set_or_unset_env('BZR_PLUGIN_PATH', path)
685
 
 
686
 
    def check_path(self, expected_dirs, setting_dirs):
687
 
        if setting_dirs:
688
 
            self._set_path(*setting_dirs)
689
 
        actual = plugin.get_standard_plugins_path()
690
 
        self.assertEquals(self._list2paths(*expected_dirs), actual)
691
 
 
692
 
    def test_default(self):
693
 
        self.check_path([self.user, self.core, self.site],
694
 
                        None)
695
 
 
696
 
    def test_adhoc_policy(self):
697
 
        self.check_path([self.user, self.core, self.site],
698
 
                        ['+user', '+core', '+site'])
699
 
 
700
 
    def test_fallback_policy(self):
701
 
        self.check_path([self.core, self.site, self.user],
702
 
                        ['+core', '+site', '+user'])
703
 
 
704
 
    def test_override_policy(self):
705
 
        self.check_path([self.user, self.site, self.core],
706
 
                        ['+user', '+site', '+core'])
707
 
 
708
 
    def test_disable_user(self):
709
 
        self.check_path([self.core, self.site], ['-user'])
710
 
 
711
 
    def test_disable_user_twice(self):
712
 
        # Ensures multiple removals don't left cruft
713
 
        self.check_path([self.core, self.site], ['-user', '-user'])
714
 
 
715
 
    def test_duplicates_are_removed(self):
716
 
        self.check_path([self.user, self.core, self.site],
717
 
                        ['+user', '+user'])
718
 
        # And only the first reference is kept (since the later references will
719
 
        # only produce '<plugin> already loaded' mutters)
720
 
        self.check_path([self.user, self.core, self.site],
721
 
                        ['+user', '+user', '+core',
722
 
                         '+user', '+site', '+site',
723
 
                         '+core'])
724
 
 
725
 
    def test_disable_overrides_enable(self):
726
 
        self.check_path([self.core, self.site], ['-user', '+user'])
727
 
 
728
 
    def test_disable_core(self):
729
 
        self.check_path([self.site], ['-core'])
730
 
        self.check_path([self.user, self.site], ['+user', '-core'])
731
 
 
732
 
    def test_disable_site(self):
733
 
        self.check_path([self.core], ['-site'])
734
 
        self.check_path([self.user, self.core], ['-site', '+user'])
735
 
 
736
 
    def test_override_site(self):
737
 
        self.check_path(['mysite', self.user, self.core],
738
 
                        ['mysite', '-site', '+user'])
739
 
        self.check_path(['mysite', self.core],
740
 
                        ['mysite', '-site'])
741
 
 
742
 
    def test_override_core(self):
743
 
        self.check_path(['mycore', self.user, self.site],
744
 
                        ['mycore', '-core', '+user', '+site'])
745
 
        self.check_path(['mycore', self.site],
746
 
                        ['mycore', '-core'])
747
 
 
748
 
    def test_my_plugin_only(self):
749
 
        self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
750
 
 
751
 
    def test_my_plugin_first(self):
752
 
        self.check_path(['myplugin', self.core, self.site, self.user],
753
 
                        ['myplugin', '+core', '+site', '+user'])
754
 
 
755
 
    def test_bogus_references(self):
756
 
        self.check_path(['+foo', '-bar', self.core, self.site],
757
 
                        ['+foo', '-bar'])
758
 
 
759
 
 
760
 
class TestDisablePlugin(tests.TestCaseInTempDir, TestPluginMixin):
761
 
 
762
 
    def setUp(self):
763
 
        super(TestDisablePlugin, self).setUp()
764
 
        self.create_plugin_package('test_foo')
765
 
        # Make sure we don't pollute the plugins namespace
766
 
        self.overrideAttr(plugins, '__path__')
767
 
        # Be paranoid in case a test fail
768
 
        self.addCleanup(self._unregister_plugin, 'test_foo')
769
 
 
770
 
    def test_cannot_import(self):
771
 
        osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
772
 
        plugin.set_plugins_path(['.'])
773
 
        try:
774
 
            import bzrlib.plugins.test_foo
775
 
        except ImportError:
776
 
            pass
777
 
        self.assertPluginUnknown('test_foo')
778
 
 
779
 
    def test_regular_load(self):
780
 
        self.overrideAttr(plugin, '_loaded', False)
781
 
        plugin.load_plugins(['.'])
782
 
        self.assertPluginKnown('test_foo')
783
 
        self.assertDocstring("This is the doc for test_foo",
784
 
                             bzrlib.plugins.test_foo)
785
 
 
786
 
    def test_not_loaded(self):
787
 
        self.warnings = []
788
 
        def captured_warning(*args, **kwargs):
789
 
            self.warnings.append((args, kwargs))
790
 
        self.overrideAttr(trace, 'warning', captured_warning)
791
 
        # Reset the flag that protect against double loading
792
 
        self.overrideAttr(plugin, '_loaded', False)
793
 
        osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
794
 
        plugin.load_plugins(['.'])
795
 
        self.assertPluginUnknown('test_foo')
796
 
        # Make sure we don't warn about the plugin ImportError since this has
797
 
        # been *requested* by the user.
798
 
        self.assertLength(0, self.warnings)
799
 
 
800
 
 
801
 
class TestLoadPluginAt(tests.TestCaseInTempDir, TestPluginMixin):
802
 
 
803
 
    def setUp(self):
804
 
        super(TestLoadPluginAt, self).setUp()
805
 
        # Make sure we don't pollute the plugins namespace
806
 
        self.overrideAttr(plugins, '__path__')
807
 
        # Be paranoid in case a test fail
808
 
        self.addCleanup(self._unregister_plugin, 'test_foo')
809
 
        # Reset the flag that protect against double loading
810
 
        self.overrideAttr(plugin, '_loaded', False)
811
 
        # Create the same plugin in two directories
812
 
        self.create_plugin_package('test_foo', dir='non-standard-dir')
813
 
        # The "normal" directory, we use 'standard' instead of 'plugins' to
814
 
        # avoid depending on the precise naming.
815
 
        self.create_plugin_package('test_foo', dir='standard/test_foo')
816
 
 
817
 
    def assertTestFooLoadedFrom(self, path):
818
 
        self.assertPluginKnown('test_foo')
819
 
        self.assertDocstring('This is the doc for test_foo',
820
 
                             bzrlib.plugins.test_foo)
821
 
        self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
822
 
 
823
 
    def test_regular_load(self):
824
 
        plugin.load_plugins(['standard'])
825
 
        self.assertTestFooLoadedFrom('standard/test_foo')
826
 
 
827
 
    def test_import(self):
828
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
829
 
        plugin.set_plugins_path(['standard'])
830
 
        try:
831
 
            import bzrlib.plugins.test_foo
832
 
        except ImportError:
833
 
            pass
834
 
        self.assertTestFooLoadedFrom('non-standard-dir')
835
 
 
836
 
    def test_loading(self):
837
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
838
 
        plugin.load_plugins(['standard'])
839
 
        self.assertTestFooLoadedFrom('non-standard-dir')
840
 
 
841
 
    def test_compiled_loaded(self):
842
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
843
 
        plugin.load_plugins(['standard'])
844
 
        self.assertTestFooLoadedFrom('non-standard-dir')
845
 
        self.assertEqual('non-standard-dir/__init__.py',
846
 
                         bzrlib.plugins.test_foo.__file__)
847
 
 
848
 
        # Try importing again now that the source has been compiled
849
 
        self._unregister_plugin('test_foo')
850
 
        plugin._loaded = False
851
 
        plugin.load_plugins(['standard'])
852
 
        self.assertTestFooLoadedFrom('non-standard-dir')
853
 
        if __debug__:
854
 
            suffix = 'pyc'
855
 
        else:
856
 
            suffix = 'pyo'
857
 
        self.assertEqual('non-standard-dir/__init__.%s' % suffix,
858
 
                         bzrlib.plugins.test_foo.__file__)
859
 
 
860
 
    def test_submodule_loading(self):
861
 
        # We create an additional directory under the one for test_foo
862
 
        self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
863
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
864
 
        plugin.set_plugins_path(['standard'])
865
 
        import bzrlib.plugins.test_foo
866
 
        self.assertEqual('bzrlib.plugins.test_foo',
867
 
                         bzrlib.plugins.test_foo.__package__)
868
 
        import bzrlib.plugins.test_foo.test_bar
869
 
        self.assertEqual('non-standard-dir/test_bar/__init__.py',
870
 
                         bzrlib.plugins.test_foo.test_bar.__file__)
871
 
 
872
 
    def test_loading_from___init__only(self):
873
 
        # We rename the existing __init__.py file to ensure that we don't load
874
 
        # a random file
875
 
        init = 'non-standard-dir/__init__.py'
876
 
        random = 'non-standard-dir/setup.py'
877
 
        os.rename(init, random)
878
 
        self.addCleanup(os.rename, random, init)
879
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
880
 
        plugin.load_plugins(['standard'])
881
 
        self.assertPluginUnknown('test_foo')
882
 
 
883
 
    def test_loading_from_specific_file(self):
884
 
        plugin_dir = 'non-standard-dir'
885
 
        plugin_file_name = 'iamtestfoo.py'
886
 
        plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
887
 
        source = '''\
888
 
"""This is the doc for %s"""
889
 
dir_source = '%s'
890
 
''' % ('test_foo', plugin_path)
891
 
        self.create_plugin('test_foo', source=source,
892
 
                           dir=plugin_dir, file_name=plugin_file_name)
893
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@%s' % plugin_path)
894
 
        plugin.load_plugins(['standard'])
895
 
        self.assertTestFooLoadedFrom(plugin_path)