← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_plugins.py

  • Committer: John Arbash Meinel
  • Date: 2011-01-12 16:45:49 UTC
  • mto: This revision was merged to the branch mainline in revision 5599.
  • Revision ID: john@arbash-meinel.com-20110112164549-6buxl1yr8vosoh1t
Add to What's New

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_plugins.py
1
 
# Copyright (C) 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
16
 
18
17
"""Tests for plugins"""
19
18
 
21
20
# affects the global state of the process.  See bzrlib/plugins.py for more
22
21
# comments.
23
22
 
 
23
from cStringIO import StringIO
 
24
import logging
24
25
import os
25
 
 
26
 
import bzrlib.plugin
27
 
import bzrlib.plugins
28
 
from bzrlib.tests import TestCaseInTempDir
29
 
 
30
 
class PluginTest(TestCaseInTempDir):
31
 
    """Create an external plugin and test loading."""
32
 
#    def test_plugin_loading(self):
33
 
#        orig_help = self.run_bzr_captured('bzr help commands')[0]
34
 
#        os.mkdir('plugin_test')
35
 
#        f = open(os.path.join('plugin_test', 'myplug.py'), 'wt')
36
 
#        f.write(PLUGIN_TEXT)
37
 
#        f.close()
38
 
#        newhelp = self.run_bzr_captured('bzr help commands')[0]
39
 
#        assert newhelp.startswith('You have been overridden\n')
40
 
#        # We added a line, but the rest should work
41
 
#        assert newhelp[25:] == help
42
 
#
43
 
#        assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
44
 
#
45
 
#        shutil.rmtree('plugin_test')
46
 
#
47
 
 
48
 
#         os.environ['BZRPLUGINPATH'] = os.path.abspath('plugin_test')
49
 
#         help = backtick('bzr help commands')
50
 
#         assert help.find('myplug') != -1
51
 
#         assert help.find('Just a simple test plugin.') != -1
52
 
 
53
 
 
54
 
#         assert backtick('bzr myplug') == 'Hello from my plugin\n'
55
 
#         assert backtick('bzr mplg') == 'Hello from my plugin\n'
56
 
 
57
 
#         f = open(os.path.join('plugin_test', 'override.py'), 'wb')
58
 
#         f.write("""import bzrlib, bzrlib.commands
59
 
#     class cmd_commit(bzrlib.commands.cmd_commit):
60
 
#         '''Commit changes into a new revision.'''
61
 
#         def run(self, *args, **kwargs):
62
 
#             print "I'm sorry dave, you can't do that"
63
 
 
64
 
#     class cmd_help(bzrlib.commands.cmd_help):
65
 
#         '''Show help on a command or other topic.'''
66
 
#         def run(self, *args, **kwargs):
67
 
#             print "You have been overridden"
68
 
#             bzrlib.commands.cmd_help.run(self, *args, **kwargs)
69
 
 
70
 
#         """
71
 
 
72
 
PLUGIN_TEXT = """\
73
 
import bzrlib.commands
74
 
class cmd_myplug(bzrlib.commands.Command):
75
 
    '''Just a simple test plugin.'''
76
 
    aliases = ['mplg']
77
 
    def run(self):
78
 
        print 'Hello from my plugin'
79
 
"""
 
26
import sys
 
27
 
 
28
import bzrlib
 
29
from bzrlib import (
 
30
    errors,
 
31
    osutils,
 
32
    plugin,
 
33
    plugins,
 
34
    tests,
 
35
    trace,
 
36
    )
 
37
 
80
38
 
81
39
# TODO: Write a test for plugin decoration of commands.
82
40
 
83
 
class TestOneNamedPluginOnly(TestCaseInTempDir):
 
41
class TestPluginMixin(object):
 
42
 
 
43
    def create_plugin(self, name, source=None, dir='.', file_name=None):
 
44
        if source is None:
 
45
            source = '''\
 
46
"""This is the doc for %s"""
 
47
''' % (name)
 
48
        if file_name is None:
 
49
            file_name = name + '.py'
 
50
        # 'source' must not fail to load
 
51
        path = osutils.pathjoin(dir, file_name)
 
52
        f = open(path, 'w')
 
53
        self.addCleanup(os.unlink, path)
 
54
        try:
 
55
            f.write(source + '\n')
 
56
        finally:
 
57
            f.close()
 
58
 
 
59
    def create_plugin_package(self, name, dir=None, source=None):
 
60
        if dir is None:
 
61
            dir = name
 
62
        if source is None:
 
63
            source = '''\
 
64
"""This is the doc for %s"""
 
65
dir_source = '%s'
 
66
''' % (name, dir)
 
67
        os.makedirs(dir)
 
68
        def cleanup():
 
69
            # Workaround lazy import random? madness
 
70
            osutils.rmtree(dir)
 
71
        self.addCleanup(cleanup)
 
72
        self.create_plugin(name, source, dir,
 
73
                           file_name='__init__.py')
 
74
 
 
75
    def _unregister_plugin(self, name):
 
76
        """Remove the plugin from sys.modules and the bzrlib namespace."""
 
77
        py_name = 'bzrlib.plugins.%s' % name
 
78
        if py_name in sys.modules:
 
79
            del sys.modules[py_name]
 
80
        if getattr(bzrlib.plugins, name, None) is not None:
 
81
            delattr(bzrlib.plugins, name)
 
82
 
 
83
    def _unregister_plugin_submodule(self, plugin_name, submodule_name):
 
84
        """Remove the submodule from sys.modules and the bzrlib namespace."""
 
85
        py_name = 'bzrlib.plugins.%s.%s' % (plugin_name, submodule_name)
 
86
        if py_name in sys.modules:
 
87
            del sys.modules[py_name]
 
88
        plugin = getattr(bzrlib.plugins, plugin_name, None)
 
89
        if plugin is not None:
 
90
            if getattr(plugin, submodule_name, None) is not None:
 
91
                delattr(plugin, submodule_name)
 
92
 
 
93
    def assertPluginUnknown(self, name):
 
94
        self.failIf(getattr(bzrlib.plugins, name, None) is not None)
 
