MUnit.m

Go to the documentation of this file.

/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

class MUnit {
    public: /* ( Constant ) */

        static const TestFunctionPrefix = "test_";
        static const GreenCol = "[0 .5 0]";
        static const BlueCol = "*"[0 0 .8]"";
        static const WarnCol = "*"[1 .4 0]"";
    public: /* ( Static ) */ /* ( Constant ) */

        static function succeeded = RunClassTests(dir,returnonerror,exclude) {

            /*  Check for no specified path */
            if nargin < 3
                exclude = [];
                if nargin < 2
                    returnonerror = false;
                    if nargin < 1
                        dir = cd;
                    end
                end
            end

            /*  Check if the current directory path contains packages and
             * extract them if necessary */
            curPackage = ;
            pckidx = strfind(dir," + ");
            if ~isempty(pckidx)
                curPackage = dir(pckidx(1)+1:end);
                curPackage = [strrep(strrep(curPackage," + "," . ")," / ",) " . "];
            end

            a = KerMor.App;
            old = a.UseDPCM;
            a.UseDPCM= false;

            /*  Start recursive run */
            [s,f,succeeded,abort] = MUnit.recursiveRun(dir, curPackage, returnonerror, exclude);

            a.UseDPCM= old;

            /*  Summary */
            if abort
                fprintf(" \n\n Test runs aborted.\n ");
            else
                fprintf(" \n\n All Class Tests finished.\n ");
            end
            cprintf(MUnit.GreenCol," Successful:%d\n ",s);
            cprintf(" Red "," Failed:%d\n ",f);
        }
    private: /* ( Static ) */ /* ( Constant ) */

        static function [s , f , cell<char>succeeded , abort ] = recursiveRun(folder,char currentPackage,returnonerror,cell<char> exclude) {

            s = 0; f = 0; succeeded = exclude;

            if exist(folder," file ") ~= 7
                folder = fullfile(pwd,folder);
                if exist(folder," file ") ~= 7
                    error(" Folder %s does not seem to exist. ",folder);
                end
            end

            /*  Descend into subfolders */
            dinf = dir(folder);
            for idx = 1:length(dinf)
                if dinf(idx).isdir
                    subdir = dinf(idx).name;
                    if ~any(strcmp(subdir,[" . "," .. "]))
                        subdir = fullfile(folder,subdir);
                        /* disp(['Descending into ' subdir]); */
                        [sa,fa,succeeded,abort] = ...
                            MUnit.recursiveRun(subdir, currentPackage, returnonerror, succeeded);
                        s = s + sa;
                        f = f + fa;
                        if abort
                            return;
                        end
                    end
                end
            end

            /*  Descend into any package */
            w = what(folder);
            w=w(1); /*  Some weird afs stuff goin on! */

            for idx = 1:length(w.packages)
                subdir = fullfile(w.path,[" + " w.packages[idx]]);
                /* disp(['Descending into ' subdir]); */
                [sa,fa,succeeded,abort] = MUnit.recursiveRun(subdir, [currentPackage w.packages[idx] " . "], returnonerror, succeeded);
                s = s + sa;
                f = f + fa;
                if abort
                    return;
                end
            end

            pref = MUnit.TestFunctionPrefix;
            pl = length(pref);

            targets = [w.m; w.classes];

            /*  Run tests in current directory */
            for idx = 1:length(targets)
                [~,n] = fileparts(targets[idx]);

                /* disp(['Checking ' n '...']); */

                try
                    mc = meta.class.fromName([currentPackage n]);
                catch ME
                    warning(" Could not instantiate class %s: %s ",[currentPackage n],ME.message);
                    abort = true;
                    return;
                end
                /*  mc is empty if m-file wasnt a class */
                if ~isempty(mc)

                    /* disp(['Checking ' mc.Name '...']); */

                    for midx=1:length(mc.Methods)
                        m = mc.Methods[midx];

                        /* disp(['Method: ' mc.Name '.' m.Name]); */

                        /*  check for test function and if the method is
                         * actually declared within the current class
                         * (subclassing would otherwise lead to a repeated
                         * call to the test) */
                        if length(m.Name) >= pl+1 ...
                                && strcmp(m.Access," public ") ...
                                && ~m.Abstract ...
                                && strcmpi(m.Name(1:pl),pref) ...
                                && strcmp(m.DefiningClass.Name,mc.Name)
                            /*  check if the method is static [non-statics
                             * cant be run without instances.. :-)] */
                            if m.Static
                                fullname = [mc.Name " . " m.Name];
                                if any(strcmp(fullname,exclude))
                                    continue;
                                end
                                lines = " @--------------@---------------@ ";
                                fprintf(2,[lines "  Running  "...
                                    " <a href='matlab: " mc.Name " . " m.Name " '> " m.Name(6:end) " </a>  " ...
                                    " in <a href='matlab:edit  " mc.Name " '> " mc.Name " </a> " ...
                                    " ...  " lines " \n "]);
                                try
                                    eval([" outargs = nargout(@ " fullname " ); "]);
                                    if outargs > 0
                                        command = [" succ =  " fullname " ; "];
                                    else
                                        command = [fullname " ; "];
                                    end
                                    eval(command);
                                    if outargs == 0 || succ
                                        cprintf(MUnit.GreenCol,[" Test  " mc.Name "  ->  " m.Name(6:end) "  succeeded!\n "]);
                                        succeeded[end+1] = fullname;/* #ok */

                                        s = s+1;
                                    elseif ~succ
                                        cprintf(" Red "," Failure!\n ");
                                        f = f+1;
                                    end
                                catch ME
                                    f = f+1;
                                    cprintf(MUnit.WarnCol,[" Test  " mc.Name "  ->  " m.Name(6:end) "  failed!\nExeption information:\n "]);
                                    disp(getReport(ME));
                                    if returnonerror
                                        abort = true;
                                        return;
                                    end
                                end
                            else
                                cprintf(MUnit.WarnCol,[" Non-static test '%s' in %s found. "...
                                    " Should this be static?\n "],...
                                    m.Name((length(MUnit.TestFunctionPrefix)+1):end),...
                                    mc.Name);
                            end
                        end
                    end
                end
            end
            abort = false;
        }
};