← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

  • Committer: Robert Collins
  • Date: 2009-07-07 04:32:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4524.
  • Revision ID: robertc@robertcollins.net-20090707043213-4hjjhgr40iq7gk2d
More informative assertions in xml serialisation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_help.py
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
"""Unit tests for the bzrlib.help module."""
18
18
 
29
29
    )
30
30
 
31
31
 
 
32
class TestHelp(tests.TestCase):
 
33
 
 
34
    def setUp(self):
 
35
        tests.TestCase.setUp(self)
 
36
        commands.install_bzr_command_hooks()
 
37
 
 
38
 
32
39
class TestCommandHelp(tests.TestCase):
33
40
    """Tests for help on commands."""
34
41
 
40
47
        helptext = cmd.get_help_text()
41
48
        self.assertEndsWith(
42
49
            helptext,
43
 
            '  -h, --help  Show help message.\n'
 
50
            '  -v, --verbose  Display more information.\n'
 
51
            '  -q, --quiet    Only display errors and warnings.\n'
 
52
            '  -h, --help     Show help message.\n'
44
53
            '\n'
45
54
            'See also: bar, foo\n')
46
55
 
50
59
            """A sample command."""
51
60
        cmd = cmd_Demo()
52
61
        helptext = cmd.get_help_text()
53
 
        self.assertStartsWith(helptext, 'usage: bzr Demo')
54
 
        self.assertEndsWith(helptext, 'Show help message.\n')
 
62
        self.assertStartsWith(helptext,
 
63
            'Purpose: A sample command.\n'
 
64
            'Usage:   bzr Demo')
 
65
        self.assertEndsWith(helptext,
 
66
            '  -h, --help     Show help message.\n\n')
55
67
 
56
68
    def test_command_with_additional_see_also(self):
57
69
        class cmd_WithSeeAlso(commands.Command):
61
73
        helptext = cmd.get_help_text(['gam'])
62
74
        self.assertEndsWith(
63
75
            helptext,
64
 
            '  -h, --help  Show help message.\n'
 
76
            '  -v, --verbose  Display more information.\n'
 
77
            '  -q, --quiet    Only display errors and warnings.\n'
 
78
            '  -h, --help     Show help message.\n'
65
79
            '\n'
66
80
            'See also: bar, foo, gam\n')
67
81
 
72
86
        helptext = cmd.get_help_text(['gam'])
73
87
        self.assertEndsWith(
74
88
            helptext,
75
 
            '  -h, --help  Show help message.\n'
 
89
            '  -v, --verbose  Display more information.\n'
 
90
            '  -q, --quiet    Only display errors and warnings.\n'
 
91
            '  -h, --help     Show help message.\n'
76
92
            '\n'
77
93
            'See also: gam\n')
78
94
 
82
98
            """A sample command."""
83
99
        cmd = cmd_foo_bar()
84
100
        self.assertEqual(cmd.name(), cmd.get_help_topic())
85
 
    
86
 
 
87
 
class TestRegisteredTopic(tests.TestCase):
 
101
 
 
102
    def test_formatted_help_text(self):
 
103
        """Help text should be plain text by default."""
 
104
        class cmd_Demo(commands.Command):
 
105
            """A sample command.
 
106
 
 
107
            :Examples:
 
108
                Example 1::
 
109
 
 
110
                    cmd arg1
 
111
 
 
112
                Example 2::
 
113
 
 
114
                    cmd arg2
 
115
            """
 
116
        cmd = cmd_Demo()
 
117
        helptext = cmd.get_help_text()
 