95
        self.failIf('bzrlib.plugins.%s' % name in sys.modules)
 
96
 
 
97
    def assertPluginKnown(self, name):
 
98
        self.failUnless(getattr(bzrlib.plugins, name, None) is not None)
 
99
        self.failUnless('bzrlib.plugins.%s' % name in sys.modules)
 
100
 
 
101
 
 
102
class TestLoadingPlugins(tests.TestCaseInTempDir, TestPluginMixin):
84
103
 
85
104
    activeattributes = {}
86
105
 
87
106
    def test_plugins_with_the_same_name_are_not_loaded(self):
 
107
        # This test tests that having two plugins in different directories does
 
108
        # not result in both being loaded when they have the same name.  get a
 
109
        # file name we can use which is also a valid attribute for accessing in
 
110
        # activeattributes. - we cannot give import parameters.
 
111
        tempattribute = "0"
 
112
        self.failIf(tempattribute in self.activeattributes)
 
113
        # set a place for the plugins to record their loading, and at the same
 
114
        # time validate that the location the plugins should record to is
 
115
        # valid and correct.
 
116
        self.__class__.activeattributes [tempattribute] = []
 
117
        self.failUnless(tempattribute in self.activeattributes)
 
118
        # create two plugin directories
 
119
        os.mkdir('first')
 
120
        os.mkdir('second')
 
121
        # write a plugin that will record when its loaded in the
 
122
        # tempattribute list.
 
123
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
 
124
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
 
125
 
 
126
        outfile = open(os.path.join('first', 'plugin.py'), 'w')
 
127
        try:
 
128
            outfile.write(template % (tempattribute, 'first'))
 
129
            outfile.write('\n')
 
130
        finally:
 
131
            outfile.close()
 
132
 
 
133
        outfile = open(os.path.join('second', 'plugin.py'), 'w')
 
134
        try:
 
135
            outfile.write(template % (tempattribute, 'second'))
 
136
            outfile.write('\n')
 
137
        finally:
 
138
            outfile.close()
 
139
 
 
140
        try:
 
141
            bzrlib.plugin.load_from_path(['first', 'second'])
 
142
            self.assertEqual(['first'], self.activeattributes[tempattribute])
 
143
        finally:
 
144
            # remove the plugin 'plugin'
 
145
            del self.activeattributes[tempattribute]
 
146
            self._unregister_plugin('plugin')
 
147
        self.assertPluginUnknown('plugin')
 
148
 
 
149
    def test_plugins_from_different_dirs_can_demand_load(self):
 
150
        self.failIf('bzrlib.plugins.pluginone' in sys.modules)
 
151
        self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
88
152
        # This test tests that having two plugins in different
89
 
        # directories does not result in both being loaded.
90
 
        # get a file name we can use which is also a valid attribute
 
153
        # directories with different names allows them both to be loaded, when
 
154
        # we do a direct import statement.
 
155
        # Determine a file name we can use which is also a valid attribute
91
156
        # for accessing in activeattributes. - we cannot give import parameters.
92
 
        tempattribute = "0"
 
157
        tempattribute = "different-dirs"
93
158
        self.failIf(tempattribute in self.activeattributes)
94
159
        # set a place for the plugins to record their loading, and at the same
95
160
        # time validate that the location the plugins should record to is
96
161
        # valid and correct.
97
 
        bzrlib.tests.test_plugins.TestOneNamedPluginOnly.activeattributes \
 
162
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
98
163
            [tempattribute] = []
99
164
        self.failUnless(tempattribute in self.activeattributes)
100
165
        # create two plugin directories
101
166
        os.mkdir('first')
102
167
        os.mkdir('second')
103
 
        # write a plugin that will record when its loaded in the 
 
168
        # write plugins that will record when they are loaded in the
104
169
        # tempattribute list.
105
 
        template = ("from bzrlib.tests.test_plugins import TestOneNamedPluginOnly\n"
106
 
                    "TestOneNamedPluginOnly.activeattributes[%r].append('%s')\n")
107
 
        print >> file(os.path.join('first', 'plugin.py'), 'w'), template % (tempattribute, 'first')
108
 
        print >> file(os.path.join('second', 'plugin.py'), 'w'), template % (tempattribute, 'second')
109
 
        try:
110
 
            bzrlib.plugin.load_from_dirs(['first', 'second'])
 
170
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
 
171
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
 
172
 
 
173
        outfile = open(os.path.join('first', 'pluginone.py'), 'w')
 
174
        try:
 
175
            outfile.write(template % (tempattribute, 'first'))
 
176
            outfile.write('\n')
 
177
        finally:
 
178
            outfile.close()
 
179
 
 
180
        outfile = open(os.path.join('second', 'plugintwo.py'), 'w')
 
181
        try:
 
182
            outfile.write(template % (tempattribute, 'second'))
 
183
            outfile.write('\n')
 
184
        finally:
 
185
            outfile.close()
 
186
 
 
187
        oldpath = bzrlib.plugins.__path__
 
188
        try:
 
189
            self.failIf('bzrlib.plugins.pluginone' in sys.modules)
 
190
            self.failIf('bzrlib.plugins.plugintwo' in sys.modules)
 
191
            bzrlib.plugins.__path__ = ['first', 'second']
 
192
            exec "import bzrlib.plugins.pluginone"
111
193
            self.assertEqual(['first'], self.activeattributes[tempattribute])
 
194
            exec "import bzrlib.plugins.plugintwo"
 
195
            self.assertEqual(['first', 'second'],
 
196
                self.activeattributes[tempattribute])
112
197
        finally:
113
198
            # remove the plugin 'plugin'
114
199
            del self.activeattributes[tempattribute]
115
 
            if getattr(bzrlib.plugins, 'plugin', None):
116
 
                del bzrlib.plugins.plugin
117
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
118
 
 
119
 
 
120
 
class TestAllPlugins(TestCaseInTempDir):
121
 
 
122
 
    def test_plugin_appears_in_all_plugins(self):
123
 
        # This test tests a new plugin appears in bzrlib.plugin.all_plugins().
