Mercurial > hg > octave-lyh
annotate scripts/testfun/test.m @ 11032:c9b0a75b02e8
Make all regexp in Octave compatible with both POSIX and PCRE.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 28 Sep 2010 09:25:14 -0700 |
parents | be55736a0783 |
children | a8a9f062d0ef |
rev | line source |
---|---|
8920 | 1 ## Copyright (C) 2005, 2006, 2007, 2008, 2009 Paul Kienzle |
5589 | 2 ## |
7016 | 3 ## This file is part of Octave. |
5589 | 4 ## |
7016 | 5 ## Octave is free software; you can redistribute it and/or modify it |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
5589 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5589 | 18 |
19 ## -*- texinfo -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10635
diff
changeset
|
20 ## @deftypefn {Function File} {} test @var{name} |
5589 | 21 ## @deftypefnx {Function File} {} test @var{name} quiet|normal|verbose |
22 ## @deftypefnx {Function File} {} test ('@var{name}', 'quiet|normal|verbose', @var{fid}) | |
23 ## @deftypefnx {Function File} {} test ([], 'explain', @var{fid}) | |
24 ## @deftypefnx {Function File} {@var{success} =} test (@dots{}) | |
25 ## @deftypefnx {Function File} {[@var{n}, @var{max}] =} test (@dots{}) | |
26 ## @deftypefnx {Function File} {[@var{code}, @var{idx}] =} test ('@var{name}','grabdemo') | |
27 ## | |
28 ## Perform tests from the first file in the loadpath matching @var{name}. | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
29 ## @code{test} can be called as a command or as a function. Called with |
5589 | 30 ## a single argument @var{name}, the tests are run interactively and stop |
31 ## after the first error is encountered. | |
32 ## | |
33 ## With a second argument the tests which are performed and the amount of | |
34 ## output is selected. | |
35 ## | |
36 ## @table @asis | |
37 ## @item 'quiet' | |
38 ## Don't report all the tests as they happen, just the errors. | |
39 ## | |
40 ## @item 'normal' | |
41 ## Report all tests as they happen, but don't do tests which require | |
42 ## user interaction. | |
43 ## | |
44 ## @item 'verbose' | |
45 ## Do tests which require user interaction. | |
46 ## @end table | |
47 ## | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
48 ## The argument @var{fid} can be used to allow batch processing. Errors |
5589 | 49 ## can be written to the already open file defined by @var{fid}, and |
8481
00df69d7e698
[docs] capitalize Octave consistently
Brian Gough <bjg@gnu.org>
parents:
8422
diff
changeset
|
50 ## hopefully when Octave crashes this file will tell you what was happening |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
51 ## when it did. You can use @code{stdout} if you want to see the results as |
5589 | 52 ## they happen. You can also give a file name rather than an @var{fid}, in |
53 ## which case the contents of the file will be replaced with the log from | |
54 ## the current test. | |
55 ## | |
56 ## Called with a single output argument @var{success}, @code{test} returns | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
57 ## true if all of the tests were successful. Called with two output arguments |
7001 | 58 ## @var{n} and @var{max}, the number of successful tests and the total number |
5589 | 59 ## of tests in the file @var{name} are returned. |
60 ## | |
61 ## If the second argument is the string 'grabdemo', the contents of the demo | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
62 ## blocks are extracted but not executed. Code for all code blocks is |
7001 | 63 ## concatenated and returned as @var{code} with @var{idx} being a vector of |
5589 | 64 ## positions of the ends of the demo blocks. |
65 ## | |
66 ## If the second argument is 'explain', then @var{name} is ignored and an | |
67 ## explanation of the line markers used is written to the file @var{fid}. | |
5642 | 68 ## @seealso{error, assert, fail, demo, example} |
5589 | 69 ## @end deftypefn |
70 | |
8202
cf59d542f33e
replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents:
7940
diff
changeset
|
71 ## FIXME: * Consider using keyword fail rather then error? This allows us |
cf59d542f33e
replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents:
7940
diff
changeset
|
72 ## to make a functional form of error blocks, which means we |
cf59d542f33e
replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents:
7940
diff
changeset
|
73 ## can include them in test sections which means that we can use |
cf59d542f33e
replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents:
7940
diff
changeset
|
74 ## octave flow control for both kinds of tests. |
5589 | 75 |
7242 | 76 function [__ret1, __ret2, __ret3, __ret4] = test (__name, __flag, __fid) |
8506 | 77 ## Information from test will be introduced by "key". |
5589 | 78 persistent __signal_fail = "!!!!! "; |
79 persistent __signal_empty = "????? "; | |
80 persistent __signal_block = " ***** "; | |
81 persistent __signal_file = ">>>>> "; | |
7242 | 82 persistent __signal_skip = "----- "; |
5589 | 83 |
6730 | 84 __xfail = 0; |
7242 | 85 __xskip = 0; |
6730 | 86 |
6494 | 87 if (nargin < 2 || isempty (__flag)) |
5589 | 88 __flag = "quiet"; |
89 endif | |
6494 | 90 if (nargin < 3) |
5589 | 91 __fid = []; |
92 endif | |
6494 | 93 if (nargin < 1 || nargin > 3 |
94 || (! ischar (__name) && ! isempty (__name)) || ! ischar (__flag)) | |
6046 | 95 print_usage (); |
5589 | 96 endif |
6494 | 97 if (isempty (__name) && (nargin != 3 || ! strcmp (__flag, "explain"))) |
6046 | 98 print_usage (); |
5589 | 99 endif |
6494 | 100 __batch = (! isempty (__fid)); |
5589 | 101 |
8506 | 102 ## Decide if error messages should be collected. |
5589 | 103 __close_fid = 0; |
104 if (__batch) | |
6494 | 105 if (ischar (__fid)) |
106 __fid = fopen (__fid, "wt"); | |
107 if (__fid < 0) | |
10635
d1978e7364ad
Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents:
10615
diff
changeset
|
108 error ("test: could not open log file"); |
6494 | 109 endif |
5589 | 110 __close_fid = 1; |
111 endif | |
112 fprintf (__fid, "%sprocessing %s\n", __signal_file, __name); | |
5908 | 113 fflush (__fid); |
5589 | 114 else |
115 __fid = stdout; | |
116 endif | |
117 | |
6494 | 118 if (strcmp (__flag, "normal")) |
5589 | 119 __grabdemo = 0; |
120 __rundemo = 0; | |
121 __verbose = __batch; | |
6494 | 122 elseif (strcmp (__flag, "quiet")) |
5589 | 123 __grabdemo = 0; |
124 __rundemo = 0; | |
125 __verbose = 0; | |
6494 | 126 elseif (strcmp (__flag, "verbose")) |
5589 | 127 __grabdemo = 0; |
128 __rundemo = 1; | |
129 __verbose = 1; | |
6494 | 130 elseif (strcmp (__flag, "grabdemo")) |
5589 | 131 __grabdemo = 1; |
132 __rundemo = 0; | |
133 __verbose = 0; | |
134 __demo_code = ""; | |
135 __demo_idx = 1; | |
6494 | 136 elseif (strcmp (__flag, "explain")) |
137 fprintf (__fid, "# %s new test file\n", __signal_file); | |
138 fprintf (__fid, "# %s no tests in file\n", __signal_empty); | |
139 fprintf (__fid, "# %s test had an unexpected result\n", __signal_fail); | |
140 fprintf (__fid, "# %s code for the test\n", __signal_block); | |
5589 | 141 fprintf (__fid, "# Search for the unexpected results in the file\n"); |
142 fprintf (__fid, "# then page back to find the file name which caused it.\n"); | |
143 fprintf (__fid, "# The result may be an unexpected failure (in which\n"); | |
144 fprintf (__fid, "# case an error will be reported) or an unexpected\n"); | |
145 fprintf (__fid, "# success (in which case no error will be reported).\n"); | |
5908 | 146 fflush (__fid); |
6494 | 147 if (__close_fid) |
148 fclose(__fid); | |
149 endif | |
5589 | 150 return; |
151 else | |
10635
d1978e7364ad
Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents:
10615
diff
changeset
|
152 error ("test: unknown flag '%s'", __flag); |
5589 | 153 endif |
154 | |
8506 | 155 ## Locate the file to test. |
6249 | 156 __file = file_in_loadpath (__name, "all"); |
157 if (isempty (__file)) | |
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7244
diff
changeset
|
158 __file = file_in_loadpath (cstrcat (__name, ".m"), "all"); |
5589 | 159 endif |
160 if (isempty (__file)) | |
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7244
diff
changeset
|
161 __file = file_in_loadpath (cstrcat (__name, ".cc"), "all"); |
6249 | 162 endif |
163 if (iscell (__file)) | |
6365 | 164 ## If repeats, return first in path. |
165 if (isempty (__file)) | |
166 __file = ""; | |
167 else | |
168 __file = __file{1}; | |
169 endif | |
5589 | 170 endif |
171 if (isempty (__file)) | |
172 if (__grabdemo) | |
173 __ret1 = ""; | |
174 __ret2 = []; | |
175 else | |
6494 | 176 fprintf (__fid, "%s%s does not exist in path\n", __signal_empty, __name); |
5908 | 177 fflush (__fid); |
6494 | 178 if (nargout > 0) |
10549 | 179 __ret1 = __ret2 = 0; |
6494 | 180 endif |
5589 | 181 endif |
6494 | 182 if (__close_fid) |
183 fclose(__fid); | |
184 endif | |
5589 | 185 return; |
186 endif | |
187 | |
8506 | 188 ## Grab the test code from the file. |
5589 | 189 __body = __extract_test_code (__file); |
190 | |
191 if (isempty (__body)) | |
192 if (__grabdemo) | |
193 __ret1 = ""; | |
194 __ret2 = []; | |
195 else | |
6494 | 196 fprintf (__fid, "%s%s has no tests available\n", __signal_empty, __file); |
5908 | 197 fflush (__fid); |
6494 | 198 if (nargout > 0) |
10549 | 199 __ret1 = __ret2 = 0; |
6494 | 200 endif |
5589 | 201 endif |
6494 | 202 if (__close_fid) |
203 fclose(__fid); | |
204 endif | |
5589 | 205 return; |
206 else | |
8506 | 207 ## Add a dummy comment block to the end for ease of indexing. |
5589 | 208 if (__body (length(__body)) == "\n") |
6494 | 209 __body = sprintf ("\n%s#", __body); |
5589 | 210 else |
6494 | 211 __body = sprintf ("\n%s\n#", __body); |
5589 | 212 endif |
213 endif | |
214 | |
8506 | 215 ## Chop it up into blocks for evaluation. |
6494 | 216 __lineidx = find (__body == "\n"); |
217 __blockidx = __lineidx(find (! isspace (__body(__lineidx+1))))+1; | |
5589 | 218 |
8506 | 219 ## Ready to start tests ... if in batch mode, tell us what is happening. |
5589 | 220 if (__verbose) |
8507 | 221 disp (cstrcat (__signal_file, __file)); |
5589 | 222 endif |
223 | |
8506 | 224 ## Assume all tests will pass. |
5589 | 225 __all_success = 1; |
226 | |
8506 | 227 ## Process each block separately, initially with no shared variables. |
5589 | 228 __tests = __successes = 0; |
229 __shared = " "; | |
230 __shared_r = " "; | |
231 __clear = ""; | |
6494 | 232 for __i = 1:length(__blockidx)-1 |
5589 | 233 |
8506 | 234 ## Extract the block. |
5589 | 235 __block = __body(__blockidx(__i):__blockidx(__i+1)-2); |
236 | |
8506 | 237 ## Let the user/logfile know what is happening. |
5589 | 238 if (__verbose) |
239 fprintf (__fid, "%s%s\n", __signal_block, __block); | |
5908 | 240 fflush (__fid); |
5589 | 241 endif |
242 | |
8506 | 243 ## Split __block into __type and __code. |
6494 | 244 __idx = find (! isletter (__block)); |
245 if (isempty (__idx)) | |
5589 | 246 __type = __block; |
247 __code = ""; | |
248 else | |
249 __type = __block(1:__idx(1)-1); | |
250 __code = __block(__idx(1):length(__block)); | |
251 endif | |
252 | |
8506 | 253 ## Assume the block will succeed. |
5589 | 254 __success = 1; |
255 __msg = []; | |
256 | |
8506 | 257 ### DEMO |
258 | |
5589 | 259 ## If in __grabdemo mode, then don't process any other block type. |
260 ## So that the other block types don't have to worry about | |
261 ## this __grabdemo mode, the demo block processor grabs all block | |
262 ## types and skips those which aren't demo blocks. | |
8506 | 263 |
5589 | 264 __isdemo = strcmp (__type, "demo"); |
265 if (__grabdemo || __isdemo) | |
266 __istest = 0; | |
267 | |
268 if (__grabdemo && __isdemo) | |
10549 | 269 if (isempty(__demo_code)) |
270 __demo_code = __code; | |
271 __demo_idx = [1, length(__demo_code)+1]; | |
272 else | |
273 __demo_code = cstrcat(__demo_code, __code); | |
274 __demo_idx = [__demo_idx, length(__demo_code)+1]; | |
275 endif | |
5589 | 276 |
277 elseif (__rundemo && __isdemo) | |
10549 | 278 try |
279 ## process the code in an environment without variables | |
280 eval (sprintf ("function __test__()\n%s\nendfunction", __code)); | |
281 __test__; | |
282 input ("Press <enter> to continue: ", "s"); | |
283 catch | |
284 __success = 0; | |
285 __msg = sprintf ("%sdemo failed\n%s", __signal_fail, __error_text__); | |
286 end_try_catch | |
287 clear __test__; | |
5589 | 288 |
289 endif | |
8506 | 290 ## Code already processed. |
291 __code = ""; | |
5589 | 292 |
8506 | 293 ### SHARED |
294 | |
295 elseif (strcmp (__type, "shared")) | |
5589 | 296 __istest = 0; |
297 | |
8506 | 298 ## Separate initialization code from variables. |
6494 | 299 __idx = find (__code == "\n"); |
300 if (isempty (__idx)) | |
10549 | 301 __vars = __code; |
302 __code = ""; | |
5589 | 303 else |
10549 | 304 __vars = __code (1:__idx(1)-1); |
305 __code = __code (__idx(1):length(__code)); | |
5589 | 306 endif |
307 | |
8506 | 308 ## Strip comments off the variables. |
6730 | 309 __idx = find (__vars == "%" | __vars == "#"); |
6494 | 310 if (! isempty (__idx)) |
10549 | 311 __vars = __vars(1:__idx(1)-1); |
5589 | 312 endif |
313 | |
8506 | 314 ## Assign default values to variables. |
5589 | 315 try |
10549 | 316 __vars = deblank (__vars); |
317 if (! isempty (__vars)) | |
318 eval (cstrcat (strrep (__vars, ",", "=[];"), "=[];")); | |
319 __shared = __vars; | |
320 __shared_r = cstrcat ("[ ", __vars, "] = "); | |
321 else | |
322 __shared = " "; | |
323 __shared_r = " "; | |
324 endif | |
5589 | 325 catch |
10549 | 326 ## Couldn't declare, so don't initialize. |
327 __code = ""; | |
328 __success = 0; | |
329 __msg = sprintf ("%sshared variable initialization failed\n", | |
330 __signal_fail); | |
5589 | 331 end_try_catch |
332 | |
8506 | 333 ## Clear shared function definitions. |
6494 | 334 eval (__clear, ""); |
335 __clear = ""; | |
5589 | 336 |
8506 | 337 ## Initialization code will be evaluated below. |
5589 | 338 |
8506 | 339 ### FUNCTION |
340 | |
6494 | 341 elseif (strcmp (__type, "function")) |
5589 | 342 __istest = 0; |
343 persistent __fn = 0; | |
6494 | 344 __name_position = function_name (__block); |
345 if (isempty (__name_position)) | |
5589 | 346 __success = 0; |
6494 | 347 __msg = sprintf ("%stest failed: missing function name\n", |
10549 | 348 __signal_fail); |
5589 | 349 else |
350 __name = __block(__name_position(1):__name_position(2)); | |
10130
0c3609dd34cf
oct-parse.yy (eval_string): save and set reading_{script,fcn,classdef}_file vars
John W. Eaton <jwe@octave.org>
parents:
10128
diff
changeset
|
351 __code = __block; |
5589 | 352 try |
353 eval(__code); ## Define the function | |
6494 | 354 __clear = sprintf ("%sclear %s;\n", __clear, __name); |
5589 | 355 catch |
356 __success = 0; | |
6494 | 357 __msg = sprintf ("%stest failed: syntax error\n%s", |
10549 | 358 __signal_fail, __error_text__); |
5589 | 359 end_try_catch |
360 endif | |
361 __code = ""; | |
362 | |
8506 | 363 ### ASSERT/FAIL |
5589 | 364 |
6494 | 365 elseif (strcmp (__type, "assert") || strcmp (__type, "fail")) |
5589 | 366 __istest = 1; |
8506 | 367 ## Put the keyword back on the code. |
368 __code = __block; | |
369 ## The code will be evaluated below as a test block. | |
5589 | 370 |
8506 | 371 ### ERROR/WARNING |
372 | |
6494 | 373 elseif (strcmp (__type, "error") || strcmp(__type, "warning")) |
5589 | 374 __istest = 1; |
6494 | 375 __warning = strcmp (__type, "warning"); |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
376 [__pattern, __id, __code] = getpattern (__code); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
377 if (__id) |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
378 __patstr = ["id=",__id]; |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
379 else |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
380 __patstr = ["<",__pattern,">"]; |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
381 endif |
5589 | 382 try |
10549 | 383 eval (sprintf ("function __test__(%s)\n%s\nendfunction", |
384 __shared, __code)); | |
5589 | 385 catch |
10549 | 386 __success = 0; |
387 __msg = sprintf ("%stest failed: syntax error\n%s", | |
388 __signal_fail, __error_text__); | |
5589 | 389 end_try_catch |
390 | |
391 if (__success) | |
392 __success = 0; | |
10549 | 393 __warnstate = warning ("query", "quiet"); |
394 warning ("on", "quiet"); | |
395 try | |
396 eval (sprintf ("__test__(%s);", __shared)); | |
6494 | 397 if (! __warning) |
10549 | 398 __msg = sprintf ("%sexpected %s but got no error\n", |
399 __signal_fail, __patstr); | |
400 else | |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
401 if (! isempty (__id)) |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
402 [~, __err] = lastwarn; |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
403 __mismatch = ! strcmp (__err, __id); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
404 else |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
405 __err = trimerr (lastwarn, "warning"); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
406 __mismatch = isempty (regexp (__err, __pattern, "once")); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
407 endif |
7028 | 408 warning (__warnstate.state, "quiet"); |
409 if (isempty (__err)) | |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
410 __msg = sprintf ("%sexpected %s but got no warning\n", |
10549 | 411 __signal_fail, __patstr); |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
412 elseif (__mismatch) |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
413 __msg = sprintf ("%sexpected %s but got %s\n", |
10549 | 414 __signal_fail, __patstr, __err); |
7028 | 415 else |
416 __success = 1; | |
417 endif | |
10549 | 418 endif |
5589 | 419 |
10549 | 420 catch |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
421 if (! isempty (__id)) |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
422 [~, __err] = lasterr; |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
423 __mismatch = ! strcmp (__err, __id); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
424 else |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
425 __err = trimerr (lasterr, "error"); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
426 __mismatch = isempty (regexp (__err, __pattern, "once")); |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
427 endif |
6494 | 428 warning (__warnstate.state, "quiet"); |
429 if (__warning) | |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
430 __msg = sprintf ("%sexpected warning %s but got error %s\n", |
10549 | 431 __signal_fail, __patstr, __err); |
432 elseif (__mismatch) | |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
433 __msg = sprintf ("%sexpected %s but got %s\n", |
10549 | 434 __signal_fail, __patstr, __err); |
5589 | 435 else |
10549 | 436 __success = 1; |
5589 | 437 endif |
10549 | 438 end_try_catch |
439 clear __test__; | |
5589 | 440 endif |
8506 | 441 ## Code already processed. |
442 __code = ""; | |
5589 | 443 |
8506 | 444 ### TESTIF |
445 | |
7242 | 446 elseif (strcmp (__type, "testif")) |
11032
c9b0a75b02e8
Make all regexp in Octave compatible with both POSIX and PCRE.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
447 [__e, __feat] = regexp (__code, '^\s*(\S+)', 'end', 'tokens'); |
7242 | 448 if (isempty (findstr (octave_config_info ("DEFS"), __feat{1}{1}))) |
449 __xskip++; | |
10549 | 450 __istest = 0; |
10615
08050f37ba49
Don't abort testing when merely skipping a testif block.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
451 __code = ""; # Skip the code. |
10549 | 452 __msg = sprintf ("%sskipped test\n", __signal_skip); |
7242 | 453 else |
454 __istest = 1; | |
10549 | 455 __code = __code(__e + 1 : end); |
7242 | 456 endif |
457 | |
8506 | 458 ### TEST |
459 | |
6728 | 460 elseif (strcmp (__type, "test") || strcmp (__type, "xtest")) |
5589 | 461 __istest = 1; |
8506 | 462 ## Code will be evaluated below. |
463 | |
464 ### Comment block. | |
465 | |
6494 | 466 elseif (strcmp (__block(1:1), "#")) |
5589 | 467 __istest = 0; |
468 __code = ""; # skip the code | |
469 | |
8506 | 470 ### Unknown block. |
471 | |
5589 | 472 else |
473 __istest = 1; | |
474 __success = 0; | |
6494 | 475 __msg = sprintf ("%sunknown test type!\n", __signal_fail); |
5589 | 476 __code = ""; # skip the code |
477 endif | |
478 | |
479 ## evaluate code for test, shared, and assert. | |
6494 | 480 if (! isempty(__code)) |
5589 | 481 try |
10549 | 482 eval (sprintf ("function %s__test__(%s)\n%s\nendfunction", |
483 __shared_r,__shared, __code)); | |
484 eval (sprintf ("%s__test__(%s);", __shared_r, __shared)); | |
5589 | 485 catch |
6728 | 486 if (strcmp (__type, "xtest")) |
487 __msg = sprintf ("%sknown failure\n%s", __signal_fail, __error_text__); | |
10549 | 488 __xfail++; |
6728 | 489 else |
490 __msg = sprintf ("%stest failed\n%s", __signal_fail, __error_text__); | |
10549 | 491 __success = 0; |
6728 | 492 endif |
10549 | 493 if (isempty (__error_text__)) |
494 error ("empty error text, probably Ctrl-C --- aborting"); | |
495 endif | |
5589 | 496 end_try_catch |
497 clear __test__; | |
498 endif | |
499 | |
8506 | 500 ## All done. Remember if we were successful and print any messages. |
6494 | 501 if (! isempty (__msg)) |
8506 | 502 ## Make sure the user knows what caused the error. |
6494 | 503 if (! __verbose) |
10549 | 504 fprintf (__fid, "%s%s\n", __signal_block, __block); |
505 fflush (__fid); | |
5589 | 506 endif |
507 fputs (__fid, __msg); | |
9996
929e53107f09
Add newline to message output of test.m
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
508 fputs (__fid, "\n"); |
5908 | 509 fflush (__fid); |
8506 | 510 ## Show the variable context. |
7244 | 511 if (! strcmp (__type, "error") && ! strcmp (__type, "testif") |
10549 | 512 && ! all (__shared == " ")) |
513 fputs (__fid, "shared variables "); | |
514 eval (sprintf ("fdisp(__fid,bundle(%s));", __shared)); | |
515 fflush (__fid); | |
5589 | 516 endif |
517 endif | |
518 if (__success == 0) | |
519 __all_success = 0; | |
8506 | 520 ## Stop after one error if not in batch mode. |
6494 | 521 if (! __batch) |
10549 | 522 if (nargout > 0) |
523 __ret1 = __ret2 = 0; | |
524 endif | |
525 if (__close_fid) | |
526 fclose(__fid); | |
527 endif | |
528 return; | |
5589 | 529 endif |
530 endif | |
531 __tests += __istest; | |
6494 | 532 __successes += __success * __istest; |
5589 | 533 endfor |
6494 | 534 eval (__clear, ""); |
5589 | 535 |
536 if (nargout == 0) | |
8422
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
537 if (__tests || __xfail || __xskip) |
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
538 if (__xfail) |
10549 | 539 printf ("PASSES %d out of %d tests (%d expected failures)\n", |
540 __successes, __tests, __xfail); | |
8422
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
541 else |
10549 | 542 printf ("PASSES %d out of %d tests\n", __successes, __tests); |
8422
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
543 endif |
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
544 if (__xskip) |
10549 | 545 printf ("Skipped %d tests due to missing features\n", __xskip); |
8422
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
546 endif |
6730 | 547 else |
8422
20cbb0fdab48
test.m: print "has no tests" message if there are demos but no tests
John W. Eaton <jwe@octave.org>
parents:
8202
diff
changeset
|
548 printf ("%s%s has no tests available\n", __signal_empty, __file); |
7242 | 549 endif |
5589 | 550 elseif (__grabdemo) |
551 __ret1 = __demo_code; | |
552 __ret2 = __demo_idx; | |
6494 | 553 elseif (nargout == 1) |
5589 | 554 __ret1 = __all_success; |
555 else | |
556 __ret1 = __successes; | |
557 __ret2 = __tests; | |
6730 | 558 __ret3 = __xfail; |
7242 | 559 __ret4 = __xskip; |
5589 | 560 endif |
561 endfunction | |
562 | |
8506 | 563 ## Create structure with fieldnames the name of the input variables. |
6494 | 564 function s = varstruct (varargin) |
565 for i = 1:nargin | |
566 s.(deblank (argn(i,:))) = varargin{i}; | |
5589 | 567 endfor |
568 endfunction | |
569 | |
8506 | 570 ## Find [start,end] of fn in 'function [a,b] = fn'. |
6494 | 571 function pos = function_name (def) |
5589 | 572 pos = []; |
573 | |
8506 | 574 ## Find the end of the name. |
6494 | 575 right = find (def == "(", 1); |
576 if (isempty (right)) | |
577 return; | |
578 endif | |
579 right = find (def(1:right-1) != " ", 1, "last"); | |
5589 | 580 |
8506 | 581 ## Find the beginning of the name. |
6494 | 582 left = max ([find(def(1:right)==" ", 1, "last"), ... |
10549 | 583 find(def(1:right)=="=", 1, "last")]); |
6494 | 584 if (isempty (left)) |
585 return; | |
586 endif | |
5589 | 587 left++; |
588 | |
8506 | 589 ## Return the end points of the name. |
6494 | 590 pos = [left, right]; |
5589 | 591 endfunction |
592 | |
8506 | 593 ## Strip <pattern> from '<pattern> code'. |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
594 ## Also handles 'id=ID code' |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
595 function [pattern, id, rest] = getpattern (str) |
6494 | 596 pattern = "."; |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
597 id = []; |
5589 | 598 rest = str; |
6494 | 599 str = trimleft (str); |
600 if (! isempty (str) && str(1) == "<") | |
601 close = index (str, ">"); | |
602 if (close) | |
5589 | 603 pattern = str(2:close-1); |
604 rest = str(close+1:end); | |
605 endif | |
10398
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
606 elseif (strncmp (str, "id=", 3)) |
f7cf1a53e1c5
support ID test for errors and warningsin test suites
Jaroslav Hajek <highegg@gmail.com>
parents:
10130
diff
changeset
|
607 [id, rest] = strtok (str(4:end)); |
5589 | 608 endif |
609 endfunction | |
610 | |
8506 | 611 ## Strip '.*prefix:' from '.*prefix: msg\n' and strip trailing blanks. |
6494 | 612 function msg = trimerr (msg, prefix) |
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7244
diff
changeset
|
613 idx = index (msg, cstrcat (prefix, ":")); |
6494 | 614 if (idx > 0) |
615 msg(1:idx+length(prefix)) = []; | |
616 endif | |
617 msg = trimleft (deblank (msg)); | |
5589 | 618 endfunction |
619 | |
8506 | 620 ## Strip leading blanks from string. |
6494 | 621 function str = trimleft (str) |
622 idx = find (isspace (str)); | |
623 leading = find (idx == 1:length(idx)); | |
624 if (! isempty (leading)) | |
5589 | 625 str = str(leading(end)+1:end); |
626 endif | |
627 endfunction | |
628 | |
8506 | 629 ## Make a structure out of the named variables |
630 ## (based on Etienne Grossmann's tar function). | |
6494 | 631 function s = bundle (varargin) |
632 for i = 1:nargin | |
633 s.(deblank (argn(i,:))) = varargin{i}; | |
7151 | 634 endfor |
5589 | 635 endfunction |
636 | |
637 function body = __extract_test_code (nm) | |
638 fid = fopen (nm, "rt"); | |
639 body = []; | |
640 if (fid >= 0) | |
6494 | 641 while (! feof (fid)) |
5589 | 642 ln = fgetl (fid); |
6494 | 643 if (length (ln) >= 2 && strcmp (ln(1:2), "%!")) |
5589 | 644 body = [body, "\n"]; |
645 if (length(ln) > 2) | |
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7244
diff
changeset
|
646 body = cstrcat (body, ln(3:end)); |
5589 | 647 endif |
648 endif | |
649 endwhile | |
650 fclose (fid); | |
651 endif | |
652 endfunction | |
653 | |
8506 | 654 ### Test for test for missing features |
7242 | 655 %!testif OCTAVE_SOURCE |
656 %! ## This test should be run | |
657 %! assert (true); | |
7243 | 658 |
659 ### Disable this test to avoid spurious skipped test for "make check" | |
660 % !testif HAVE_FOOBAR | |
661 % ! ## missing feature. Fail if this test is run | |
662 % ! error("Failed missing feature test"); | |
7242 | 663 |
6728 | 664 ### Test for a known failure |
665 %!xtest error("This test is known to fail") | |
666 | |
5589 | 667 ### example from toeplitz |
668 %!shared msg | |
669 %! msg="expecting vector arguments"; | |
670 %!fail ('toeplitz([])', msg); | |
671 %!fail ('toeplitz([1,2],[])', msg); | |
672 %!fail ('toeplitz([1,2;3,4])', msg); | |
673 %!fail ('toeplitz([1,2],[1,2;3,4])', msg); | |
674 %!fail ('toeplitz ([1,2;3,4],[1,2])', msg); | |
675 % !fail ('toeplitz','usage: toeplitz'); # usage doesn't generate an error | |
676 % !fail ('toeplitz(1, 2, 3)', 'usage: toeplitz'); | |
677 %!test assert (toeplitz ([1,2,3], [1,4]), [1,4; 2,1; 3,2]); | |
678 %!demo toeplitz ([1,2,3,4],[1,5,6]) | |
679 | |
680 ### example from kron | |
5775 | 681 %!#error kron # FIXME suppress these until we can handle output |
5589 | 682 %!#error kron(1,2,3) |
683 %!test assert (isempty (kron ([], rand(3, 4)))) | |
684 %!test assert (isempty (kron (rand (3, 4), []))) | |
685 %!test assert (isempty (kron ([], []))) | |
686 %!shared A, B | |
687 %!test | |
688 %! A = [1, 2, 3; 4, 5, 6]; | |
689 %! B = [1, -1; 2, -2]; | |
690 %!assert (size (kron (zeros (3, 0), A)), [ 3*rows(A), 0 ]) | |
691 %!assert (size (kron (zeros (0, 3), A)), [ 0, 3*columns(A) ]) | |
692 %!assert (size (kron (A, zeros (3, 0))), [ 3*rows(A), 0 ]) | |
693 %!assert (size (kron (A, zeros (0, 3))), [ 0, 3*columns(A) ]) | |
694 %!assert (kron (pi, e), pi*e) | |
695 %!assert (kron (pi, A), pi*A) | |
696 %!assert (kron (A, e), e*A) | |
697 %!assert (kron ([1, 2, 3], A), [ A, 2*A, 3*A ]) | |
698 %!assert (kron ([1; 2; 3], A), [ A; 2*A; 3*A ]) | |
699 %!assert (kron ([1, 2; 3, 4], A), [ A, 2*A; 3*A, 4*A ]) | |
700 %!test | |
701 %! res = [1,-1,2,-2,3,-3; 2,-2,4,-4,6,-6; 4,-4,5,-5,6,-6; 8,-8,10,-10,12,-12]; | |
702 %! assert (kron (A, B), res) | |
703 | |
704 ### an extended demo from specgram | |
705 %!#demo | |
706 %! ## Speech spectrogram | |
707 %! [x, Fs] = auload(file_in_loadpath("sample.wav")); # audio file | |
708 %! step = fix(5*Fs/1000); # one spectral slice every 5 ms | |
709 %! window = fix(40*Fs/1000); # 40 ms data window | |
710 %! fftn = 2^nextpow2(window); # next highest power of 2 | |
711 %! [S, f, t] = specgram(x, fftn, Fs, window, window-step); | |
712 %! S = abs(S(2:fftn*4000/Fs,:)); # magnitude in range 0<f<=4000 Hz. | |
713 %! S = S/max(max(S)); # normalize magnitude so that max is 0 dB. | |
714 %! S = max(S, 10^(-40/10)); # clip below -40 dB. | |
715 %! S = min(S, 10^(-3/10)); # clip above -3 dB. | |
716 %! imagesc(flipud(20*log10(S)), 1); | |
717 %! % you should now see a spectrogram in the image window | |
718 | |
719 | |
720 ### now test test itself | |
721 | |
722 %!## usage and error testing | |
723 % !fail ('test','usage.*test') # no args, generates usage() | |
724 % !fail ('test(1,2,3,4)','usage.*test') # too many args, generates usage() | |
725 %!fail ('test("test", "bogus")','unknown flag') # incorrect args | |
726 %!fail ('garbage','garbage.*undefined') # usage on nonexistent function should be | |
727 | |
7940 | 728 %!error test # no args, generates usage() |
729 %!error test(1,2,3,4) # too many args, generates usage() | |
5589 | 730 %!error <unknown flag> test("test", 'bogus'); # incorrect args, generates error() |
731 %!error <garbage' undefined> garbage # usage on nonexistent function should be | |
732 | |
733 %!error test("test", 'bogus'); # test without pattern | |
734 | |
5681 | 735 %!test |
736 %! lastwarn(); # clear last warning just in case | |
737 | |
5781 | 738 %!warning <warning message> warning('warning message'); |
5589 | 739 |
740 %!## test of shared variables | |
741 %!shared a # create a shared variable | |
742 %!test a=3; # assign to a shared variable | |
743 %!test assert(a,3) # variable should equal 3 | |
744 %!shared b,c # replace shared variables | |
745 %!test assert (!exist("a")); # a no longer exists | |
746 %!test assert (isempty(b)); # variables start off empty | |
747 %!shared a,b,c # recreate a shared variable | |
748 %!test assert (isempty(a)); # value is empty even if it had a previous value | |
749 %!test a=1; b=2; c=3; # give values to all variables | |
750 %!test assert ([a,b,c],[1,2,3]); # test all of them together | |
751 %!test c=6; # update a value | |
752 %!test assert([a, b, c],[1, 2, 6]); # show that the update sticks | |
753 %!shared # clear all shared variables | |
754 %!test assert(!exist("a")) # show that they are cleared | |
755 %!shared a,b,c # support for initializer shorthand | |
756 %! a=1; b=2; c=4; | |
757 | |
758 %!function x = __test_a(y) | |
759 %! x = 2*y; | |
760 %!assert(__test_a(2),4); # Test a test function | |
761 | |
762 %!function __test_a (y) | |
763 %! x = 2*y; | |
764 %!test | |
765 %! __test_a(2); # Test a test function with no return value | |
766 | |
767 %!function [x,z] = __test_a (y) | |
768 %! x = 2*y; | |
769 %! z = 3*y; | |
770 %!test # Test a test function with multiple returns | |
771 %! [x,z] = __test_a(3); | |
772 %! assert(x,6); | |
773 %! assert(z,9); | |
774 | |
775 %!## test of assert block | |
776 %!assert (isempty([])) # support for test assert shorthand | |
777 | |
778 %!## demo blocks | |
779 %!demo # multiline demo block | |
780 %! t=[0:0.01:2*pi]; x=sin(t); | |
781 %! plot(t,x); | |
782 %! % you should now see a sine wave in your figure window | |
783 %!demo a=3 # single line demo blocks work too | |
784 | |
785 %!## this is a comment block. it can contain anything. | |
786 %!## | |
787 %! it is the "#" as the block type that makes it a comment | |
788 %! and it stays as a comment even through continuation lines | |
789 %! which means that it works well with commenting out whole tests | |
790 | |
791 % !# failure tests. All the following should fail. These tests should | |
792 % !# be disabled unless you are developing test() since users don't | |
793 % !# like to be presented with expected failures. I use % ! to disable. | |
794 % !test error("---------Failure tests. Use test('test','verbose',1)"); | |
795 % !test assert([a,b,c],[1,3,6]); # variables have wrong values | |
796 % !bogus # unknown block type | |
797 % !error toeplitz([1,2,3]); # correct usage | |
798 % !test syntax errors) # syntax errors fail properly | |
799 % !shared garbage in # variables must be comma separated | |
800 % !error syntax++error # error test fails on syntax errors | |
801 % !error "succeeds."; # error test fails if code succeeds | |
802 % !error <wrong pattern> error("message") # error pattern must match | |
803 % !demo with syntax error # syntax errors in demo fail properly | |
804 % !shared a,b,c | |
805 % !demo # shared variables not available in demo | |
806 % ! assert(exist("a")) | |
807 % !error | |
808 % ! test('/etc/passwd'); | |
809 % ! test("nonexistent file"); | |
810 % ! ## These don't signal an error, so the test for an error fails. Note | |
811 % ! ## that the call doesn't reference the current fid (it is unavailable), | |
812 % ! ## so of course the informational message is not printed in the log. |