← 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: Vincent Ladeuil
  • Date: 2009-07-02 09:03:14 UTC
  • mto: (4536.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4537.
  • Revision ID: v.ladeuil+lp@free.fr-20090702090314-xzzq2108489y6l4g
Use config.get_user_option_as_bool().

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
 
96
103
        """Help text should be plain text by default."""
97
104
        class cmd_Demo(commands.Command):
98
105
            """A sample command.
99
 
 
 
106
 
100
107
            :Examples:
101
108
                Example 1::
102
 
 
 
109
 
103
110
                    cmd arg1
104
 
 
 
111
 
105
112
                Example 2::
106
 
 
 
113
 
107
114
                    cmd arg2
108
115
            """
109
116
        cmd = cmd_Demo()
114
121
            'Usage:   bzr Demo\n'
115
122
            '\n'
116
123
            'Options:\n'
 
124
            '  --usage        Show usage message and options.\n'
117
125
            '  -v, --verbose  Display more information.\n'
118
126
            '  -q, --quiet    Only display errors and warnings.\n'
119
127
            '  -h, --help     Show help message.\n'
133
141
            ':Usage:   bzr Demo\n'
134
142
            '\n'
135
143
            ':Options:\n'
 
144
            '  --usage        Show usage message and options.\n'
136
145
            '  -v, --verbose  Display more information.\n'
137
146
            '  -q, --quiet    Only display errors and warnings.\n'
138
147
            '  -h, --help     Show help message.\n'
147
156
            '        cmd arg2\n'
148
157
            '\n')
149
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
 
150
252
    def test_help_text_custom_usage(self):
151
253
        """Help text may contain a custom usage section."""
152
254
        class cmd_Demo(commands.Command):
153
255
            """A sample command.
154
 
 
 
256
 
155
257
            :Usage:
156
258
                cmd Demo [opts] args
157
 
 
 
259
 
158
260
                cmd Demo -h
159
 
 
 
261
 
160
262
            Blah blah blah.
161
263
            """
162
264
        cmd = cmd_Demo()
170
272
            '\n'
171
273
            '\n'
172
274
            'Options:\n'
 
275
            '  --usage        Show usage message and options.\n'
173
276
            '  -v, --verbose  Display more information.\n'
174
277
            '  -q, --quiet    Only display errors and warnings.\n'
175
278
            '  -h, --help     Show help message.\n'
178
281
            '  Blah blah blah.\n\n')
179
282
 
180
283
 
181
 
class TestRegisteredTopic(tests.TestCase):
 
284
class TestRegisteredTopic(TestHelp):
182
285
    """Tests for the RegisteredTopic class."""
183
286
 
184
287
    def test_contruct(self):
185
288
        """Construction takes the help topic name for the registered item."""
186
 
        # validate our test 
 
289
        # validate our test
187
290
        self.assertTrue('basic' in help_topics.topic_registry)
188
291
        topic = help_topics.RegisteredTopic('basic')
189
292
        self.assertEqual('basic', topic.topic)
203
306
 
204
307
    def test_get_help_text_loaded_from_file(self):
205
308
        # Pick a known topic stored in an external file
206
 
        topic = help_topics.RegisteredTopic('hooks')
 
309
        topic = help_topics.RegisteredTopic('authentication')
207
310
        self.assertStartsWith(topic.get_help_text(),
208
 
            'Hooks\n'
209
 
            '=====\n'
 
311
            'Authentication Settings\n'
 
312
            '=======================\n'
210
313
            '\n')
211
314
 
212
315
    def test_get_help_topic(self):
217
320
        self.assertEqual('baz', topic.get_help_topic())
218
321
 
219
322
 
220
 
class TestTopicIndex(tests.TestCase):
 
323
class TestTopicIndex(TestHelp):
221
324
    """Tests for the HelpTopicIndex class."""
222
325
 
223
326
    def test_default_constructable(self):
250
353
        self.assertEqual('', index.prefix)
251
354
 
252
355
 
253
 
class TestCommandIndex(tests.TestCase):
 
356
class TestCommandIndex(TestHelp):
254
357
    """Tests for the HelpCommandIndex class."""
255
358
 
256
359
    def test_default_constructable(self):