/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/blackbox/test_help.py

  • Committer: Robert Collins
  • Date: 2007-04-18 08:39:02 UTC
  • mto: (2425.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 2427.
  • Revision ID: robertc@robertcollins.net-20070418083902-4o66h9fk7zeisvwa
Command objects can now declare related help topics by having _see_also
set to a list of related topic. Updated the HACKING guide entry on
documentation to be more clear about how the help for commands is
generated and to reference this new feature. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 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
 
 
18
"""Black-box tests for bzr help.
 
19
"""
 
20
 
 
21
 
 
22
from bzrlib.tests.blackbox import ExternalBase
 
23
 
 
24
 
 
25
class TestHelp(ExternalBase):
 
26
 
 
27
    def test_help_basic(self):
 
28
        for cmd in ['--help', 'help', '-h', '-?']:
 
29
            output = self.runbzr(cmd)[0]
 
30
            line1 = output.split('\n')[0]
 
31
            if not line1.startswith('Bazaar'):
 
32
                self.fail("bad output from bzr %s:\n%r" % (cmd, output))
 
33
        # see https://launchpad.net/products/bzr/+bug/35940, -h doesn't work
 
34
 
 
35
    def test_help_topics(self):
 
36
        """Smoketest for 'bzr help topics'"""
 
37
        out, err = self.run_bzr('help', 'topics')
 
38
        self.assertContainsRe(out, 'basic')
 
39
        self.assertContainsRe(out, 'topics')
 
40
        self.assertContainsRe(out, 'commands')
 
41
        self.assertContainsRe(out, 'revisionspec')
 
42
 
 
43
    def test_help_revisionspec(self):
 
44
        """Smoke test for 'bzr help revisionspec'"""
 
45
        out, err = self.run_bzr('help', 'revisionspec')
 
46
        self.assertContainsRe(out, 'revno:')
 
47
        self.assertContainsRe(out, 'date:')
 
48
        self.assertContainsRe(out, 'revid:')
 
49
        self.assertContainsRe(out, 'last:')
 
50
        self.assertContainsRe(out, 'before:')
 
51
        self.assertContainsRe(out, 'ancestor:')
 
52
        self.assertContainsRe(out, 'branch:')
 
53
 
 
54
    def test_help_checkouts(self):
 
55
        """Smoke test for 'bzr help checkouts'"""
 
56
        out, err = self.runbzr('help checkouts')
 
57
        self.assertContainsRe(out, 'checkout')
 
58
        self.assertContainsRe(out, 'lightweight')
 
59
 
 
60
    def test_help_commands(self):
 
61
        dash_help  = self.runbzr('--help commands')[0]
 
62
        commands   = self.runbzr('help commands')[0]
 
63
        hidden = self.runbzr('help hidden-commands')[0]
 
64
        long_help  = self.runbzr('help --long')[0]
 
65
        qmark_long = self.runbzr('? --long')[0]
 
66
        qmark_cmds = self.runbzr('? commands')[0]
 
67
        self.assertEquals(dash_help, commands)
 
68
        self.assertEquals(dash_help, long_help)
 
69
        self.assertEquals(dash_help, qmark_long)
 
70
        self.assertEquals(dash_help, qmark_cmds)
 
71
 
 
72
    def test_hidden(self):
 
73
        commands = self.runbzr('help commands')[0]
 
74
        hidden = self.runbzr('help hidden-commands')[0]
 
75
        self.assertTrue('commit' in commands)
 
76
        self.assertTrue('commit' not in hidden)
 
77
        self.assertTrue('rocks' in hidden)
 
78
        self.assertTrue('rocks' not in commands)
 
79
 
 
80
    def test_help_detail(self):
 
81
        dash_h  = self.runbzr('commit -h')[0]
 
82
        help_x  = self.runbzr('help commit')[0]
 
83
        qmark_x = self.runbzr('help commit')[0]
 
84
        self.assertEquals(dash_h, help_x)
 
85
        self.assertEquals(dash_h, qmark_x)
 
86
 
 
87
    def test_help_help(self):
 
88
        help = self.runbzr('help help')[0]
 
89
        qmark = self.runbzr('? ?')[0]
 
90
        self.assertEquals(help, qmark)
 
91
        for line in help.split('\n'):
 
92
            if '--long' in line:
 
93
                self.assertTrue('show help on all commands' in line)
 
94