nwbtest.m

function results = nwbtest(varargin)
    % NWBTEST Run MatNWB test suite.
    %
    %   The nwbtest function provides a simple way to run the MatNWB test
    %   suite. It writes a JUnit-style XML file containing the test results
    %   (testResults.xml) and a Cobertura-style XML file containing a code
    %   coverage report (coverage.xml).
    %
    %   EXITCODE = nwbtest() runs all tests in the MatNWB test suite and
    %   returns a logical 1 (true) if any tests failed, or a logical 0 (false)
    %   if all tests passed.
    %
    %   EXITCODE = nwbtest('Verbosity', VERBOSITY) runs the tests at the
    %   specified VERBOSITY level. VERBOSITY can be specified as either a
    %   numeric value (1, 2, 3, or 4) or a value from the
    %   matlab.unittest.Verbosity enumeration.
    %
    %   EXITCODE = nwbtest(NAME, VALUE, ...) also supports those name-value
    %   pairs of the matlab.unittest.TestSuite.fromPackage function.
    %
    %   Examples:
    %
    %     % Run all tests in the MatNWB test suite.
    %     nwbtest()
    %
    %     % Run all unit tests in the MatNWB test suite.
    %     nwbtest('Name', 'tests.unit.*')
    %
    %     % Run only tests that match the ProcedureName 'testSmoke*'.
    %     nwbtest('ProcedureName', 'testSmoke*')
    %
    %   See also: matlab.unittest.TestSuite.fromPackage
    import matlab.unittest.TestSuite;
    import matlab.unittest.TestRunner;
    import matlab.unittest.plugins.XMLPlugin;
    
    import matlab.unittest.plugins.CodeCoveragePlugin;
    import matlab.unittest.plugins.codecoverage.CoberturaFormat;
    try
        parser = inputParser;
        parser.KeepUnmatched = true;
        parser.addParameter('Verbosity', 1);
        parser.addParameter('Selector', [])
        parser.parse(varargin{:});
        
        ws = pwd;
        
        nwbClearGenerated(); % Clear default files if any.
        cleanupObj = onCleanup(@() generateCore);
        cleaner = onCleanup(@generateCore); % Regenerate core when finished

        pvcell = struct2pvcell(parser.Unmatched);
        suite = TestSuite.fromPackage('tests', 'IncludingSubpackages', true, pvcell{:});
        if ~isempty(parser.Results.Selector)
            suite = suite.selectIf(parser.Results.Selector);
        end
        
        runner = TestRunner.withTextOutput('Verbosity', parser.Results.Verbosity);
        
        resultsFile = fullfile(ws, 'testResults.xml');
        runner.addPlugin(XMLPlugin.producingJUnitFormat(resultsFile));
        
        coverageFile = fullfile(ws, 'coverage.xml');
        [installDir, ~, ~] = fileparts(mfilename('fullpath'));
        
        ignoreFolders = {'tutorials', 'tools', '+contrib', '+util', 'external_packages', '+tests'};
        ignorePaths = {fullfile('+misc', 'generateDocs.m'), [mfilename '.m'], 'nwbClearGenerated.m'};
        mfilePaths = getMfilePaths(installDir, ignoreFolders, ignorePaths);
        if ~verLessThan('matlab', '9.3') && ~isempty(mfilePaths)
            runner.addPlugin(CodeCoveragePlugin.forFile(mfilePaths,...
                'Producing', CoberturaFormat(coverageFile)));
        end % add cobertura coverage
        
        results = runner.run(suite);
        
        display(results);
    catch e
        disp(e.getReport('extended'));
        results = [];
    end
end

function pv = struct2pvcell(s)
    p = fieldnames(s);
    v = struct2cell(s);
    n = 2*numel(p);
    
    pv = cell(1,n);
    pv(1:2:n) = p;
    pv(2:2:n) = v;
end

function paths = getMfilePaths(folder, excludeFolders, excludePaths)
    mfiles = dir(fullfile(folder, '**', '*.m'));
    excludeFolders = fullfile(folder, excludeFolders);
    excludePaths = fullfile(folder, excludePaths);
    paths = {};
    for i = 1:numel(mfiles)
        file = mfiles(i);
        filePath = fullfile(file.folder, file.name);
        if any(startsWith(file.folder, excludeFolders)) || any(strcmp(filePath, excludePaths))
            continue;
        end
        paths{end+1} = filePath; %#ok<AGROW>
    end
end