124
 
        # check the plugin is not loaded already
125
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
200
            self._unregister_plugin('pluginone')
 
201
            self._unregister_plugin('plugintwo')
 
202
        self.assertPluginUnknown('pluginone')
 
203
        self.assertPluginUnknown('plugintwo')
 
204
 
 
205
    def test_plugins_can_load_from_directory_with_trailing_slash(self):
 
206
        # This test tests that a plugin can load from a directory when the
 
207
        # directory in the path has a trailing slash.
 
208
        # check the plugin is not loaded already
 
209
        self.assertPluginUnknown('ts_plugin')
 
210
        tempattribute = "trailing-slash"
 
211
        self.failIf(tempattribute in self.activeattributes)
 
212
        # set a place for the plugin to record its loading, and at the same
 
213
        # time validate that the location the plugin should record to is
 
214
        # valid and correct.
 
215
        bzrlib.tests.test_plugins.TestLoadingPlugins.activeattributes \
 
216
            [tempattribute] = []
 
217
        self.failUnless(tempattribute in self.activeattributes)
 
218
        # create a directory for the plugin
 
219
        os.mkdir('plugin_test')
 
220
        # write a plugin that will record when its loaded in the
 
221
        # tempattribute list.
 
222
        template = ("from bzrlib.tests.test_plugins import TestLoadingPlugins\n"
 
223
                    "TestLoadingPlugins.activeattributes[%r].append('%s')\n")
 
224
 
 
225
        outfile = open(os.path.join('plugin_test', 'ts_plugin.py'), 'w')
 
226
        try:
 
227
            outfile.write(template % (tempattribute, 'plugin'))
 
228
            outfile.write('\n')
 
229
        finally:
 
230
            outfile.close()
 
231
 
 
232
        try:
 
233
            bzrlib.plugin.load_from_path(['plugin_test'+os.sep])
 
234
            self.assertEqual(['plugin'], self.activeattributes[tempattribute])
 
235
        finally:
 
236
            del self.activeattributes[tempattribute]
 
237
            self._unregister_plugin('ts_plugin')
 
238
        self.assertPluginUnknown('ts_plugin')
 
239
 
 
240
    def load_and_capture(self, name):
 
241
        """Load plugins from '.' capturing the output.
 
242
 
 
243
        :param name: The name of the plugin.
 
244
        :return: A string with the log from the plugin loading call.
 
245
        """
 
246
        # Capture output
 
247
        stream = StringIO()
 
248
        try:
 
249
            handler = logging.StreamHandler(stream)
 
250
            log = logging.getLogger('bzr')
 
251
            log.addHandler(handler)
 
252
            try:
 
253
                try:
 
254
                    bzrlib.plugin.load_from_path(['.'])
 
255
                finally:
 
256
                    if 'bzrlib.plugins.%s' % name in sys.modules:
 
257
                        del sys.modules['bzrlib.plugins.%s' % name]
 
258
                    if getattr(bzrlib.plugins, name, None):
 
259
                        delattr(bzrlib.plugins, name)
 
260
            finally:
 
261
                # Stop capturing output
 
262
                handler.flush()
 
263
                handler.close()
 
264
                log.removeHandler(handler)
 
265
            return stream.getvalue()
 
266
        finally:
 
267
            stream.close()
 
268
 
 
269
    def test_plugin_with_bad_api_version_reports(self):
 
270
        # This plugin asks for bzrlib api version 1.0.0, which is not supported
 
271
        # anymore.
 
272
        name = 'wants100.py'
 
273
        f = file(name, 'w')
 
274
        try:
 
275
            f.write("import bzrlib.api\n"
 
276
                "bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")
 
277
        finally:
 
278
            f.close()
 
279
 
 
280
        log = self.load_and_capture(name)
 
281
        self.assertContainsRe(log,
 
282
            r"It requested API version")
 
283
 
 
284
    def test_plugin_with_bad_name_does_not_load(self):
 
285
        # The file name here invalid for a python module.
 
286
        name = 'bzr-bad plugin-name..py'
 
287
        file(name, 'w').close()
 
288
        log = self.load_and_capture(name)
 
289
        self.assertContainsRe(log,
 
290
            r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "
 
291
            "because the file path isn't a valid module name; try renaming "
 
292
            "it to 'bad_plugin_name_'\.")
 
293
 
 
294
 
 
295
class TestPlugins(tests.TestCaseInTempDir, TestPluginMixin):
 
296
 
 
297
    def setup_plugin(self, source=""):
 
298
        # This test tests a new plugin appears in bzrlib.plugin.plugins().
 
299
        # check the plugin is not loaded already
 
300
        self.assertPluginUnknown('plugin')
126
301
        # write a plugin that _cannot_ fail to load.
127
 
        print >> file('plugin.py', 'w'), ""
128
 
        try:
129
 
            bzrlib.plugin.load_from_dirs(['.'])
130
 
            self.failUnless('plugin' in bzrlib.plugin.all_plugins())
131
 
            self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
132
 
            self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
133
 
                             bzrlib.plugins.plugin)
134
 
        finally:
135
 
            # remove the plugin 'plugin'
136
 
            if getattr(bzrlib.plugins, 'plugin', None):
137
 
                del bzrlib.plugins.plugin
138
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
302
        file('plugin.py', 'w').write(source + '\n')
 
303
        self.addCleanup(self.teardown_plugin)
 
304
        plugin.load_from_path(['.'])
 
305
 
 
306
    def teardown_plugin(self):
 
307
        self._unregister_plugin('plugin')
 
308
        self.assertPluginUnknown('plugin')
 
309
 
 
310
    def test_plugin_appears_in_plugins(self):
 
311
        self.setup_plugin()
 
312
        self.assertPluginKnown('plugin')
 
313
        p = plugin.plugins()['plugin']
 
314
        self.assertIsInstance(p, bzrlib.plugin.PlugIn)
 
315
        self.assertEqual(p.module, plugins.plugin)
 
316
 
 
317
    def test_trivial_plugin_get_path(self):
 
318
        self.setup_plugin()
 
319
        p = plugin.plugins()['plugin']
 
