← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

(gz) Remove bzrlib/util/elementtree/ package (Martin Packman)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_help.py
16
16
 
17
17
"""Unit tests for the bzrlib.help module."""
18
18
 
 
19
import textwrap
 
20
 
19
21
from bzrlib import (
20
22
    builtins,
21
23
    commands,
 
24
    config,
22
25
    errors,
23
26
    help,
24
27
    help_topics,
 
28
    i18n,
25
29
    plugin,
26
30
    tests,
27
31
    )
28
32
 
29
 
 
30
 
class TestHelp(tests.TestCase):
31
 
 
32
 
    def setUp(self):
33
 
        tests.TestCase.setUp(self)
34
 
        commands.install_bzr_command_hooks()
 
33
from bzrlib.tests.test_i18n import ZzzTranslations
 
34
import re
35
35
 
36
36
 
37
37
class TestCommandHelp(tests.TestCase):
38
38
    """Tests for help on commands."""
39
39
 
 
40
    def assertCmdHelp(self, expected, cmd):
 
41
        self.assertEqualDiff(textwrap.dedent(expected), cmd.get_help_text())
 
42
 
40
43
    def test_command_help_includes_see_also(self):
41
44
        class cmd_WithSeeAlso(commands.Command):
42
45
            __doc__ = """A sample command."""
43
46
            _see_also = ['foo', 'bar']
44
 
        cmd = cmd_WithSeeAlso()
45
 
        helptext = cmd.get_help_text()
46
 
        self.assertEndsWith(
47
 
            helptext,
48
 
            '  -v, --verbose  Display more information.\n'
49
 
            '  -q, --quiet    Only display errors and warnings.\n'
50
 
            '  -h, --help     Show help message.\n'
51
 
            '\n'
52
 
            'See also: bar, foo\n')
 
47
        self.assertCmdHelp('''\
 
48
Purpose: A sample command.
 
49
Usage:   bzr WithSeeAlso
 
50
 
 
51
Options:
 
52
  --usage        Show usage message and options.
 
53
  -q, --quiet    Only display errors and warnings.
 
54
  -v, --verbose  Display more information.
 
55
  -h, --help     Show help message.
 
56
 
 
57
See also: bar, foo
 
58
''',
 
59
                           cmd_WithSeeAlso())
53
60
 
54
61
    def test_get_help_text(self):
55
62
        """Commands have a get_help_text method which returns their help."""
56
63
        class cmd_Demo(commands.Command):
57
64
            __doc__ = """A sample command."""
 
65
        self.assertCmdHelp('''\
 
66
Purpose: A sample command.
 
67
Usage:   bzr Demo
 
68
 
 
69
Options:
 
70
  --usage        Show usage message and options.
 
71
  -q, --quiet    Only display errors and warnings.
 
72
  -v, --verbose  Display more information.
 
73
  -h, --help     Show help message.
 
74
 
 
75
''',
 
76
                           cmd_Demo())
58
77
        cmd = cmd_Demo()
59
78
        helptext = cmd.get_help_text()