118
        self.assertEquals(
 
119
            helptext,
 
120
            'Purpose: A sample command.\n'
 
121
            'Usage:   bzr Demo\n'
 
122
            '\n'
 
123
            'Options:\n'
 
124
            '  --usage        Show usage message and options.\n'
 
125
            '  -v, --verbose  Display more information.\n'
 
126
            '  -q, --quiet    Only display errors and warnings.\n'
 
127
            '  -h, --help     Show help message.\n'
 
128
            '\n'
 
129
            'Examples:\n'
 
130
            '    Example 1:\n'
 
131
            '\n'
 
132
            '        cmd arg1\n'
 
133
            '\n'
 
134
            '    Example 2:\n'
 
135
            '\n'
 
136
            '        cmd arg2\n'
 
137
            '\n')
 
138
        helptext = cmd.get_help_text(plain=False)
 
139
        self.assertEquals(helptext,
 
140
            ':Purpose: A sample command.\n'
 
141
            ':Usage:   bzr Demo\n'
 
142
            '\n'
 
143
            ':Options:\n'
 
144
            '  --usage        Show usage message and options.\n'
 
145
            '  -v, --verbose  Display more information.\n'
 
146
            '  -q, --quiet    Only display errors and warnings.\n'
 
147
            '  -h, --help     Show help message.\n'
 
148
            '\n'
 
149
            ':Examples:\n'
 
150
            '    Example 1::\n'
 
151
            '\n'
 
152
            '        cmd arg1\n'
 
153
            '\n'
 
154
            '    Example 2::\n'
 
155
            '\n'
 
156
            '        cmd arg2\n'
 
157
            '\n')
 
158
 
 
159
    def test_concise_help_text(self):
 
160
        """Concise help text excludes the descriptive sections."""
 
161
        class cmd_Demo(commands.Command):
 
162
            """A sample command.
 
163
 
 
164
            Blah blah blah.
 
165
 
 
166
            :Examples:
 
167
                Example 1::
 
168
 
 
169
                    cmd arg1
 
170
            """
 
171
        cmd = cmd_Demo()
 
172
        helptext = cmd.get_help_text()
 
173
        self.assertEqualDiff(
 
174
            helptext,
 
175
            'Purpose: A sample command.\n'
 
176
            'Usage:   bzr Demo\n'
 
177
            '\n'
 
178
            'Options:\n'
 
179
            '  --usage        Show usage message and options.\n'
 
180
            '  -v, --verbose  Display more information.\n'
 
181
            '  -q, --quiet    Only display errors and warnings.\n'
 
182
            '  -h, --help     Show help message.\n'
 
183
            '\n'
 
184
            'Description:\n'
 
185
            '  Blah blah blah.\n'
 
186
            '\n'
 
187
            'Examples:\n'
 
188
            '    Example 1:\n'
 
189
            '\n'
 
190
            '        cmd arg1\n'
 
191
            '\n')
 
192
        helptext = cmd.get_help_text(verbose=False)
 
193
        self.assertEquals(helptext,
 
194
            'Purpose: A sample command.\n'
 
195
            'Usage:   bzr Demo\n'
 
196
            '\n'
 
197
            'Options:\n'
 
198
            '  --usage        Show usage message and options.\n'
 
199
            '  -v, --verbose  Display more information.\n'
 
200
            '  -q, --quiet    Only display errors and warnings.\n'
 
201
            '  -h, --help     Show help message.\n'
 
202
            '\n'
 
203
            'See bzr help Demo for more details and examples.\n'
 
204
            '\n')
 
205
 
 
206
    def test_help_custom_section_ordering(self):
 
207
        """Custom descriptive sections should remain in the order given."""
 
208
        class cmd_Demo(commands.Command):
 
209
            """A sample command.
 
210
 
 
211
            Blah blah blah.
 
212
 
 
213
            :Formats:
 
214
              Interesting stuff about formats.
 
215
 
 
216
            :Examples:
 
217
              Example 1::
 
218
 
 
219
                cmd arg1
 
220
 
 
221
            :Tips:
 
222
              Clever things to keep in mind.
 
223
            """
 
224
        cmd = cmd_Demo()
 
225
        helptext = cmd.get_help_text()
 
