← 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: Matt Nordhoff
  • Date: 2009-04-04 02:50:01 UTC
  • mfrom: (4253 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: mnordhoff@mattnordhoff.com-20090404025001-z1403k0tatmc8l91
Merge bzr.dev, fixing conflicts.

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
 
96
96
        """Help text should be plain text by default."""
97
97
        class cmd_Demo(commands.Command):
98
98
            """A sample command.
99
 
 
 
99
 
100
100
            :Examples:
101
101
                Example 1::
102
 
 
 
102
 
103
103
                    cmd arg1
104
 
 
 
104
 
105
105
                Example 2::
106
 
 
 
106
 
107
107
                    cmd arg2
108
108
            """
109
109
        cmd = cmd_Demo()
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):
153
248
            """A sample command.
154
 
 
 
249
 
155
250
            :Usage:
156
251
                cmd Demo [opts] args
157
 
 
 
252
 
158
253
                cmd Demo -h
159
 
 
 
254
 
160
255
            Blah blah blah.
161
256
            """
162
257
        cmd = cmd_Demo()
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'
183
279
 
184
280
    def test_contruct(self):
185
281
        """Construction takes the help topic name for the registered item."""
186
 
        # validate our test 
 
282
        # validate our test
187
283
        self.assertTrue('basic' in help_topics.topic_registry)
188
284
        topic = help_topics.RegisteredTopic('basic')
189
285
        self.assertEqual('basic', topic.topic)
203
299
 
204
300
    def test_get_help_text_loaded_from_file(self):
205
301
        # Pick a known topic stored in an external file
206
 
        topic = help_topics.RegisteredTopic('hooks')
 
302
        topic = help_topics.RegisteredTopic('authentication')
207
303
        self.assertStartsWith(topic.get_help_text(),
208
 
            'Hooks\n'
209
 
            '=====\n'
 
304
            'Authentication Settings\n'
 
305
            '=======================\n'
210
306
            '\n')
211
307
 
212
308
    def test_get_help_topic(self):