Mercurial > octave
view scripts/testfun/__run_test_suite__.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 505ed551e366 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2005-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {[@var{pass}, @var{fail}, @var{xfail}, @var{xbug}, @var{skip}, @var{rtskip}, @var{regress}]} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}) ## @deftypefnx {} {[@var{pass}, @var{fail}, @var{xfail}, @var{xbug}, @var{skip}, @var{rtskip}, @var{regress}]} __run_test_suite__ (@var{fcndirs}, @var{fixedtestdirs}, @var{topsrcdir}, @var{topbuilddir}) ## Undocumented internal function. ## @end deftypefn function [pass, fail, xfail, xbug, skip, rtskip, regress] = __run_test_suite__ (fcndirs, fixedtestdirs, topsrcdir = [], topbuilddir = []) testsdir = __octave_config_info__ ("octtestsdir"); libinterptestdir = fullfile (testsdir, "libinterp"); liboctavetestdir = fullfile (testsdir, "liboctave"); fixedtestdir = fullfile (testsdir, "fixed"); fcnfiledir = __octave_config_info__ ("fcnfiledir"); if (nargin == 0) fcndirs = { liboctavetestdir, libinterptestdir, fcnfiledir }; fixedtestdirs = { fixedtestdir }; endif files_with_no_tests = {}; files_with_tests = {}; summary_failure_info = struct ([]); ## FIXME: These names don't really make sense if we are running ## tests for an installed copy of Octave. if (isempty (topsrcdir)) topsrcdir = fcnfiledir; endif if (isempty (topbuilddir)) topbuilddir = testsdir; endif pso = page_screen_output (); orig_wquiet = warning ("query", "quiet"); orig_wstate = warning (); orig_mfile_encoding = __mfile_encoding__ ("utf-8"); logfile = make_absolute_filename ("fntests.log"); unwind_protect page_screen_output (false); warning ("on", "quiet"); warning ("off", "Octave:deprecated-function"); warning ("off", "Octave:legacy-function"); nfail = dp = dn = dxf = dxb = dsk = drtsk = drgrs = 0; try fid = fopen (logfile, "wt"); if (fid < 0) error ("__run_test_suite__: could not open %s for writing", logfile); endif test ("", "explain", fid); puts ("\nIntegrated test scripts:\n\n"); for i = 1:length (fcndirs) [p, n, xf, xb, sk, rtsk, rgrs] = run_test_dir (fid, fcndirs{i}, false); dp += p; dn += n; dxf += xf; dxb += xb; dsk += sk; drtsk += rtsk; drgrs += rgrs; endfor puts ("\nFixed test scripts:\n\n"); for i = 1:length (fixedtestdirs) [p, n, xf, xb, sk, rtsk, rgrs] = run_test_dir (fid, fixedtestdirs{i}, true); dp += p; dn += n; dxf += xf; dxb += xb; dsk += sk; drtsk += rtsk; drgrs += rgrs; endfor if (! isempty (summary_failure_info)) puts ("\nFailure Summary:\n\n"); for i = 1:numel (summary_failure_info) info = summary_failure_info(i); print_test_file_name (info.name); print_pass_fail (info); endfor endif puts ("\nSummary:\n\n"); nfail = dn - dp - dxf - dxb - drgrs; printf (" %-30s %6d\n", "PASS", dp); printf (" %-30s %6d\n", "FAIL", nfail); if (drgrs > 0) printf (" %-30s %6d\n", "REGRESSION", drgrs); endif if (dxb > 0) printf (" %-30s %6d\n", "XFAIL (reported bug)", dxb); endif if (dxf > 0) printf (" %-30s %6d\n", "XFAIL (expected failure)", dxf); endif if (dsk > 0) printf (" %-30s %6d\n", "SKIP (missing feature)", dsk); endif if (drtsk > 0) printf (" %-30s %6d\n", "SKIP (run-time condition)", drtsk); endif puts ("\n"); printf ("See the file %s for additional details.\n", logfile); if (dxf > 0 || dxb > 0) puts ("\n"); puts ("XFAIL items are known bugs or expected failures.\n"); puts ("Bug report numbers may be found in the log file:\n"); puts (logfile); puts ("\nPlease help improve Octave by contributing fixes for them.\n"); endif if (dsk > 0 || drtsk > 0) puts ("\n"); puts ("Tests are often skipped because required features were\n"); puts ("disabled or were not present when Octave was built.\n"); puts ("The configure script should have printed a summary\n"); puts ("indicating which dependencies were not found.\n"); endif ## Weed out deprecated, legacy, and private functions weed_idx = cellfun (@isempty, regexp (files_with_tests, '\<deprecated\>|\<legacy\>|\<private\>', 'once')); files_with_tests = files_with_tests(weed_idx); weed_idx = cellfun (@isempty, regexp (files_with_no_tests, '\<deprecated\>|\<legacy\>|\<private\>', 'once')); files_with_no_tests = files_with_no_tests(weed_idx); report_files_with_no_tests (files_with_tests, files_with_no_tests, ".m"); puts ("\nPlease help improve Octave by contributing tests for these files\n"); printf ("(see the list in the file %s).\n\n", logfile); fprintf (fid, "\nFiles with no tests:\n\n%s", list_in_columns (files_with_no_tests, 80)); fclose (fid); catch disp (lasterr ()); end_try_catch unwind_protect_cleanup warning ("off", "all"); warning (orig_wstate); warning (orig_wquiet.state, "quiet"); __mfile_encoding__ (orig_mfile_encoding); page_screen_output (pso); end_unwind_protect if (nargout > 0) pass = dp; fail = nfail; xfail = dxf; xbug = dxb; skip = dsk; rtskip = drtsk; regress = drgrs; endif function [dp, dn, dxf, dxb, dsk, drtsk, drgrs] = run_test_dir (fid, d, is_fixed = false) lst = dir (d); dp = dn = dxf = dxb = dsk = drtsk = drgrs = 0; for i = 1:length (lst) nm = lst(i).name; if (lst(i).isdir && nm(1) != "." && ! strcmp (nm, "private")) [p, n, xf, xb, sk, rtsk, rgrs] = run_test_dir (fid, [d, filesep, nm], is_fixed); dp += p; dn += n; dxf += xf; dxb += xb; dsk += sk; drtsk += rtsk; drgrs += rgrs; endif endfor saved_dir = pwd (); unwind_protect [dnm, fnm] = fileparts (d); if (fnm(1) != "@") cd (d); endif for i = 1:length (lst) nm = lst(i).name; ## Ignore hidden files if (nm(1) == '.') continue; endif if ((! is_fixed && length (nm) > 2 && strcmpi (nm((end-1):end), ".m")) || (! is_fixed && length (nm) > 4 && strcmpi (nm((end-3):end), "-tst")) || (is_fixed && length (nm) > 4 && strcmpi (nm((end-3):end), ".tst"))) p = n = xf = xb = sk = rtsk = rgrs = 0; ffnm = fullfile (d, nm); if (! isfile (ffnm)) continue; endif ## Only run if contains %!test, %!assert, %!error, %!fail, or %!warning if (has_tests (ffnm)) tmp = reduce_test_file_name (ffnm, topbuilddir, topsrcdir); print_test_file_name (tmp); [p, n, xf, xb, sk, rtsk, rgrs] = test (ffnm, "quiet", fid); print_pass_fail (p, n, xf, xb, sk, rtsk, rgrs); dp += p; dn += n; dxf += xf; dxb += xb; dsk += sk; drtsk += rtsk; drgrs += rgrs; files_with_tests(end+1) = ffnm; if (n - p > 0) ## Save info for summary if there were any failed ## tests for this file. failure_info = struct ("name", tmp, "pass", p, "ntst", n, "xf", xf, "xb", xb, "rgrs", rgrs); summary_failure_info(end+1) = failure_info; endif else ## To reduce the list length, only mark .cc files that contain ## DEFUN definitions. files_with_no_tests(end+1) = ffnm; endif endif endfor unwind_protect_cleanup cd (saved_dir); end_unwind_protect endfunction endfunction function print_test_file_name (nm) nmlen = numel (nm); filler = repmat (".", 1, 63-nmlen); if (nmlen > 63) nm = ["..", nm(nmlen-60:end)]; endif printf (" %s %s", nm, filler); endfunction function fail_info = print_pass_fail (p, n, xf, xb, sk, rtsk, rgrs) if (nargin == 1) ## The summary info struct just contains info about failures, not ## skipped tests. info = p; p = info.pass; n = info.ntst; xf = info.xf; xb = info.xb; sk = 0; rtsk = 0; rgrs = info.rgrs; endif if ((n + sk + rtsk + rgrs) > 0) printf (" pass %4d/%-4d", p, n); nfail = n - p - xf - xb - rgrs; if (nfail > 0) printf ("\n%72s %3d", "FAIL ", nfail); endif if (rgrs > 0) printf ("\n%72s %3d", "REGRESSION", rgrs); endif if (sk > 0) printf ("\n%72s %3d", "(missing feature) SKIP ", sk); endif if (rtsk > 0) printf ("\n%72s %3d", "(run-time condition) SKIP ", rtsk); endif if (xb > 0) printf ("\n%72s %3d", "(reported bug) XFAIL", xb); endif if (xf > 0) printf ("\n%72s %3d", "(expected failure) XFAIL", xf); endif endif puts ("\n"); endfunction function retval = reduce_test_file_name (nm, builddir, srcdir) ## Reduce the given absolute file name to a relative path by removing one ## of the likely root directory prefixes. prefix = { builddir, fullfile(builddir, "scripts"), ... srcdir, fullfile(srcdir, "scripts"), ... srcdir, fullfile(srcdir, "test") }; retval = nm; for i = 1:numel (prefix) tmp = strrep (nm, [prefix{i}, filesep], ""); if (length (tmp) < length (retval)) retval = tmp; endif endfor endfunction function retval = has_functions (f) n = length (f); if (n > 3 && strcmpi (f((end-2):end), ".cc")) fid = fopen (f); if (fid < 0) error ("__run_test_suite__: fopen failed: %s", f); endif str = fread (fid, "*char")'; fclose (fid); retval = ! isempty (regexp (str,'^(DEFUN|DEFUN_DLD)\>', 'lineanchors', 'once')); elseif (n > 2 && strcmpi (f((end-1):end), ".m")) retval = true; else retval = false; endif endfunction function retval = has_tests (f) fid = fopen (f); if (fid < 0) error ("__run_test_suite__: fopen failed: %s", f); endif str = fread (fid, "*char")'; fclose (fid); retval = ! isempty (regexp (str, '^%!(assert|error|fail|test|xtest|warning)', 'lineanchors', 'once')); endfunction function n = num_elts_matching_pattern (lst, pat) n = sum (! cellfun ("isempty", regexp (lst, pat, 'once'))); endfunction function report_files_with_no_tests (with, without, typ) pat = ['\' typ "$"]; n_with = num_elts_matching_pattern (with, pat); n_without = num_elts_matching_pattern (without, pat); n_tot = n_with + n_without; printf ("\n%d (of %d) %s files have no tests.\n", n_without, n_tot, typ); endfunction ## No test coverage for internal function. It is tested through calling fcn. %!assert (1)