226
        self.assertEqualDiff(
 
227
            helptext,
 
228
            'Purpose: A sample command.\n'
 
229
            'Usage:   bzr Demo\n'
 
230
            '\n'
 
231
            'Options:\n'
 
232
            '  --usage        Show usage message and options.\n'
 
233
            '  -v, --verbose  Display more information.\n'
 
234
            '  -q, --quiet    Only display errors and warnings.\n'
 
235
            '  -h, --help     Show help message.\n'
 
236
            '\n'
 
237
            'Description:\n'
 
238
            '  Blah blah blah.\n'
 
239
            '\n'
 
240
            'Formats:\n'
 
241
            '  Interesting stuff about formats.\n'
 
242
            '\n'
 
243
            'Examples:\n'
 
244
            '  Example 1:\n'
 
245
            '\n'
 
246
            '    cmd arg1\n'
 
247
            '\n'
 
248
            'Tips:\n'
 
249
            '  Clever things to keep in mind.\n'
 
250
            '\n')
 
251
 
 
252
    def test_help_text_custom_usage(self):
 
253
        """Help text may contain a custom usage section."""
 
254
        class cmd_Demo(commands.Command):
 
255
            """A sample command.
 
256
 
 
257
            :Usage:
 
258
                cmd Demo [opts] args
 
259
 
 
260
                cmd Demo -h
 
261
 
 
262
            Blah blah blah.
 
263
            """
 
264
        cmd = cmd_Demo()
 
265
        helptext = cmd.get_help_text()
 
266
        self.assertEquals(helptext,
 
267
            'Purpose: A sample command.\n'
 
268
            'Usage:\n'
 
269
            '    cmd Demo [opts] args\n'
 
270
            '\n'
 
271
            '    cmd Demo -h\n'
 
272
            '\n'
 
273
            '\n'
 
274
            'Options:\n'
 
275
            '  --usage        Show usage message and options.\n'
 
276
            '  -v, --verbose  Display more information.\n'
 
277
            '  -q, --quiet    Only display errors and warnings.\n'
 
278
            '  -h, --help     Show help message.\n'
 
279
            '\n'
 
280
            'Description:\n'
 
281
            '  Blah blah blah.\n\n')
 
282
 
 
283
 
 
284
class TestRegisteredTopic(TestHelp):
88
285
    """Tests for the RegisteredTopic class."""
89
286
 
90
287
    def test_contruct(self):
91
288
        """Construction takes the help topic name for the registered item."""
92
 
        # validate our test 
 
289
        # validate our test
93
290
        self.assertTrue('basic' in help_topics.topic_registry)
94
291
        topic = help_topics.RegisteredTopic('basic')
95
292
        self.assertEqual('basic', topic.topic)
107
304
            '\n'
108
305
            'See also: bar, foo\n')
109
306
 
 
307
    def test_get_help_text_loaded_from_file(self):
 
308
        # Pick a known topic stored in an external file
 
309
        topic = help_topics.RegisteredTopic('authentication')
 
310
        self.assertStartsWith(topic.get_help_text(),
 
311
            'Authentication Settings\n'
 
312
            '=======================\n'
 
313
            '\n')
 
314
 
110
315
    def test_get_help_topic(self):
111
316
        """The help topic for a RegisteredTopic is its topic from construction."""
112
317
        topic = help_topics.RegisteredTopic('foobar')
115
320
        self.assertEqual('baz', topic.get_help_topic())
116
321
 
117
322
 
118
 
class TestTopicIndex(tests.TestCase):
 
323
class TestTopicIndex(TestHelp):
119
324
    """Tests for the HelpTopicIndex class."""
120
325
 
121
326
    def test_default_constructable(self):
148
353
        self.assertEqual('', index.prefix)
149
354
 
150
355
 
151
 
class TestCommandIndex(tests.TestCase):
 
356
class TestCommandIndex(TestHelp):
152
357
    """Tests for the HelpCommandIndex class."""
153
358
 
154
359
    def test_default_constructable(self):