← 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-02-25 21:13:22 UTC
  • mto: This revision was merged to the branch mainline in revision 4051.
  • Revision ID: john@arbash-meinel.com-20090225211322-qc94czk3s1g7nliq
Some direct tests for _group_keys_for_io

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
 
39
32
class TestCommandHelp(tests.TestCase):
40
33
    """Tests for help on commands."""
41
34
 
121
114
            'Usage:   bzr Demo\n'
122
115
            '\n'
123
116
            'Options:\n'
124
 
            '  --usage        Show usage message and options.\n'
125
117
            '  -v, --verbose  Display more information.\n'
126
118
            '  -q, --quiet    Only display errors and warnings.\n'
127
119
            '  -h, --help     Show help message.\n'
141
133
            ':Usage:   bzr Demo\n'
142
134
            '\n'
143
135
            ':Options:\n'
144
 
            '  --usage        Show usage message and options.\n'
145
136
            '  -v, --verbose  Display more information.\n'
146
137
            '  -q, --quiet    Only display errors and warnings.\n'
147
138
            '  -h, --help     Show help message.\n'
156
147
            '        cmd arg2\n'
157
148
            '\n')
158
149
 
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
150
    def test_help_text_custom_usage(self):
253
151
        """Help text may contain a custom usage section."""
254
152
        class cmd_Demo(commands.Command):
272
170
            '\n'
273
171
            '\n'
274
172
            'Options:\n'
275
 
            '  --usage        Show usage message and options.\n'
276
173
            '  -v, --verbose  Display more information.\n'
277
174
            '  -q, --quiet    Only display errors and warnings.\n'
278
175
            '  -h, --help     Show help message.\n'
281
178
            '  Blah blah blah.\n\n')
282
179
 
283
180
 
284
 
class TestRegisteredTopic(TestHelp):
 
181
class TestRegisteredTopic(tests.TestCase):
285
182
    """Tests for the RegisteredTopic class."""
286
183
 
287
184
    def test_contruct(self):
306
203
 
307
204
    def test_get_help_text_loaded_from_file(self):
308
205
        # Pick a known topic stored in an external file
309
 
        topic = help_topics.RegisteredTopic('authentication')
 
206
        topic = help_topics.RegisteredTopic('hooks')
310
207
        self.assertStartsWith(topic.get_help_text(),
311
 
            'Authentication Settings\n'
312
 
            '=======================\n'
 
208
            'Hooks\n'
 
209
            '=====\n'
313
210
            '\n')
314
211
 
315
212
    def test_get_help_topic(self):
320
217
        self.assertEqual('baz', topic.get_help_topic())
321
218
 
322
219
 
323
 
class TestTopicIndex(TestHelp):
 
220
class TestTopicIndex(tests.TestCase):
324
221
    """Tests for the HelpTopicIndex class."""
325
222
 
326
223
    def test_default_constructable(self):
353
250
        self.assertEqual('', index.prefix)
354
251
 
355
252
 
356
 
class TestCommandIndex(TestHelp):
 
253
class TestCommandIndex(tests.TestCase):
357
254
    """Tests for the HelpCommandIndex class."""
358
255
 
359
256
    def test_default_constructable(self):