1
# Copyright (C) 2006, 2007, 2009-2012, 2016 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Black-box tests for brz help.
28
from breezy.tests.test_i18n import ZzzTranslations
31
class TestHelp(tests.TestCaseWithTransport):
33
def test_help_basic(self):
34
for cmd in ['--help', 'help', '-h', '-?']:
35
output = self.run_bzr(cmd)[0]
36
line1 = output.split('\n')[0]
37
if not line1.startswith('Breezy'):
38
self.fail("bad output from brz %s:\n%r" % (cmd, output))
39
# see https://launchpad.net/products/bzr/+bug/35940, -h doesn't work
41
def test_help_topics(self):
42
"""Smoketest for 'brz 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 'brz 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 'brz 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 'brz help urlspec'"""
68
out, err = self.run_bzr('help urlspec')
69
self.assertContainsRe(out, 'bzr://')
70
self.assertContainsRe(out, 'bzr\\+ssh://')
71
self.assertContainsRe(out, 'file://')
72
self.assertContainsRe(out, 'http://')
73
self.assertContainsRe(out, 'https://')
74
self.assertContainsRe(out, 'sftp://')
76
def test_help_repositories(self):
77
"""Smoke test for 'brz help repositories'"""
78
out, err = self.run_bzr('help repositories')
79
from breezy.help_topics import help_as_plain_text, _repositories
80
expected = help_as_plain_text(_repositories)
81
self.assertEqual(expected, out)
83
def test_help_working_trees(self):
84
"""Smoke test for 'brz help working-trees'"""
85
out, err = self.run_bzr('help working-trees')
86
from breezy.help_topics import help_as_plain_text, _working_trees
87
expected = help_as_plain_text(_working_trees)
88
self.assertEqual(expected, out)
90
def test_help_status_flags(self):
91
"""Smoke test for 'brz help status-flags'"""
92
out, err = self.run_bzr('help status-flags')
93
from breezy.help_topics import help_as_plain_text, _status_flags
94
expected = help_as_plain_text(_status_flags)
95
self.assertEqual(expected, out)
97
def test_help_commands(self):
98
dash_help = self.run_bzr('--help commands')[0]
99
commands = self.run_bzr('help commands')[0]
100
hidden = self.run_bzr('help hidden-commands')[0]
101
long_help = self.run_bzr('help --long')[0]
102
qmark_long = self.run_bzr('? --long')[0]
103
qmark_cmds = self.run_bzr('? commands')[0]
104
self.assertEqual(dash_help, commands)
105
self.assertEqual(dash_help, long_help)
106
self.assertEqual(dash_help, qmark_long)
107
self.assertEqual(dash_help, qmark_cmds)
109
def test_help_width_zero(self):
110
self.overrideEnv('BRZ_COLUMNS', '0')
111
self.run_bzr('help commands')
113
def test_hidden(self):
114
help_commands = self.run_bzr('help commands')[0]
115
help_hidden = self.run_bzr('help hidden-commands')[0]
117
def extract_cmd_names(help_output):
118
# keep only the command names to avoid matching on help text (there
119
# is a high risk to fail a test when a plugin get installed
122
for line in help_output.split('\n'):
123
if line.startswith(' '):
124
continue # help on more than one line
125
cmd = line.split(' ')[0]
129
commands = extract_cmd_names(help_commands)
130
hidden = extract_cmd_names(help_hidden)
131
self.assertTrue('commit' in commands)
132
self.assertTrue('commit' not in hidden)
133
self.assertTrue('rocks' in hidden)
134
self.assertTrue('rocks' not in commands)
136
def test_help_detail(self):
137
dash_h = self.run_bzr('diff -h')[0]
138
help_x = self.run_bzr('help diff')[0]
139
self.assertEqual(dash_h, help_x)
140
self.assertContainsRe(help_x, "Purpose:")
141
self.assertContainsRe(help_x, "Usage:")
142
self.assertContainsRe(help_x, "Options:")
143
self.assertContainsRe(help_x, "Description:")
144
self.assertContainsRe(help_x, "Examples:")
145
self.assertContainsRe(help_x, "See also:")
146
self.assertContainsRe(help_x, "Aliases:")
148
def test_help_usage(self):
149
usage = self.run_bzr('diff --usage')[0]
150
self.assertContainsRe(usage, "Purpose:")
151
self.assertContainsRe(usage, "Usage:")
152
self.assertContainsRe(usage, "Options:")
153
self.assertNotContainsRe(usage, "Description:")
154
self.assertNotContainsRe(usage, "Examples:")
155
self.assertContainsRe(usage, "See also:")
156
self.assertContainsRe(usage, "Aliases:")
158
def test_help_help(self):
159
help = self.run_bzr('help help')[0]
160
qmark = self.run_bzr('? ?')[0]
161
self.assertEqual(help, qmark)
162
for line in help.split('\n'):
164
self.assertContainsRe(line,
165
r'Show help on all commands\.')
167
def test_help_with_aliases(self):
168
original = self.run_bzr('help cat')[0]
170
conf = config.GlobalConfig.from_string('''[ALIASES]
175
expected = original + "'brz cat' is an alias for 'brz cat'.\n"
176
self.assertEqual(expected, self.run_bzr('help cat')[0])
178
self.assertEqual("'brz c' is an alias for 'brz cat'.\n",
179
self.run_bzr('help c')[0])
182
class TestTranslatedHelp(tests.TestCaseWithTransport):
183
"""Tests for display of translated help topics"""
186
super(TestTranslatedHelp, self).setUp()
187
self.overrideAttr(i18n, '_translations', ZzzTranslations())
189
def test_help_command_utf8(self):
190
out, err = self.run_bzr_raw(["help", "push"], encoding="utf-8")
191
self.assertContainsRe(out, b"zz\xc3\xa5{{:See also:")
193
def test_help_switch_utf8(self):
194
out, err = self.run_bzr_raw(["push", "--help"], encoding="utf-8")
195
self.assertContainsRe(out, b"zz\xc3\xa5{{:See also:")
197
def test_help_command_ascii(self):
198
out, err = self.run_bzr_raw(["help", "push"], encoding="ascii")
199
self.assertContainsRe(out, b"zz\\?{{:See also:")
201
def test_help_switch_ascii(self):
202
out, err = self.run_bzr_raw(["push", "--help"], encoding="ascii")
203
self.assertContainsRe(out, b"zz\\?{{:See also:")