320
        plugin_path = self.test_dir + '/plugin.py'
 
321
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
322
 
 
323
    def test_plugin_get_path_py_not_pyc(self):
 
324
        # first import creates plugin.pyc
 
325
        self.setup_plugin()
 
326
        self.teardown_plugin()
 
327
        plugin.load_from_path(['.']) # import plugin.pyc
 
328
        p = plugin.plugins()['plugin']
 
329
        plugin_path = self.test_dir + '/plugin.py'
 
330
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
331
 
 
332
    def test_plugin_get_path_pyc_only(self):
 
333
        # first import creates plugin.pyc (or plugin.pyo depending on __debug__)
 
334
        self.setup_plugin()
 
335
        self.teardown_plugin()
 
336
        os.unlink(self.test_dir + '/plugin.py')
 
337
        plugin.load_from_path(['.']) # import plugin.pyc (or .pyo)
 
338
        p = plugin.plugins()['plugin']
 
339
        if __debug__:
 
340
            plugin_path = self.test_dir + '/plugin.pyc'
 
341
        else:
 
342
            plugin_path = self.test_dir + '/plugin.pyo'
 
343
        self.assertIsSameRealPath(plugin_path, osutils.normpath(p.path()))
 
344
 
 
345
    def test_no_test_suite_gives_None_for_test_suite(self):
 
346
        self.setup_plugin()
 
347
        p = plugin.plugins()['plugin']
 
348
        self.assertEqual(None, p.test_suite())
 
349
 
 
350
    def test_test_suite_gives_test_suite_result(self):
 
351
        source = """def test_suite(): return 'foo'"""
 
352
        self.setup_plugin(source)
 
353
        p = plugin.plugins()['plugin']
 
354
        self.assertEqual('foo', p.test_suite())
 
355
 
 
356
    def test_no_load_plugin_tests_gives_None_for_load_plugin_tests(self):
 
357
        self.setup_plugin()
 
358
        loader = tests.TestUtil.TestLoader()
 
359
        p = plugin.plugins()['plugin']
 
360
        self.assertEqual(None, p.load_plugin_tests(loader))
 
361
 
 
362
    def test_load_plugin_tests_gives_load_plugin_tests_result(self):
 
363
        source = """
 
364
def load_tests(standard_tests, module, loader):
 
365
    return 'foo'"""
 
366
        self.setup_plugin(source)
 
367
        loader = tests.TestUtil.TestLoader()
 
368
        p = plugin.plugins()['plugin']
 
369
        self.assertEqual('foo', p.load_plugin_tests(loader))
 
370
 
 
371
    def check_version_info(self, expected, source='', name='plugin'):
 
372
        self.setup_plugin(source)
 
373
        self.assertEqual(expected, plugin.plugins()[name].version_info())
 
374
 
 
375
    def test_no_version_info(self):
 
376
        self.check_version_info(None)
 
377
 
 
378
    def test_with_version_info(self):
 
379
        self.check_version_info((1, 2, 3, 'dev', 4),
 
380
                                "version_info = (1, 2, 3, 'dev', 4)")
 
381
 
 
382
    def test_short_version_info_gets_padded(self):
 
383
        # the gtk plugin has version_info = (1,2,3) rather than the 5-tuple.
 
384
        # so we adapt it
 
385
        self.check_version_info((1, 2, 3, 'final', 0),
 
386
                                "version_info = (1, 2, 3)")
 
387
 
 
388
    def check_version(self, expected, source=None, name='plugin'):
 
389
        self.setup_plugin(source)
 
390
        self.assertEqual(expected, plugins[name].__version__)
 
391
 
 
392
    def test_no_version_info___version__(self):
 
393
        self.setup_plugin()
 
394
        plugin = bzrlib.plugin.plugins()['plugin']
 
395
        self.assertEqual("unknown", plugin.__version__)
 
396
 
 
397
    def test_str__version__with_version_info(self):
 
398
        self.setup_plugin("version_info = '1.2.3'")
 
399
        plugin = bzrlib.plugin.plugins()['plugin']
 
400
        self.assertEqual("1.2.3", plugin.__version__)
 
401
 
 
402
    def test_noniterable__version__with_version_info(self):
 
403
        self.setup_plugin("version_info = (1)")
 
404
        plugin = bzrlib.plugin.plugins()['plugin']
 
405
        self.assertEqual("1", plugin.__version__)
 
406
 
 
407
    def test_1__version__with_version_info(self):
 
408
        self.setup_plugin("version_info = (1,)")
 
409
        plugin = bzrlib.plugin.plugins()['plugin']
 
410
        self.assertEqual("1", plugin.__version__)
 
411
 
 
412
    def test_1_2__version__with_version_info(self):
 
413
        self.setup_plugin("version_info = (1, 2)")
 
414
        plugin = bzrlib.plugin.plugins()['plugin']
 
415
        self.assertEqual("1.2", plugin.__version__)
 
416
 
 
417
    def test_1_2_3__version__with_version_info(self):
 
418
        self.setup_plugin("version_info = (1, 2, 3)")
 
419
        plugin = bzrlib.plugin.plugins()['plugin']
 
420
        self.assertEqual("1.2.3", plugin.__version__)
 
421
 
 
422
    def test_candidate__version__with_version_info(self):
 
423
        self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")
 
424
        plugin = bzrlib.plugin.plugins()['plugin']
 
425
        self.assertEqual("1.2.3rc1", plugin.__version__)
 
426
 
 
427
    def test_dev__version__with_version_info(self):
 
428
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")
 
429
        plugin = bzrlib.plugin.plugins()['plugin']
 
430
        self.assertEqual("1.2.3dev", plugin.__version__)
 
431
 
 
432
    def test_dev_fallback__version__with_version_info(self):
 
433
        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")
 
434
        plugin = bzrlib.plugin.plugins()['plugin']
 
435
        self.assertEqual("1.2.3dev4", plugin.__version__)
 
436
 
 
437
    def test_final__version__with_version_info(self):
 
438
        self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")
 
439
        plugin = bzrlib.plugin.plugins()['plugin']
 
