~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

  • Committer: Robert Collins
  • Date: 2007-04-19 04:54:08 UTC
  • mto: (2425.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 2427.
  • Revision ID: robertc@robertcollins.net-20070419045408-uvczw1fcfzprz7ep
``bzr help`` now provides cross references to other help topics using the
_see_also facility on command classes. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Unit tests for the bzrlib.help module."""
 
18
 
 
19
from cStringIO import StringIO
 
20
 
 
21
from bzrlib import (
 
22
    commands,
 
23
    help,
 
24
    tests,
 
25
    )
 
26
 
 
27
 
 
28
class TestCommandHelp(tests.TestCase):
 
29
    """Tests for help on commands."""
 
30
 
 
31
    def test_command_help_includes_see_also(self):
 
32
        class cmd_WithSeeAlso(commands.Command):
 
33
            """A sample command."""
 
34
            _see_also = ['foo', 'bar']
 
35
        cmd = cmd_WithSeeAlso()
 
36
        helpfile = StringIO()
 
37
        help.help_on_command_object(cmd, 'cmd_sample', helpfile)
 
38
        self.assertEqual('usage: bzr WithSeeAlso\n'
 
39
            '\n'
 
40
            'A sample command.\n'
 
41
            '\n'
 
42
            'Options:\n'
 
43
            '  -h, --help  show help message\n'
 
44
            '\n'
 
45
            'See also: bar, foo\n',
 
46
            helpfile.getvalue())