~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

Merge bzr.dev 4187, and revert the change to fix refcycle issues.

I apparently didn't run the smart fetch tests. Which show that we access inv+chk pages
as a fulltext, and then insert the stream, which expects to get the block as a compressed
block. :(.
Need to rethink how to do it, possibly with weakrefs.


This also brings in CommitBuilder.record_iter_changes() and the updates to btree_index
and backing indices.

Show diffs side-by-side

added added

removed removed

Lines of Context:
114
114
            'Usage:   bzr Demo\n'
115
115
            '\n'
116
116
            'Options:\n'
 
117
            '  --usage        Show usage message and options.\n'
117
118
            '  -v, --verbose  Display more information.\n'
118
119
            '  -q, --quiet    Only display errors and warnings.\n'
119
120
            '  -h, --help     Show help message.\n'
133
134
            ':Usage:   bzr Demo\n'
134
135
            '\n'
135
136
            ':Options:\n'
 
137
            '  --usage        Show usage message and options.\n'
136
138
            '  -v, --verbose  Display more information.\n'
137
139
            '  -q, --quiet    Only display errors and warnings.\n'
138
140
            '  -h, --help     Show help message.\n'
147
149
            '        cmd arg2\n'
148
150
            '\n')
149
151
 
 
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
 
150
245
    def test_help_text_custom_usage(self):
151
246
        """Help text may contain a custom usage section."""
152
247
        class cmd_Demo(commands.Command):
170
265
            '\n'
171
266
            '\n'
172
267
            'Options:\n'
 
268
            '  --usage        Show usage message and options.\n'
173
269
            '  -v, --verbose  Display more information.\n'
174
270
            '  -q, --quiet    Only display errors and warnings.\n'
175
271
            '  -h, --help     Show help message.\n'