matlabtest.codequalitydashboard.getMetrics - Get metrics from Code Quality Dashboard - MATLAB (original) (raw)
Get metrics from Code Quality Dashboard
Since R2024a
Syntax
Description
[info](#mw%5Ff0f2628f-631d-43a2-8cec-75282a98e261) = matlabtest.codequalitydashboard.getMetrics returns information about the current project and the code quality metrics from the Code Quality Dashboard.
Examples
This example shows how to update, get, and export metrics from the Code Quality Dashboard.
Open the ShortestPath project.
openProject("MATLABShortestPath");
Open the Code Quality Dashboard.
Run the tests in the project, collect coverage for the tests, verify the requirements, and update the metrics in the dashboard.
matlabtest.codequalitydashboard.runTestsAndRefreshData
Get the metrics from the Code Quality Dashboard.
metrics = matlabtest.codequalitydashboard.getMetrics
metrics = struct with fields: ProjectPath: "C:\Users\jdoe\MATLAB\MATLABShortestPath" Metrics: [1×1 struct]
Export the metrics to a JSON file.
filePath = matlabtest.codequalitydashboard.exportMetrics
filePath = "C:\Users\jdoe\MATLAB\MATLABShortestPath\CodeQualityMetrics.json"
Output Arguments
Code quality metric information, returned as a structure with these fields:
Project root folder path, returned as a string.
Code Quality Dashboard metric results, returned as a structure with these fields:
Code Analyzer metric results, returned as a structure with these fields:
Date and time when the software collected the results, returned as a character vector.
Stale metric indicator, returned as a 1 or 0 of data type logical.
Code Analyzer metric data, returned as a structure with these fields:
Number of errors, returned as a double.
Number of warnings, returned as a double.
Number of informational messages, returned as a double.
Test metric results, returned as a structure with these fields:
Date and time when the software collected the results, returned as a character vector.
Stale metric indicator, returned as a 1 or 0 of data type logical.
Test result metric data, returned as a structure with these fields:
Number of passed tests, returned as a double.
Number of failed tests, returned as a double.
Number of incomplete tests, returned as a double.
Number of tests that have not run, returned as a double.
Total number of tests, returned as a double.
Code coverage metric results, returned as a structure with these fields:
Date and time when the software collected the results, returned as a character vector.
Stale metric indicator, returned as a 1 or 0 of data type logical.
Code coverage metric data, returned as a structure with these fields:
Function coverage percentage, returned as a double.
Statement coverage percentage, returned as a double.
Decision coverage percentage, returned as a double.
Condition coverage percentage, returned as a double.
MC/DC coverage percentage, returned as a double.
Since R2024b
Generated code coverage metric results, returned as a structure with these fields:
Date and time when the software collected the results, returned as a character vector.
Stale metric indicator, returned as a 1 or 0 of data type logical.
Code coverage metric data, returned as a structure with these fields:
Function coverage percentage, returned as a double.
Statement coverage percentage, returned as a double.
Decision coverage percentage, returned as a double.
Condition coverage percentage, returned as a double.
MC/DC coverage percentage, returned as a double.
Requirement verification metric results, returned as a structure with these fields:
Date and time when the software collected the results, returned as a character vector.
Stale metric indicator, returned as a 1 or 0 of data type logical.
Requirement verification metric data, returned as a structure with these fields:
Number of requirements that link to passed tests, returned as a double.
Number of requirements that link to failed tests, returned as a double.
Number of requirements that link to tests that have not run, returned as a double.
Number of requirements that do not link to tests, returned as a double.
Number of justified requirements links, returned as a double.
Total number of requirements, returned as a double.
Version History
Introduced in R2024a
If you have Embedded Coder®, the returned structure contains the GeneratedCodeCoverage structure, which returns information about the generated code coverage metric results.