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
' -v, --verbose Display more information.\n'
44
' -q, --quiet Only display errors and warnings.\n'
45
' -h, --help Show help message.\n'
47
'See also: bar, foo\n')
49
def test_get_help_text(self):
50
"""Commands have a get_help_text method which returns their help."""
51
class cmd_Demo(commands.Command):
52
"""A sample command."""
54
helptext = cmd.get_help_text()
55
self.assertStartsWith(helptext,
56
'Purpose: A sample command.\n'
58
self.assertEndsWith(helptext,
59
' -h, --help Show help message.\n\n')
61
def test_command_with_additional_see_also(self):
62
class cmd_WithSeeAlso(commands.Command):
63
"""A sample command."""
64
_see_also = ['foo', 'bar']
65
cmd = cmd_WithSeeAlso()
66
helptext = cmd.get_help_text(['gam'])
69
' -v, --verbose Display more information.\n'
70
' -q, --quiet Only display errors and warnings.\n'
71
' -h, --help Show help message.\n'
73
'See also: bar, foo, gam\n')
75
def test_command_only_additional_see_also(self):
76
class cmd_WithSeeAlso(commands.Command):
77
"""A sample command."""
78
cmd = cmd_WithSeeAlso()
79
helptext = cmd.get_help_text(['gam'])
82
' -v, --verbose Display more information.\n'
83
' -q, --quiet Only display errors and warnings.\n'
84
' -h, --help Show help message.\n'
88
def test_get_help_topic(self):
89
"""The help topic for a Command is its name()."""
90
class cmd_foo_bar(commands.Command):
91
"""A sample command."""
93
self.assertEqual(cmd.name(), cmd.get_help_topic())
95
def test_formatted_help_text(self):
96
"""Help text should be plain text by default."""
97
class cmd_Demo(commands.Command):
110
helptext = cmd.get_help_text()
113
'Purpose: A sample command.\n'
117
' -v, --verbose Display more information.\n'
118
' -q, --quiet Only display errors and warnings.\n'
119
' -h, --help Show help message.\n'
130
helptext = cmd.get_help_text(plain=False)
131
self.assertEquals(helptext,
132
':Purpose: A sample command.\n'
136
' -v, --verbose Display more information.\n'
137
' -q, --quiet Only display errors and warnings.\n'
138
' -h, --help Show help message.\n'
150
def test_help_text_custom_usage(self):
151
"""Help text may contain a custom usage section."""
152
class cmd_Demo(commands.Command):
163
helptext = cmd.get_help_text()
164
self.assertEquals(helptext,
165
'Purpose: A sample command.\n'
167
' cmd Demo [opts] args\n'
173
' -v, --verbose Display more information.\n'
174
' -q, --quiet Only display errors and warnings.\n'
175
' -h, --help Show help message.\n'
178
' Blah blah blah.\n\n')
181
class TestRegisteredTopic(tests.TestCase):
182
"""Tests for the RegisteredTopic class."""
184
def test_contruct(self):
185
"""Construction takes the help topic name for the registered item."""
187
self.assertTrue('basic' in help_topics.topic_registry)
188
topic = help_topics.RegisteredTopic('basic')
189
self.assertEqual('basic', topic.topic)
191
def test_get_help_text(self):
192
"""A RegisteredTopic returns the get_detail results for get_help_text."""
193
topic = help_topics.RegisteredTopic('commands')
194
self.assertEqual(help_topics.topic_registry.get_detail('commands'),
195
topic.get_help_text())
197
def test_get_help_text_with_additional_see_also(self):
198
topic = help_topics.RegisteredTopic('commands')
200
topic.get_help_text(['foo', 'bar']),
202
'See also: bar, foo\n')
204
def test_get_help_text_loaded_from_file(self):
205
# Pick a known topic stored in an external file
206
topic = help_topics.RegisteredTopic('hooks')
207
self.assertStartsWith(topic.get_help_text(),
212
def test_get_help_topic(self):
213
"""The help topic for a RegisteredTopic is its topic from construction."""
214
topic = help_topics.RegisteredTopic('foobar')
215
self.assertEqual('foobar', topic.get_help_topic())
216
topic = help_topics.RegisteredTopic('baz')
217
self.assertEqual('baz', topic.get_help_topic())
220
class TestTopicIndex(tests.TestCase):
221
"""Tests for the HelpTopicIndex class."""
223
def test_default_constructable(self):
224
index = help_topics.HelpTopicIndex()
226
def test_get_topics_None(self):
227
"""Searching for None returns the basic help topic."""
228
index = help_topics.HelpTopicIndex()
229
topics = index.get_topics(None)
230
self.assertEqual(1, len(topics))
231
self.assertIsInstance(topics[0], help_topics.RegisteredTopic)
232
self.assertEqual('basic', topics[0].topic)
234
def test_get_topics_topics(self):
235
"""Searching for a string returns the matching string."""
236
index = help_topics.HelpTopicIndex()
237
topics = index.get_topics('topics')
238
self.assertEqual(1, len(topics))
239
self.assertIsInstance(topics[0], help_topics.RegisteredTopic)
240
self.assertEqual('topics', topics[0].topic)
242
def test_get_topics_no_topic(self):
243
"""Searching for something not registered returns []."""
244
index = help_topics.HelpTopicIndex()
245
self.assertEqual([], index.get_topics('nothing by this name'))
247
def test_prefix(self):
248
"""TopicIndex has a prefix of ''."""
249
index = help_topics.HelpTopicIndex()
250
self.assertEqual('', index.prefix)
253
class TestCommandIndex(tests.TestCase):
254
"""Tests for the HelpCommandIndex class."""
256
def test_default_constructable(self):
257
index = commands.HelpCommandIndex()
259
def test_get_topics_None(self):
260
"""Searching for None returns an empty list."""
261
index = commands.HelpCommandIndex()
262
self.assertEqual([], index.get_topics(None))
264
def test_get_topics_rocks(self):
265
"""Searching for 'rocks' returns the cmd_rocks command instance."""
266
index = commands.HelpCommandIndex()
267
topics = index.get_topics('rocks')
268
self.assertEqual(1, len(topics))
269
self.assertIsInstance(topics[0], builtins.cmd_rocks)
271
def test_get_topics_no_topic(self):
272
"""Searching for something that is not a command returns []."""
273
index = commands.HelpCommandIndex()
274
self.assertEqual([], index.get_topics('nothing by this name'))
276
def test_prefix(self):
277
"""CommandIndex has a prefix of 'commands/'."""
278
index = commands.HelpCommandIndex()
279
self.assertEqual('commands/', index.prefix)
281
def test_get_topic_with_prefix(self):
282
"""Searching for commands/rocks returns the rocks command object."""
283
index = commands.HelpCommandIndex()
284
topics = index.get_topics('commands/rocks')
285
self.assertEqual(1, len(topics))
286
self.assertIsInstance(topics[0], builtins.cmd_rocks)
289
class TestHelpIndices(tests.TestCase):
290
"""Tests for the HelpIndices class."""
292
def test_default_search_path(self):
293
"""The default search path should include internal indexs."""
294
indices = help.HelpIndices()
295
self.assertEqual(3, len(indices.search_path))
296
# help topics should be searched in first.
297
self.assertIsInstance(indices.search_path[0],
298
help_topics.HelpTopicIndex)
299
# with commands being search second.
300
self.assertIsInstance(indices.search_path[1],
301
commands.HelpCommandIndex)
302
# and plugins are a third index.
303
self.assertIsInstance(indices.search_path[2],
304
plugin.PluginsHelpIndex)
306
def test_search_for_unknown_topic_raises(self):
307
"""Searching for an unknown topic should raise NoHelpTopic."""
308
indices = help.HelpIndices()
309
indices.search_path = []
310
error = self.assertRaises(errors.NoHelpTopic, indices.search, 'foo')
311
self.assertEqual('foo', error.topic)
313
def test_search_calls_get_topic(self):
314
"""Searching should call get_topics in all indexes in order."""
316
class RecordingIndex(object):
317
def __init__(self, name):
319
def get_topics(self, topic):
320
calls.append(('get_topics', self.prefix, topic))
322
index = help.HelpIndices()
323
index.search_path = [RecordingIndex('1'), RecordingIndex('2')]
327
('get_topics', '1', None),
328
('get_topics', '2', None),
335
('get_topics', '1', 'bar'),
336
('get_topics', '2', 'bar'),
340
def test_search_returns_index_and_results(self):
341
"""Searching should return help topics with their index"""
342
class CannedIndex(object):
343
def __init__(self, prefix, search_result):
345
self.result = search_result
346
def get_topics(self, topic):
348
index = help.HelpIndices()
349
index_one = CannedIndex('1', ['a'])
350
index_two = CannedIndex('2', ['b', 'c'])
351
index.search_path = [index_one, index_two]
352
self.assertEqual([(index_one, 'a'), (index_two, 'b'), (index_two, 'c')],
355
def test_search_checks_for_duplicate_prefixes(self):
356
"""Its an error when there are multiple indices with the same prefix."""
357
indices = help.HelpIndices()
358
indices.search_path = [help_topics.HelpTopicIndex(),
359
help_topics.HelpTopicIndex()]
360
self.assertRaises(errors.DuplicateHelpPrefix, indices.search, None)
added
removed
bzrlib/tests/test_help.py
