← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/blackbox/test_help.py
1
 
# Copyright (C) 2006, 2007, 2009-2012, 2016 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
"""Black-box tests for bzr help.
19
19
"""
20
20
 
21
21
 
22
 
from bzrlib import (
23
 
    config,
24
 
    i18n,
25
 
    tests,
26
 
    )
27
 
 
28
 
from bzrlib.tests.test_i18n import ZzzTranslations
29
 
 
30
 
 
31
 
class TestHelp(tests.TestCaseWithTransport):
 
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):
32
28
 
33
29
    def test_help_basic(self):
34
30
        for cmd in ['--help', 'help', '-h', '-?']:
62
58
        out, err = self.run_bzr('help checkouts')
63
59
        self.assertContainsRe(out, 'checkout')
64
60
        self.assertContainsRe(out, 'lightweight')
65
 
 
 
61
        
66
62
    def test_help_urlspec(self):
67
63
        """Smoke test for 'bzr help urlspec'"""
68
64
        out, err = self.run_bzr('help urlspec')
103
99
        long_help  = self.run_bzr('help --long')[0]
104
100
        qmark_long = self.run_bzr('? --long')[0]
105
101
        qmark_cmds = self.run_bzr('? commands')[0]
106
 
        self.assertEqual(dash_help, commands)
107
 
        self.assertEqual(dash_help, long_help)
108
 
        self.assertEqual(dash_help, qmark_long)
109
 
        self.assertEqual(dash_help, qmark_cmds)
110
 
 
111
 
    def test_help_width_zero(self):
112
 
        self.overrideEnv('BZR_COLUMNS', '0')
113
 
        self.run_bzr('help commands')
 
102
        self.assertEquals(dash_help, commands)
 
103
        self.assertEquals(dash_help, long_help)
 
104
        self.assertEquals(dash_help, qmark_long)
 
105
        self.assertEquals(dash_help, qmark_cmds)
114
106
 
115
107
    def test_hidden(self):
116
 
        help_commands = self.run_bzr('help commands')[0]
117
 
        help_hidden = self.run_bzr('help hidden-commands')[0]
118
 
 
119
 
        def extract_cmd_names(help_output):
120
 
            # keep only the command names to avoid matching on help text (there
121
 
            # is a high risk to fail a test when a plugin get installed
122
 
            # otherwise)
123
 
            cmds = []
124
 
            for line in help_output.split('\n'):
125
 
                if line.startswith(' '):
126
 
                    continue # help on more than one line
127
 
                cmd = line.split(' ')[0]
128
 
                if line:
129
 
                    cmds.append(cmd)
130
 
            return cmds
131
 
        commands = extract_cmd_names(help_commands)
132
 
        hidden = extract_cmd_names(help_hidden)
 
108
        commands = self.run_bzr('help commands')[0]
 
109
        hidden = self.run_bzr('help hidden-commands')[0]
133
110
        self.assertTrue('commit' in commands)
134
111
        self.assertTrue('commit' not in hidden)
135
112
        self.assertTrue('rocks' in hidden)
136
113
        self.assertTrue('rocks' not in commands)
137
114
 
138
115
    def test_help_detail(self):
139
 
        dash_h  = self.run_bzr('diff -h')[0]
140
 
        help_x  = self.run_bzr('help diff')[0]
141
 
        self.assertEqual(dash_h, help_x)
142
 
        self.assertContainsRe(help_x, "Purpose:")
143
 
        self.assertContainsRe(help_x, "Usage:")
144
 
        self.assertContainsRe(help_x, "Options:")
145
 
        self.assertContainsRe(help_x, "Description:")
146
 
        self.assertContainsRe(help_x, "Examples:")
147
 
        self.assertContainsRe(help_x, "See also:")
148
 
        self.assertContainsRe(help_x, "Aliases:")
149
 
 
150
 
    def test_help_usage(self):
151
 
        usage  = self.run_bzr('diff --usage')[0]
152
 
        self.assertContainsRe(usage, "Purpose:")
153
 
        self.assertContainsRe(usage, "Usage:")
154
 
        self.assertContainsRe(usage, "Options:")
155
 
        self.assertNotContainsRe(usage, "Description:")
156
 
        self.assertNotContainsRe(usage, "Examples:")
157
 
        self.assertContainsRe(usage, "See also:")
158
 
        self.assertContainsRe(usage, "Aliases:")
 
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]
 
119
        self.assertEquals(dash_h, help_x)
 
120
        self.assertEquals(dash_h, qmark_x)
159
121
 
160
122
    def test_help_help(self):
161
123
        help = self.run_bzr('help help')[0]
162
124
        qmark = self.run_bzr('? ?')[0]
163
 
        self.assertEqual(help, qmark)
 
125
        self.assertEquals(help, qmark)
164
126
        for line in help.split('\n'):
165
127
            if '--long' in line:
166
128
                self.assertContainsRe(line,
169
131
    def test_help_with_aliases(self):
170
132
        original = self.run_bzr('help cat')[0]
171
133
 
172
 
        conf = config.GlobalConfig.from_string('''[ALIASES]
173
 
c=cat
174
 
cat=cat
175
 
''', save=True)
 
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)
176
140
 
177
141
        expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
178
142
        self.assertEqual(expected, self.run_bzr('help cat')[0])
179
143
 
180
144
        self.assertEqual("'bzr c' is an alias for 'bzr cat'.\n",
181
145
                         self.run_bzr('help c')[0])
182
 
 
183
 
 
184
 
class TestTranslatedHelp(tests.TestCaseWithTransport):
185
 
    """Tests for display of translated help topics"""
186
 
 
187
 
    def setUp(self):
188
 
        super(TestTranslatedHelp, self).setUp()
189
 
        self.overrideAttr(i18n, '_translations', ZzzTranslations())
190
 
 
191
 
    def test_help_command_utf8(self):
192
 
        out, err = self.run_bzr(["help", "push"], encoding="utf-8")
193
 
        self.assertContainsRe(out, "zz\xc3\xa5{{:See also:")
194
 
 
195
 
    def test_help_switch_utf8(self):
196
 
        out, err = self.run_bzr(["push", "--help"], encoding="utf-8")
197
 
        self.assertContainsRe(out, "zz\xc3\xa5{{:See also:")
198
 
 
199
 
    def test_help_command_ascii(self):
200
 
        out, err = self.run_bzr(["help", "push"], encoding="ascii")
201
 
        self.assertContainsRe(out, "zz\\?{{:See also:")
202
 
 
203
 
    def test_help_switch_ascii(self):
204
 
        out, err = self.run_bzr(["push", "--help"], encoding="ascii")
205
 
        self.assertContainsRe(out, "zz\\?{{:See also:")