1
# Copyright (C) 2006, 2007, 2009-2012, 2016 Canonical Ltd
1
# Copyright (C) 2005, 2006 by Canonical Ltd
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
18
18
"""Black-box tests for bzr help.
28
from bzrlib.tests.test_i18n import ZzzTranslations
31
class TestHelp(tests.TestCaseWithTransport):
22
from bzrlib.tests.blackbox import ExternalBase
25
class TestHelp(ExternalBase):
33
27
def test_help_basic(self):
34
28
for cmd in ['--help', 'help', '-h', '-?']:
35
output = self.run_bzr(cmd)[0]
29
output = self.runbzr(cmd)[0]
36
30
line1 = output.split('\n')[0]
37
if not line1.startswith('Bazaar'):
31
if not line1.startswith('Bazaar-NG'):
38
32
self.fail("bad output from bzr %s:\n%r" % (cmd, output))
39
33
# see https://launchpad.net/products/bzr/+bug/35940, -h doesn't work
41
def test_help_topics(self):
42
"""Smoketest for 'bzr help topics'"""
43
out, err = self.run_bzr('help topics')
44
self.assertContainsRe(out, 'basic')
45
self.assertContainsRe(out, 'topics')
46
self.assertContainsRe(out, 'commands')
47
self.assertContainsRe(out, 'revisionspec')
49
def test_help_revisionspec(self):
50
"""Smoke test for 'bzr help revisionspec'"""
51
out, err = self.run_bzr('help revisionspec')
52
self.assertContainsRe(out, 'revno:')
53
self.assertContainsRe(out, 'date:')
54
self.assertContainsRe(out, 'revid:')
55
self.assertContainsRe(out, 'last:')
56
self.assertContainsRe(out, 'before:')
57
self.assertContainsRe(out, 'ancestor:')
58
self.assertContainsRe(out, 'branch:')
60
def test_help_checkouts(self):
61
"""Smoke test for 'bzr help checkouts'"""
62
out, err = self.run_bzr('help checkouts')
63
self.assertContainsRe(out, 'checkout')
64
self.assertContainsRe(out, 'lightweight')
66
def test_help_urlspec(self):
67
"""Smoke test for 'bzr help urlspec'"""
68
out, err = self.run_bzr('help urlspec')
69
self.assertContainsRe(out, 'aftp://')
70
self.assertContainsRe(out, 'bzr://')
71
self.assertContainsRe(out, 'bzr\+ssh://')
72
self.assertContainsRe(out, 'file://')
73
self.assertContainsRe(out, 'ftp://')
74
self.assertContainsRe(out, 'http://')
75
self.assertContainsRe(out, 'https://')
76
self.assertContainsRe(out, 'sftp://')
78
def test_help_repositories(self):
79
"""Smoke test for 'bzr help repositories'"""
80
out, err = self.run_bzr('help repositories')
81
from bzrlib.help_topics import help_as_plain_text, _repositories
82
expected = help_as_plain_text(_repositories)
83
self.assertEqual(expected, out)
85
def test_help_working_trees(self):
86
"""Smoke test for 'bzr help working-trees'"""
87
out, err = self.run_bzr('help working-trees')
88
from bzrlib.help_topics import help_as_plain_text, _working_trees
89
expected = help_as_plain_text(_working_trees)
90
self.assertEqual(expected, out)
92
def test_help_status_flags(self):
93
"""Smoke test for 'bzr help status-flags'"""
94
out, err = self.run_bzr('help status-flags')
95
from bzrlib.help_topics import help_as_plain_text, _status_flags
96
expected = help_as_plain_text(_status_flags)
97
self.assertEqual(expected, out)
99
35
def test_help_commands(self):
100
dash_help = self.run_bzr('--help commands')[0]
101
commands = self.run_bzr('help commands')[0]
102
hidden = self.run_bzr('help hidden-commands')[0]
103
long_help = self.run_bzr('help --long')[0]
104
qmark_long = self.run_bzr('? --long')[0]
105
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)
111
def test_help_width_zero(self):
112
self.overrideEnv('BZR_COLUMNS', '0')
113
self.run_bzr('help commands')
115
def test_hidden(self):
116
help_commands = self.run_bzr('help commands')[0]
117
help_hidden = self.run_bzr('help hidden-commands')[0]
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
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]
131
commands = extract_cmd_names(help_commands)
132
hidden = extract_cmd_names(help_hidden)
133
self.assertTrue('commit' in commands)
134
self.assertTrue('commit' not in hidden)
135
self.assertTrue('rocks' in hidden)
136
self.assertTrue('rocks' not in commands)
36
dash_help = self.runbzr('--help commands')[0]
37
commands = self.runbzr('help commands')[0]
38
long_help = self.runbzr('help --long')[0]
39
qmark_long = self.runbzr('? --long')[0]
40
qmark_cmds = self.runbzr('? commands')[0]
41
self.assertEquals(dash_help, commands)
42
self.assertEquals(dash_help, long_help)
43
self.assertEquals(dash_help, qmark_long)
44
self.assertEquals(dash_help, qmark_cmds)
138
46
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:")
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:")
47
dash_h = self.runbzr('commit -h')[0]
48
help_x = self.runbzr('help commit')[0]
49
qmark_x = self.runbzr('help commit')[0]
50
self.assertEquals(dash_h, help_x)
51
self.assertEquals(dash_h, qmark_x)
160
53
def test_help_help(self):
161
help = self.run_bzr('help help')[0]
162
qmark = self.run_bzr('? ?')[0]
163
self.assertEqual(help, qmark)
54
help = self.runbzr('help help')[0]
55
qmark = self.runbzr('? ?')[0]
56
self.assertEquals(help, qmark)
164
57
for line in help.split('\n'):
165
58
if '--long' in line:
166
self.assertContainsRe(line,
167
r'Show help on all commands\.')
169
def test_help_with_aliases(self):
170
original = self.run_bzr('help cat')[0]
172
conf = config.GlobalConfig.from_string('''[ALIASES]
177
expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
178
self.assertEqual(expected, self.run_bzr('help cat')[0])
180
self.assertEqual("'bzr c' is an alias for 'bzr cat'.\n",
181
self.run_bzr('help c')[0])
184
class TestTranslatedHelp(tests.TestCaseWithTransport):
185
"""Tests for display of translated help topics"""
188
super(TestTranslatedHelp, self).setUp()
189
self.overrideAttr(i18n, '_translations', ZzzTranslations())
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:")
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:")
199
def test_help_command_ascii(self):
200
out, err = self.run_bzr(["help", "push"], encoding="ascii")
201
self.assertContainsRe(out, "zz\\?{{:See also:")
203
def test_help_switch_ascii(self):
204
out, err = self.run_bzr(["push", "--help"], encoding="ascii")
205
self.assertContainsRe(out, "zz\\?{{:See also:")
59
self.assertTrue('show help on all commands' in line)