← 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: Aaron Bentley
  • Date: 2006-11-10 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2127.
  • Revision ID: aaron.bentley@utoronto.ca-20061110015555-f48202744b630209
Ignore html docs (both kinds)

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 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
 
 
18
17
"""Tests for plugins"""
19
18
 
20
19
# XXX: There are no plugin tests at the moment because the plugin module
22
21
# comments.
23
22
 
24
23
import os
 
24
from StringIO import StringIO
25
25
 
26
 
from bzrlib.selftest import TestCaseInTempDir
 
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
27
32
 
28
33
class PluginTest(TestCaseInTempDir):
29
34
    """Create an external plugin and test loading."""
30
35
#    def test_plugin_loading(self):
31
36
#        orig_help = self.run_bzr_captured('bzr help commands')[0]
32
37
#        os.mkdir('plugin_test')
33
 
#        f = open(os.path.join('plugin_test', 'myplug.py'), 'wt')
 
38
#        f = open(pathjoin('plugin_test', 'myplug.py'), 'wt')
34
39
#        f.write(PLUGIN_TEXT)
35
40
#        f.close()
36
41
#        newhelp = self.run_bzr_captured('bzr help commands')[0]
43
48
#        shutil.rmtree('plugin_test')
44
49
#
45
50
 
46
 
#         os.environ['BZRPLUGINPATH'] = os.path.abspath('plugin_test')
 
51
#         os.environ['BZRPLUGINPATH'] = abspath('plugin_test')
47
52
#         help = backtick('bzr help commands')
48
53
#         assert help.find('myplug') != -1
49
54
#         assert help.find('Just a simple test plugin.') != -1
52
57
#         assert backtick('bzr myplug') == 'Hello from my plugin\n'
53
58
#         assert backtick('bzr mplg') == 'Hello from my plugin\n'
54
59
 
55
 
#         f = open(os.path.join('plugin_test', 'override.py'), 'wb')
 
60
#         f = open(pathjoin('plugin_test', 'override.py'), 'wb')
56
61
#         f.write("""import bzrlib, bzrlib.commands
57
62
#     class cmd_commit(bzrlib.commands.cmd_commit):
58
63
#         '''Commit changes into a new revision.'''
75
80
    def run(self):
76
81
        print 'Hello from my plugin'
77
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