matlab.unittest.plugins.CodeCoveragePlugin.forFolder — Select source folders for test-run coverage collection.
CodeCoveragePlugin.forFolder(folder, ...) creates a plugin that retains the selected folders and IncludingSubfolders flag for a RunMat TestRunner.
Syntax
plugin = matlab.unittest.plugins.CodeCoveragePlugin.forFolder(folder, ...)Inputs
folder- Type
Any- Required
- Yes
- Default
- —
- Description
- At least one nonempty host string scalar, character row, or string array of folders.
additionalFoldersOrOptions- Type
Any- Required
- Variadic
- Default
- —
- Description
- Further folders or the supported 'IncludingSubfolders' name-value pair.
Returns
plugin- Type
Any- Description
- A scalar plugin object of the declared concrete class.
Errors
RunMat:Testing:InvalidPlugin- When
- No nonempty folder is supplied, a folder is not supported host text, or IncludingSubfolders is absent or not scalar logical or numeric 0/1.
- Message
CodeCoveragePlugin.forFolder requires supported nonempty folders and a valid IncludingSubfolders option
RunMat:Testing:UnsupportedPluginOption- When
- Producing, MetricLevel, or Filter appears after a folder.
- Message
CodeCoveragePlugin.forFolder does not support that option
Accepted constructor forms
Pass one or more nonempty host string scalars, character rows, or string arrays as folders. The first argument is always a folder. The supported name-value option after it is IncludingSubfolders as a string scalar or character row, with scalar logical true/false or numeric double 0/1. The constructor records paths without checking that the folders exist; empty entries in a string array are currently skipped.
Producing, MetricLevel, and Filter are recognized as unsupported option names after the first folder and return UnsupportedPluginOption rather than silently becoming folders. Cell arrays of character vectors and coverage-report format objects are not implemented. Other unrecognized text arguments are treated as folders, so explicit option-like text that is not one of these names is not interpreted as an option.
Coverage during a test run
Construction alone does not run tests or instrument code. When the plugin is attached to a runner, the Core test executor uses its folder selection to filter collected coverage sites and projects a RunMat coverage summary onto test results. It does not emit MATLAB's HTML report or guarantee MATLAB coverage metrics and report formats.
Example
Configure coverage collection for a folder tree
plugin = matlab.unittest.plugins.CodeCoveragePlugin.forFolder('src', 'IncludingSubfolders', true);Using matlab.unittest.plugins.CodeCoveragePlugin.forFolder with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how matlab.unittest.plugins.CodeCoveragePlugin.forFolder changes the result.
Run a small matlab.unittest.plugins.CodeCoveragePlugin.forFolder example, explain the result, then change one input and compare the output.
Related Testing functions
Testing
functiontests · matlab.unittest.TestCase · matlab.unittest.TestRunner.addPlugin · matlab.unittest.TestRunner.run · matlab.unittest.TestRunner.withTextOutput · testsuite
Constraints
matlab.unittest.constraints.IsEqualTo · matlab.unittest.constraints.IsFalse · matlab.unittest.constraints.IsTrue
Fixtures
matlab.unittest.fixtures.PathFixture · matlab.unittest.fixtures.TemporaryFolderFixture · matlab.unittest.TestCase.addTeardown · matlab.unittest.TestCase.applyFixture
Qualifications
matlab.unittest.TestCase.assertEqual · matlab.unittest.TestCase.assertThat · matlab.unittest.TestCase.assertTrue · matlab.unittest.TestCase.assumeEqual · matlab.unittest.TestCase.assumeTrue · matlab.unittest.TestCase.fatalAssertTrue · matlab.unittest.TestCase.verifyEmpty · matlab.unittest.TestCase.verifyEqual · matlab.unittest.TestCase.verifyFalse · matlab.unittest.TestCase.verifyGreaterThan · matlab.unittest.TestCase.verifyLessThan · matlab.unittest.TestCase.verifyNotEmpty · matlab.unittest.TestCase.verifyNotEqual · matlab.unittest.TestCase.verifyThat · matlab.unittest.TestCase.verifyTrue
Source you can read
Every RunMat function's source is public. Read exactly how matlab.unittest.plugins.CodeCoveragePlugin.forFolder is executed, line by line, in Rust.
- View the source for matlab.unittest.plugins.CodeCoveragePlugin.forFolder in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.