440
        self.assertEqual("1.2.3", plugin.__version__)
 
441
 
 
442
    def test_final_fallback__version__with_version_info(self):
 
443
        self.setup_plugin("version_info = (1, 2, 3, 'final', 2)")
 
444
        plugin = bzrlib.plugin.plugins()['plugin']
 
445
        self.assertEqual("1.2.3.final.2", plugin.__version__)
 
446
 
 
447
 
 
448
class TestPluginHelp(tests.TestCaseInTempDir):
 
449
 
 
450
    def split_help_commands(self):
 
451
        help = {}
 
452
        current = None
 
453
        out, err = self.run_bzr('--no-plugins help commands')
 
454
        for line in out.splitlines():
 
455
            if not line.startswith(' '):
 
456
                current = line.split()[0]
 
457
            help[current] = help.get(current, '') + line
 
458
 
 
459
        return help
 
460
 
 
461
    def test_plugin_help_builtins_unaffected(self):
 
462
        # Check we don't get false positives
 
463
        help_commands = self.split_help_commands()
 
464
        for cmd_name in bzrlib.commands.builtin_command_names():
 
465
            if cmd_name in bzrlib.commands.plugin_command_names():
 
466
                continue
 
467
            try:
 
468
                help = bzrlib.commands.get_cmd_object(cmd_name).get_help_text()
 
469
            except NotImplementedError:
 
470
                # some commands have no help
 
471
                pass
 
472
            else:
 
473
                self.assertNotContainsRe(help, 'plugin "[^"]*"')
 
474
 
 
475
            if cmd_name in help_commands.keys():
 
476
                # some commands are hidden
 
477
                help = help_commands[cmd_name]
 
478
                self.assertNotContainsRe(help, 'plugin "[^"]*"')
 
479
 
 
480
    def test_plugin_help_shows_plugin(self):
 
481
        # Create a test plugin
 
482
        os.mkdir('plugin_test')
 
483
        f = open(osutils.pathjoin('plugin_test', 'myplug.py'), 'w')
 
484
        f.write("""\
 
485
from bzrlib import commands
 
486
class cmd_myplug(commands.Command):
 
487
    __doc__ = '''Just a simple test plugin.'''
 
488
    aliases = ['mplg']
 
489
    def run(self):
 
490
        print 'Hello from my plugin'
 
491
 
 
492
"""
 
493
)
 
494
        f.close()
 
495
 
 
496
        try:
 
497
            # Check its help
 
498
            bzrlib.plugin.load_from_path(['plugin_test'])
 
499
            bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
 
500
            help = self.run_bzr('help myplug')[0]
 
501
            self.assertContainsRe(help, 'plugin "myplug"')
 
502
            help = self.split_help_commands()['myplug']
 
503
            self.assertContainsRe(help, '\[myplug\]')
 
504
        finally:
 
505
            # unregister command
 
506
            if 'myplug' in bzrlib.commands.plugin_cmds:
 
507
                bzrlib.commands.plugin_cmds.remove('myplug')
 
508
            # remove the plugin 'myplug'
 
509
            if getattr(bzrlib.plugins, 'myplug', None):
 
510
                delattr(bzrlib.plugins, 'myplug')
 
511
 
 
512
 
 
513
class TestHelpIndex(tests.TestCase):
 
514
    """Tests for the PluginsHelpIndex class."""
 
515
 
 
516
    def test_default_constructable(self):
 
517
        index = plugin.PluginsHelpIndex()
 
518
 
 
519
    def test_get_topics_None(self):
 
520
        """Searching for None returns an empty list."""
 
521
        index = plugin.PluginsHelpIndex()
 
522
        self.assertEqual([], index.get_topics(None))
 
523
 
 
524
    def test_get_topics_for_plugin(self):
 
525
        """Searching for plugin name gets its docstring."""
 
526
        index = plugin.PluginsHelpIndex()
 
527
        # make a new plugin here for this test, even if we're run with
 
528
        # --no-plugins
 
529
        self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
 
530
        demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
 
531
        sys.modules['bzrlib.plugins.demo_module'] = demo_module
 
532
        try:
 
533
            topics = index.get_topics('demo_module')
 
534
            self.assertEqual(1, len(topics))
 
535
            self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
 
536
            self.assertEqual(demo_module, topics[0].module)
 
537
        finally:
 
538
            del sys.modules['bzrlib.plugins.demo_module']
 
539
 
 
540
    def test_get_topics_no_topic(self):
 
541
        """Searching for something that is not a plugin returns []."""
 
542
        # test this by using a name that cannot be a plugin - its not
 
543
        # a valid python identifier.
 
544
        index = plugin.PluginsHelpIndex()
 
545
        self.assertEqual([], index.get_topics('nothing by this name'))
 
546
 
 
547
    def test_prefix(self):
 
548
        """PluginsHelpIndex has a prefix of 'plugins/'."""
 
549
        index = plugin.PluginsHelpIndex()
 
550
        self.assertEqual('plugins/', index.prefix)
 
551
 
 
552
    def test_get_plugin_topic_with_prefix(self):
 
553
        """Searching for plugins/demo_module returns help."""
 
554
        index = plugin.PluginsHelpIndex()
 
555
        self.assertFalse(sys.modules.has_key('bzrlib.plugins.demo_module'))
 
556
        demo_module = FakeModule('', 'bzrlib.plugins.demo_module')
 
557
        sys.modules['bzrlib.plugins.demo_module'] = demo_module
 
558
        try:
 
559
            topics = index.get_topics('plugins/demo_module')
 
560
            self.assertEqual(1, len(topics))
 
561
            self.assertIsInstance(topics[0], plugin.ModuleHelpTopic)
 
562
            self.assertEqual(demo_module, topics[0].module)
 
563
        finally:
 
564
            del sys.modules['bzrlib.plugins.demo_module']
 
565
 
 
566
 
 
567
class FakeModule(object):
 
568
    """A fake module to test with."""
 
569
 
 
570
    def __init__(self, doc, name):
 
571
        self.__doc__ = doc
 
572
        self.__name__ = name
 
