~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2009, 2010, 2011 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Black-box tests for bzr help.
20
20
 
21
21
 
22
22
import bzrlib
23
 
from bzrlib.tests.blackbox import ExternalBase
24
 
from bzrlib.config import (ensure_config_dir_exists, config_filename)
25
 
 
26
 
 
27
 
class TestHelp(ExternalBase):
 
23
from bzrlib import config
 
24
from bzrlib.tests import TestCaseWithTransport
 
25
 
 
26
 
 
27
class TestHelp(TestCaseWithTransport):
28
28
 
29
29
    def test_help_basic(self):
30
30
        for cmd in ['--help', 'help', '-h', '-?']:
58
58
        out, err = self.run_bzr('help checkouts')
59
59
        self.assertContainsRe(out, 'checkout')
60
60
        self.assertContainsRe(out, 'lightweight')
61
 
        
 
61
 
62
62
    def test_help_urlspec(self):
63
63
        """Smoke test for 'bzr help urlspec'"""
64
64
        out, err = self.run_bzr('help urlspec')
104
104
        self.assertEquals(dash_help, qmark_long)
105
105
        self.assertEquals(dash_help, qmark_cmds)
106
106
 
 
107
    def test_help_width_zero(self):
 
108
        self.overrideEnv('BZR_COLUMNS', '0')
 
109
        self.run_bzr('help commands')
 
110
 
107
111
    def test_hidden(self):
108
 
        commands = self.run_bzr('help commands')[0]
109
 
        hidden = self.run_bzr('help hidden-commands')[0]
 
112
        help_commands = self.run_bzr('help commands')[0]
 
113
        help_hidden = self.run_bzr('help hidden-commands')[0]
 
114
 
 
115
        def extract_cmd_names(help_output):
 
116
            # keep only the command names to avoid matching on help text (there
 
117
            # is a high risk to fail a test when a plugin get installed
 
118
            # otherwise)
 
119
            cmds = []
 
120
            for line in help_output.split('\n'):
 
121
                if line.startswith(' '):
 
122
                    continue # help on more than one line
 
123
                cmd = line.split(' ')[0]
 
124
                if line:
 
125
                    cmds.append(cmd)
 
126
            return cmds
 
127
        commands = extract_cmd_names(help_commands)
 
128
        hidden = extract_cmd_names(help_hidden)
110
129
        self.assertTrue('commit' in commands)
111
130
        self.assertTrue('commit' not in hidden)
112
131
        self.assertTrue('rocks' in hidden)
113
132
        self.assertTrue('rocks' not in commands)
114
133
 
115
134
    def test_help_detail(self):
116
 
        dash_h  = self.run_bzr('commit -h')[0]
117
 
        help_x  = self.run_bzr('help commit')[0]
118
 
        qmark_x = self.run_bzr('help commit')[0]
 
135
        dash_h  = self.run_bzr('diff -h')[0]
 
136
        help_x  = self.run_bzr('help diff')[0]
119
137
        self.assertEquals(dash_h, help_x)
120
 
        self.assertEquals(dash_h, qmark_x)
 
138
        self.assertContainsRe(help_x, "Purpose:")
 
139
        self.assertContainsRe(help_x, "Usage:")
 
140
        self.assertContainsRe(help_x, "Options:")
 
141
        self.assertContainsRe(help_x, "Description:")
 
142
        self.assertContainsRe(help_x, "Examples:")
 
143
        self.assertContainsRe(help_x, "See also:")
 
144
        self.assertContainsRe(help_x, "Aliases:")
 
145
 
 
146
    def test_help_usage(self):
 
147
        usage  = self.run_bzr('diff --usage')[0]
 
148
        self.assertContainsRe(usage, "Purpose:")
 
149
        self.assertContainsRe(usage, "Usage:")
 
150
        self.assertContainsRe(usage, "Options:")
 
151
        self.assertNotContainsRe(usage, "Description:")
 
152
        self.assertNotContainsRe(usage, "Examples:")
 
153
        self.assertContainsRe(usage, "See also:")
 
154
        self.assertContainsRe(usage, "Aliases:")
121
155
 
122
156
    def test_help_help(self):
123
157
        help = self.run_bzr('help help')[0]
131
165
    def test_help_with_aliases(self):
132
166
        original = self.run_bzr('help cat')[0]
133
167
 
134
 
        ensure_config_dir_exists()
135
 
        CONFIG=("[ALIASES]\n"
136
 
        "c=cat\n"
137
 
        "cat=cat\n")
138
 
 
139
 
        open(config_filename(),'wb').write(CONFIG)
 
168
        conf = config.GlobalConfig.from_string('''[ALIASES]
 
169
c=cat
 
170
cat=cat
 
171
''', save=True)
140
172
 
141
173
        expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
142
174
        self.assertEqual(expected, self.run_bzr('help cat')[0])