1
# Copyright (C) 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Unit tests for the bzrlib.help module."""
19
from cStringIO import StringIO
32
class TestCommandHelp(tests.TestCase):
33
"""Tests for help on commands."""
35
def test_command_help_includes_see_also(self):
36
class cmd_WithSeeAlso(commands.Command):
37
"""A sample command."""
38
_see_also = ['foo', 'bar']
39
cmd = cmd_WithSeeAlso()
40
helptext = cmd.get_help_text()
43
' -h, --help Show help message.\n'
45
'See also: bar, foo\n')
47
def test_get_help_text(self):
48
"""Commands have a get_help_text method which returns their help."""
49
class cmd_Demo(commands.Command):
50
"""A sample command."""
52
helptext = cmd.get_help_text()
53
self.assertStartsWith(helptext,
54
'Purpose: A sample command.\n'
56
self.assertEndsWith(helptext, 'Show help message.\n\n')
58
def test_command_with_additional_see_also(self):
59
class cmd_WithSeeAlso(commands.Command):
60
"""A sample command."""
61
_see_also = ['foo', 'bar']
62
cmd = cmd_WithSeeAlso()
63
helptext = cmd.get_help_text(['gam'])
66
' -h, --help Show help message.\n'
68
'See also: bar, foo, gam\n')
70
def test_command_only_additional_see_also(self):
71
class cmd_WithSeeAlso(commands.Command):
72
"""A sample command."""
73
cmd = cmd_WithSeeAlso()
74
helptext = cmd.get_help_text(['gam'])
77
' -h, --help Show help message.\n'
81
def test_get_help_topic(self):
82
"""The help topic for a Command is its name()."""
83
class cmd_foo_bar(commands.Command):
84
"""A sample command."""
86
self.assertEqual(cmd.name(), cmd.get_help_topic())
88
def test_formatted_help_text(self):
89
"""Help text should be plain text by default."""
90
class cmd_Demo(commands.Command):
103
helptext = cmd.get_help_text()
106
'Purpose: A sample command.\n'
110
' -h, --help Show help message.\n'
121
helptext = cmd.get_help_text(plain=False)
122
self.assertEquals(helptext,
123
':Purpose: A sample command.\n'
127
' -h, --help Show help message.\n'
139
def test_help_text_custom_usage(self):
140
"""Help text may contain a custom usage section."""
141
class cmd_Demo(commands.Command):
152
helptext = cmd.get_help_text()
153
self.assertEquals(helptext,
154
'Purpose: A sample command.\n'
156
' cmd Demo [opts] args\n'
162
' -h, --help Show help message.\n'
165
' Blah blah blah.\n\n')
168
class TestRegisteredTopic(tests.TestCase):
169
"""Tests for the RegisteredTopic class."""
171
def test_contruct(self):
172
"""Construction takes the help topic name for the registered item."""
174
self.assertTrue('basic' in help_topics.topic_registry)
175
topic = help_topics.RegisteredTopic('basic')
176
self.assertEqual('basic', topic.topic)
178
def test_get_help_text(self):
179
"""A RegisteredTopic returns the get_detail results for get_help_text."""
180
topic = help_topics.RegisteredTopic('commands')
181
self.assertEqual(help_topics.topic_registry.get_detail('commands'),
182
topic.get_help_text())
184
def test_get_help_text_with_additional_see_also(self):
185
topic = help_topics.RegisteredTopic('commands')
187
topic.get_help_text(['foo', 'bar']),
189
'See also: bar, foo\n')
191
def test_get_help_topic(self):
192
"""The help topic for a RegisteredTopic is its topic from construction."""
193
topic = help_topics.RegisteredTopic('foobar')
194
self.assertEqual('foobar', topic.get_help_topic())
195
topic = help_topics.RegisteredTopic('baz')
196
self.assertEqual('baz', topic.get_help_topic())
199
class TestTopicIndex(tests.TestCase):
200
"""Tests for the HelpTopicIndex class."""
202
def test_default_constructable(self):
203
index = help_topics.HelpTopicIndex()
205
def test_get_topics_None(self):
206
"""Searching for None returns the basic help topic."""
207
index = help_topics.HelpTopicIndex()
208
topics = index.get_topics(None)
209
self.assertEqual(1, len(topics))
210
self.assertIsInstance(topics[0], help_topics.RegisteredTopic)
211
self.assertEqual('basic', topics[0].topic)
213
def test_get_topics_topics(self):
214
"""Searching for a string returns the matching string."""
215
index = help_topics.HelpTopicIndex()
216
topics = index.get_topics('topics')
217
self.assertEqual(1, len(topics))
218
self.assertIsInstance(topics[0], help_topics.RegisteredTopic)
219
self.assertEqual('topics', topics[0].topic)
221
def test_get_topics_no_topic(self):
222
"""Searching for something not registered returns []."""
223
index = help_topics.HelpTopicIndex()
224
self.assertEqual([], index.get_topics('nothing by this name'))
226
def test_prefix(self):
227
"""TopicIndex has a prefix of ''."""
228
index = help_topics.HelpTopicIndex()
229
self.assertEqual('', index.prefix)
232
class TestCommandIndex(tests.TestCase):
233
"""Tests for the HelpCommandIndex class."""
235
def test_default_constructable(self):
236
index = commands.HelpCommandIndex()
238
def test_get_topics_None(self):
239
"""Searching for None returns an empty list."""
240
index = commands.HelpCommandIndex()
241
self.assertEqual([], index.get_topics(None))
243
def test_get_topics_rocks(self):
244
"""Searching for 'rocks' returns the cmd_rocks command instance."""
245
index = commands.HelpCommandIndex()
246
topics = index.get_topics('rocks')
247
self.assertEqual(1, len(topics))
248
self.assertIsInstance(topics[0], builtins.cmd_rocks)
250
def test_get_topics_no_topic(self):
251
"""Searching for something that is not a command returns []."""
252
index = commands.HelpCommandIndex()
253
self.assertEqual([], index.get_topics('nothing by this name'))
255
def test_prefix(self):
256
"""CommandIndex has a prefix of 'commands/'."""
257
index = commands.HelpCommandIndex()
258
self.assertEqual('commands/', index.prefix)
260
def test_get_topic_with_prefix(self):
261
"""Searching for commands/rocks returns the rocks command object."""
262
index = commands.HelpCommandIndex()
263
topics = index.get_topics('commands/rocks')
264
self.assertEqual(1, len(topics))
265
self.assertIsInstance(topics[0], builtins.cmd_rocks)
268
class TestHelpIndices(tests.TestCase):
269
"""Tests for the HelpIndices class."""
271
def test_default_search_path(self):
272
"""The default search path should include internal indexs."""
273
indices = help.HelpIndices()
274
self.assertEqual(3, len(indices.search_path))
275
# help topics should be searched in first.
276
self.assertIsInstance(indices.search_path[0],
277
help_topics.HelpTopicIndex)
278
# with commands being search second.
279
self.assertIsInstance(indices.search_path[1],
280
commands.HelpCommandIndex)
281
# and plugins are a third index.
282
self.assertIsInstance(indices.search_path[2],
283
plugin.PluginsHelpIndex)
285
def test_search_for_unknown_topic_raises(self):
286
"""Searching for an unknown topic should raise NoHelpTopic."""
287
indices = help.HelpIndices()
288
indices.search_path = []
289
error = self.assertRaises(errors.NoHelpTopic, indices.search, 'foo')
290
self.assertEqual('foo', error.topic)
292
def test_search_calls_get_topic(self):
293
"""Searching should call get_topics in all indexes in order."""
295
class RecordingIndex(object):
296
def __init__(self, name):
298
def get_topics(self, topic):
299
calls.append(('get_topics', self.prefix, topic))
301
index = help.HelpIndices()
302
index.search_path = [RecordingIndex('1'), RecordingIndex('2')]
306
('get_topics', '1', None),
307
('get_topics', '2', None),
314
('get_topics', '1', 'bar'),
315
('get_topics', '2', 'bar'),
319
def test_search_returns_index_and_results(self):
320
"""Searching should return help topics with their index"""
321
class CannedIndex(object):
322
def __init__(self, prefix, search_result):
324
self.result = search_result
325
def get_topics(self, topic):
327
index = help.HelpIndices()
328
index_one = CannedIndex('1', ['a'])
329
index_two = CannedIndex('2', ['b', 'c'])
330
index.search_path = [index_one, index_two]
331
self.assertEqual([(index_one, 'a'), (index_two, 'b'), (index_two, 'c')],
334
def test_search_checks_for_duplicate_prefixes(self):
335
"""Its an error when there are multiple indices with the same prefix."""
336
indices = help.HelpIndices()
337
indices.search_path = [help_topics.HelpTopicIndex(),
338
help_topics.HelpTopicIndex()]
339
self.assertRaises(errors.DuplicateHelpPrefix, indices.search, None)
added
removed
bzrlib/tests/test_help.py
