/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2425.2.2 by Robert Collins
``bzr help`` now provides cross references to other help topics using the
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,
2432.1.1 by Robert Collins
Add a HelpTopicContext object.
24
    help_topics,
2425.2.2 by Robert Collins
``bzr help`` now provides cross references to other help topics using the
25
    tests,
26
    )
27
28
29
class TestCommandHelp(tests.TestCase):
30
    """Tests for help on commands."""
31
32
    def test_command_help_includes_see_also(self):
33
        class cmd_WithSeeAlso(commands.Command):
34
            """A sample command."""
35
            _see_also = ['foo', 'bar']
36
        cmd = cmd_WithSeeAlso()
37
        helpfile = StringIO()
38
        help.help_on_command_object(cmd, 'cmd_sample', helpfile)
2425.1.3 by Robert Collins
Python 2.4 compatability change for the new help see-also tests.
39
        self.assertEndsWith(
40
            helpfile.getvalue(),
2425.2.2 by Robert Collins
``bzr help`` now provides cross references to other help topics using the
41
            '  -h, --help  show help message\n'
42
            '\n'
2425.1.3 by Robert Collins
Python 2.4 compatability change for the new help see-also tests.
43
            'See also: bar, foo\n')
2432.1.1 by Robert Collins
Add a HelpTopicContext object.
44
45
46
class TestTopicContext(tests.TestCase):
47
    """Tests for the HelpTopicContext object."""
48
49
    def test_construct(self):
50
        context = help_topics.HelpTopicContext()
51
2432.1.2 by Robert Collins
Add a HelpCommandContext class for help from commands.
52
53
class TestCommandContext(tests.TestCase):
54
    """Tests for the HelpCommandContext object."""
55
56
    def test_construct(self):
57
        context = commands.HelpCommandContext()