← 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: Canonical.com Patch Queue Manager
  • Date: 2009-03-17 07:05:37 UTC
  • mfrom: (4152.1.2 branch.stacked.streams)
  • Revision ID: pqm@pqm.ubuntu.com-20090317070537-zaud24vjs2szna87
(robertc) Add client-side streaming from stacked branches (over
        bzr:// protocols) when the sort order is compatible with doing
        that. (Robert Collins, Andrew Bennetts)

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.
 
98
            """A sample command.
106
99
 
107
100
            :Examples:
108
101
                Example 1::
112
105
                Example 2::
113
106
 
114
107
                    cmd arg2
115
 
 
116
 
                A code block follows.
117
 
 
118
 
                ::
119
 
 
120
 
                    bzr Demo something
121
108
            """
122
109
        cmd = cmd_Demo()
123
110
        helptext = cmd.get_help_text()
127
114
            'Usage:   bzr Demo\n'
128
115
            '\n'
129
116
            'Options:\n'
130
 
            '  --usage        Show usage message and options.\n'
131
117
            '  -v, --verbose  Display more information.\n'
132
118
            '  -q, --quiet    Only display errors and warnings.\n'
133
119
            '  -h, --help     Show help message.\n'
140
126
            '    Example 2:\n'
141
127
            '\n'
142
128
            '        cmd arg2\n'
143
 
            '\n'
144
 
            '    A code block follows.\n'
145
 
            '\n'
146
 
            '        bzr Demo something\n'
147
129
            '\n')
148
130
        helptext = cmd.get_help_text(plain=False)
149
131
        self.assertEquals(helptext,
151
133
            ':Usage:   bzr Demo\n'
152
134
            '\n'
153
135
            ':Options:\n'
154
 
            '  --usage        Show usage message and options.\n'
155
136
            '  -v, --verbose  Display more information.\n'
156
137
            '  -q, --quiet    Only display errors and warnings.\n'
157
138
            '  -h, --help     Show help message.\n'
164
145
            '    Example 2::\n'
165
146
            '\n'
166
147
            '        cmd arg2\n'
167
 
            '\n'
168
 
            '    A code block follows.\n'
169
 
            '\n'
170
 
            '    ::\n'
171
 
            '\n'
172
 
            '        bzr Demo something\n'
173
 
            '\n')
174
 
 
175
 
    def test_concise_help_text(self):
176
 
        """Concise help text excludes the descriptive sections."""
177
 
        class cmd_Demo(commands.Command):
178
 
            __doc__ = """A sample command.
179
 
 
180
 
            Blah blah blah.
181
 
 
182
 
            :Examples:
183
 
                Example 1::
184
 
 
185
 
                    cmd arg1
186
 
            """
187
 
        cmd = cmd_Demo()
188
 
        helptext = cmd.get_help_text()
189
 
        self.assertEqualDiff(
190
 
            helptext,
191
 
            'Purpose: A sample command.\n'
192
 
            'Usage:   bzr Demo\n'
193
 
            '\n'
194
 
            'Options:\n'
195
 
            '  --usage        Show usage message and options.\n'
196
 
            '  -v, --verbose  Display more information.\n'
197
 
            '  -q, --quiet    Only display errors and warnings.\n'
198
 
            '  -h, --help     Show help message.\n'
199
 
            '\n'
200
 
            'Description:\n'
201
 
            '  Blah blah blah.\n'
202
 
            '\n'
203
 
            'Examples:\n'
204
 
            '    Example 1:\n'
205
 
            '\n'
206
 
            '        cmd arg1\n'
207
 
            '\n')
208
 
        helptext = cmd.get_help_text(verbose=False)
209
 
        self.assertEquals(helptext,
210
 
            'Purpose: A sample command.\n'
211
 
            'Usage:   bzr Demo\n'
212
 
            '\n'
213
 
            'Options:\n'
214
 
            '  --usage        Show usage message and options.\n'
215
 
            '  -v, --verbose  Display more information.\n'
216
 
            '  -q, --quiet    Only display errors and warnings.\n'
217
 
            '  -h, --help     Show help message.\n'
218
 
            '\n'
219
 
            'See bzr help Demo for more details and examples.\n'
220
 
            '\n')
221
 
 
222
 
    def test_help_custom_section_ordering(self):
223
 
        """Custom descriptive sections should remain in the order given."""
224
 
        class cmd_Demo(commands.Command):
225
 
            __doc__ = """A sample command.
226
 
 
227
 
            Blah blah blah.
228
 
 
229
 
            :Formats:
230
 
              Interesting stuff about formats.
231
 
 
232
 
            :Examples:
233
 
              Example 1::
234
 
 
235
 
                cmd arg1
236
 
 
237
 
            :Tips:
238
 
              Clever things to keep in mind.
239
 
            """
240
 
        cmd = cmd_Demo()
241
 
        helptext = cmd.get_help_text()
242
 
        self.assertEqualDiff(
243
 
            helptext,
244
 
            'Purpose: A sample command.\n'
245
 
            'Usage:   bzr Demo\n'
246
 
            '\n'
247
 
            'Options:\n'
248
 
            '  --usage        Show usage message and options.\n'
249
 
            '  -v, --verbose  Display more information.\n'
250
 
            '  -q, --quiet    Only display errors and warnings.\n'
251
 
            '  -h, --help     Show help message.\n'
252
 
            '\n'
253
 
            'Description:\n'
254
 
            '  Blah blah blah.\n'
255
 
            '\n'
256
 
            'Formats:\n'
257
 
            '  Interesting stuff about formats.\n'
258
 
            '\n'
259
 
            'Examples:\n'
260
 
            '  Example 1:\n'
261
 
            '\n'
262
 
            '    cmd arg1\n'
263
 
            '\n'
264
 
            'Tips:\n'
265
 
            '  Clever things to keep in mind.\n'
266
148
            '\n')
267
149
 
268
150
    def test_help_text_custom_usage(self):
269
151
        """Help text may contain a custom usage section."""
270
152
        class cmd_Demo(commands.Command):
271
 
            __doc__ = """A sample command.
 
153
            """A sample command.
272
154
 
273
155
            :Usage:
274
156
                cmd Demo [opts] args
288
170
            '\n'
289
171
            '\n'
290
172
            'Options:\n'
291
 
            '  --usage        Show usage message and options.\n'
292
173
            '  -v, --verbose  Display more information.\n'
293
174
            '  -q, --quiet    Only display errors and warnings.\n'
294
175
            '  -h, --help     Show help message.\n'
297
178
            '  Blah blah blah.\n\n')
298
179
 
299
180
 
300
 
class TestRegisteredTopic(TestHelp):
 
181
class TestRegisteredTopic(tests.TestCase):
301
182
    """Tests for the RegisteredTopic class."""
302
183
 
303
184
    def test_contruct(self):
336
217
        self.assertEqual('baz', topic.get_help_topic())
337
218
 
338
219
 
339
 
class TestTopicIndex(TestHelp):
 
220
class TestTopicIndex(tests.TestCase):
340
221
    """Tests for the HelpTopicIndex class."""
341
222
 
342
223
    def test_default_constructable(self):
369
250
        self.assertEqual('', index.prefix)
370
251
 
371
252
 
372
 
class TestCommandIndex(TestHelp):
 
253
class TestCommandIndex(tests.TestCase):
373
254
    """Tests for the HelpCommandIndex class."""
374
255
 
375
256
    def test_default_constructable(self):