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