60
79
        self.assertStartsWith(helptext,
71
90
        helptext = cmd.get_help_text(['gam'])
72
91
        self.assertEndsWith(
73
92
            helptext,
 
93
            '  -q, --quiet    Only display errors and warnings.\n'
74
94
            '  -v, --verbose  Display more information.\n'
75
 
            '  -q, --quiet    Only display errors and warnings.\n'
76
95
            '  -h, --help     Show help message.\n'
77
96
            '\n'
78
97
            'See also: bar, foo, gam\n')
84
103
        helptext = cmd.get_help_text(['gam'])
85
104
        self.assertEndsWith(
86
105
            helptext,
 
106
            '  -q, --quiet    Only display errors and warnings.\n'
87
107
            '  -v, --verbose  Display more information.\n'
88
 
            '  -q, --quiet    Only display errors and warnings.\n'
89
108
            '  -h, --help     Show help message.\n'
90
109
            '\n'
91
110
            'See also: gam\n')
119
138
            """
120
139
        cmd = cmd_Demo()
121
140
        helptext = cmd.get_help_text()
122
 
        self.assertEquals(
123
 
            helptext,
124
 
            'Purpose: A sample command.\n'
125
 
            'Usage:   bzr Demo\n'
126
 
            '\n'
127
 
            'Options:\n'
128
 
            '  --usage        Show usage message and options.\n'
129
 
            '  -v, --verbose  Display more information.\n'
130
 
            '  -q, --quiet    Only display errors and warnings.\n'
131
 
            '  -h, --help     Show help message.\n'
132
 
            '\n'
133
 
            'Examples:\n'
134
 
            '    Example 1:\n'
135
 
            '\n'
136
 
            '        cmd arg1\n'
137
 
            '\n'
138
 
            '    Example 2:\n'
139
 
            '\n'
140
 
            '        cmd arg2\n'
141
 
            '\n'
142
 
            '    A code block follows.\n'
143
 
            '\n'
144
 
            '        bzr Demo something\n'
145
 
            '\n')
 
141
        self.assertEqualDiff('''\
 
142
Purpose: A sample command.
 
143
Usage:   bzr Demo
 
144
 
 
145
Options:
 
146
  --usage        Show usage message and options.
 
147
  -q, --quiet    Only display errors and warnings.
 
148
  -v, --verbose  Display more information.
 
149
  -h, --help     Show help message.
 
150
 
 
151
Examples:
 
152
    Example 1:
 
153
 
 
154
        cmd arg1
 
155
 
 
156
    Example 2:
 
157
 
 
158
        cmd arg2
 
159
 
 
160
    A code block follows.
 
161
 
 
162
        bzr Demo something
 
163
 
 
164
''',
 
165
                                         helptext)
146
166
        helptext = cmd.get_help_text(plain=False)
147
 
        self.assertEquals(helptext,
148
 
            ':Purpose: A sample command.\n'
149
 
            ':Usage:   bzr Demo\n'
150
 
            '\n'
151
 
            ':Options:\n'
152
 
            '  --usage        Show usage message and options.\n'
153
 
            '  -v, --verbose  Display more information.\n'
154
 
            '  -q, --quiet    Only display errors and warnings.\n'
155
 
            '  -h, --help     Show help message.\n'
156
 
            '\n'
157
 
            ':Examples:\n'
158
 
            '    Example 1::\n'
159
 
            '\n'
160
 
            '        cmd arg1\n'
161
 
            '\n'
162
 
            '    Example 2::\n'
163
 
            '\n'
164
 
            '        cmd arg2\n'
165
 
            '\n'
166
 
            '    A code block follows.\n'
167
 
            '\n'
168
 
            '    ::\n'
169
 
            '\n'
170
 
            '        bzr Demo something\n'
171
 
            '\n')
 
167
        self.assertEqualDiff('''\
 
168
:Purpose: A sample command.
 
169
:Usage:   bzr Demo
 
170
 
 
171
:Options:
 
172
  --usage        Show usage message and options.
 
173
  -q, --quiet    Only display errors and warnings.
 
174
  -v, --verbose  Display more information.
 
175
  -h, --help     Show help message.
 
176
 
 
177
:Examples:
 
178
    Example 1::
 
179
 
 
180
        cmd arg1
 
181
 
 
182
    Example 2::
 
183
 
 
184
        cmd arg2
 
185
 
 
186
    A code block follows.
 
187
 
 
188
    ::
 
189
 
 
190
        bzr Demo something
 
191
 
 
192
''',
 
193
                             helptext)
172
194
 
173
195
    def test_concise_help_text(self):
174
196
        """Concise help text excludes the descriptive sections."""
184
206
            """
185
207
        cmd = cmd_Demo()
186
208
        helptext = cmd.get_help_text()
187
 
        self.assertEqualDiff(
188
 
            helptext,
189
 
            'Purpose: A sample command.\n'
190
 
            'Usage:   bzr Demo\n'
191
 
            '\n'
192
 
            'Options:\n'
193
 
            '  --usage        Show usage message and options.\n'
194
 
            '  -v, --verbose  Display more information.\n'
195
 
            '  -q, --quiet    Only display errors and warnings.\n'
196
 
            '  -h, --help     Show help message.\n'
197
 
            '\n'
198
 
            'Description:\n'
199
 
            '  Blah blah blah.\n'
200
 
            '\n'
201
 
            'Examples:\n'
202
 
            '    Example 1:\n'
203
 
            '\n'
204
 
            '        cmd arg1\n'
205
 
            '\n')
 
209
        self.assertEqualDiff('''\
 
210
Purpose: A sample command.
 
211
Usage:   bzr Demo
 
212
 
 
213
Options:
 
214
  --usage        Show usage message and options.
 
215
  -q, --quiet    Only display errors and warnings.
 
216
  -v, --verbose  Display more information.
 
217
  -h, --help     Show help message.
 
218
 
 
219
Description:
 
220
  Blah blah blah.
 
221
 
 
222
Examples:
 
223
    Example 1:
 
224
 
 
225
        cmd arg1
 
226
 
 
227
''',
 
228
                             helptext)
206
229
        helptext = cmd.get_help_text(verbose=False)
207
 
        self.assertEquals(helptext,
208
 
            'Purpose: A sample command.\n'
209
 
            'Usage:   bzr Demo\n'
210
 
            '\n'
211
 
            'Options:\n'
212
 
            '  --usage        Show usage message and options.\n'
213
 
            '  -v, --verbose  Display more information.\n'
214
 
            '  -q, --quiet    Only display errors and warnings.\n'
215
 
            '  -h, --help     Show help message.\n'
216
 
            '\n'
217
 
            'See bzr help Demo for more details and examples.\n'
218
 
            '\n')
219
 
 
220
 
    def test_help_custom_section_ordering(self):
221
 
        """Custom descriptive sections should remain in the order given."""
 
230
        self.assertEqualDiff('''\
 
231
Purpose: A sample command.
 
232
Usage:   bzr Demo
 
233
 
 
234
Options:
 
235
  --usage        Show usage message and options.
 
236
  -q, --quiet    Only display errors and warnings.
 
237
  -v, --verbose  Display more information.
 
238
  -h, --help     Show help message.
 
239
 
 
240
See bzr help Demo for more details and examples.
 
241
 
 
242
''',
 
243
                             helptext)
 
244
 
 
245
    def test_help_custom_section_ordering(self):
 
246
        """Custom descriptive sections should remain in the order given."""
 
247
        class cmd_Demo(commands.Command):
 
248
            __doc__ = """\
 
249
A sample command.
 
250
 
 
251
Blah blah blah.
 
252
 
 
253
:Formats:
 
254
  Interesting stuff about formats.
 
255
 
 
256
:Examples:
 
257
  Example 1::
 
258
 
 
259
    cmd arg1
 
260
 
 
261
:Tips:
 
262
  Clever things to keep in mind.
 
263
"""
 
264
        cmd = cmd_Demo()
 
265
        helptext = cmd.get_help_text()
 
266
        self.assertEqualDiff('''\
 
267
Purpose: A sample command.
 
268
Usage:   bzr Demo
 
269
 
 
270
Options:
 
271
  --usage        Show usage message and options.
 
272
  -q, --quiet    Only display errors and warnings.
 
273
  -v, --verbose  Display more information.
 
274
  -h, --help     Show help message.
 
275
 
 
276
Description:
 
277
  Blah blah blah.
 
278
 
 
279
Formats:
 
280
  Interesting stuff about formats.
 
281
 
 
282
Examples:
 
283
  Example 1:
 
284
 
 
285
    cmd arg1
 
286
 
 
287
Tips:
 
288
  Clever things to keep in mind.
 
289
 
 
290
''',
 
291
                             helptext)
 
292
 
 
293
    def test_help_text_custom_usage(self):
 
294
        """Help text may contain a custom usage section."""
 
295
        class cmd_Demo(commands.Command):
 
296
            __doc__ = """A sample command.
 
297
 
 
298
            :Usage:
 
299
                cmd Demo [opts] args
 
300
 
 
301
                cmd Demo -h
 
302
 
 
303
            Blah blah blah.
 
304
            """
 
305
        cmd = cmd_Demo()
 
306
        helptext = cmd.get_help_text()
 
307
        self.assertEqualDiff('''\
 
308
Purpose: A sample command.
 
309
Usage:
 
310
    cmd Demo [opts] args
 
311
 
 
312
    cmd Demo -h
 
313
 
 
314
 
 
315
Options:
 
316
  --usage        Show usage message and options.
 
317
  -q, --quiet    Only display errors and warnings.
 
318
  -v, --verbose  Display more information.
 
319
  -h, --help     Show help message.
 
320
 
 
321
Description:
 
322
  Blah blah blah.
 
323
 
 
324
''',
 
325
                             helptext)
 
326
 
 
327
 
 
328
class ZzzTranslationsForDoc(ZzzTranslations):
 
329
 
 
330
    _section_pat = re.compile(':\w+:\\n\\s+')
 
331
    _indent_pat = re.compile('\\s+')
 
332
 
 
333
    def zzz(self, s):
 
334
        m = self._section_pat.match(s)
 
335
        if m is None:
 
336
            m = self._indent_pat.match(s)
 
337
        if m:
 
338
            return u'%szz{{%s}}' % (m.group(0), s[m.end():])
 
339
        return u'zz{{%s}}' % s
 
340
 
 
341
 
 
342
class TestCommandHelpI18n(tests.TestCase):
 
343
    """Tests for help on translated commands."""
 
344
 
 
345
    def setUp(self):
 
346
        super(TestCommandHelpI18n, self).setUp()
 
347
        self.overrideAttr(i18n, '_translations', ZzzTranslationsForDoc())
 
348
 
 
349
    def assertCmdHelp(self, expected, cmd):
 
350
        self.assertEqualDiff(textwrap.dedent(expected), cmd.get_help_text())
 
351
 
 
352
    def test_command_help_includes_see_also(self):
 
353
        class cmd_WithSeeAlso(commands.Command):
 
354
            __doc__ = """A sample command."""
 
355
            _see_also = ['foo', 'bar']
 
356
        self.assertCmdHelp('''\
 
357
zz{{:Purpose: zz{{A sample command.}}
 
358
}}zz{{:Usage:   bzr WithSeeAlso
 
359
}}
 
360
zz{{:Options:
 
361
  --usage        zz{{Show usage message and options.}}
 
362
  -q, --quiet    zz{{Only display errors and warnings.}}
 
363
  -v, --verbose  zz{{Display more information.}}
 
364
  -h, --help     zz{{Show help message.}}
 
365
}}
 
366
zz{{:See also: bar, foo}}
 
367
''',
 
368
                           cmd_WithSeeAlso())
 
369
 
 
370
    def test_get_help_text(self):
 
371
        """Commands have a get_help_text method which returns their help."""
 
372
        class cmd_Demo(commands.Command):
 
373
            __doc__ = """A sample command."""
 
374
        self.assertCmdHelp('''\
 
375
zz{{:Purpose: zz{{A sample command.}}
 
376
}}zz{{:Usage:   bzr Demo
 
377
}}
 
378
zz{{:Options:
 
379
  --usage        zz{{Show usage message and options.}}
 
380
  -q, --quiet    zz{{Only display errors and warnings.}}
 
381
  -v, --verbose  zz{{Display more information.}}
 
382
  -h, --help     zz{{Show help message.}}
 
383
}}
 
384
''',
 
385
                           cmd_Demo())
 
386
 
 
387
    def test_command_with_additional_see_also(self):
 
388
        class cmd_WithSeeAlso(commands.Command):
 
389
            __doc__ = """A sample command."""
 
390
            _see_also = ['foo', 'bar']
 
391
        cmd = cmd_WithSeeAlso()
 
392
        helptext = cmd.get_help_text(['gam'])
 
393
        self.assertEndsWith(
 
394
            helptext,'''\
 
395
  -q, --quiet    zz{{Only display errors and warnings.}}
 
396
  -v, --verbose  zz{{Display more information.}}
 
397
  -h, --help     zz{{Show help message.}}
 
398
}}
 
399
zz{{:See also: bar, foo, gam}}
 
400
''')
 
401
 
 
402
    def test_command_only_additional_see_also(self):
 
403
        class cmd_WithSeeAlso(commands.Command):
 
404
            __doc__ = """A sample command."""
 
405
        cmd = cmd_WithSeeAlso()
 
406
        helptext = cmd.get_help_text(['gam'])
 
407
        self.assertEndsWith(
 
408
            helptext, '''\
 
409
zz{{:Options:
 
410
  --usage        zz{{Show usage message and options.}}
 
411
  -q, --quiet    zz{{Only display errors and warnings.}}
 
412
  -v, --verbose  zz{{Display more information.}}
 
413
  -h, --help     zz{{Show help message.}}
 
414
}}
 
415
zz{{:See also: gam}}
 
416
''')
 
417
 
 
418
 
 
419
    def test_help_custom_section_ordering(self):
 
420
        """Custom descriptive sections should remain in the order given."""
 
421
        # The help formatter expect the class name to start with 'cmd_'
222
422
        class cmd_Demo(commands.Command):
223
423
            __doc__ = """A sample command.
224
424
 
235
435
            :Tips:
236
436
              Clever things to keep in mind.
237
437
            """
238
 
        cmd = cmd_Demo()
239
 
        helptext = cmd.get_help_text()
240
 
        self.assertEqualDiff(
241
 
            helptext,
242
 
            'Purpose: A sample command.\n'
243
 
            'Usage:   bzr Demo\n'
244
 
            '\n'
245
 
            'Options:\n'
246
 
            '  --usage        Show usage message and options.\n'
247
 
            '  -v, --verbose  Display more information.\n'
248
 
            '  -q, --quiet    Only display errors and warnings.\n'
249
 
            '  -h, --help     Show help message.\n'
250
 
            '\n'
251
 
            'Description:\n'
252
 
            '  Blah blah blah.\n'
253
 
            '\n'
254
 
            'Formats:\n'
255
 
            '  Interesting stuff about formats.\n'
256
 
            '\n'
257
 
            'Examples:\n'
258
 
            '  Example 1:\n'
259
 
            '\n'
260
 
            '    cmd arg1\n'
261
 
            '\n'
262
 
            'Tips:\n'
263
 
            '  Clever things to keep in mind.\n'
264
 
            '\n')
 
438
        self.assertCmdHelp('''\
 
439
zz{{:Purpose: zz{{A sample command.}}
 
440
}}zz{{:Usage:   bzr Demo
 
441
}}
 
442
zz{{:Options:
 
443
  --usage        zz{{Show usage message and options.}}
 
444
  -q, --quiet    zz{{Only display errors and warnings.}}
 
445
  -v, --verbose  zz{{Display more information.}}
 
446
  -h, --help     zz{{Show help message.}}
 
447
}}
 
448
Description:
 
449
  zz{{zz{{Blah blah blah.}}
 
450
 
 
451
}}:Formats:
 
452
  zz{{Interesting stuff about formats.}}
 
453
 
 
454
Examples:
 
455
  zz{{Example 1::}}
 
456
 
 
457
    zz{{cmd arg1}}
 
458
 
 
459
Tips:
 
460
  zz{{Clever things to keep in mind.}}
 
461
 
 
462
''',
 
463
                           cmd_Demo())
265
464
 
266
465
    def test_help_text_custom_usage(self):
267
466
        """Help text may contain a custom usage section."""
275
474
 
276
475
            Blah blah blah.
277
476
            """
278
 
        cmd = cmd_Demo()
279
 
        helptext = cmd.get_help_text()
280
 
        self.assertEquals(helptext,
281
 
            'Purpose: A sample command.\n'
282
 
            'Usage:\n'
283
 
            '    cmd Demo [opts] args\n'
284
 
            '\n'
285
 
            '    cmd Demo -h\n'
286
 
            '\n'
287
 
            '\n'
288
 
            'Options:\n'
289
 
            '  --usage        Show usage message and options.\n'
290
 
            '  -v, --verbose  Display more information.\n'
291
 
            '  -q, --quiet    Only display errors and warnings.\n'
292
 
            '  -h, --help     Show help message.\n'
293
 
            '\n'
294
 
            'Description:\n'
295
 
            '  Blah blah blah.\n\n')
 
477
        self.assertCmdHelp('''\
 
478
zz{{:Purpose: zz{{A sample command.}}
 
479
}}zz{{:Usage:
 
480
    zz{{cmd Demo [opts] args}}
 
481
 
 
482
    zz{{cmd Demo -h}}
 
483
 
 
484
}}
 
485
zz{{:Options:
 
486
  --usage        zz{{Show usage message and options.}}
 
487
  -q, --quiet    zz{{Only display errors and warnings.}}
 
488
  -v, --verbose  zz{{Display more information.}}
 
489
  -h, --help     zz{{Show help message.}}
 
490
}}
 
491
Description:
 
492
  zz{{zz{{Blah blah blah.}}
 
493
 
 
494
}}
 
495
''',
 
496
                           cmd_Demo())
 
497
 
 
498
 
 
499
class TestHelp(tests.TestCase):
 
500
 
 
501
    def setUp(self):
 
502
        tests.TestCase.setUp(self)
 
503
        commands.install_bzr_command_hooks()
296
504
 
297
505
 
298
506
class TestRegisteredTopic(TestHelp):
306
514
        self.assertEqual('basic', topic.topic)
307
515
 
308
516
    def test_get_help_text(self):
309
 
        """A RegisteredTopic returns the get_detail results for get_help_text."""
 
517
        """RegisteredTopic returns the get_detail results for get_help_text."""
310
518
        topic = help_topics.RegisteredTopic('commands')
311
519
        self.assertEqual(help_topics.topic_registry.get_detail('commands'),
312
 
            topic.get_help_text())
 
520
                         topic.get_help_text())
313
521
 
314
522
    def test_get_help_text_with_additional_see_also(self):
315
523
        topic = help_topics.RegisteredTopic('commands')
327
535
            '\n')
328
536
 
329
537
    def test_get_help_topic(self):
330
 
        """The help topic for a RegisteredTopic is its topic from construction."""
 
538
        """The help topic for RegisteredTopic is its topic from construction."""
331
539
        topic = help_topics.RegisteredTopic('foobar')
332
540
        self.assertEqual('foobar', topic.get_help_topic())
333
541
        topic = help_topics.RegisteredTopic('baz')
367
575
        self.assertEqual('', index.prefix)
368
576
 
369
577
 
 
578
class TestConfigOptionIndex(TestHelp):
 
579
    """Tests for the HelpCommandIndex class."""
 
580
 
 
581
    def setUp(self):
 
582
        super(TestConfigOptionIndex, self).setUp()
 
583
        self.index = help_topics.ConfigOptionHelpIndex()
 
584
 
 
585
    def test_get_topics_None(self):
 
586
        """Searching for None returns an empty list."""
 
587
        self.assertEqual([], self.index.get_topics(None))
 
588
 
 
589
    def test_get_topics_no_topic(self):
 
590
        self.assertEqual([], self.index.get_topics('nothing by this name'))
 
591
 
 
592
    def test_prefix(self):
 
593
        self.assertEqual('configuration/', self.index.prefix)
 
594
 
 
595
    def test_get_topic_with_prefix(self):
 
596
        topics = self.index.get_topics('configuration/default_format')
 
597
        self.assertLength(1, topics)
 
598
        opt = topics[0]
 
599
        self.assertIsInstance(opt, config.Option)
 
600
        self.assertEquals('default_format', opt.name)
 
601
 
 
602
 
370
603
class TestCommandIndex(TestHelp):
371
604
    """Tests for the HelpCommandIndex class."""
372
605
 
409
642
    def test_default_search_path(self):
410
643
        """The default search path should include internal indexs."""
411
644
        indices = help.HelpIndices()
412
 
        self.assertEqual(3, len(indices.search_path))
 
645
        self.assertEqual(4, len(indices.search_path))
413
646
        # help topics should be searched in first.
414
647
        self.assertIsInstance(indices.search_path[0],
415
 
            help_topics.HelpTopicIndex)
 
648
                              help_topics.HelpTopicIndex)
416
649
        # with commands being search second.
417
650
        self.assertIsInstance(indices.search_path[1],
418
 
            commands.HelpCommandIndex)
419
 
        # and plugins are a third index.
 
651
                              commands.HelpCommandIndex)
 
652
        # plugins are a third index.
420
653
        self.assertIsInstance(indices.search_path[2],
421
 
            plugin.PluginsHelpIndex)
 
654
                              plugin.PluginsHelpIndex)
 
655
        # config options are a fourth index
 
656
        self.assertIsInstance(indices.search_path[3],
 
657
                              help_topics.ConfigOptionHelpIndex)
422
658
 
423
659
    def test_search_for_unknown_topic_raises(self):
424
660
        """Searching for an unknown topic should raise NoHelpTopic."""