/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_plugins.py

  • Committer: Jelmer Vernooij
  • Date: 2019-01-01 21:38:07 UTC
  • mfrom: (7228 work)
  • mto: This revision was merged to the branch mainline in revision 7233.
  • Revision ID: jelmer@jelmer.uk-20190101213807-ay6uqghz0nnrgjvx
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_plugins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2012, 2016 Canonical Ltd
 
2
# Copyright (C) 2017-2018 Breezy developers
2
3
#
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
16
17
 
17
18
"""Tests for plugins"""
18
19
 
19
 
# XXX: There are no plugin tests at the moment because the plugin module
20
 
# affects the global state of the process.  See bzrlib/plugins.py for more
21
 
# comments.
22
 
 
23
 
from cStringIO import StringIO
 
20
import importlib
24
21
import logging
25
22
import os
26
23
import sys
 
24
import types
27
25
 
28
 
import bzrlib
29
 
from bzrlib import (
 
26
import breezy
 
27
from .. import (
30
28
    osutils,
31
29
    plugin,
32
 
    plugins,
33
30
    tests,
34
 
    trace,
 
31
    )
 
32
from ..sixish import (
 
33
    StringIO,
 
34
    viewkeys,
35
35
    )
36
36
 
37
37
 
38
38
# TODO: Write a test for plugin decoration of commands.
39
39
 
40
 
class TestPluginMixin(object):
 
40
invalidate_caches = getattr(importlib, "invalidate_caches", lambda: None)
 
41
 
 
42
 
 
43
class BaseTestPlugins(tests.TestCaseInTempDir):
 
44
    """TestCase that isolates plugin imports and cleans up on completion."""
 
45
 
 
46
    def setUp(self):
 
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)
 
51
 
 
52
        self.overrideAttr(plugin, "_MODULE_PREFIX", self.module_prefix)
 
53
        self.overrideAttr(breezy, "testingplugins", self.module)
 
54
 
 
55
        sys.modules[self.module_name] = self.module
 
56
        self.addCleanup(self._unregister_all)
 
57
        self.addCleanup(self._unregister_finder)
 
58
 
 
59
        invalidate_caches()
 
60
 
 
61
    def reset(self):
 
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__):
 
70
            if name[:2] != '__':
 
71
                delattr(self.module, name)
 
72
        invalidate_caches()
 
73
        self.plugins = None
 
74
 
 
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)
 
79
        return paths
 
80
 
 
81
    def load_with_paths(self, paths):
 
82
        self.log("loading plugins!")
 
83
        plugin.load_plugins(self.update_module_paths(paths), state=self)
41
84
 
42
85
    def create_plugin(self, name, source=None, dir='.', file_name=None):
43
86
        if source is None:
48
91
            file_name = name + '.py'
49
92
        # 'source' must not fail to load
50
93
        path = osutils.pathjoin(dir, file_name)
51
 
        f = open(path, 'w')
52
 
        self.addCleanup(os.unlink, path)
53
 
        try:
 
94
        with open(path, 'w') as f:
54
95
            f.write(source + '\n')
55
 
        finally:
56
 
            f.close()
57
96
 
58
97
    def create_plugin_package(self, name, dir=None, source=None):
59
98
        if dir is None:
