← 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: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_help.py
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007-2012, 2016 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
21
21
from bzrlib import (
22
22
    builtins,
23
23
    commands,
 
24
    config,
24
25
    errors,
25
26
    help,
26
27
    help_topics,
44
45
            __doc__ = """A sample command."""
45
46
            _see_also = ['foo', 'bar']
46
47
        self.assertCmdHelp('''\
47
 
            Purpose: A sample command.
48
 
            Usage:   bzr WithSeeAlso
49
 
            
50
 
            Options:
51
 
              --usage        Show usage message and options.
52
 
              -v, --verbose  Display more information.
53
 
              -q, --quiet    Only display errors and warnings.
54
 
              -h, --help     Show help message.
55
 
            
56
 
            See also: bar, foo
57
 
            ''',
 
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
''',
58
59
                           cmd_WithSeeAlso())
59
60
 
60
61
    def test_get_help_text(self):
62
63
        class cmd_Demo(commands.Command):
63
64
            __doc__ = """A sample command."""
64
65
        self.assertCmdHelp('''\
65
 
            Purpose: A sample command.
66
 
            Usage:   bzr Demo
67
 
            
68
 
            Options:
69
 
              --usage        Show usage message and options.
70
 
              -v, --verbose  Display more information.
71
 
              -q, --quiet    Only display errors and warnings.
72
 
              -h, --help     Show help message.
73
 
 
74
 
            ''',
 
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
''',
75
76
                           cmd_Demo())
76
77
        cmd = cmd_Demo()
77
78
        helptext = cmd.get_help_text()
89
90
        helptext = cmd.get_help_text(['gam'])
90
91
        self.assertEndsWith(
91
92
            helptext,
 
93
            '  -q, --quiet    Only display errors and warnings.\n'
92
94
            '  -v, --verbose  Display more information.\n'
93
 
            '  -q, --quiet    Only display errors and warnings.\n'
94
95
            '  -h, --help     Show help message.\n'
95
96
            '\n'
96
97
            'See also: bar, foo, gam\n')
102
103
        helptext = cmd.get_help_text(['gam'])
103
104
        self.assertEndsWith(
104
105
            helptext,
 
106
            '  -q, --quiet    Only display errors and warnings.\n'
105
107
            '  -v, --verbose  Display more information.\n'
106
 
            '  -q, --quiet    Only display errors and warnings.\n'
107
108
            '  -h, --help     Show help message.\n'
108
109
            '\n'
109
110
            'See also: gam\n')
137
138
            """
138
139
        cmd = cmd_Demo()
139
140
        helptext = cmd.get_help_text()
140
 
        self.assertEquals(
141
 
            helptext,
142
 
            'Purpose: A sample command.\n'
143
 
            'Usage:   bzr Demo\n'
144
 
            '\n'
145
 
            'Options:\n'
146
 
            '  --usage        Show usage message and options.\n'
147
 
            '  -v, --verbose  Display more information.\n'
148
 
            '  -q, --quiet    Only display errors and warnings.\n'
149
 
            '  -h, --help     Show help message.\n'
150
 
            '\n'
151
 
            'Examples:\n'
152
 
            '    Example 1:\n'
153
 
            '\n'
154
 
            '        cmd arg1\n'
155
 
            '\n'
156
 
            '    Example 2:\n'
157
 
            '\n'
158
 
            '        cmd arg2\n'
159
 
            '\n'
160
 
            '    A code block follows.\n'
161
 
            '\n'
162
 
            '        bzr Demo something\n'
163
 
            '\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)
164
166
        helptext = cmd.get_help_text(plain=False)
165
 
        self.assertEquals(helptext,
166
 
            ':Purpose: A sample command.\n'
167
 
            ':Usage:   bzr Demo\n'
168
 
            '\n'
169
 
            ':Options:\n'
170
 
            '  --usage        Show usage message and options.\n'
171
 
            '  -v, --verbose  Display more information.\n'
172
 
            '  -q, --quiet    Only display errors and warnings.\n'
173
 
            '  -h, --help     Show help message.\n'
174
 
            '\n'
175
 
            ':Examples:\n'
176
 
            '    Example 1::\n'
177
 
            '\n'
178
 
            '        cmd arg1\n'
179
 
            '\n'
180
 
            '    Example 2::\n'
181
 
            '\n'
182
 
            '        cmd arg2\n'
183
 
            '\n'
184
 
            '    A code block follows.\n'
185
 
            '\n'
186
 
            '    ::\n'
187
 
            '\n'
188
 
            '        bzr Demo something\n'
189
 
            '\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)
190
194
 
191
195
    def test_concise_help_text(self):
192
196
        """Concise help text excludes the descriptive sections."""
202
206
            """
203
207
        cmd = cmd_Demo()
204
208
        helptext = cmd.get_help_text()
205
 
        self.assertEqualDiff(
206
 
            helptext,
207
 
            'Purpose: A sample command.\n'
208
 
            'Usage:   bzr Demo\n'
209
 
            '\n'
210
 
            'Options:\n'
211
 
            '  --usage        Show usage message and options.\n'
212
 
            '  -v, --verbose  Display more information.\n'
213
 
            '  -q, --quiet    Only display errors and warnings.\n'
214
 
            '  -h, --help     Show help message.\n'
215
 
            '\n'
216
 
            'Description:\n'
217
 
            '  Blah blah blah.\n'
218
 
            '\n'
219
 
            'Examples:\n'
220
 
            '    Example 1:\n'
221
 
            '\n'
222
 
            '        cmd arg1\n'
223
 
            '\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)
224
229
        helptext = cmd.get_help_text(verbose=False)
225
 
        self.assertEquals(helptext,
226
 
            'Purpose: A sample command.\n'
227
 
            'Usage:   bzr Demo\n'
228
 
            '\n'
229
 
            'Options:\n'
230
 
            '  --usage        Show usage message and options.\n'
231
 
            '  -v, --verbose  Display more information.\n'
232
 
            '  -q, --quiet    Only display errors and warnings.\n'
233
 
            '  -h, --help     Show help message.\n'
234
 
            '\n'
235
 
            'See bzr help Demo for more details and examples.\n'
236
 
            '\n')
 
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)
237
244
 
238
245
    def test_help_custom_section_ordering(self):
239
246
        """Custom descriptive sections should remain in the order given."""
240
247
        class cmd_Demo(commands.Command):
241
 
            __doc__ = """A sample command.
242
 
 
243
 
            Blah blah blah.
244
 
 
245
 
            :Formats:
246
 
              Interesting stuff about formats.
247
 
 
248
 
            :Examples:
249
 
              Example 1::
250
 
 
251
 
                cmd arg1
252
 
 
253
 
            :Tips:
254
 
              Clever things to keep in mind.
255
 
            """
 
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
"""
256
264
        cmd = cmd_Demo()
257
265
        helptext = cmd.get_help_text()
258
 
        self.assertEqualDiff(
259
 
            helptext,
260
 
            'Purpose: A sample command.\n'
261
 
            'Usage:   bzr Demo\n'
262
 
            '\n'
263
 
            'Options:\n'
264
 
            '  --usage        Show usage message and options.\n'
265
 
            '  -v, --verbose  Display more information.\n'
266
 
            '  -q, --quiet    Only display errors and warnings.\n'
267
 
            '  -h, --help     Show help message.\n'
268
 
            '\n'
269
 
            'Description:\n'
270
 
            '  Blah blah blah.\n'
271
 
            '\n'
272
 
            'Formats:\n'
273
 
            '  Interesting stuff about formats.\n'
274
 
            '\n'
275
 
            'Examples:\n'
276
 
            '  Example 1:\n'
277
 
            '\n'
278
 
            '    cmd arg1\n'
279
 
            '\n'
280
 
            'Tips:\n'
281
 
            '  Clever things to keep in mind.\n'
282
 
            '\n')
 
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)
283
292
 
284
293
    def test_help_text_custom_usage(self):
285
294
        """Help text may contain a custom usage section."""
295
304
            """
296
305
        cmd = cmd_Demo()
297
306
        helptext = cmd.get_help_text()
298
 
        self.assertEquals(helptext,
299
 
            'Purpose: A sample command.\n'
300
 
            'Usage:\n'
301
 
            '    cmd Demo [opts] args\n'
302
 
            '\n'
303
 
            '    cmd Demo -h\n'
304
 
            '\n'
305
 
            '\n'
306
 
            'Options:\n'
307
 
            '  --usage        Show usage message and options.\n'
308
 
            '  -v, --verbose  Display more information.\n'
309
 
            '  -q, --quiet    Only display errors and warnings.\n'
310
 
            '  -h, --help     Show help message.\n'
311
 
            '\n'
312
 
            'Description:\n'
313
 
            '  Blah blah blah.\n\n')
 
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)
314
326
 
