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
18
18
"""Black-box tests for bzr help.
22
23
from bzrlib.tests.blackbox import ExternalBase
24
from bzrlib.config import (ensure_config_dir_exists, config_filename)
25
27
class TestHelp(ExternalBase):
27
29
def test_help_basic(self):
28
30
for cmd in ['--help', 'help', '-h', '-?']:
29
output = self.runbzr(cmd)[0]
31
output = self.run_bzr(cmd)[0]
30
32
line1 = output.split('\n')[0]
31
33
if not line1.startswith('Bazaar'):
32
34
self.fail("bad output from bzr %s:\n%r" % (cmd, output))
54
56
def test_help_checkouts(self):
55
57
"""Smoke test for 'bzr help checkouts'"""
56
out, err = self.runbzr('help checkouts')
58
out, err = self.run_bzr('help checkouts')
57
59
self.assertContainsRe(out, 'checkout')
58
60
self.assertContainsRe(out, 'lightweight')
62
def test_help_urlspec(self):
63
"""Smoke test for 'bzr help urlspec'"""
64
out, err = self.run_bzr('help urlspec')
65
self.assertContainsRe(out, 'aftp://')
66
self.assertContainsRe(out, 'bzr://')
67
self.assertContainsRe(out, 'bzr\+ssh://')
68
self.assertContainsRe(out, 'file://')
69
self.assertContainsRe(out, 'ftp://')
70
self.assertContainsRe(out, 'http://')
71
self.assertContainsRe(out, 'https://')
72
self.assertContainsRe(out, 'sftp://')
74
def test_help_repositories(self):
75
"""Smoke test for 'bzr help repositories'"""
76
out, err = self.run_bzr('help repositories')
77
from bzrlib.help_topics import help_as_plain_text, _repositories
78
expected = help_as_plain_text(_repositories)
79
self.assertEqual(expected, out)
81
def test_help_working_trees(self):
82
"""Smoke test for 'bzr help working-trees'"""
83
out, err = self.run_bzr('help working-trees')
84
from bzrlib.help_topics import help_as_plain_text, _working_trees
85
expected = help_as_plain_text(_working_trees)
86
self.assertEqual(expected, out)
88
def test_help_status_flags(self):
89
"""Smoke test for 'bzr help status-flags'"""
90
out, err = self.run_bzr('help status-flags')
91
from bzrlib.help_topics import help_as_plain_text, _status_flags
92
expected = help_as_plain_text(_status_flags)
93
self.assertEqual(expected, out)
60
95
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]
96
dash_help = self.run_bzr('--help commands')[0]
97
commands = self.run_bzr('help commands')[0]
98
hidden = self.run_bzr('help hidden-commands')[0]
99
long_help = self.run_bzr('help --long')[0]
100
qmark_long = self.run_bzr('? --long')[0]
101
qmark_cmds = self.run_bzr('? commands')[0]
67
102
self.assertEquals(dash_help, commands)
68
103
self.assertEquals(dash_help, long_help)
69
104
self.assertEquals(dash_help, qmark_long)
70
105
self.assertEquals(dash_help, qmark_cmds)
72
107
def test_hidden(self):
73
commands = self.runbzr('help commands')[0]
74
hidden = self.runbzr('help hidden-commands')[0]
108
commands = self.run_bzr('help commands')[0]
109
hidden = self.run_bzr('help hidden-commands')[0]
75
110
self.assertTrue('commit' in commands)
76
111
self.assertTrue('commit' not in hidden)
77
112
self.assertTrue('rocks' in hidden)
78
113
self.assertTrue('rocks' not in commands)
80
115
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]
116
dash_h = self.run_bzr('diff -h')[0]
117
help_x = self.run_bzr('help diff')[0]
84
118
self.assertEquals(dash_h, help_x)
85
self.assertEquals(dash_h, qmark_x)
119
self.assertContainsRe(help_x, "Purpose:")
120
self.assertContainsRe(help_x, "Usage:")
121
self.assertContainsRe(help_x, "Options:")
122
self.assertContainsRe(help_x, "Description:")
123
self.assertContainsRe(help_x, "Examples:")
124
self.assertContainsRe(help_x, "See also:")
125
self.assertContainsRe(help_x, "Aliases:")
127
def test_help_usage(self):
128
usage = self.run_bzr('diff --usage')[0]
129
self.assertContainsRe(usage, "Purpose:")
130
self.assertContainsRe(usage, "Usage:")
131
self.assertContainsRe(usage, "Options:")
132
self.assertNotContainsRe(usage, "Description:")
133
self.assertNotContainsRe(usage, "Examples:")
134
self.assertContainsRe(usage, "See also:")
135
self.assertContainsRe(usage, "Aliases:")
87
137
def test_help_help(self):
88
help = self.runbzr('help help')[0]
89
qmark = self.runbzr('? ?')[0]
138
help = self.run_bzr('help help')[0]
139
qmark = self.run_bzr('? ?')[0]
90
140
self.assertEquals(help, qmark)
91
141
for line in help.split('\n'):
92
142
if '--long' in line:
93
self.assertTrue('show help on all commands' in line)
143
self.assertContainsRe(line,
144
r'Show help on all commands\.')
146
def test_help_with_aliases(self):
147
original = self.run_bzr('help cat')[0]
149
ensure_config_dir_exists()
150
CONFIG=("[ALIASES]\n"
154
open(config_filename(),'wb').write(CONFIG)
156
expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
157
self.assertEqual(expected, self.run_bzr('help cat')[0])
159
self.assertEqual("'bzr c' is an alias for 'bzr cat'.\n",
160
self.run_bzr('help c')[0])