← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/selftest/plugins.py

  • Committer: Martin Pool
  • Date: 2005-08-30 03:29:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050830032932-1ad1c40cfacde866
- add a docstring for the placeholder plugin

- remove the checkperms shell plugin, which was in the wrong
  place anyhow

Show diffs side-by-side

added added

removed removed

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