/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

  • Committer: Ian Clatworthy
  • Date: 2007-11-23 05:52:03 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071123055203-r2t2r27amhzllubr
first cut at Central development chapter

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_help.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
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
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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Unit tests for the bzrlib.help module."""
18
18
 
29
29
    )
30
30
 
31
31
 
32
 
class TestHelp(tests.TestCase):
33
 
 
34
 
    def setUp(self):
35
 
        tests.TestCase.setUp(self)
36
 
        commands.install_bzr_command_hooks()
37
 
 
38
 
 
39
32
class TestCommandHelp(tests.TestCase):
40
33
    """Tests for help on commands."""
41
34
 
42
35
    def test_command_help_includes_see_also(self):
43
36
        class cmd_WithSeeAlso(commands.Command):
44
 
            __doc__ = """A sample command."""
 
37
            """A sample command."""
45
38
            _see_also = ['foo', 'bar']
46
39
        cmd = cmd_WithSeeAlso()
47
40
        helptext = cmd.get_help_text()
56
49
    def test_get_help_text(self):
57
50
        """Commands have a get_help_text method which returns their help."""
58
51
        class cmd_Demo(commands.Command):
59
 
            __doc__ = """A sample command."""
 
52
            """A sample command."""
60
53
        cmd = cmd_Demo()
61
54
        helptext = cmd.get_help_text()
62
55
        self.assertStartsWith(helptext,
67
60
 
68
61
    def test_command_with_additional_see_also(self):
69
62
        class cmd_WithSeeAlso(commands.Command):
70
 
            __doc__ = """A sample command."""
 
63
            """A sample command."""
71
64
            _see_also = ['foo', 'bar']
72
65
        cmd = cmd_WithSeeAlso()
73
66
        helptext = cmd.get_help_text(['gam'])
81
74
 
82
75
    def test_command_only_additional_see_also(self):
83
76
        class cmd_WithSeeAlso(commands.Command):
84
 
            __doc__ = """A sample command."""
 
77
            """A sample command."""
85
78
        cmd = cmd_WithSeeAlso()
86
79
        helptext = cmd.get_help_text(['gam'])
87
80
        self.assertEndsWith(
95
88
    def test_get_help_topic(self):
96
89
        """The help topic for a Command is its name()."""
97
90
        class cmd_foo_bar(commands.Command):
98
 
            __doc__ = """A sample command."""
 
91
            """A sample command."""
99
92
        cmd = cmd_foo_bar()
100
93
        self.assertEqual(cmd.name(), cmd.get_help_topic())
101
94
 
102
95
    def test_formatted_help_text(self):
103
96
        """Help text should be plain text by default."""
104
97
        class cmd_Demo(commands.Command):
105
 
            __doc__ = """A sample command.
106
 
 
 
98
            """A sample command.
 
99
 
107
100
            :Examples:
108
101
                Example 1::
109
 
 
 
102
 
110
103
                    cmd arg1
111
 
 
 
104
 
112
105
                Example 2::
113
 
 
 
106
 
114
107
                    cmd arg2
115
108
            """
116
109
        cmd = cmd_Demo()
121
114
            'Usage:   bzr Demo\n'
122
115
            '\n'
123
116
            'Options:\n'
124
 
            '  --usage        Show usage message and options.\n'
125
 
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
126
117
            '  -v, --verbose  Display more information.\n'
127
118
            '  -q, --quiet    Only display errors and warnings.\n'
128
119
            '  -h, --help     Show help message.\n'
142
133
            ':Usage:   bzr Demo\n'
143
134
            '\n'
144
135
            ':Options:\n'
145
 
            '  --usage        Show usage message and options.\n'
146
 
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
147
136
            '  -v, --verbose  Display more information.\n'
148
137
            '  -q, --quiet    Only display errors and warnings.\n'
149
138
            '  -h, --help     Show help message.\n'
158
147
            '        cmd arg2\n'
159
148
            '\n')
160
149
 
161
 
    def test_concise_help_text(self):
162
 
        """Concise help text excludes the descriptive sections."""
163
 
        class cmd_Demo(commands.Command):
164
 
            __doc__ = """A sample command.
165
 
 
166
 
            Blah blah blah.
167
 
 
168
 
            :Examples:
169
 
                Example 1::
170
 
 
171
 
                    cmd arg1
172
 
            """
173
 
        cmd = cmd_Demo()
174
 
        helptext = cmd.get_help_text()
175
 
        self.assertEqualDiff(
176
 
            helptext,
177
 
            'Purpose: A sample command.\n'
178
 
            'Usage:   bzr Demo\n'
179
 
            '\n'
180
 
            'Options:\n'
181
 
            '  --usage        Show usage message and options.\n'
182
 
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
183
 
            '  -v, --verbose  Display more information.\n'
184
 
            '  -q, --quiet    Only display errors and warnings.\n'
185
 
            '  -h, --help     Show help message.\n'
186
 
            '\n'
187
 
            'Description:\n'
188
 
            '  Blah blah blah.\n'
189
 
            '\n'
190
 
            'Examples:\n'
191
 
            '    Example 1:\n'
192
 
            '\n'
193
 
            '        cmd arg1\n'
194
 
            '\n')