315
327
 
316
328
class ZzzTranslationsForDoc(ZzzTranslations):
342
354
            __doc__ = """A sample command."""
343
355
            _see_also = ['foo', 'bar']
344
356
        self.assertCmdHelp('''\
345
 
            zz{{:Purpose: zz{{A sample command.}}
346
 
            }}zz{{:Usage:   bzr WithSeeAlso
347
 
            }}
348
 
            zz{{:Options:
349
 
              --usage        Show usage message and options.
350
 
              -v, --verbose  Display more information.
351
 
              -q, --quiet    Only display errors and warnings.
352
 
              -h, --help     Show help message.
353
 
            }}
354
 
            zz{{:See also: bar, foo}}
355
 
            ''',
 
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
''',
356
368
                           cmd_WithSeeAlso())
357
369
 
358
370
    def test_get_help_text(self):
360
372
        class cmd_Demo(commands.Command):
361
373
            __doc__ = """A sample command."""
362
374
        self.assertCmdHelp('''\
363
 
            zz{{:Purpose: zz{{A sample command.}}
364
 
            }}zz{{:Usage:   bzr Demo
365
 
            }}
366
 
            zz{{:Options:
367
 
              --usage        Show usage message and options.
368
 
              -v, --verbose  Display more information.
369
 
              -q, --quiet    Only display errors and warnings.
370
 
              -h, --help     Show help message.
371
 
            }}
372
 
            ''',
 
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
''',
373
385
                           cmd_Demo())
