Визуализация результатов анализа проверки кода в MATLAB

После анализа результаты можно прочесть в таблицу MATLAB ®. С помощью таблицы можно создавать графики или статистические данные о результатах. При наличии генератора отчетов MATLAB эти таблицы и графики можно включить в отчет PDF или HTML.

Экспорт результатов в таблицу MATLAB

Для считывания существующих результатов анализа Polyspace ® в таблицу MATLAB используйте polyspace.CodeProverResults объект, связанный с результатами.

Например, для чтения демонстрационных результатов в подпапке только для чтения polyspace/examples/cxx/Code_Prover_Example/Module_1/CP_Result папки установки MATLAB скопируйте результаты в папку для записи и прочитайте их:

resPath = fullfile(polyspaceroot, 'polyspace', ... 
    'examples', 'cxx', 'Code_Prover_Example', 'Module_1','CP_Result');

userResPath = tempname;
copyfile(resPath,userResPath);

resObj = polyspace.CodeProverResults(userResPath);
resSummary = getSummary(resObj);
resTable = getResults(resObj);

resSummary и resTable две таблицы MATLAB, содержащие сводку и подробные данные результатов Polyspace.

Можно также выполнить анализ Polyspace для исходных файлов C/C + + с помощью polyspace.Project объект. После анализа Results свойство объекта содержит результаты. См. раздел Выполнение анализа в пространстве с использованием сценариев MATLAB.

Создание графиков на основе результатов и включение в отчет

Результаты анализа можно визуализировать в таблице MATLAB в удобном формате. При наличии генератора отчетов MATLAB можно создать отчет PDF или HTML, содержащий визуализации.

В этом примере создается круговая диаграмма, показывающая распределение красных, серых и оранжевых проверок времени выполнения по типу проверки, и диаграмма включается в отчет.

%% This example shows how to create a pie chart from your results and append 
% it to a report.

%% Generate Pie Chart from Polyspace Results

% Copy a demo result set to a temporary folder.
resPath = fullfile(polyspaceroot,'polyspace','examples','cxx', ...
    'Code_Prover_Example','Module_1','CP_Result');  
userResPath = tempname;
copyfile(resPath,userResPath);
 
% Read results into a table.
resObj = polyspace.CodeProverResults(userResPath);
resTable = getResults(resObj);
 
% Keep results that are run-time checks and eliminate green checks.
matches = (resTable.Family == 'Run-time Check') &...
    (resTable.Color  ~= 'Green');
checkTable = resTable(matches, :);
 
% Create a pie chart showing distribution of checks.
checkList = removecats(checkTable.Check);
pieChecks = pie(checkList);
labels = get(pieChecks(2:2:end),'String');
set(pieChecks(2:2:end),'String','');
legend(labels,'Location','bestoutside')

% Save the pie chart.
print('file','-dpng');


%% Append Pie Chart to Report 
% Requires MATLAB Report Generator

% Create a report object.
import mlreportgen.dom.*;
report = Document('PolyspaceReport','html');
 
% Add a heading and paragraph to the report.
append(report, Heading(1,'Code Prover Run-Time Errors Graph'));
paragraphText = ['The following graph shows the distribution of ' ...
               'run-time errors in your code.'];
append(report, Paragraph(paragraphText));

% Add the image to the report.
chartObj = Image('file.png');
append(report, chartObj);

% Add another heading and paragraph to the report.
append(report, Heading(1,'Code Prover Run-Time Errors Details'));
paragraphText = ['The following table shows the run-time errors ' ...
               'in your code.'];
append(report, Paragraph(paragraphText));
 
% Add the table of run-time errors to the report.
reducedInfoTable = checkTable(:,{'File','Function','Check','Color',...
    'Status','Severity','Comment'});
reducedInfoTable = sortrows(reducedInfoTable,[1 2]);
tableObj = MATLABTable(reducedInfoTable);
tableObj.Style = {Border('solid','black'),ColSep('solid','black'),...
    RowSep('solid','black')};
append(report, tableObj);
 
% Close and view the report in a browser.
close(report);
rptview(report.OutputPath);

В примере используются следующие ключевые функции:

polyspace.CodeProverResults: Прочтите результаты проверки кода в таблицу.
pie: Создание круговой диаграммы из категориального массива. Можно также использовать функцию. histogram или heatmap.
Для создания гистограмм замените pie с histogram в сценарии и удалить легенды круговой диаграммы.
mlreportgen.dom.Document(Генератор отчетов MATLAB): создание объекта отчета, определяющего формат и место хранения отчета.
append(Генератор отчетов MATLAB): добавление содержимого к существующему отчету.

При выполнении сценария отображается распределение чеков по типу чека. Сценарий также создает HTML-отчет, содержащий график и таблицу проверок Polyspace.

Документация