573
 
 
574
 
 
575
class TestModuleHelpTopic(tests.TestCase):
 
576
    """Tests for the ModuleHelpTopic class."""
 
577
 
 
578
    def test_contruct(self):
 
579
        """Construction takes the module to document."""
 
580
        mod = FakeModule('foo', 'foo')
 
581
        topic = plugin.ModuleHelpTopic(mod)
 
582
        self.assertEqual(mod, topic.module)
 
583
 
 
584
    def test_get_help_text_None(self):
 
585
        """A ModuleHelpTopic returns the docstring for get_help_text."""
 
586
        mod = FakeModule(None, 'demo')
 
587
        topic = plugin.ModuleHelpTopic(mod)
 
588
        self.assertEqual("Plugin 'demo' has no docstring.\n",
 
589
            topic.get_help_text())
 
590
 
 
591
    def test_get_help_text_no_carriage_return(self):
 
592
        """ModuleHelpTopic.get_help_text adds a \n if needed."""
 
593
        mod = FakeModule('one line of help', 'demo')
 
594
        topic = plugin.ModuleHelpTopic(mod)
 
595
        self.assertEqual("one line of help\n",
 
596
            topic.get_help_text())
 
597
 
 
598
    def test_get_help_text_carriage_return(self):
 
599
        """ModuleHelpTopic.get_help_text adds a \n if needed."""
 
600
        mod = FakeModule('two lines of help\nand more\n', 'demo')
 
601
        topic = plugin.ModuleHelpTopic(mod)
 
602
        self.assertEqual("two lines of help\nand more\n",
 
603
            topic.get_help_text())
 
604
 
 
605
    def test_get_help_text_with_additional_see_also(self):
 
606
        mod = FakeModule('two lines of help\nand more', 'demo')
 
607
        topic = plugin.ModuleHelpTopic(mod)
 
608
        self.assertEqual("two lines of help\nand more\nSee also: bar, foo\n",
 
609
            topic.get_help_text(['foo', 'bar']))
 
610
 
 
611
    def test_get_help_topic(self):
 
612
        """The help topic for a plugin is its module name."""
 
613
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.demo')
 
614
        topic = plugin.ModuleHelpTopic(mod)
 
615
        self.assertEqual('demo', topic.get_help_topic())
 
616
        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')
 
617
        topic = plugin.ModuleHelpTopic(mod)
 
618
        self.assertEqual('foo_bar', topic.get_help_topic())
 
619
 
 
620
 
 
621
class TestLoadFromPath(tests.TestCaseInTempDir):
 
622
 
 
623
    def setUp(self):
 
624
        super(TestLoadFromPath, self).setUp()
 
625
        # Change bzrlib.plugin to think no plugins have been loaded yet.
 
626
        self.overrideAttr(bzrlib.plugins, '__path__', [])
 
627
        self.overrideAttr(plugin, '_loaded', False)
 
628
 
 
629
        # Monkey-patch load_from_path to stop it from actually loading anything.
 
630
        self.overrideAttr(plugin, 'load_from_path', lambda dirs: None)
 
631
 
 
632
    def test_set_plugins_path_with_args(self):
 
633
        plugin.set_plugins_path(['a', 'b'])
 
634
        self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)
 
635
 
 
636
    def test_set_plugins_path_defaults(self):
 
637
        plugin.set_plugins_path()
 
638
        self.assertEqual(plugin.get_standard_plugins_path(),
 
639
                         bzrlib.plugins.__path__)
 
640
 
 
641
    def test_get_standard_plugins_path(self):
 
642
        path = plugin.get_standard_plugins_path()
 
643
        for directory in path:
 
644
            self.assertNotContainsRe(directory, r'\\/$')
 
645
        try:
 
646
            from distutils.sysconfig import get_python_lib
 
647
        except ImportError:
 
648
            pass
 
649
        else:
 
650
            if sys.platform != 'win32':
 
651
                python_lib = get_python_lib()
 
652
                for directory in path:
 
653
                    if directory.startswith(python_lib):
 
654
                        break
 
655
                else:
 
656
                    self.fail('No path to global plugins')
 
657
 
 
658
    def test_get_standard_plugins_path_env(self):
 
659
        self.overrideEnv('BZR_PLUGIN_PATH', 'foo/')
 
660
        path = plugin.get_standard_plugins_path()
 
661
        for directory in path:
 
662
            self.assertNotContainsRe(directory, r'\\/$')
 
663
 
 
664
    def test_load_plugins(self):
 
665
        plugin.load_plugins(['.'])
 
666
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
 
667
        # subsequent loads are no-ops
 
668
        plugin.load_plugins(['foo'])
 
669
        self.assertEqual(bzrlib.plugins.__path__, ['.'])
 
670
 
 
671
    def test_load_plugins_default(self):
 
672
        plugin.load_plugins()
 
673
        path = plugin.get_standard_plugins_path()
 
674
        self.assertEqual(path, bzrlib.plugins.__path__)
 
675
 
 
676
 
 
677
class TestEnvPluginPath(tests.TestCase):
 
678
 
 
679
    def setUp(self):
 
680
        super(TestEnvPluginPath, self).setUp()
 
681
        self.overrideAttr(plugin, 'DEFAULT_PLUGIN_PATH', None)
 
682
 
 
683
        self.user = plugin.get_user_plugin_path()
 
684
        self.site = plugin.get_site_plugin_path()
 
685
        self.core = plugin.get_core_plugin_path()
 
686
 
 
687
    def _list2paths(self, *args):
 
688
        paths = []
 
689
        for p in args:
 
690
            plugin._append_new_path(paths, p)
 
691
        return paths
 
692
 
 
693
    def _set_path(self, *args):
 
694
        path = os.pathsep.join(self._list2paths(*args))
 
695
        self.overrideEnv('BZR_PLUGIN_PATH', path)
 
696
 
 
697
    def check_path(self, expected_dirs, setting_dirs):
 
698
        if setting_dirs:
 
699
            self._set_path(*setting_dirs)
 
700
        actual = plugin.get_standard_plugins_path()
 
