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.
23
from bzrlib import config
24
from bzrlib.tests import TestCaseWithTransport
27
class TestHelp(TestCaseWithTransport):
23
from bzrlib.tests.blackbox import ExternalBase
24
from bzrlib.config import (ensure_config_dir_exists, config_filename)
27
class TestHelp(ExternalBase):
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')
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)
107
def test_help_width_zero(self):
108
self.overrideEnv('BZR_COLUMNS', '0')
109
self.run_bzr('help commands')
111
107
def test_hidden(self):
112
help_commands = self.run_bzr('help commands')[0]
113
help_hidden = self.run_bzr('help hidden-commands')[0]
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
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]
127
commands = extract_cmd_names(help_commands)
128
hidden = extract_cmd_names(help_hidden)
108
commands = self.run_bzr('help commands')[0]
109
hidden = self.run_bzr('help hidden-commands')[0]
129
110
self.assertTrue('commit' in commands)
130
111
self.assertTrue('commit' not in hidden)
131
112
self.assertTrue('rocks' in hidden)
132
113
self.assertTrue('rocks' not in commands)
134
115
def test_help_detail(self):
135
dash_h = self.run_bzr('diff -h')[0]
136
help_x = self.run_bzr('help diff')[0]
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]
137
119
self.assertEquals(dash_h, help_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:")
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:")
120
self.assertEquals(dash_h, qmark_x)
156
122
def test_help_help(self):
157
123
help = self.run_bzr('help help')[0]
165
131
def test_help_with_aliases(self):
166
132
original = self.run_bzr('help cat')[0]
168
conf = config.GlobalConfig.from_string('''[ALIASES]
134
ensure_config_dir_exists()
135
CONFIG=("[ALIASES]\n"
139
open(config_filename(),'wb').write(CONFIG)
173
141
expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
174
142
self.assertEqual(expected, self.run_bzr('help cat')[0])