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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
# Copyright (C) 2007 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
"""Unit tests for the bzrlib.help module."""
from cStringIO import StringIO
from bzrlib import (
builtins,
commands,
errors,
help,
help_topics,
plugin,
tests,
)
class TestCommandHelp(tests.TestCase):
"""Tests for help on commands."""
def test_command_help_includes_see_also(self):
class cmd_WithSeeAlso(commands.Command):
"""A sample command."""
_see_also = ['foo', 'bar']
cmd = cmd_WithSeeAlso()
helptext = cmd.get_help_text()
self.assertEndsWith(
helptext,
' -h, --help show help message\n'
'\n'
'See also: bar, foo\n')
def test_get_help_text(self):
"""Commands have a get_help_text method which returns their help."""
class cmd_Demo(commands.Command):
"""A sample command."""
cmd = cmd_Demo()
helptext = cmd.get_help_text()
self.assertStartsWith(helptext, 'usage: bzr Demo')
self.assertEndsWith(helptext, 'show help message\n')
def test_command_with_additional_see_also(self):
class cmd_WithSeeAlso(commands.Command):
"""A sample command."""
_see_also = ['foo', 'bar']
cmd = cmd_WithSeeAlso()
helptext = cmd.get_help_text(['gam'])
self.assertEndsWith(
helptext,
' -h, --help show help message\n'
'\n'
'See also: bar, foo, gam\n')
def test_command_only_additional_see_also(self):
class cmd_WithSeeAlso(commands.Command):
"""A sample command."""
cmd = cmd_WithSeeAlso()
helptext = cmd.get_help_text(['gam'])
self.assertEndsWith(
helptext,
' -h, --help show help message\n'
'\n'
'See also: gam\n')
def test_get_help_topic(self):
"""The help topic for a Command is its name()."""
class cmd_foo_bar(commands.Command):
"""A sample command."""
cmd = cmd_foo_bar()
self.assertEqual(cmd.name(), cmd.get_help_topic())
class TestRegisteredTopic(tests.TestCase):
"""Tests for the RegisteredTopic class."""
def test_contruct(self):
"""Construction takes the help topic name for the registered item."""
# validate our test
self.assertTrue('basic' in help_topics.topic_registry)
topic = help_topics.RegisteredTopic('basic')
self.assertEqual('basic', topic.topic)
def test_get_help_text(self):
"""A RegisteredTopic returns the get_detail results for get_help_text."""
topic = help_topics.RegisteredTopic('commands')
self.assertEqual(help_topics.topic_registry.get_detail('commands'),
topic.get_help_text())
def test_get_help_text_with_additional_see_also(self):
topic = help_topics.RegisteredTopic('commands')
self.assertEndsWith(
topic.get_help_text(['foo', 'bar']),
'\n'
'See also: bar, foo\n')
def test_get_help_topic(self):
"""The help topic for a RegisteredTopic is its topic from construction."""
topic = help_topics.RegisteredTopic('foobar')
self.assertEqual('foobar', topic.get_help_topic())
topic = help_topics.RegisteredTopic('baz')
self.assertEqual('baz', topic.get_help_topic())
class TestTopicIndex(tests.TestCase):
"""Tests for the HelpTopicIndex class."""
def test_default_constructable(self):
index = help_topics.HelpTopicIndex()
def test_get_topics_None(self):
"""Searching for None returns the basic help topic."""
index = help_topics.HelpTopicIndex()
topics = index.get_topics(None)
self.assertEqual(1, len(topics))
self.assertIsInstance(topics[0], help_topics.RegisteredTopic)
self.assertEqual('basic', topics[0].topic)
def test_get_topics_topics(self):
"""Searching for a string returns the matching string."""
index = help_topics.HelpTopicIndex()
topics = index.get_topics('topics')
self.assertEqual(1, len(topics))
self.assertIsInstance(topics[0], help_topics.RegisteredTopic)
self.assertEqual('topics', topics[0].topic)
def test_get_topics_no_topic(self):
"""Searching for something not registered returns []."""
index = help_topics.HelpTopicIndex()
self.assertEqual([], index.get_topics('nothing by this name'))
def test_prefix(self):
"""TopicIndex has a prefix of ''."""
index = help_topics.HelpTopicIndex()
self.assertEqual('', index.prefix)
class TestCommandIndex(tests.TestCase):
"""Tests for the HelpCommandIndex class."""
def test_default_constructable(self):
index = commands.HelpCommandIndex()
def test_get_topics_None(self):
"""Searching for None returns an empty list."""
index = commands.HelpCommandIndex()
self.assertEqual([], index.get_topics(None))
def test_get_topics_rocks(self):
"""Searching for 'rocks' returns the cmd_rocks command instance."""
index = commands.HelpCommandIndex()
topics = index.get_topics('rocks')
self.assertEqual(1, len(topics))
self.assertIsInstance(topics[0], builtins.cmd_rocks)
def test_get_topics_no_topic(self):
"""Searching for something that is not a command returns []."""
index = commands.HelpCommandIndex()
self.assertEqual([], index.get_topics('nothing by this name'))
def test_prefix(self):
"""CommandIndex has a prefix of 'commands/'."""
index = commands.HelpCommandIndex()
self.assertEqual('commands/', index.prefix)
def test_get_topic_with_prefix(self):
"""Searching for commands/rocks returns the rocks command object."""
index = commands.HelpCommandIndex()
topics = index.get_topics('commands/rocks')
self.assertEqual(1, len(topics))
self.assertIsInstance(topics[0], builtins.cmd_rocks)
class TestHelpIndices(tests.TestCase):
"""Tests for the HelpIndices class."""
def test_default_search_path(self):
"""The default search path should include internal indexs."""
indices = help.HelpIndices()
self.assertEqual(3, len(indices.search_path))
# help topics should be searched in first.
self.assertIsInstance(indices.search_path[0],
help_topics.HelpTopicIndex)
# with commands being search second.
self.assertIsInstance(indices.search_path[1],
commands.HelpCommandIndex)
# and plugins are a third index.
self.assertIsInstance(indices.search_path[2],
plugin.PluginsHelpIndex)
def test_search_for_unknown_topic_raises(self):
"""Searching for an unknown topic should raise NoHelpTopic."""
indices = help.HelpIndices()
indices.search_path = []
error = self.assertRaises(errors.NoHelpTopic, indices.search, 'foo')
self.assertEqual('foo', error.topic)
def test_search_calls_get_topic(self):
"""Searching should call get_topics in all indexes in order."""
calls = []
class RecordingIndex(object):
def __init__(self, name):
self.prefix = name
def get_topics(self, topic):
calls.append(('get_topics', self.prefix, topic))
return ['something']
index = help.HelpIndices()
index.search_path = [RecordingIndex('1'), RecordingIndex('2')]
# try with None
index.search(None)
self.assertEqual([
('get_topics', '1', None),
('get_topics', '2', None),
],
calls)
# and with a string
del calls[:]
index.search('bar')
self.assertEqual([
('get_topics', '1', 'bar'),
('get_topics', '2', 'bar'),
],
calls)
def test_search_returns_index_and_results(self):
"""Searching should return help topics with their index"""
class CannedIndex(object):
def __init__(self, prefix, search_result):
self.prefix = prefix
self.result = search_result
def get_topics(self, topic):
return self.result
index = help.HelpIndices()
index_one = CannedIndex('1', ['a'])
index_two = CannedIndex('2', ['b', 'c'])
index.search_path = [index_one, index_two]
self.assertEqual([(index_one, 'a'), (index_two, 'b'), (index_two, 'c')],
index.search(None))
def test_search_checks_for_duplicate_prefixes(self):
"""Its an error when there are multiple indices with the same prefix."""
indices = help.HelpIndices()
indices.search_path = [help_topics.HelpTopicIndex(),
help_topics.HelpTopicIndex()]
self.assertRaises(errors.DuplicateHelpPrefix, indices.search, None)
|