701
        self.assertEquals(self._list2paths(*expected_dirs), actual)
 
702
 
 
703
    def test_default(self):
 
704
        self.check_path([self.user, self.core, self.site],
 
705
                        None)
 
706
 
 
707
    def test_adhoc_policy(self):
 
708
        self.check_path([self.user, self.core, self.site],
 
709
                        ['+user', '+core', '+site'])
 
710
 
 
711
    def test_fallback_policy(self):
 
712
        self.check_path([self.core, self.site, self.user],
 
713
                        ['+core', '+site', '+user'])
 
714
 
 
715
    def test_override_policy(self):
 
716
        self.check_path([self.user, self.site, self.core],
 
717
                        ['+user', '+site', '+core'])
 
718
 
 
719
    def test_disable_user(self):
 
720
        self.check_path([self.core, self.site], ['-user'])
 
721
 
 
722
    def test_disable_user_twice(self):
 
723
        # Ensures multiple removals don't left cruft
 
724
        self.check_path([self.core, self.site], ['-user', '-user'])
 
725
 
 
726
    def test_duplicates_are_removed(self):
 
727
        self.check_path([self.user, self.core, self.site],
 
728
                        ['+user', '+user'])
 
729
        # And only the first reference is kept (since the later references will
 
730
        # only produce '<plugin> already loaded' mutters)
 
731
        self.check_path([self.user, self.core, self.site],
 
732
                        ['+user', '+user', '+core',
 
733
                         '+user', '+site', '+site',
 
734
                         '+core'])
 
735
 
 
736
    def test_disable_overrides_enable(self):
 
737
        self.check_path([self.core, self.site], ['-user', '+user'])
 
738
 
 
739
    def test_disable_core(self):
 
740
        self.check_path([self.site], ['-core'])
 
741
        self.check_path([self.user, self.site], ['+user', '-core'])
 
742
 
 
743
    def test_disable_site(self):
 
744
        self.check_path([self.core], ['-site'])
 
745
        self.check_path([self.user, self.core], ['-site', '+user'])
 
746
 
 
747
    def test_override_site(self):
 
748
        self.check_path(['mysite', self.user, self.core],
 
749
                        ['mysite', '-site', '+user'])
 
750
        self.check_path(['mysite', self.core],
 
751
                        ['mysite', '-site'])
 
752
 
 
753
    def test_override_core(self):
 
754
        self.check_path(['mycore', self.user, self.site],
 
755
                        ['mycore', '-core', '+user', '+site'])
 
756
        self.check_path(['mycore', self.site],
 
757
                        ['mycore', '-core'])
 
758
 
 
759
    def test_my_plugin_only(self):
 
760
        self.check_path(['myplugin'], ['myplugin', '-user', '-core', '-site'])
 
761
 
 
762
    def test_my_plugin_first(self):
 
763
        self.check_path(['myplugin', self.core, self.site, self.user],
 
764
                        ['myplugin', '+core', '+site', '+user'])
 
765
 
 
766
    def test_bogus_references(self):
 
767
        self.check_path(['+foo', '-bar', self.core, self.site],
 
768
                        ['+foo', '-bar'])
 
769
 
 
770
 
 
771
class TestDisablePlugin(tests.TestCaseInTempDir, TestPluginMixin):
 
772
 
 
773
    def setUp(self):
 
774
        super(TestDisablePlugin, self).setUp()
 
775
        self.create_plugin_package('test_foo')
 
776
        # Make sure we don't pollute the plugins namespace
 
777
        self.overrideAttr(plugins, '__path__')
 
778
        # Be paranoid in case a test fail
 
779
        self.addCleanup(self._unregister_plugin, 'test_foo')
 
780
 
 
781
    def test_cannot_import(self):
 
782
        self.overrideEnv('BZR_DISABLE_PLUGINS', 'test_foo')
 
783
        plugin.set_plugins_path(['.'])
 
784
        try:
 
785
            import bzrlib.plugins.test_foo
 
786
        except ImportError:
 
787
            pass
 
788
        self.assertPluginUnknown('test_foo')
 
789
 
 
790
    def test_regular_load(self):
 
791
        self.overrideAttr(plugin, '_loaded', False)
 
792
        plugin.load_plugins(['.'])
 
793
        self.assertPluginKnown('test_foo')
 
794
        self.assertDocstring("This is the doc for test_foo",
 
795
                             bzrlib.plugins.test_foo)
 
796
 
 
797
    def test_not_loaded(self):
 
798
        self.warnings = []
 
799
        def captured_warning(*args, **kwargs):
 
800
            self.warnings.append((args, kwargs))
 
801
        self.overrideAttr(trace, 'warning', captured_warning)
 
802
        # Reset the flag that protect against double loading
 
803
        self.overrideAttr(plugin, '_loaded', False)
 
804
        self.overrideEnv('BZR_DISABLE_PLUGINS', 'test_foo')
 
805
        plugin.load_plugins(['.'])
 
806
        self.assertPluginUnknown('test_foo')
 
807
        # Make sure we don't warn about the plugin ImportError since this has
 
808
        # been *requested* by the user.
 
809
        self.assertLength(0, self.warnings)
 
810
 
 
811
 
 
812
class TestLoadPluginAtSyntax(tests.TestCase):
 
813
 
 
814
    def _get_paths(self, paths):
 
815
        return plugin._get_specific_plugin_paths(paths)
 
816
 
 
817
    def test_empty(self):
 
818
        self.assertEquals([], self._get_paths(None))
 
819
        self.assertEquals([], self._get_paths(''))
 
820
 
 
821
    def test_one_path(self):
 
822
        self.assertEquals([('b', 'man')], self._get_paths('b@man'))
 
823
 
 
824
    def test_bogus_path(self):
 
825
        # We need a '@'
 
826
        self.assertRaises(errors.BzrCommandError, self._get_paths, 'batman')
 
827
        # Too much '@' isn't good either
 
828
        self.assertRaises(errors.BzrCommandError, self._get_paths,
 
829
                          'batman@mobile@cave')
 
830
        # An empty description probably indicates a problem
 
