← 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: Jelmer Vernooij
  • Date: 2011-08-19 22:34:02 UTC
  • mto: This revision was merged to the branch mainline in revision 6089.
  • Revision ID: jelmer@samba.org-20110819223402-wjywqb0fa1xxx522
Use get_transport_from_{url,path} in more places.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/blackbox/test_help.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2009, 2010, 2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Black-box tests for bzr help.
19
19
"""
20
20
 
21
21
 
22
 
from bzrlib.tests.blackbox import ExternalBase
23
 
 
24
 
 
25
 
class TestHelp(ExternalBase):
 
22
import bzrlib
 
23
from bzrlib import config
 
24
from bzrlib.tests import TestCaseWithTransport
 
25
 
 
26
 
 
27
class TestHelp(TestCaseWithTransport):
26
28
 
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))
34
36
 
35
37
    def test_help_topics(self):
36
38
        """Smoketest for 'bzr help topics'"""
37
 
        out, err = self.run_bzr('help', 'topics')
 
39
        out, err = self.run_bzr('help topics')
38
40
        self.assertContainsRe(out, 'basic')
39
41
        self.assertContainsRe(out, 'topics')
40
42
        self.assertContainsRe(out, 'commands')
42
44
 
43
45
    def test_help_revisionspec(self):
44
46
        """Smoke test for 'bzr help revisionspec'"""
45
 
        out, err = self.run_bzr('help', 'revisionspec')
 
47
        out, err = self.run_bzr('help revisionspec')
46
48
        self.assertContainsRe(out, 'revno:')
47
49
        self.assertContainsRe(out, 'date:')
48
50
        self.assertContainsRe(out, 'revid:')
53
55
 
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')
59
61
 
 
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://')
 
73
 
 
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)
 
80
 
 
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)
 
87
 
 
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)
 
94
 
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)
71
106
 
 
107
    def test_help_width_zero(self):
 
108
        self.overrideEnv('BZR_COLUMNS', '0')
 
109
        self.run_bzr('help commands')
 
110
 
72
111
    def test_hidden(self):
73
 
        commands = self.runbzr('help commands')[0]
74
 
        hidden = self.runbzr('help hidden-commands')[0]
 
112
        help_commands = self.run_bzr('help commands')[0]
 
113
        help_hidden = self.run_bzr('help hidden-commands')[0]
 
114
 
 
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
 
118
            # otherwise)
 
119
            cmds = []
 
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]
 
124
                if line:
 
125
                    cmds.append(cmd)
 
126
            return cmds
 
127
        commands = extract_cmd_names(help_commands)
 
128
        hidden = extract_cmd_names(help_hidden)
75
129
        self.assertTrue('commit' in commands)
76
130
        self.assertTrue('commit' not in hidden)
77
131
        self.assertTrue('rocks' in hidden)
78
132
        self.assertTrue('rocks' not in commands)
79
133
 
80
134
    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]
 
135
        dash_h  = self.run_bzr('diff -h')[0]
 
136
        help_x  = self.run_bzr('help diff')[0]
84
137
        self.assertEquals(dash_h, help_x)
85
 
        self.assertEquals(dash_h, qmark_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:")
 
145
 
 
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:")
86
155
 
87
156
    def test_help_help(self):
88
 
        help = self.runbzr('help help')[0]
89
 
        qmark = self.runbzr('? ?')[0]
 
157
        help = self.run_bzr('help help')[0]
 
158
        qmark = self.run_bzr('? ?')[0]
90
159
        self.assertEquals(help, qmark)
91
160
        for line in help.split('\n'):
92
161
            if '--long' in line:
93
 
                self.assertTrue('show help on all commands' in line)
94
 
 
 
162
                self.assertContainsRe(line,
 
163
                    r'Show help on all commands\.')
 
164
 
 
165
    def test_help_with_aliases(self):
 
166
        original = self.run_bzr('help cat')[0]
 
167
 
 
168
        conf = config.GlobalConfig.from_string('''[ALIASES]
 
169
c=cat
 
170
cat=cat
 
171
''', save=True)
 
172
 
 
173
        expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
 
174
        self.assertEqual(expected, self.run_bzr('help cat')[0])
 
175
 
 
176
        self.assertEqual("'bzr c' is an alias for 'bzr cat'.\n",
 
177
                         self.run_bzr('help c')[0])