← 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: John Arbash Meinel
  • Date: 2013-06-24 12:03:12 UTC
  • mfrom: (6437.77.2 2.5)
  • mto: This revision was merged to the branch mainline in revision 6579.
  • Revision ID: john@arbash-meinel.com-20130624120312-pmvck24x052csigx
Merge lp:bzr/2.5 r6515 to get the fix for bug #855155 (Dirstate.update_basis_by_delta)

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
from bzrlib import (
 
23
    config,
 
24
    i18n,
 
25
    tests,
 
26
    )
 
27
 
 
28
from bzrlib.tests.test_i18n import ZzzTranslations
 
29
 
 
30
 
 
31
class TestHelp(tests.TestCaseWithTransport):
26
32
 
27
33
    def test_help_basic(self):
28
34
        for cmd in ['--help', 'help', '-h', '-?']:
29
 
            output = self.runbzr(cmd)[0]
 
35
            output = self.run_bzr(cmd)[0]
30
36
            line1 = output.split('\n')[0]
31
37
            if not line1.startswith('Bazaar'):
32
38
                self.fail("bad output from bzr %s:\n%r" % (cmd, output))
34
40
 
35
41
    def test_help_topics(self):
36
42
        """Smoketest for 'bzr help topics'"""
37
 
        out, err = self.run_bzr('help', 'topics')
 
43
        out, err = self.run_bzr('help topics')
38
44
        self.assertContainsRe(out, 'basic')
39
45
        self.assertContainsRe(out, 'topics')
40
46
        self.assertContainsRe(out, 'commands')
42
48
 
43
49
    def test_help_revisionspec(self):
44
50
        """Smoke test for 'bzr help revisionspec'"""
45
 
        out, err = self.run_bzr('help', 'revisionspec')
 
51
        out, err = self.run_bzr('help revisionspec')
46
52
        self.assertContainsRe(out, 'revno:')
47
53
        self.assertContainsRe(out, 'date:')
48
54
        self.assertContainsRe(out, 'revid:')
53
59
 
54
60
    def test_help_checkouts(self):
55
61
        """Smoke test for 'bzr help checkouts'"""
56
 
        out, err = self.runbzr('help checkouts')
 
62
        out, err = self.run_bzr('help checkouts')
57
63
        self.assertContainsRe(out, 'checkout')
58
64
        self.assertContainsRe(out, 'lightweight')
59
 
        
 
65
 
60
66
    def test_help_urlspec(self):
61
67
        """Smoke test for 'bzr help urlspec'"""
62
 
        out, err = self.run_bzr('help', 'urlspec')
 
68
        out, err = self.run_bzr('help urlspec')
63
69
        self.assertContainsRe(out, 'aftp://')
64
70
        self.assertContainsRe(out, 'bzr://')
65
71
        self.assertContainsRe(out, 'bzr\+ssh://')
69
75
        self.assertContainsRe(out, 'https://')
70
76
        self.assertContainsRe(out, 'sftp://')
71
77
 
 
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)
 
84
 
 
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)
 
91
 
 
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)
 
98
 
72
99
    def test_help_commands(self):
73
 
        dash_help  = self.runbzr('--help commands')[0]
74
 
        commands   = self.runbzr('help commands')[0]
75
 
        hidden = self.runbzr('help hidden-commands')[0]
76
 
        long_help  = self.runbzr('help --long')[0]
77
 
        qmark_long = self.runbzr('? --long')[0]
78
 
        qmark_cmds = self.runbzr('? commands')[0]
 
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]
79
106
        self.assertEquals(dash_help, commands)
80
107
        self.assertEquals(dash_help, long_help)
81
108
        self.assertEquals(dash_help, qmark_long)
82
109
        self.assertEquals(dash_help, qmark_cmds)
83
110
 
 
111
    def test_help_width_zero(self):
 
112
        self.overrideEnv('BZR_COLUMNS', '0')
 
113
        self.run_bzr('help commands')
 
114
 
84
115
    def test_hidden(self):
85
 
        commands = self.runbzr('help commands')[0]
86
 
        hidden = self.runbzr('help hidden-commands')[0]
 
116
        help_commands = self.run_bzr('help commands')[0]
 
117
        help_hidden = self.run_bzr('help hidden-commands')[0]
 
118
 
 
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
 
122
            # otherwise)
 
123
            cmds = []
 
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]
 
128
                if line:
 
129
                    cmds.append(cmd)
 
130
            return cmds
 
131
        commands = extract_cmd_names(help_commands)
 
132
        hidden = extract_cmd_names(help_hidden)
87
133
        self.assertTrue('commit' in commands)
88
134
        self.assertTrue('commit' not in hidden)
89
135
        self.assertTrue('rocks' in hidden)
90
136
        self.assertTrue('rocks' not in commands)
91
137
 
92
138
    def test_help_detail(self):
93
 
        dash_h  = self.runbzr('commit -h')[0]
94
 
        help_x  = self.runbzr('help commit')[0]
95
 
        qmark_x = self.runbzr('help commit')[0]
 
139
        dash_h  = self.run_bzr('diff -h')[0]
 
140
        help_x  = self.run_bzr('help diff')[0]
96
141
        self.assertEquals(dash_h, help_x)
97
 
        self.assertEquals(dash_h, qmark_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:")
 
149
 
 
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:")
98
159
 
99
160
    def test_help_help(self):
100
 
        help = self.runbzr('help help')[0]
101
 
        qmark = self.runbzr('? ?')[0]
 
161
        help = self.run_bzr('help help')[0]
 
162
        qmark = self.run_bzr('? ?')[0]
102
163
        self.assertEquals(help, qmark)
103
164
        for line in help.split('\n'):
104
165
            if '--long' in line:
105
 
                self.assertTrue('show help on all commands' in line)
 
166
                self.assertContainsRe(line,
 
167
                    r'Show help on all commands\.')
 
168
 
 
169
    def test_help_with_aliases(self):
 
170
        original = self.run_bzr('help cat')[0]
 
171
 
 
172
        conf = config.GlobalConfig.from_string('''[ALIASES]
 
173
c=cat
 
174
cat=cat
 
175
''', save=True)
 
176
 
 
177
        expected = original + "'bzr cat' is an alias for 'bzr cat'.\n"
 
178
        self.assertEqual(expected, self.run_bzr('help cat')[0])
 
179
 
 
180
        self.assertEqual("'bzr c' is an alias for 'bzr cat'.\n",
 
181
                         self.run_bzr('help c')[0])
 
182
 
 
183
 
 
184
class TestTranslatedHelp(tests.TestCaseWithTransport):
 
185
    """Tests for display of translated help topics"""
 
186
 
 
187
    def setUp(self):
 
188
        super(TestTranslatedHelp, self).setUp()
 
189
        self.overrideAttr(i18n, '_translations', ZzzTranslations())
 
190
 
 
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:")
 
194
 
 
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:")
 
198
 
 
199
    def test_help_command_ascii(self):
 
200
        out, err = self.run_bzr(["help", "push"], encoding="ascii")
 
201
        self.assertContainsRe(out, "zz\\?{{:See also:")
 
202
 
 
203
    def test_help_switch_ascii(self):
 
204
        out, err = self.run_bzr(["push", "--help"], encoding="ascii")
 
205
        self.assertContainsRe(out, "zz\\?{{:See also:")