← 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: Canonical.com Patch Queue Manager
  • Date: 2009-03-06 06:48:25 UTC
  • mfrom: (4070.8.6 debug-config)
  • Revision ID: pqm@pqm.ubuntu.com-20090306064825-kbpwggw21dygeix6
(mbp) debug_flags configuration option

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
 
114
114
            'Usage:   bzr Demo\n'
115
115
            '\n'
116
116
            'Options:\n'
117
 
            '  --usage        Show usage message and options.\n'
118
117
            '  -v, --verbose  Display more information.\n'
119
118
            '  -q, --quiet    Only display errors and warnings.\n'
120
119
            '  -h, --help     Show help message.\n'
134
133
            ':Usage:   bzr Demo\n'
135
134
            '\n'
136
135
            ':Options:\n'
137
 
            '  --usage        Show usage message and options.\n'
138
136
            '  -v, --verbose  Display more information.\n'
139
137
            '  -q, --quiet    Only display errors and warnings.\n'
140
138
            '  -h, --help     Show help message.\n'
149
147
            '        cmd arg2\n'
150
148
            '\n')
151
149
 
152
 
    def test_concise_help_text(self):
153
 
        """Concise help text excludes the descriptive sections."""
154
 
        class cmd_Demo(commands.Command):
155
 
            """A sample command.
156
 
 
157
 
            Blah blah blah.
158
 
 
159
 
            :Examples:
160
 
                Example 1::
161
 
 
162
 
                    cmd arg1
163
 
            """
164
 
        cmd = cmd_Demo()
165
 
        helptext = cmd.get_help_text()
166
 
        self.assertEqualDiff(
167
 
            helptext,
168
 
            'Purpose: A sample command.\n'
169
 
            'Usage:   bzr Demo\n'
170
 
            '\n'
171
 
            'Options:\n'
172
 
            '  --usage        Show usage message and options.\n'
173
 
            '  -v, --verbose  Display more information.\n'
174
 
            '  -q, --quiet    Only display errors and warnings.\n'
175
 
            '  -h, --help     Show help message.\n'
176
 
            '\n'
177
 
            'Description:\n'
178
 
            '  Blah blah blah.\n'
179
 
            '\n'
180
 
            'Examples:\n'
181
 
            '    Example 1:\n'
182
 
            '\n'
183
 
            '        cmd arg1\n'
184
 
            '\n')
185
 
        helptext = cmd.get_help_text(verbose=False)
186
 
        self.assertEquals(helptext,
187
 
            'Purpose: A sample command.\n'
188
 
            'Usage:   bzr Demo\n'
189
 
            '\n'
190
 
            'Options:\n'
191
 
            '  --usage        Show usage message and options.\n'
192
 
            '  -v, --verbose  Display more information.\n'
193
 
            '  -q, --quiet    Only display errors and warnings.\n'
194
 
            '  -h, --help     Show help message.\n'
195
 
            '\n'
196
 
            'See bzr help Demo for more details and examples.\n'
197
 
            '\n')
198
 
 
199
 
    def test_help_custom_section_ordering(self):
200
 
        """Custom descriptive sections should remain in the order given."""
201
 
        class cmd_Demo(commands.Command):
202
 
            """A sample command.
203
 
 
204
 
            Blah blah blah.
205
 
 
206
 
            :Formats:
207
 
              Interesting stuff about formats.
208
 
 
209
 
            :Examples:
210
 
              Example 1::
211
 
 
212
 
                cmd arg1
213
 
 
214
 
            :Tips:
215
 
              Clever things to keep in mind.
216
 
            """
217
 
        cmd = cmd_Demo()
218
 
        helptext = cmd.get_help_text()
219
 
        self.assertEqualDiff(
220
 
            helptext,
221
 
            'Purpose: A sample command.\n'
222
 
            'Usage:   bzr Demo\n'
223
 
            '\n'
224
 
            'Options:\n'
225
 
            '  --usage        Show usage message and options.\n'
226
 
            '  -v, --verbose  Display more information.\n'
227
 
            '  -q, --quiet    Only display errors and warnings.\n'
228
 
            '  -h, --help     Show help message.\n'
229
 
            '\n'
230
 
            'Description:\n'
231
 
            '  Blah blah blah.\n'
232
 
            '\n'
233
 
            'Formats:\n'
234
 
            '  Interesting stuff about formats.\n'
235
 
            '\n'
236
 
            'Examples:\n'
237
 
            '  Example 1:\n'
238
 
            '\n'
239
 
            '    cmd arg1\n'
240
 
            '\n'
241
 
            'Tips:\n'
242
 
            '  Clever things to keep in mind.\n'
243
 
            '\n')
244
 
 
245
150
    def test_help_text_custom_usage(self):
246
151
        """Help text may contain a custom usage section."""
247
152
        class cmd_Demo(commands.Command):
265
170
            '\n'
266
171
            '\n'
267
172
            'Options:\n'
268
 
            '  --usage        Show usage message and options.\n'
269
173
            '  -v, --verbose  Display more information.\n'
270
174
            '  -q, --quiet    Only display errors and warnings.\n'
271
175
            '  -h, --help     Show help message.\n'
299
203
 
300
204
    def test_get_help_text_loaded_from_file(self):
301
205
        # Pick a known topic stored in an external file
302
 
        topic = help_topics.RegisteredTopic('authentication')
 
206
        topic = help_topics.RegisteredTopic('hooks')
303
207
        self.assertStartsWith(topic.get_help_text(),
304
 
            'Authentication Settings\n'
305
 
            '=======================\n'
 
208
            'Hooks\n'
 
209
            '=====\n'
306
210
            '\n')
307
211
 
308
212
    def test_get_help_topic(self):