195
 
        helptext = cmd.get_help_text(verbose=False)
196
 
        self.assertEquals(helptext,
197
 
            'Purpose: A sample command.\n'
198
 
            'Usage:   bzr Demo\n'
199
 
            '\n'
200
 
            'Options:\n'
201
 
            '  --usage        Show usage message and options.\n'
202
 
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
203
 
            '  -v, --verbose  Display more information.\n'
204
 
            '  -q, --quiet    Only display errors and warnings.\n'
205
 
            '  -h, --help     Show help message.\n'
206
 
            '\n'
207
 
            'See bzr help Demo for more details and examples.\n'
208
 
            '\n')
209
 
 
210
 
    def test_help_custom_section_ordering(self):
211
 
        """Custom descriptive sections should remain in the order given."""
212
 
        class cmd_Demo(commands.Command):
213
 
            __doc__ = """A sample command.
214
 
 
215
 
            Blah blah blah.
216
 
 
217
 
            :Formats:
218
 
              Interesting stuff about formats.
219
 
 
220
 
            :Examples:
221
 
              Example 1::
222
 
 
223
 
                cmd arg1
224
 
 
225
 
            :Tips:
226
 
              Clever things to keep in mind.
227
 
            """
228
 
        cmd = cmd_Demo()
229
 
        helptext = cmd.get_help_text()
230
 
        self.assertEqualDiff(
231
 
            helptext,
232
 
            'Purpose: A sample command.\n'
233
 
            'Usage:   bzr Demo\n'
234
 
            '\n'
235
 
            'Options:\n'
236
 
            '  --usage        Show usage message and options.\n'
237
 
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
238
 
            '  -v, --verbose  Display more information.\n'
239
 
            '  -q, --quiet    Only display errors and warnings.\n'
240
 
            '  -h, --help     Show help message.\n'
241
 
            '\n'
242
 
            'Description:\n'
243
 
            '  Blah blah blah.\n'
244
 
            '\n'
245
 
            'Formats:\n'
246
 
            '  Interesting stuff about formats.\n'
247
 
            '\n'
248
 
            'Examples:\n'
249
 
            '  Example 1:\n'
250
 
            '\n'
251
 
            '    cmd arg1\n'
252
 
            '\n'
253
 
            'Tips:\n'
254
 
            '  Clever things to keep in mind.\n'
255
 
            '\n')
256
 
 
257
150
    def test_help_text_custom_usage(self):
258
151
        """Help text may contain a custom usage section."""
259
152
        class cmd_Demo(commands.Command):
260
 
            __doc__ = """A sample command.
261
 
 
 
153
            """A sample command.
 
154
 
262
155
            :Usage:
263
156
                cmd Demo [opts] args
264
 
 
 
157
 
265
158
                cmd Demo -h
266
 
 
 
159
 
267
160
            Blah blah blah.
268
161
            """
269
162
        cmd = cmd_Demo()
277
170
            '\n'
278
171
            '\n'
279
172
            'Options:\n'
280
 
            '  --usage        Show usage message and options.\n'
281
 
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
282
173
            '  -v, --verbose  Display more information.\n'
283
174
            '  -q, --quiet    Only display errors and warnings.\n'
284
175
            '  -h, --help     Show help message.\n'
287
178
            '  Blah blah blah.\n\n')
288
179
 
289
180
 
290
 
class TestRegisteredTopic(TestHelp):
 
181
class TestRegisteredTopic(tests.TestCase):
291
182
    """Tests for the RegisteredTopic class."""
292
183
 
293
184
    def test_contruct(self):
294
185
        """Construction takes the help topic name for the registered item."""
295
 
        # validate our test
 
186
        # validate our test 
296
187
        self.assertTrue('basic' in help_topics.topic_registry)
297
188
        topic = help_topics.RegisteredTopic('basic')
298
189
        self.assertEqual('basic', topic.topic)
310
201
            '\n'
311
202
            'See also: bar, foo\n')
312
203
 
313
 
    def test_get_help_text_loaded_from_file(self):
314
 
        # Pick a known topic stored in an external file
315
 
        topic = help_topics.RegisteredTopic('authentication')
316
 
        self.assertStartsWith(topic.get_help_text(),
317
 
            'Authentication Settings\n'
318
 
            '=======================\n'
319
 
            '\n')
320
 
 
321
204
    def test_get_help_topic(self):
322
205
        """The help topic for a RegisteredTopic is its topic from construction."""
323
206
        topic = help_topics.RegisteredTopic('foobar')
326
209
        self.assertEqual('baz', topic.get_help_topic())
327
210
 
328
211
 
329
 
class TestTopicIndex(TestHelp):
 
212
class TestTopicIndex(tests.TestCase):
330
213
    """Tests for the HelpTopicIndex class."""
331
214
 
332
215
    def test_default_constructable(self):
359
242
        self.assertEqual('', index.prefix)
360
243
 
361
244
 
362
 
class TestCommandIndex(TestHelp):
 
245
class TestCommandIndex(tests.TestCase):
363
246
    """Tests for the HelpCommandIndex class."""
364
247
 
365
248
    def test_default_constructable(self):