← 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: John Arbash Meinel
  • Date: 2009-03-27 22:29:55 UTC
  • mto: (3735.39.2 clean)
  • mto: This revision was merged to the branch mainline in revision 4280.
  • Revision ID: john@arbash-meinel.com-20090327222955-utifmfm888zerixt
Implement apply_delta_to_source which doesn't have to malloc another string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_help.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007 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
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
 
 
39
32
class TestCommandHelp(tests.TestCase):
40
33
    """Tests for help on commands."""
41
34
 
42
35
    def test_command_help_includes_see_also(self):
43
36
        class cmd_WithSeeAlso(commands.Command):
44
 
            __doc__ = """A sample command."""
 
37
            """A sample command."""
45
38
            _see_also = ['foo', 'bar']
46
39
        cmd = cmd_WithSeeAlso()
47
40
        helptext = cmd.get_help_text()
56
49
    def test_get_help_text(self):
57
50
        """Commands have a get_help_text method which returns their help."""
58
51
        class cmd_Demo(commands.Command):
59
 
            __doc__ = """A sample command."""
 
52
            """A sample command."""
60
53
        cmd = cmd_Demo()
61
54
        helptext = cmd.get_help_text()
62
55
        self.assertStartsWith(helptext,
67
60
 
68
61
    def test_command_with_additional_see_also(self):
69
62
        class cmd_WithSeeAlso(commands.Command):
70
 
            __doc__ = """A sample command."""
 
63
            """A sample command."""
71
64
            _see_also = ['foo', 'bar']
72
65
        cmd = cmd_WithSeeAlso()
73
66
        helptext = cmd.get_help_text(['gam'])
81
74
 
82
75
    def test_command_only_additional_see_also(self):
83
76
        class cmd_WithSeeAlso(commands.Command):
84
 
            __doc__ = """A sample command."""
 
77
            """A sample command."""
85
78
        cmd = cmd_WithSeeAlso()
86
79
        helptext = cmd.get_help_text(['gam'])
87
80
        self.assertEndsWith(
95
88
    def test_get_help_topic(self):
96
89
        """The help topic for a Command is its name()."""
97
90
        class cmd_foo_bar(commands.Command):
98
 
            __doc__ = """A sample command."""
 
91
            """A sample command."""
99
92
        cmd = cmd_foo_bar()
100
93
        self.assertEqual(cmd.name(), cmd.get_help_topic())
101
94
 
102
95
    def test_formatted_help_text(self):
103
96
        """Help text should be plain text by default."""
104
97
        class cmd_Demo(commands.Command):
105
 
            __doc__ = """A sample command.
 
98
            """A sample command.
106
99
 
107
100
            :Examples:
108
101
                Example 1::
112
105
                Example 2::
113
106
 
114
107
                    cmd arg2
115
 
 
116
 
                A code block follows.
117
 
 
118
 
                ::
119
 
 
120
 
                    bzr Demo something
121
108
            """
122
109
        cmd = cmd_Demo()
123
110
        helptext = cmd.get_help_text()
140
127
            '    Example 2:\n'
141
128
            '\n'
142
129
            '        cmd arg2\n'
143
 
            '\n'
144
 
            '    A code block follows.\n'
145
 
            '\n'
146
 
            '        bzr Demo something\n'
147
130
            '\n')
148
131
        helptext = cmd.get_help_text(plain=False)
149
132
        self.assertEquals(helptext,
164
147
            '    Example 2::\n'
165
148
            '\n'
166
149
            '        cmd arg2\n'
167
 
            '\n'
168
 
            '    A code block follows.\n'
169
 
            '\n'
170
 
            '    ::\n'
171
 
            '\n'
172
 
            '        bzr Demo something\n'
173
150
            '\n')
174
151
 
175
152
    def test_concise_help_text(self):
176
153
        """Concise help text excludes the descriptive sections."""
177
154
        class cmd_Demo(commands.Command):
178
 
            __doc__ = """A sample command.
 
155
            """A sample command.
179
156
 
180
157
            Blah blah blah.
181
158
 
222
199
    def test_help_custom_section_ordering(self):
223
200
        """Custom descriptive sections should remain in the order given."""
224
201
        class cmd_Demo(commands.Command):
225
 
            __doc__ = """A sample command.
 
202
            """A sample command.
226
203
 
227
204
            Blah blah blah.
228
205
 
268
245
    def test_help_text_custom_usage(self):
269
246
        """Help text may contain a custom usage section."""
270
247
        class cmd_Demo(commands.Command):
271
 
            __doc__ = """A sample command.
 
248
            """A sample command.
272
249
 
273
250
            :Usage:
274
251
                cmd Demo [opts] args
297
274
            '  Blah blah blah.\n\n')
298
275
 
299
276
 
300
 
class TestRegisteredTopic(TestHelp):
 
277
class TestRegisteredTopic(tests.TestCase):
301
278
    """Tests for the RegisteredTopic class."""
302
279
 
303
280
    def test_contruct(self):
336
313
        self.assertEqual('baz', topic.get_help_topic())
337
314
 
338
315
 
339
 
class TestTopicIndex(TestHelp):
 
316
class TestTopicIndex(tests.TestCase):
340
317
    """Tests for the HelpTopicIndex class."""
341
318
 
342
319
    def test_default_constructable(self):
369
346
        self.assertEqual('', index.prefix)
370
347
 
371
348
 
372
 
class TestCommandIndex(TestHelp):
 
349
class TestCommandIndex(tests.TestCase):
373
350
    """Tests for the HelpCommandIndex class."""
374
351
 
375
352
    def test_default_constructable(self):