64
103
dir_source = '%s'
65
104
''' % (name, dir)
66
105
        os.makedirs(dir)
67
 
        def cleanup():
68
 
            # Workaround lazy import random? madness
69
 
            osutils.rmtree(dir)
70
 
        self.addCleanup(cleanup)
71
106
        self.create_plugin(name, source, dir,
72
107
                           file_name='__init__.py')
73
108
 
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)
 
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))
 
119
 
 
120
    def _unregister_finder(self):
 
121
        """Removes any test copies of _PluginsAtFinder from sys.meta_path."""
 
122
        idx = len(sys.meta_path)
 
123
        while idx:
 
124
            idx -= 1
 
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)
 
129
 
 
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]
 
136
 
 
137
    def assertPluginModules(self, plugin_dict):
 
138
        self.assertEqual(
 
139
            dict((k[len(self.module_prefix):], sys.modules[k])
 
140
                 for k in sys.modules if k.startswith(self.module_prefix)),
 
141
            plugin_dict)
81
142
 
82
143
    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)
 
144
        self.assertTrue(getattr(self.module, name, None) is None)
 
145
        self.assertFalse(self.module_prefix + name in sys.modules)
85
146
 
86
147
    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):
 
148
        self.assertTrue(getattr(self.module, name, None) is not None)
 
149
        self.assertTrue(self.module_prefix + name in sys.modules)
 
150
 
 
151
 
 
152
class TestLoadingPlugins(BaseTestPlugins):
92
153
 
93
154
    activeattributes = {}
94
155
 
98
159
        # file name we can use which is also a valid attribute for accessing in
99
160
        # activeattributes. - we cannot give import parameters.
100
161
        tempattribute = "0"
101
 
        self.failIf(tempattribute in self.activeattributes)
 
162
        self.assertFalse(tempattribute in self.activeattributes)
102
163
        # set a place for the plugins to record their loading, and at the same
103
164
        # time validate that the location the plugins should record to is
104
165
        # valid and correct.
105
 
        self.__class__.activeattributes [tempattribute] = []
106
 
        self.failUnless(tempattribute in self.activeattributes)
 
166
        self.__class__.activeattributes[tempattribute] = []
 
167
        self.assertTrue(tempattribute in self.activeattributes)
107
168
        # create two plugin directories
108
169
        os.mkdir('first')
109
170
        os.mkdir('second')
110
171
        # write a plugin that will record when its loaded in the
111
172
        # tempattribute list.
112
 
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
 
173
        template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
113
174
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
114
175
 
115
 
        outfile = open(os.path.join('first', 'plugin.py'), 'w')
116
 
        try:
 
176
        with open(os.path.join('first', 'plugin.py'), 'w') as outfile:
117
177
            outfile.write(template % (tempattribute, 'first'))
118
178
            outfile.write('\n')
119
 
        finally:
120
 
            outfile.close()
121
179
 
122
 
        outfile = open(os.path.join('second', 'plugin.py'), 'w')
123
 
        try:
 
180
        with open(os.path.join('second', 'plugin.py'), 'w') as outfile:
124
181
            outfile.write(template % (tempattribute, 'second'))
125
182
            outfile.write('\n')
126
 
        finally:
127
 
            outfile.close()
128
183
 
129
184
        try:
130
 
            bzrlib.plugin.load_from_path(['first', 'second'])
 
185
            self.load_with_paths(['first', 'second'])
131
186
            self.assertEqual(['first'], self.activeattributes[tempattribute])
132
187
        finally:
133
 
            # remove the plugin 'plugin'
134
188
            del self.activeattributes[tempattribute]
135
 
            self._unregister_plugin('plugin')
136
 
        self.assertPluginUnknown('plugin')
137
189
 
138
190
    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)
 
191
        self.assertFalse('breezy.plugins.pluginone' in sys.modules)
 
192
        self.assertFalse('breezy.plugins.plugintwo' in sys.modules)
141
193
        # This test tests that having two plugins in different
142
194
        # directories with different names allows them both to be loaded, when
143
195
        # we do a direct import statement.
144
196
        # Determine a file name we can use which is also a valid attribute
145
197
        # for accessing in activeattributes. - we cannot give import parameters.
146
198
        tempattribute = "different-dirs"
147
 
        self.failIf(tempattribute in self.activeattributes)
 
199
        self.assertFalse(tempattribute in self.activeattributes)
148
200
        # set a place for the plugins to record their loading, and at the same
149
201
        # time validate that the location the plugins should record to is
150
202
        # valid and correct.
151
 
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
152
 
            [tempattribute] = []
153
 
        self.failUnless(tempattribute in self.activeattributes)
 
203
        breezy.tests.test_plugins.TestLoadingPlugins.activeattributes[tempattribute] = [
 
204
            ]
 
205
        self.assertTrue(tempattribute in self.activeattributes)
154
206
        # create two plugin directories
155
207
        os.mkdir('first')
156
208
        os.mkdir('second')
157
209
        # write plugins that will record when they are loaded in the
158
210
        # tempattribute list.
159
 
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
 
211
        template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
160
212
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
161
213
 
162
 
        outfile = open(os.path.join('first', 'pluginone.py'), 'w')
163
 
        try:
 
214
        with open(os.path.join('first', 'pluginone.py'), 'w') as outfile:
164
215
            outfile.write(template % (tempattribute, 'first'))
165
216
            outfile.write('\n')
166
 
        finally:
167
 
            outfile.close()
168
217
 
169
 
        outfile = open(os.path.join('second', 'plugintwo.py'), 'w')
170
 
        try:
 
218
        with open(os.path.join('second', 'plugintwo.py'), 'w') as outfile:
171
219
            outfile.write(template % (tempattribute, 'second'))
172
220
            outfile.write('\n')
173
 
        finally:
174
 
            outfile.close()
175
221
 
176
 
        oldpath = bzrlib.plugins.__path__
177
222
        try:
178
 
            self.failIf('bzrlib.plugins.pluginone' in sys.modules)
179
 
            self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
180
 
            bzrlib.plugins.__path__ = ['first', 'second']
181
 
            exec "import bzrlib.plugins.pluginone"
 
223
            self.assertPluginUnknown('pluginone')
 
224
            self.assertPluginUnknown('plugintwo')
 
225
            self.update_module_paths(['first', 'second'])
 
226
            exec("import %spluginone" % self.module_prefix)
182
227
            self.assertEqual(['first'], self.activeattributes[tempattribute])
183
 
            exec "import bzrlib.plugins.plugintwo"
 
228
            exec("import %splugintwo" % self.module_prefix)
184
229
            self.assertEqual(['first', 'second'],
185
 
                self.activeattributes[tempattribute])
 
230
                             self.activeattributes[tempattribute])
186
231
        finally:
187
 
            # remove the plugin 'plugin'
188
232
            del self.activeattributes[tempattribute]
189
 
            self._unregister_plugin('pluginone')
190
 
            self._unregister_plugin('plugintwo')
191
 
        self.assertPluginUnknown('pluginone')
192
 
        self.assertPluginUnknown('plugintwo')
193
233
 
194
234
    def test_plugins_can_load_from_directory_with_trailing_slash(self):
195
235
        # This test tests that a plugin can load from a directory when the
197
237
        # check the plugin is not loaded already
198
238
        self.assertPluginUnknown('ts_plugin')
199
239
        tempattribute = "trailing-slash"
200
 
        self.failIf(tempattribute in self.activeattributes)
 
240
        self.assertFalse(tempattribute in self.activeattributes)
201
241
        # set a place for the plugin to record its loading, and at the same
202
242
        # time validate that the location the plugin should record to is
203
243
        # valid and correct.
204
 
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
205
 
            [tempattribute] = []
206
 
        self.failUnless(tempattribute in self.activeattributes)
 
244
        breezy.tests.test_plugins.TestLoadingPlugins.activeattributes[tempattribute] = [
 
245
            ]
 
246
        self.assertTrue(tempattribute in self.activeattributes)
207
247
        # create a directory for the plugin
208
248
        os.mkdir('plugin_test')
209
249
        # write a plugin that will record when its loaded in the
210
250
        # tempattribute list.
211
 
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
 
251
        template = ("from breezy.tests.test_plugins import TestLoadingPlugins\n"
212
252
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
213
253
 
214
 
        outfile = open(os.path.join('plugin_test', 'ts_plugin.py'), 'w')
215
 
        try:
 
254
        with open(os.path.join('plugin_test', 'ts_plugin.py'), 'w') as outfile:
216
255
            outfile.write(template % (tempattribute, 'plugin'))
217
256
            outfile.write('\n')
218
 
        finally:
219
 
            outfile.close()
220
257
 
221
258
        try:
222
 
            bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
 
259
            self.load_with_paths(['plugin_test' + os.sep])
223
260
            self.assertEqual(['plugin'], self.activeattributes[tempattribute])
 
261
            self.assertPluginKnown('ts_plugin')
224
262
        finally:
225
263
            del self.activeattributes[tempattribute]
226
 
            self._unregister_plugin('ts_plugin')
227
 
        self.assertPluginUnknown('ts_plugin')
228
264
 
229
265
    def load_and_capture(self, name):
230
266
        """Load plugins from '.' capturing the output.
236
272
        stream = StringIO()
237
273
        try:
238
274
            handler = logging.StreamHandler(stream)
239
 
            log = logging.getLogger('bzr')
 
275
            log = logging.getLogger('brz')
240
276
            log.addHandler(handler)
241
277
            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)
 
278
                self.load_with_paths(['.'])
249
279
            finally:
250
280
                # Stop capturing output
251
281
                handler.flush()
256
286
            stream.close()
257
287
 
258
288
    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.
 
289
        """Try loading a plugin that requests an unsupported api.
 
290
 
 
291
        Observe that it records the problem but doesn't complain on stderr.
 
292
 
 
293
        See https://bugs.launchpad.net/bzr/+bug/704195
 
294
        """
261
295
        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
 
 
 
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")
269
300
        log = self.load_and_capture(name)
270
 
        self.assertContainsRe(log,
271
 
            r"It requested API version")
 
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")
272
307
 
273
308
    def test_plugin_with_bad_name_does_not_load(self):
274
309
        # The file name here invalid for a python module.
275
 
        name = 'bzr-bad plugin-name..py'
276
 
        file(name, 'w').close()
 
310
        name = 'brz-bad plugin-name..py'
 
311
        open(name, 'w').close()
277
312
        log = self.load_and_capture(name)
278
313
        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):
 
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_'\\.")
 
317
 
 
318
 
 
319
class TestPlugins(BaseTestPlugins):
285
320
 
286
321
    def setup_plugin(self, source=""):
287
 
        # This test tests a new plugin appears in bzrlib.plugin.plugins().
 
322
        # This test tests a new plugin appears in breezy.plugin.plugins().
288
323
        # check the plugin is not loaded already
289
324
        self.assertPluginUnknown('plugin')
290
325
        # write a plugin that _cannot_ fail to load.
291
 
        file('plugin.py', 'w').write(source + '\n')
292
 
        self.addCleanup(self.teardown_plugin)
293
 
        plugin.load_from_path(['.'])
294
 
 
295
 
    def teardown_plugin(self):
296
 
        self._unregister_plugin('plugin')
297
 
        self.assertPluginUnknown('plugin')
 
326
        with open('plugin.py', 'w') as f:
 
327
            f.write(source + '\n')
 
328
        self.load_with_paths(['.'])
 
329
 
 
330
    def test_plugin_loaded(self):
 
331
        self.assertPluginUnknown('plugin')
 
332
        self.assertIs(None, breezy.plugin.get_loaded_plugin('plugin'))
 
333
        self.setup_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'])
 
337
 
 
338
    def test_plugin_loaded_disabled(self):
 
339
        self.assertPluginUnknown('plugin')
 
340
        self.overrideEnv('BRZ_DISABLE_PLUGINS', 'plugin')
 
341
        self.setup_plugin()
 
342
        self.assertIs(None, breezy.plugin.get_loaded_plugin('plugin'))
298
343
 
299
344
    def test_plugin_appears_in_plugins(self):
300
345
        self.setup_plugin()
301
346
        self.assertPluginKnown('plugin')
302
 
        p = plugin.plugins()['plugin']
303
 
        self.assertIsInstance(p, bzrlib.plugin.PlugIn)
304
 
        self.assertEqual(p.module, plugins.plugin)
 
347
        p = self.plugins['plugin']
 
348
        self.assertIsInstance(p, breezy.plugin.PlugIn)
 
349
        self.assertIs(p.module, sys.modules[self.module_prefix + 'plugin'])
305
350
 
306
351
    def test_trivial_plugin_get_path(self):
307
352
        self.setup_plugin()
308
 
        p = plugin.plugins()['plugin']
 
353
        p = self.plugins['plugin']
309
354
        plugin_path = self.test_dir + '/plugin.py'
310
355
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
311
356
 
312
357
    def test_plugin_get_path_py_not_pyc(self):
313
358
        # first import creates plugin.pyc
314
359
        self.setup_plugin()
315
 
        self.teardown_plugin()
316
 
        plugin.load_from_path(['.']) # import plugin.pyc
 
360
        self.promote_cache(self.test_dir)
 
361
        self.reset()
 
362
        self.load_with_paths(['.'])  # import plugin.pyc
317
363
        p = plugin.plugins()['plugin']
318
364
        plugin_path = self.test_dir + '/plugin.py'
319
365
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
321
367
    def test_plugin_get_path_pyc_only(self):
322
368
        # first import creates plugin.pyc (or plugin.pyo depending on __debug__)
323
369
        self.setup_plugin()
324
 
        self.teardown_plugin()
325
370
        os.unlink(self.test_dir + '/plugin.py')
326
 
        plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
 
371
        self.promote_cache(self.test_dir)
 
372
        self.reset()
 
373
        self.load_with_paths(['.'])  # import plugin.pyc (or .pyo)
327
374
        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'
 
375
        plugin_path = self.test_dir + '/plugin' + plugin.COMPILED_EXT
332
376
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
333
377
 
334
378
    def test_no_test_suite_gives_None_for_test_suite(self):
350
394
 
351
395
    def test_load_plugin_tests_gives_load_plugin_tests_result(self):
352
396
        source = """
353
 
def load_tests(standard_tests, module, loader):
 
397
def load_tests(loader, standard_tests, pattern):
354
398
    return 'foo'"""
355
399
        self.setup_plugin(source)
356
400
        loader = tests.TestUtil.TestLoader()
380
424
 
381
425
    def test_no_version_info___version__(self):
382
426
        self.setup_plugin()
383
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
427
        plugin = breezy.plugin.plugins()['plugin']
384
428
        self.assertEqual("unknown", plugin.__version__)
385
429
 
386
430
    def test_str__version__with_version_info(self):
387
431
        self.setup_plugin("version_info = '1.2.3'")
388
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
432
        plugin = breezy.plugin.plugins()['plugin']
389
433
        self.assertEqual("1.2.3", plugin.__version__)
390
434
 
391
435
    def test_noniterable__version__with_version_info(self):
392
436
        self.setup_plugin("version_info = (1)")
393
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
437
        plugin = breezy.plugin.plugins()['plugin']
394
438
        self.assertEqual("1", plugin.__version__)
395
439
 
396
440
    def test_1__version__with_version_info(self):
397
441
        self.setup_plugin("version_info = (1,)")
398
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
442
        plugin = breezy.plugin.plugins()['plugin']
399
443
        self.assertEqual("1", plugin.__version__)
400
444
 
401
445
    def test_1_2__version__with_version_info(self):
402
446
        self.setup_plugin("version_info = (1, 2)")
403
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
447
        plugin = breezy.plugin.plugins()['plugin']
404
448
        self.assertEqual("1.2", plugin.__version__)
405
449
 
406
450
    def test_1_2_3__version__with_version_info(self):
407
451
        self.setup_plugin("version_info = (1, 2, 3)")
408
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
452
        plugin = breezy.plugin.plugins()['plugin']
409
453
        self.assertEqual("1.2.3", plugin.__version__)
410
454
 
411
455
    def test_candidate__version__with_version_info(self):
412
456
        self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
413
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
457
        plugin = breezy.plugin.plugins()['plugin']
414
458
        self.assertEqual("1.2.3rc1", plugin.__version__)
415
459
 
416
460
    def test_dev__version__with_version_info(self):
417
461
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
418
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
462
        plugin = breezy.plugin.plugins()['plugin']
419
463
        self.assertEqual("1.2.3dev", plugin.__version__)
420
464
 
421
465
    def test_dev_fallback__version__with_version_info(self):
422
466
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
423
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
467
        plugin = breezy.plugin.plugins()['plugin']
424
468
        self.assertEqual("1.2.3dev4", plugin.__version__)
425
469
 
426
470
    def test_final__version__with_version_info(self):
427
471
        self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
428
 
        plugin = bzrlib.plugin.plugins()['plugin']
 
472
        plugin = breezy.plugin.plugins()['plugin']
429
473
        self.assertEqual("1.2.3", plugin.__version__)
430
474
 
431
475
    def test_final_fallback__version__with_version_info(self):
432
476
        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):
438
 
 
439
 
    def split_help_commands(self):
440
 
        help = {}
441
 
        current = None
442
 
        out, err = self.run_bzr('--no-plugins help commands')
443
 
        for line in out.splitlines():
444
 
            if not line.startswith(' '):
445
 
                current = line.split()[0]
446
 
            help[current] = help.get(current, '') + line
447
 
 
448
 
        return help
449
 
 
450
 
    def test_plugin_help_builtins_unaffected(self):
451
 
        # Check we don't get false positives
452
 
        help_commands = self.split_help_commands()
453
 
        for cmd_name in bzrlib.commands.builtin_command_names():
454
 
            if cmd_name in bzrlib.commands.plugin_command_names():
455
 
                continue
456
 
            try:
457
 
                help = bzrlib.commands.get_cmd_object(cmd_name).get_help_text()
458
 
            except NotImplementedError:
459
 
                # some commands have no help
460
 
                pass
461
 
            else:
462
 
                self.assertNotContainsRe(help, 'plugin "[^"]*"')
463
 
 
464
 
            if cmd_name in help_commands.keys():
465
 
                # some commands are hidden
466
 
                help = help_commands[cmd_name]
467
 
                self.assertNotContainsRe(help, 'plugin "[^"]*"')
468
 
 
469
 
    def test_plugin_help_shows_plugin(self):
470
 
        # Create a test plugin
471
 
        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
 
)
483
 
        f.close()
484
 
 
485
 
        try:
486
 
            # Check its help
487
 
            bzrlib.plugin.load_from_path(['plugin_test'])
488
 
            bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
489
 
            help = self.run_bzr('help myplug')[0]
490
 
            self.assertContainsRe(help, 'plugin "myplug"')
491
 
            help = self.split_help_commands()['myplug']
492
 
            self.assertContainsRe(help, '\[myplug\]')
493
 
        finally:
494
 
            # unregister command
495
 
            if 'myplug' in bzrlib.commands.plugin_cmds:
496
 
                bzrlib.commands.plugin_cmds.remove('myplug')
497
 
            # remove the plugin 'myplug'
498
 
            if getattr(bzrlib.plugins, 'myplug', None):
499
 
                delattr(bzrlib.plugins, 'myplug')
 
477
        plugin = breezy.plugin.plugins()['plugin']
 
478
        self.assertEqual("1.2.3.2", plugin.__version__)
500
479
 
501
480
 
502
481
class TestHelpIndex(tests.TestCase):
515
494
        index = plugin.PluginsHelpIndex()
516
495
        # make a new plugin here for this test, even if we're run with
517
496
        # --no-plugins
518
 
        self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
519
 
        demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
520
 
        sys.modules['bzrlib.plugins.demo_module'] = demo_module
 
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
521
500
        try:
522
501
            topics = index.get_topics('demo_module')
523
502
            self.assertEqual(1, len(topics))
524
503
            self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
525
504
            self.assertEqual(demo_module, topics[0].module)
526
505
        finally:
527
 
            del sys.modules['bzrlib.plugins.demo_module']
 
506
            del sys.modules['breezy.plugins.demo_module']
528
507
 
529
508
    def test_get_topics_no_topic(self):
530
509
        """Searching for something that is not a plugin returns []."""
541
520
    def test_get_plugin_topic_with_prefix(self):
542
521
        """Searching for plugins/demo_module returns help."""
543
522
        index = plugin.PluginsHelpIndex()
544
 
        self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
545
 
        demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
546
 
        sys.modules['bzrlib.plugins.demo_module'] = demo_module
 
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
547
526
        try:
548
527
            topics = index.get_topics('plugins/demo_module')
549
528
            self.assertEqual(1, len(topics))
550
529
            self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
551
530
            self.assertEqual(demo_module, topics[0].module)
552
531
        finally:
553
 
            del sys.modules['bzrlib.plugins.demo_module']
 
532
            del sys.modules['breezy.plugins.demo_module']
554
533
 
555
534
 
556
535
class FakeModule(object):
575
554
        mod = FakeModule(None, 'demo')
576
555
        topic = plugin.ModuleHelpTopic(mod)
577
556
        self.assertEqual("Plugin 'demo' has no docstring.\n",
578
 
            topic.get_help_text())
 
557
                         topic.get_help_text())
579
558
 
580
559
    def test_get_help_text_no_carriage_return(self):
581
560
        """ModuleHelpTopic.get_help_text adds a \n if needed."""
582
561
        mod = FakeModule('one line of help', 'demo')
583
562
        topic = plugin.ModuleHelpTopic(mod)
584
563
        self.assertEqual("one line of help\n",
585
 
            topic.get_help_text())
 
564
                         topic.get_help_text())
586
565
 
587
566
    def test_get_help_text_carriage_return(self):
588
567
        """ModuleHelpTopic.get_help_text adds a \n if needed."""
589
568
        mod = FakeModule('two lines of help\nand more\n', 'demo')
590
569
        topic = plugin.ModuleHelpTopic(mod)
591
570
        self.assertEqual("two lines of help\nand more\n",
592
 
            topic.get_help_text())
 
571
                         topic.get_help_text())
593
572
 
594
573
    def test_get_help_text_with_additional_see_also(self):
595
574
        mod = FakeModule('two lines of help\nand more', 'demo')
596
575
        topic = plugin.ModuleHelpTopic(mod)
597
 
        self.assertEqual("two lines of help\nand more\nSee also: bar, foo\n",
 
576
        self.assertEqual(
 
577
            "two lines of help\nand more\n\n:See also: bar, foo\n",
598
578
            topic.get_help_text(['foo', 'bar']))
599
579
 
600
580
    def test_get_help_topic(self):
601
581
        """The help topic for a plugin is its module name."""
602
 
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.demo')
 
582
        mod = FakeModule('two lines of help\nand more', 'breezy.plugins.demo')
603
583
        topic = plugin.ModuleHelpTopic(mod)
604
584
        self.assertEqual('demo', topic.get_help_topic())
605
 
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
 
585
        mod = FakeModule('two lines of help\nand more',
 
586
                         'breezy.plugins.foo_bar')
606
587
        topic = plugin.ModuleHelpTopic(mod)
607
588
        self.assertEqual('foo_bar', topic.get_help_topic())
608
589
 
609
590
 
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
591
class TestEnvPluginPath(tests.TestCase):
667
592
 
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)
 
593
    user = "USER"
 
594
    core = "CORE"
 
595
    site = "SITE"
685
596
 
686
597
    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)
 
598
        if setting_dirs is None:
 
599
            del os.environ['BRZ_PLUGIN_PATH']
 
600
        else:
 
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)
691
605
 
692
606
    def test_default(self):
693
607
        self.check_path([self.user, self.core, self.site],
757
671
                        ['+foo', '-bar'])
758
672
 
759
673
 
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')
 
674
class TestDisablePlugin(BaseTestPlugins):
769
675
 
770
676
    def test_cannot_import(self):
771
 
        osutils.set_or_unset_env('BZR_DISABLE_PLUGINS', 'test_foo')
772
 
        plugin.set_plugins_path(['.'])
 
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
773
682
        try:
774
 
            import bzrlib.plugins.test_foo
 
683
            import breezy.testingplugins.fails as fails
775
684
        except ImportError:
776
685
            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):
 
686
        else:
 
687
            self.fail("Loaded blocked plugin: " + repr(fails))
 
688
        self.assertPluginModules({'fails': None, 'works': works})
 
689
 
 
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,
 
699
            'bad': None,
 
700
            'ugly': None,
 
701
        })
 
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")
 
705
 
 
706
 
 
707
class TestEnvDisablePlugins(tests.TestCase):
 
708
 
 
709
    def _get_names(self, env_value):
 
710
        os.environ['BRZ_DISABLE_PLUGINS'] = env_value
 
711
        return plugin._env_disable_plugins()
 
712
 
 
713
    def test_unset(self):
 
714
        self.assertEqual([], plugin._env_disable_plugins())
 
715
 
 
716
    def test_empty(self):
 
717
        self.assertEqual([], self._get_names(''))
 
718
 
 
719
    def test_single(self):
 
720
        self.assertEqual(['single'], self._get_names('single'))
 
721
 
 
722
    def test_multi(self):
 
723
        expected = ['one', 'two']
 
724
        self.assertEqual(expected, self._get_names(os.pathsep.join(expected)))
 
725
 
 
726
    def test_mixed(self):
 
727
        value = os.pathsep.join(['valid', 'in-valid'])
 
728
        self.assertEqual(['valid'], self._get_names(value))
 
729
        self.assertContainsRe(
 
730
            self.get_log(),
 
731
            r"Invalid name 'in-valid' in BRZ_DISABLE_PLUGINS=" + repr(value))
 
732
 
 
733
 
 
734
class TestEnvPluginsAt(tests.TestCase):
 
735
 
 
736
    def _get_paths(self, env_value):
 
737
        os.environ['BRZ_PLUGINS_AT'] = env_value
 
738
        return plugin._env_plugins_at()
 
739
 
 
740
    def test_empty(self):
 
741
        self.assertEqual([], plugin._env_plugins_at())
 
742
        self.assertEqual([], self._get_paths(''))
 
743
 
 
744
    def test_one_path(self):
 
745
        self.assertEqual([('b', 'man')], self._get_paths('b@man'))
 
746
 
 
747
    def test_multiple(self):
 
748
        self.assertEqual(
 
749
            [('tools', 'bzr-tools'), ('p', 'play.py')],
 
750
            self._get_paths(os.pathsep.join(('tools@bzr-tools', 'p@play.py'))))
 
751
 
 
752
    def test_many_at(self):
 
753
        self.assertEqual(
 
754
            [('church', 'StMichael@Plea@Norwich')],
 
755
            self._get_paths('church@StMichael@Plea@Norwich'))
 
756
 
 
757
    def test_only_py(self):
 
758
        self.assertEqual([('test', './test.py')], self._get_paths('./test.py'))
 
759
 
 
760
    def test_only_package(self):
 
761
        self.assertEqual([('py', '/opt/b/py')], self._get_paths('/opt/b/py'))
 
762
 
 
763
    def test_bad_name(self):
 
764
        self.assertEqual([], self._get_paths('/usr/local/bzr-git'))
 
765
        self.assertContainsRe(
 
766
            self.get_log(),
 
767
            r"Invalid name 'bzr-git' in BRZ_PLUGINS_AT='/usr/local/bzr-git'")
 
768
 
 
769
 
 
770
class TestLoadPluginAt(BaseTestPlugins):
802
771
 
803
772
    def setUp(self):
804
773
        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
774
        # Create the same plugin in two directories
812
775
        self.create_plugin_package('test_foo', dir='non-standard-dir')
813
776
        # The "normal" directory, we use 'standard' instead of 'plugins' to
817
780
    def assertTestFooLoadedFrom(self, path):
818
781
        self.assertPluginKnown('test_foo')
819
782
        self.assertDocstring('This is the doc for test_foo',
820
 
                             bzrlib.plugins.test_foo)
821
 
        self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
 
783
                             self.module.test_foo)
 
784
        self.assertEqual(path, self.module.test_foo.dir_source)
822
785
 
823
786
    def test_regular_load(self):
824
 
        plugin.load_plugins(['standard'])
 
787
        self.load_with_paths(['standard'])
825
788
        self.assertTestFooLoadedFrom('standard/test_foo')
826
789
 
827
790
    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
 
791
        self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
 
792
        self.update_module_paths(['standard'])
 
793
        import breezy.testingplugins.test_foo
834
794
        self.assertTestFooLoadedFrom('non-standard-dir')
835
795
 
836
796
    def test_loading(self):
837
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
838
 
        plugin.load_plugins(['standard'])
 
797
        self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
 
798
        self.load_with_paths(['standard'])
 
799
        self.assertTestFooLoadedFrom('non-standard-dir')
 
800
 
 
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'])
839
805
        self.assertTestFooLoadedFrom('non-standard-dir')
840
806
 
841
807
    def test_compiled_loaded(self):
842
 
        osutils.set_or_unset_env('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
843
 
        plugin.load_plugins(['standard'])
 
808
        self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
 
809
        self.load_with_paths(['standard'])
844
810
        self.assertTestFooLoadedFrom('non-standard-dir')
845
 
        self.assertEqual('non-standard-dir/__init__.py',
846
 
                         bzrlib.plugins.test_foo.__file__)
 
811
        self.assertIsSameRealPath('non-standard-dir/__init__.py',
 
812
                                  self.module.test_foo.__file__)
847
813
 
848
814
        # 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'])
 
815
        os.remove('non-standard-dir/__init__.py')
 
816
        self.promote_cache('non-standard-dir')
 
817
        self.reset()
 
818
        self.load_with_paths(['standard'])
852
819
        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__)
 
820
        suffix = plugin.COMPILED_EXT
 
821
        self.assertIsSameRealPath('non-standard-dir/__init__' + suffix,
 
822
                                  self.module.test_foo.__file__)
859
823
 
860
824
    def test_submodule_loading(self):
861
825
        # We create an additional directory under the one for test_foo
862
826
        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__)
 
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__)
 
835
 
 
836
    def test_relative_submodule_loading(self):
 
837
        self.create_plugin_package('test_foo', dir='another-dir', source='''
 