374
386
 
375
387
    def test_command_with_additional_see_also(self):
379
391
        cmd = cmd_WithSeeAlso()
380
392
        helptext = cmd.get_help_text(['gam'])
381
393
        self.assertEndsWith(
382
 
            helptext,
383
 
            '  -v, --verbose  Display more information.\n'
384
 
            '  -q, --quiet    Only display errors and warnings.\n'
385
 
            '  -h, --help     Show help message.\n'
386
 
            '}}\n'
387
 
            'zz{{:See also: bar, foo, gam}}\n')
 
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
''')
388
401
 
389
402
    def test_command_only_additional_see_also(self):
390
403
        class cmd_WithSeeAlso(commands.Command):
392
405
        cmd = cmd_WithSeeAlso()
393
406
        helptext = cmd.get_help_text(['gam'])
394
407
        self.assertEndsWith(
395
 
            helptext,
396
 
            'zz{{:Options:\n'
397
 
            '  --usage        Show usage message and options.\n'
398
 
            '  -v, --verbose  Display more information.\n'
399
 
            '  -q, --quiet    Only display errors and warnings.\n'
400
 
            '  -h, --help     Show help message.\n'
401
 
            '}}\n'
402
 
            'zz{{:See also: gam}}\n')
 
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
''')
403
417
 
