/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_help.py

merge bzr.dev.

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
 
40
40
        helptext = cmd.get_help_text()
41
41
        self.assertEndsWith(
42
42
            helptext,
43
 
            '  -h, --help  Show help message.\n'
 
43
            '  -v, --verbose  Display more information.\n'
 
44
            '  -q, --quiet    Only display errors and warnings.\n'
 
45
            '  -h, --help     Show help message.\n'
44
46
            '\n'
45
47
            'See also: bar, foo\n')
46
48
 
53
55
        self.assertStartsWith(helptext,
54
56
            'Purpose: A sample command.\n'
55
57
            'Usage:   bzr Demo')
56
 
        self.assertEndsWith(helptext, 'Show help message.\n\n')
 
58
        self.assertEndsWith(helptext,
 
59
            '  -h, --help     Show help message.\n\n')
57
60
 
58
61
    def test_command_with_additional_see_also(self):
59
62
        class cmd_WithSeeAlso(commands.Command):
63
66
        helptext = cmd.get_help_text(['gam'])
64
67
        self.assertEndsWith(
65
68
            helptext,
66
 
            '  -h, --help  Show help message.\n'
 
69
            '  -v, --verbose  Display more information.\n'
 
70
            '  -q, --quiet    Only display errors and warnings.\n'
 
71
            '  -h, --help     Show help message.\n'
67
72
            '\n'
68
73
            'See also: bar, foo, gam\n')
69
74
 
74
79
        helptext = cmd.get_help_text(['gam'])
75
80
        self.assertEndsWith(
76
81
            helptext,
77
 
            '  -h, --help  Show help message.\n'
 
82
            '  -v, --verbose  Display more information.\n'
 
83
            '  -q, --quiet    Only display errors and warnings.\n'
 
84
            '  -h, --help     Show help message.\n'
78
85
            '\n'
79
86
            'See also: gam\n')
80
87
 
89
96
        """Help text should be plain text by default."""
90
97
        class cmd_Demo(commands.Command):
91
98
            """A sample command.
92
 
 
 
99
 
93
100
            :Examples:
94
101
                Example 1::
95
 
 
 
102
 
96
103
                    cmd arg1
97
 
 
 
104
 
98
105
                Example 2::
99
 
 
 
106
 
100
107
                    cmd arg2
101
108
            """
102
109
        cmd = cmd_Demo()
107
114
            'Usage:   bzr Demo\n'
108
115
            '\n'
109
116
            'Options:\n'
110
 
            '  -h, --help  Show help message.\n'
 
117
            '  --usage        Show usage message and options.\n'
 
118
            '  -v, --verbose  Display more information.\n'
 
119
            '  -q, --quiet    Only display errors and warnings.\n'
 
120
            '  -h, --help     Show help message.\n'
111
121
            '\n'
112
122
            'Examples:\n'
113
123
            '    Example 1:\n'
124
134
            ':Usage:   bzr Demo\n'
125
135
            '\n'
126
136
            ':Options:\n'
127
 
            '  -h, --help  Show help message.\n'
 
137
            '  --usage        Show usage message and options.\n'
 
138
            '  -v, --verbose  Display more information.\n'
 
139
            '  -q, --quiet    Only display errors and warnings.\n'
 
140
            '  -h, --help     Show help message.\n'
128
141
            '\n'
129
142
            ':Examples:\n'
130
143
            '    Example 1::\n'
136
149
            '        cmd arg2\n'
137
150
            '\n')
138
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
 
139
245
    def test_help_text_custom_usage(self):
140
246
        """Help text may contain a custom usage section."""
141
247
        class cmd_Demo(commands.Command):
142
248
            """A sample command.
143
 
 
 
249
 
144
250
            :Usage:
145
251
                cmd Demo [opts] args
146
 
 
 
252
 
147
253
                cmd Demo -h
148
 
 
 
254
 
149
255
            Blah blah blah.
150
256
            """
151
257
        cmd = cmd_Demo()
159
265
            '\n'
160
266
            '\n'
161
267
            'Options:\n'
162
 
            '  -h, --help  Show help message.\n'
 
268
            '  --usage        Show usage message and options.\n'
 
269
            '  -v, --verbose  Display more information.\n'
 
270
            '  -q, --quiet    Only display errors and warnings.\n'
 
271
            '  -h, --help     Show help message.\n'
163
272
            '\n'
164
273
            'Description:\n'
165
274
            '  Blah blah blah.\n\n')
170
279
 
171
280
    def test_contruct(self):
172
281
        """Construction takes the help topic name for the registered item."""
173
 
        # validate our test 
 
282
        # validate our test
174
283
        self.assertTrue('basic' in help_topics.topic_registry)
175
284
        topic = help_topics.RegisteredTopic('basic')
176
285
        self.assertEqual('basic', topic.topic)
188
297
            '\n'
189
298
            'See also: bar, foo\n')
190
299
 
 
300
    def test_get_help_text_loaded_from_file(self):
 
301
        # Pick a known topic stored in an external file
 
302
        topic = help_topics.RegisteredTopic('authentication')
 
303
        self.assertStartsWith(topic.get_help_text(),
 
304
            'Authentication Settings\n'
 
305
            '=======================\n'
 
306
            '\n')
 
307
 
191
308
    def test_get_help_topic(self):
192
309
        """The help topic for a RegisteredTopic is its topic from construction."""
193
310
        topic = help_topics.RegisteredTopic('foobar')