← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/selftest/plugins.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/selftest/plugins.py
1
1
# Copyright (C) 2005 by Canonical Ltd
2
 
#
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
17
17
 
18
18
"""Tests for plugins"""
19
19
 
20
 
# XXX: There are no plugin tests at the moment because the plugin module
21
 
# affects the global state of the process.  See bzrlib/plugins.py for more
22
 
# comments.
23
 
 
24
 
import os
25
 
from StringIO import StringIO
26
 
 
27
 
import bzrlib.plugin
28
 
import bzrlib.plugins
29
 
import bzrlib.commands
30
 
import bzrlib.help
31
 
from bzrlib.tests import TestCaseInTempDir
32
 
from bzrlib.osutils import pathjoin, abspath
 
20
 
 
21
 
 
22
# **************************************************
 
23
# NOT RUN YET
 
24
# **************************************************
 
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
from bzrlib.selftest import TestCaseInTempDir
 
34
 
33
35
 
34
36
class PluginTest(TestCaseInTempDir):
35
37
    """Create an external plugin and test loading."""
36
 
#    def test_plugin_loading(self):
37
 
#        orig_help = self.run_bzr_captured('bzr help commands')[0]
38
 
#        os.mkdir('plugin_test')
39
 
#        f = open(pathjoin('plugin_test', 'myplug.py'), 'wt')
40
 
#        f.write(PLUGIN_TEXT)
41
 
#        f.close()
42
 
#        newhelp = self.run_bzr_captured('bzr help commands')[0]
43
 
#        assert newhelp.startswith('You have been overridden\n')
44
 
#        # We added a line, but the rest should work
45
 
#        assert newhelp[25:] == help
46
 
#
47
 
#        assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
48
 
#
49
 
#        shutil.rmtree('plugin_test')
50
 
#
51
 
 
52
 
#         os.environ['BZRPLUGINPATH'] = abspath('plugin_test')
 
38
    def test_plugin_loading(self):
 
39
        import os
 
40
        
 
41
        orig_help = self.backtick('bzr help commands') # No plugins yet
 
42
        os.mkdir('plugin_test')
 
43
        f = open(os.path.join('plugin_test', 'myplug.py'), 'wt')
 
44
        f.write(PLUGIN_TEXT)
 
45
        f.close()
 
46
 
 
47
        newhelp = backtick('bzr help commands')
 
48
        assert newhelp.startswith('You have been overridden\n')
 
49
        # We added a line, but the rest should work
 
50
        assert newhelp[25:] == help
 
51
 
 
52
        assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
 
53
 
 
54
        shutil.rmtree('plugin_test')
 
55
 
 
56
 
 
57
 
 
58
 
 
59
#         PLUGIN_TEXT = \
 
60
#         """import bzrlib, bzrlib.commands
 
61
#         class cmd_myplug(bzrlib.commands.Command):
 
62
#             '''Just a simple test plugin.'''
 
63
#             aliases = ['mplg']
 
64
#             def run(self):
 
65
#                 print 'Hello from my plugin'
 
66
#         """
 
67
#         f.close()
 
68
 
 
69
#         os.environ['BZRPLUGINPATH'] = os.path.abspath('plugin_test')
53
70
#         help = backtick('bzr help commands')
54
71
#         assert help.find('myplug') != -1
55
72
#         assert help.find('Just a simple test plugin.') != -1
58
75
#         assert backtick('bzr myplug') == 'Hello from my plugin\n'
59
76
#         assert backtick('bzr mplg') == 'Hello from my plugin\n'
60
77
 
61
 
#         f = open(pathjoin('plugin_test', 'override.py'), 'wb')
 
78
#         f = open(os.path.join('plugin_test', 'override.py'), 'wb')
62
79
#         f.write("""import bzrlib, bzrlib.commands
63
80
#     class cmd_commit(bzrlib.commands.cmd_commit):
64
81
#         '''Commit changes into a new revision.'''
72
89
#             bzrlib.commands.cmd_help.run(self, *args, **kwargs)
73
90
 
74
91
#         """
75
 
 
76
 
PLUGIN_TEXT = """\
77
 
import bzrlib.commands
78
 
class cmd_myplug(bzrlib.commands.Command):
79
 
    '''Just a simple test plugin.'''
80
 
    aliases = ['mplg']
81
 
    def run(self):
82
 
        print 'Hello from my plugin'
83
 
"""
84
 
 
85
 
# TODO: Write a test for plugin decoration of commands.
86
 
 
87
 
class TestOneNamedPluginOnly(TestCaseInTempDir):
88
 
 
89
 
    activeattributes = {}
90
 
 
91
 
    def test_plugins_with_the_same_name_are_not_loaded(self):
92
 
        # This test tests that having two plugins in different
93
 
        # directories does not result in both being loaded.
94
 
        # get a file name we can use which is also a valid attribute