831
        self.assertRaises(errors.BzrCommandError, self._get_paths,
 
832
                          os.pathsep.join(['batman@cave', '', 'robin@mobile']))
 
833
 
 
834
 
 
835
class TestLoadPluginAt(tests.TestCaseInTempDir, TestPluginMixin):
 
836
 
 
837
    def setUp(self):
 
838
        super(TestLoadPluginAt, self).setUp()
 
839
        # Make sure we don't pollute the plugins namespace
 
840
        self.overrideAttr(plugins, '__path__')
 
841
        # Reset the flag that protect against double loading
 
842
        self.overrideAttr(plugin, '_loaded', False)
 
843
        # Create the same plugin in two directories
 
844
        self.create_plugin_package('test_foo', dir='non-standard-dir')
 
845
        # The "normal" directory, we use 'standard' instead of 'plugins' to
 
846
        # avoid depending on the precise naming.
 
847
        self.create_plugin_package('test_foo', dir='standard/test_foo')
 
848
        # All the tests will load the 'test_foo' plugin from various locations
 
849
        self.addCleanup(self._unregister_plugin, 'test_foo')
 
850
 
 
851
    def assertTestFooLoadedFrom(self, path):
 
852
        self.assertPluginKnown('test_foo')
 
853
        self.assertDocstring('This is the doc for test_foo',
 
854
                             bzrlib.plugins.test_foo)
 
855
        self.assertEqual(path, bzrlib.plugins.test_foo.dir_source)
 
856
 
 
857
    def test_regular_load(self):
 
858
        plugin.load_plugins(['standard'])
 
859
        self.assertTestFooLoadedFrom('standard/test_foo')
 
860
 
 
861
    def test_import(self):
 
862
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
863
        plugin.set_plugins_path(['standard'])
 
864
        try:
 
865
            import bzrlib.plugins.test_foo
 
866
        except ImportError:
 
867
            pass
 
868
        self.assertTestFooLoadedFrom('non-standard-dir')
 
869
 
 
870
    def test_loading(self):
 
871
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
872
        plugin.load_plugins(['standard'])
 
873
        self.assertTestFooLoadedFrom('non-standard-dir')
 
874
 
 
875
    def test_compiled_loaded(self):
 
876
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
877
        plugin.load_plugins(['standard'])
 
878
        self.assertTestFooLoadedFrom('non-standard-dir')
 
879
        self.assertIsSameRealPath('non-standard-dir/__init__.py',
 
880
                                  bzrlib.plugins.test_foo.__file__)
 
881
 
 
882
        # Try importing again now that the source has been compiled
 
883
        self._unregister_plugin('test_foo')
 
884
        plugin._loaded = False
 
885
        plugin.load_plugins(['standard'])
 
886
        self.assertTestFooLoadedFrom('non-standard-dir')
 
887
        if __debug__:
 
888
            suffix = 'pyc'
 
889
        else:
 
890
            suffix = 'pyo'
 
891
        self.assertIsSameRealPath('non-standard-dir/__init__.%s' % suffix,
 
892
                                  bzrlib.plugins.test_foo.__file__)
 
893
 
 
894
    def test_submodule_loading(self):
 
895
        # We create an additional directory under the one for test_foo
 
896
        self.create_plugin_package('test_bar', dir='non-standard-dir/test_bar')
 
897
        self.addCleanup(self._unregister_plugin_submodule,
 
898
                        'test_foo', 'test_bar')
 
899
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
900
        plugin.set_plugins_path(['standard'])
 
901
        import bzrlib.plugins.test_foo
 
902
        self.assertEqual('bzrlib.plugins.test_foo',
 
903
                         bzrlib.plugins.test_foo.__package__)
 
904
        import bzrlib.plugins.test_foo.test_bar
 
905
        self.assertIsSameRealPath('non-standard-dir/test_bar/__init__.py',
 
906
                                  bzrlib.plugins.test_foo.test_bar.__file__)
 
907
 
 
908
    def test_relative_submodule_loading(self):
 
909
        self.create_plugin_package('test_foo', dir='another-dir', source='''
 
910
import test_bar
 
911
''')
 
912
        # We create an additional directory under the one for test_foo
 
913
        self.create_plugin_package('test_bar', dir='another-dir/test_bar')
 
914
        self.addCleanup(self._unregister_plugin_submodule,
 
915
                        'test_foo', 'test_bar')
 
916
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@another-dir')
 
917
        plugin.set_plugins_path(['standard'])
 
918
        import bzrlib.plugins.test_foo
 
919
        self.assertEqual('bzrlib.plugins.test_foo',
 
920
                         bzrlib.plugins.test_foo.__package__)
 
921
        self.assertIsSameRealPath('another-dir/test_bar/__init__.py',
 
922
                                  bzrlib.plugins.test_foo.test_bar.__file__)
 
923
 
 
924
    def test_loading_from___init__only(self):
 
925
        # We rename the existing __init__.py file to ensure that we don't load
 
926
        # a random file
 
927
        init = 'non-standard-dir/__init__.py'
 
928
        random = 'non-standard-dir/setup.py'
 
929
        os.rename(init, random)
 
930
        self.addCleanup(os.rename, random, init)
 
931
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@non-standard-dir')
 
932
        plugin.load_plugins(['standard'])
 
933
        self.assertPluginUnknown('test_foo')
 
934
 
 
935
    def test_loading_from_specific_file(self):
 
936
        plugin_dir = 'non-standard-dir'
 
937
        plugin_file_name = 'iamtestfoo.py'
 
938
        plugin_path = osutils.pathjoin(plugin_dir, plugin_file_name)
 
939
        source = '''\
 
940
"""This is the doc for %s"""
 
941
dir_source = '%s'
 
942
''' % ('test_foo', plugin_path)
 
943
        self.create_plugin('test_foo', source=source,
 
944
                           dir=plugin_dir, file_name=plugin_file_name)
 
945
        self.overrideEnv('BZR_PLUGINS_AT', 'test_foo@%s' % plugin_path)
 
946
        plugin.load_plugins(['standard'])
 
947
        self.assertTestFooLoadedFrom(plugin_path)