← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

  • Committer: Martin
  • Date: 2010-05-16 15:18:43 UTC
  • mfrom: (5235 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5239.
  • Revision ID: gzlist@googlemail.com-20100516151843-lu53u7caehm3ie3i
Merge bzr.dev to resolve conflicts in NEWS and _chk_map_pyx

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_help.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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
41
41
 
42
42
    def test_command_help_includes_see_also(self):
43
43
        class cmd_WithSeeAlso(commands.Command):
44
 
            """A sample command."""
 
44
            __doc__ = """A sample command."""
45
45
            _see_also = ['foo', 'bar']
46
46
        cmd = cmd_WithSeeAlso()
47
47
        helptext = cmd.get_help_text()
56
56
    def test_get_help_text(self):
57
57
        """Commands have a get_help_text method which returns their help."""
58
58
        class cmd_Demo(commands.Command):
59
 
            """A sample command."""
 
59
            __doc__ = """A sample command."""
60
60
        cmd = cmd_Demo()
61
61
        helptext = cmd.get_help_text()
62
62
        self.assertStartsWith(helptext,
67
67
 
68
68
    def test_command_with_additional_see_also(self):
69
69
        class cmd_WithSeeAlso(commands.Command):
70
 
            """A sample command."""
 
70
            __doc__ = """A sample command."""
71
71
            _see_also = ['foo', 'bar']
72
72
        cmd = cmd_WithSeeAlso()
73
73
        helptext = cmd.get_help_text(['gam'])
81
81
 
82
82
    def test_command_only_additional_see_also(self):
83
83
        class cmd_WithSeeAlso(commands.Command):
84
 
            """A sample command."""
 
84
            __doc__ = """A sample command."""
85
85
        cmd = cmd_WithSeeAlso()
86
86
        helptext = cmd.get_help_text(['gam'])
87
87
        self.assertEndsWith(
95
95
    def test_get_help_topic(self):
96
96
        """The help topic for a Command is its name()."""
97
97
        class cmd_foo_bar(commands.Command):
98
 
            """A sample command."""
 
98
            __doc__ = """A sample command."""
99
99
        cmd = cmd_foo_bar()
100
100
        self.assertEqual(cmd.name(), cmd.get_help_topic())
101
101
 
102
102
    def test_formatted_help_text(self):
103
103
        """Help text should be plain text by default."""
104
104
        class cmd_Demo(commands.Command):
105
 
            """A sample command.
 
105
            __doc__ = """A sample command.
106
106
 
107
107
            :Examples:
108
108
                Example 1::
122
122
            '\n'
123
123
            'Options:\n'
124
124
            '  --usage        Show usage message and options.\n'
 
125
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
125
126
            '  -v, --verbose  Display more information.\n'
126
127
            '  -q, --quiet    Only display errors and warnings.\n'
127
128
            '  -h, --help     Show help message.\n'
142
143
            '\n'
143
144
            ':Options:\n'
144
145
            '  --usage        Show usage message and options.\n'
 
146
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
145
147
            '  -v, --verbose  Display more information.\n'
146
148
            '  -q, --quiet    Only display errors and warnings.\n'
147
149
            '  -h, --help     Show help message.\n'
159
161
    def test_concise_help_text(self):
160
162
        """Concise help text excludes the descriptive sections."""
161
163
        class cmd_Demo(commands.Command):
162
 
            """A sample command.
 
164
            __doc__ = """A sample command.
163
165
 
164
166
            Blah blah blah.
165
167
 
177
179
            '\n'
178
180
            'Options:\n'
179
181
            '  --usage        Show usage message and options.\n'
 
182
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
180
183
            '  -v, --verbose  Display more information.\n'
181
184
            '  -q, --quiet    Only display errors and warnings.\n'
182
185
            '  -h, --help     Show help message.\n'
196
199
            '\n'
197
200
            'Options:\n'
198
201
            '  --usage        Show usage message and options.\n'
 
202
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
199
203
            '  -v, --verbose  Display more information.\n'
200
204
            '  -q, --quiet    Only display errors and warnings.\n'
201
205
            '  -h, --help     Show help message.\n'
206
210
    def test_help_custom_section_ordering(self):
207
211
        """Custom descriptive sections should remain in the order given."""
208
212
        class cmd_Demo(commands.Command):
209
 
            """A sample command.
 
213
            __doc__ = """A sample command.
210
214
 
211
215
            Blah blah blah.
212
216
 
230
234
            '\n'
231
235
            'Options:\n'
232
236
            '  --usage        Show usage message and options.\n'
 
237
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
233
238
            '  -v, --verbose  Display more information.\n'
234
239
            '  -q, --quiet    Only display errors and warnings.\n'
235
240
            '  -h, --help     Show help message.\n'
252
257
    def test_help_text_custom_usage(self):
253
258
        """Help text may contain a custom usage section."""
254
259
        class cmd_Demo(commands.Command):
255
 
            """A sample command.
 
260
            __doc__ = """A sample command.
256
261
 
257
262
            :Usage:
258
263
                cmd Demo [opts] args
273
278
            '\n'
274
279
            'Options:\n'
275
280
            '  --usage        Show usage message and options.\n'
 
281
            '  -0, --null     Use an ASCII NUL (\\0) separator rather than a newline.\n'
276
282
            '  -v, --verbose  Display more information.\n'
277
283
            '  -q, --quiet    Only display errors and warnings.\n'
278
284
            '  -h, --help     Show help message.\n'