838
from . import test_bar
 
839
''')
 
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__)
871
849
 
872
850
    def test_loading_from___init__only(self):
873
851
        # We rename the existing __init__.py file to ensure that we don't load
875
853
        init = 'non-standard-dir/__init__.py'
876
854
        random = 'non-standard-dir/setup.py'
877
855
        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'])
 
856
        self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@non-standard-dir')
 
857
        self.load_with_paths(['standard'])
881
858
        self.assertPluginUnknown('test_foo')
882
859
 
883
860
    def test_loading_from_specific_file(self):
890
867
''' % ('test_foo', plugin_path)
891
868
        self.create_plugin('test_foo', source=source,
892
869
                           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'])
 
870
        self.overrideEnv('BRZ_PLUGINS_AT', 'test_foo@%s' % plugin_path)
 
871
        self.load_with_paths(['standard'])
895
872
        self.assertTestFooLoadedFrom(plugin_path)
 
873
 
 
874
 
 
875
class TestDescribePlugins(BaseTestPlugins):
 
876
 
 
877
    def test_describe_plugins(self):
 
878
        class DummyModule(object):
 
879
            __doc__ = 'Hi there'
 
880
 
 
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("""\
 
887
bad (failed to load)
 
888
  ** Failed to load (just testing)
 
889
 
 
890
good 0.1.0
 
891
  Hi there
 
892
 
 
893
""", ''.join(plugin.describe_plugins(state=self)))