404
418
 
405
419
    def test_help_custom_section_ordering(self):
422
436
              Clever things to keep in mind.
423
437
            """
424
438
        self.assertCmdHelp('''\
425
 
            zz{{:Purpose: zz{{A sample command.}}
426
 
            }}zz{{:Usage:   bzr Demo
427
 
            }}
428
 
            zz{{:Options:
429
 
              --usage        Show usage message and options.
430
 
              -v, --verbose  Display more information.
431
 
              -q, --quiet    Only display errors and warnings.
432
 
              -h, --help     Show help message.
433
 
            }}
434
 
            Description:
435
 
              zz{{zz{{Blah blah blah.}}
436
 
            
437
 
            }}:Formats:
438
 
              zz{{Interesting stuff about formats.}}
439
 
            
440
 
            Examples:
441
 
              zz{{Example 1::}}
442
 
            
443
 
                zz{{cmd arg1}}
444
 
            
445
 
            Tips:
446
 
              zz{{Clever things to keep in mind.}}
447
 
 
448
 
            ''',
 
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
''',
449
463
                           cmd_Demo())
450
464
 
451
465
    def test_help_text_custom_usage(self):
461
475
            Blah blah blah.
462
476
            """
463
477
        self.assertCmdHelp('''\
464
 
            zz{{:Purpose: zz{{A sample command.}}
465
 
            }}zz{{:Usage:
466
 
                zz{{cmd Demo [opts] args}}
467
 
            
468
 
                zz{{cmd Demo -h}}
469
 
 
470
 
            }}
471
 
            zz{{:Options:
472
 
              --usage        Show usage message and options.
473
 
              -v, --verbose  Display more information.
474
 
              -q, --quiet    Only display errors and warnings.
475
 
              -h, --help     Show help message.
476
 
            }}
477
 
            Description:
478
 
              zz{{zz{{Blah blah blah.}}
479
 
 
480
 
            }}
481
 
            ''',
 
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
''',
482
496
                           cmd_Demo())
483
497
 
484
498
 
485
499
class TestHelp(tests.TestCase):
486
500
 
487
501
    def setUp(self):
488
 
        tests.TestCase.setUp(self)
 
502
        super(TestHelp, self).setUp()
489
503
        commands.install_bzr_command_hooks()
490
504
 
491
505
 
561
575
        self.assertEqual('', index.prefix)
562
576
 
563
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.assertEqual('default_format', opt.name)
 
601
 
 
602
 
564
603
class TestCommandIndex(TestHelp):
565
604
    """Tests for the HelpCommandIndex class."""
566
605
 
603
642
    def test_default_search_path(self):
604
643
        """The default search path should include internal indexs."""
605
644
        indices = help.HelpIndices()
606
 
        self.assertEqual(3, len(indices.search_path))
 
645
        self.assertEqual(4, len(indices.search_path))
607
646
        # help topics should be searched in first.
608
647
        self.assertIsInstance(indices.search_path[0],
609
 
            help_topics.HelpTopicIndex)
 
648
                              help_topics.HelpTopicIndex)
610
649
        # with commands being search second.
611
650
        self.assertIsInstance(indices.search_path[1],
612
 
            commands.HelpCommandIndex)
613
 
        # and plugins are a third index.
 
651
                              commands.HelpCommandIndex)
 
652
        # plugins are a third index.
614
653
        self.assertIsInstance(indices.search_path[2],
615
 
            plugin.PluginsHelpIndex)
 
654
                              plugin.PluginsHelpIndex)
 
655
        # config options are a fourth index
 
656
        self.assertIsInstance(indices.search_path[3],
 
657
                              help_topics.ConfigOptionHelpIndex)
616
658
 
617
659
    def test_search_for_unknown_topic_raises(self):
618
660
        """Searching for an unknown topic should raise NoHelpTopic."""