95
 
        # for accessing in activeattributes. - we cannot give import parameters.
96
 
        tempattribute = "0"
97
 
        self.failIf(tempattribute in self.activeattributes)
98
 
        # set a place for the plugins to record their loading, and at the same
99
 
        # time validate that the location the plugins should record to is
100
 
        # valid and correct.
101
 
        bzrlib.tests.test_plugins.TestOneNamedPluginOnly.activeattributes \
102
 
            [tempattribute] = []
103
 
        self.failUnless(tempattribute in self.activeattributes)
104
 
        # create two plugin directories
105
 
        os.mkdir('first')
106
 
        os.mkdir('second')
107
 
        # write a plugin that will record when its loaded in the 
108
 
        # tempattribute list.
109
 
        template = ("from bzrlib.tests.test_plugins import TestOneNamedPluginOnly\n"
110
 
                    "TestOneNamedPluginOnly.activeattributes[%r].append('%s')\n")
111
 
        print >> file(os.path.join('first', 'plugin.py'), 'w'), template % (tempattribute, 'first')
112
 
        print >> file(os.path.join('second', 'plugin.py'), 'w'), template % (tempattribute, 'second')
113
 
        try:
114
 
            bzrlib.plugin.load_from_dirs(['first', 'second'])
115
 
            self.assertEqual(['first'], self.activeattributes[tempattribute])
116
 
        finally:
117
 
            # remove the plugin 'plugin'
118
 
            del self.activeattributes[tempattribute]
119
 
            if getattr(bzrlib.plugins, 'plugin', None):
120
 
                del bzrlib.plugins.plugin
121
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
122
 
 
123
 
 
124
 
class TestAllPlugins(TestCaseInTempDir):
125
 
 
126
 
    def test_plugin_appears_in_all_plugins(self):
127
 
        # This test tests a new plugin appears in bzrlib.plugin.all_plugins().
128
 
        # check the plugin is not loaded already
129
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
130
 
        # write a plugin that _cannot_ fail to load.
131
 
        print >> file('plugin.py', 'w'), ""
132
 
        try:
133
 
            bzrlib.plugin.load_from_dirs(['.'])
134
 
            self.failUnless('plugin' in bzrlib.plugin.all_plugins())
135
 
            self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
136
 
            self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
137
 
                             bzrlib.plugins.plugin)
138
 
        finally:
139
 
            # remove the plugin 'plugin'
140
 
            if getattr(bzrlib.plugins, 'plugin', None):
141
 
                del bzrlib.plugins.plugin
142
 
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
143
 
 
144
 
 
145
 
class TestPluginHelp(TestCaseInTempDir):
146
 
 
147
 
    def split_help_commands(self):
148
 
        help = {}
149
 
        current = None
150
 
        for line in self.capture('help commands').splitlines():
151
 
            if line.startswith('bzr '):
152
 
                current = line.split()[1]
153
 
            help[current] = help.get(current, '') + line
154
 
 
155
 
        return help
156
 
 
157
 
    def test_plugin_help_builtins_unaffected(self):
158
 
        # Check we don't get false positives
159
 
        help_commands = self.split_help_commands()
160
 
        for cmd_name in bzrlib.commands.builtin_command_names():
161
 
            if cmd_name in bzrlib.commands.plugin_command_names():
162
 
                continue
163
 
            help = StringIO()
164
 
            try:
165
 
                bzrlib.help.help_on_command(cmd_name, help)
166
 
            except NotImplementedError:
167
 
                # some commands have no help
168
 
                pass
169
 
            else:
170
 
                help.seek(0)
171
 
                self.assertNotContainsRe(help.read(), 'From plugin "[^"]*"')
172
 
 
173
 
            if help in help_commands.keys():
174
 
                # some commands are hidden
175
 
                help = help_commands[cmd_name]
176
 
                self.assertNotContainsRe(help, 'From plugin "[^"]*"')
177
 
 
178
 
    def test_plugin_help_shows_plugin(self):
179
 
        # Create a test plugin
180
 
        os.mkdir('plugin_test')
181
 
        f = open(pathjoin('plugin_test', 'myplug.py'), 'w')
182
 
        f.write(PLUGIN_TEXT)
183
 
        f.close()
184
 
 
185
 
        try:
186
 
            # Check its help
187
 
            bzrlib.plugin.load_from_dirs(['plugin_test'])
188
 
            bzrlib.commands.register_command( bzrlib.plugins.myplug.cmd_myplug)
189
 
            help = self.capture('help myplug')
190
 
            self.assertContainsRe(help, 'From plugin "myplug"')
191
 
            help = self.split_help_commands()['myplug']
192
 
            self.assertContainsRe(help, 'From plugin "myplug"')
193
 
        finally:
194
 
            # remove the plugin 'plugin'
195
 
            if getattr(bzrlib.plugins, 'plugin', None):
196
 
                del bzrlib.plugins.plugin