-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathprocessmodel.m
372 lines (335 loc) · 17.2 KB
/
processmodel.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
function processmodel(pm)
% Defines the project's processmodel
arguments
pm padv.ProcessModel
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Include/Exclude Tasks in processmodel
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
includeModelMaintainabilityMetricTask = true;
includeModelTestingMetricTask = false;
includeModelStandardsTask = false;
includeDesignErrorDetectionTask = false;
includeFindClones = false;
includeModelComparisonTask = false;
includeSDDTask = false;
includeSimulinkWebViewTask = false;
includeTestsPerTestCaseTask = false;
includeMergeTestResultsTask = false;
includeRefGenerateCodeTask = false;
includeTopGenerateCodeTask = false; % Project Level Top-Model code generation
includeRefAnalyzeModelCode = false && ~padv.internal.isMACA64 && exist('polyspaceroot','file');
includeTopAnalyzeModelCode = false && ~padv.internal.isMACA64 && exist('polyspaceroot','file'); % Project Level Top-Model code analysis
includeRefProveCodeQuality = false && ~padv.internal.isMACA64 && (~isempty(ver('pscodeprover')) || ~isempty(ver('pscodeproverserver')));
includeTopProveCodeQuality = false && ~padv.internal.isMACA64 && (~isempty(ver('pscodeprover')) || ~isempty(ver('pscodeproverserver')));% Project Level Top-Model code proving
includeRefCodeInspection = false;
includeTopCodeInspection = false;
includeGenerateRequirementsReport = false;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Define Shared Path Variables
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Set default root directory for task results
pm.DefaultOutputDirectory = fullfile('$PROJECTROOT$', 'PA_Results');
defaultResultPath = fullfile('$DEFAULTOUTPUTDIR$','$ITERATIONARTIFACT$');
defaultTestResultPath = fullfile(defaultResultPath,'test_results');
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Define Shared Queries
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
findModels = padv.builtin.query.FindModels(Name="ModelsQuery");
findModelsWithTests = padv.builtin.query.FindModelsWithTestCases(Parent=findModels);
findTestsForModel = padv.builtin.query.FindTestCasesForModel(Parent=findModels);
findRefModels = padv.builtin.query.FindRefModels(Name="RefModelsQuery");
findTopModels = padv.builtin.query.FindTopModels(Name="TopModelsQuery");
findProjectFile = padv.builtin.query.FindProjectFile();
findRefModels2 = padv.builtin.query.FindRefModels(Name="RefModelsQuery");
p2 = pm.addProcess("Process2");
p2task2 = p2.addTask(padv.builtin.task.RunModelStandards(Name = "task2", IterationQuery=findRefModels2));
p2task2.Title= "Task2-title";
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Register Tasks
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Collect Model Maintainability Metrics
% Tools required: Simulink Check
if includeModelMaintainabilityMetricTask
mmMetricTask = pm.addTask(padv.builtin.task.CollectMetrics());
end
%% Check modeling standards
% Tools required: Model Advisor
if includeModelStandardsTask
maTask = pm.addTask(padv.builtin.task.RunModelStandards(IterationQuery=findModels));
maTask.ReportPath = fullfile( ...
defaultResultPath,'model_standards_results');
end
%% Detect design errors
% Tools required: Simulink Design Verifier
if includeDesignErrorDetectionTask
dedTask = pm.addTask(padv.builtin.task.DetectDesignErrors(IterationQuery=findModels)); %#ok<*UNRCH>
dedTask.ReportFilePath = fullfile( ...
defaultResultPath, 'design_error_detections','$ITERATIONARTIFACT$_DED');
end
%% Generate clone detection reports
% Tools required: Clone Detector
if includeFindClones
%Across Model Clones Instance
acrossModelCloneDetectTask = pm.addTask(padv.builtin.task.FindClones(Name = "FindAcrossModelClones", ...
IterationQuery=findModels,Title=message('padv_spkg:builtin_text:FindClonesAcrossModelTitle').getString()));
acrossModelCloneDetectTask.ReportPath = fullfile(defaultResultPath,'findAcrossModelClones');
acrossModelCloneDetectTask.AcrossModelReportName = "$ITERATIONARTIFACT$_AcrossModelClonesReport";
acrossModelCloneDetectTask.DetectLibraryClones = false;
%Library Clones Instance
libCloneDetectTask = pm.addTask(padv.builtin.task.FindClones(Name = "FindLibraryClones", ...
IterationQuery=findModels,Title=message('padv_spkg:builtin_text:FindLibraryClonesTitle').getString()));
libCloneDetectTask.ReportPath = fullfile(defaultResultPath,'findLibraryClones');
libCloneDetectTask.LibraryReportName = "$ITERATIONARTIFACT$_LibraryClonesReport";
libCloneDetectTask.DetectClonesAcrossModel = false;
end
%% Generate Model Comparison
if includeModelComparisonTask
mdlCompTask = pm.addTask(padv.builtin.task.GenerateModelComparison(IterationQuery=findModels));
mdlCompTask.ReportPath = fullfile( ...
defaultResultPath,'model_comparison');
end
%% Generate SDD report (System Design Description)
% Tools required: Simulink Report Generator
if includeSDDTask
sddTask = pm.addTask(padv.builtin.task.GenerateSDDReport(IterationQuery=findModels));
sddTask.ReportPath = fullfile( ...
defaultResultPath,'system_design_description');
sddTask.ReportName = '$ITERATIONARTIFACT$_SDD';
end
%% Generate Simulink web view
% Tools required: Simulink Report Generator
if includeSimulinkWebViewTask
slwebTask = pm.addTask(padv.builtin.task.GenerateSimulinkWebView(IterationQuery=findModels));
slwebTask.ReportPath = fullfile(defaultResultPath,'webview');
slwebTask.ReportName = '$ITERATIONARTIFACT$_webview';
end
%% Run tests per test case
% Tools required: Simulink Test
if includeTestsPerTestCaseTask
milTask = pm.addTask(padv.builtin.task.RunTestsPerTestCase(IterationQuery=findTestsForModel));
% Configure the tests per testcase task
milTask.OutputDirectory = defaultTestResultPath;
end
%% Merge test results
% Tools required: Simulink Test (and optionally Simulink Coverage)
if includeTestsPerTestCaseTask && includeMergeTestResultsTask
mergeTestTask = pm.addTask(padv.builtin.task.MergeTestResults(IterationQuery=findModelsWithTests));
mergeTestTask.ReportPath = defaultTestResultPath;
end
%% Collect Model Testing Metrics
if includeModelTestingMetricTask
mtMetricTask = pm.addTask(padv.builtin.task.CollectMetrics(Name="ModelTestingMetrics", IterationQuery=padv.builtin.query.FindUnits));
mtMetricTask.Title = message('padv_spkg:builtin_text:ModelTestingMetricDemoTaskTitle').getString();
mtMetricTask.Dashboard = "ModelUnitTesting";
mtMetricTask.ReportName = "$ITERATIONARTIFACT$_ModelTesting";
mtMetricTask.ReportPath = fullfile(defaultResultPath, 'testing_metrics');
end
%% Generate Code
% Tools required: Embedded Coder
% By default, we generate code for all models in the project;
if includeRefGenerateCodeTask
codegenTask = pm.addTask(padv.builtin.task.GenerateCode("IterationQuery", ...
findRefModels));
codegenTask.UpdateThisModelReferenceTarget = 'IfOutOfDate';
codegenTask.TreatAsRefModel = true;
codegenTask.Title = "Reference Model Code Generation";
codegenTask.GenerateExternalCodeCache = true;
codegenTask.ExternalCodeCacheDirectory = fullfile(defaultResultPath, 'external_code_cache');
end
if includeTopGenerateCodeTask && includeRefGenerateCodeTask
codegenTopTask = pm.addTask(padv.builtin.task.GenerateCode("IterationQuery", ...
findProjectFile,"InputQueries",{findTopModels,...
padv.builtin.query.GetOutputsOfDependentTask("padv.builtin.task.GenerateCode")},...
"Name", "Top Model Code Generation"));
codegenTopTask.UpdateThisModelReferenceTarget = 'IfOutOfDate';
codegenTopTask.TreatAsRefModel = false;
codegenTopTask.Title = "Top Model Code Generation";
codegenTopTask.TrackAllGeneratedCode = true;
end
%% Check coding standards
% Tools required: Polyspace Bug Finder
if includeRefGenerateCodeTask && includeRefAnalyzeModelCode
psbfTask = pm.addTask(padv.builtin.task.AnalyzeModelCode("IterationQuery", ...
findRefModels,"Name","Reference Model Code Analysis"));
psbfTask.ResultDir = fullfile(defaultResultPath,'bug_finder');
psbfTask.ReportPath = fullfile(defaultResultPath,'bug_finder');
psbfTask.Title = "Reference Model Code Analysis";
end
if includeTopGenerateCodeTask && includeTopAnalyzeModelCode
psbfTopTask = pm.addTask(padv.builtin.task.AnalyzeModelCode("IterationQuery", ...
findProjectFile,"InputQueries",...
{padv.builtin.query.GetOutputsOfDependentTask("Top Model Code Generation"),...
findTopModels},...
"Name","Top Model Code Analysis"));
psbfTopTask.PsPrjFileName = "$INPUTARTIFACT$_BugFinder";
psbfTopTask.Title = "Top Model Code Analysis";
psbfTopTask.ResultDir = fullfile('$DEFAULTOUTPUTDIR$', 'bug_finder', '$INPUTARTIFACT$');
psbfTopTask.ReportPath = string(fullfile('$DEFAULTOUTPUTDIR$', 'bug_finder', '$INPUTARTIFACT$'));
psbfTopTask.ReportNames = ["$INPUTARTIFACT$_BugFinderSummary", ...
"$INPUTARTIFACT$_CodingStandards"];
psbfTopTask.OutputDirectory = string(fullfile('$DEFAULTOUTPUTDIR$', 'bug_finder'));
end
%% Prove Code Quality
% Tools required: Polyspace Code Prover
if includeRefGenerateCodeTask && includeRefProveCodeQuality
pscpTask = pm.addTask(padv.builtin.task.AnalyzeModelCode(Name="RefProveCodeQuality", IterationQuery= ...
findRefModels));
pscpTask.Title = "Ref Model Code Proving";
pscpTask.VerificationMode = "CodeProver";
pscpTask.ResultDir = string(fullfile(defaultResultPath,'code_prover'));
pscpTask.Reports = ["Developer", "CallHierarchy", "VariableAccess"];
pscpTask.ReportPath = string(fullfile(defaultResultPath,'code_prover'));
pscpTask.ReportNames = [...
"$ITERATIONARTIFACT$_Developer", ...
"$ITERATIONARTIFACT$_CallHierarchy", ...
"$ITERATIONARTIFACT$_VariableAccess"];
end
if includeTopGenerateCodeTask && includeTopProveCodeQuality
pscpTopTask = pm.addTask(padv.builtin.task.AnalyzeModelCode(Name="TopProveCodeQuality", IterationQuery= ...
findProjectFile, ...
InputQueries={padv.builtin.query.GetOutputsOfDependentTask("Top Model Code Generation"),...
findTopModels}));
pscpTopTask.Title = "Top Model Code Proving";
pscpTopTask.VerificationMode = "CodeProver";
pscpTopTask.ResultDir = string(fullfile('$DEFAULTOUTPUTDIR$', 'code_prover', '$INPUTARTIFACT$'));
pscpTopTask.Reports = ["Developer", "CallHierarchy", "VariableAccess"];
pscpTopTask.ReportPath = string(fullfile('$DEFAULTOUTPUTDIR$', 'code_prover', '$INPUTARTIFACT$'));
pscpTopTask.ReportNames = [...
"$INPUTARTIFACT$_Developer", ...
"$INPUTARTIFACT$_CallHierarchy", ...
"$INPUTARTIFACT$_VariableAccess"];
pscpTopTask.OutputDirectory = string(fullfile('$DEFAULTOUTPUTDIR$', 'code_prover'));
end
%% Inspect Reference Model Code
if includeRefGenerateCodeTask && includeRefCodeInspection
slciTask = pm.addTask(padv.builtin.task.RunCodeInspection("IterationQuery", ...
findRefModels));
slciTask.ReportFolder = fullfile(defaultResultPath,'code_inspection');
slciTask.Title = "Ref Model Code Inspection";
end
if includeTopGenerateCodeTask && includeTopCodeInspection
slciTopTask = pm.addTask(padv.builtin.task.RunCodeInspection("IterationQuery", ...
findProjectFile,"InputQueries",...
{padv.builtin.query.GetOutputsOfDependentTask("Top Model Code Generation"),...
findTopModels},"Name","Top Model Code Inspection"));
slciTopTask.Title = "Top Model Code Inspection";
slciTopTask.ReportFolder = fullfile('$DEFAULTOUTPUTDIR$','code_inspection', '$INPUTARTIFACT$');
slciTopTask.OutputDirectory = string(fullfile('$DEFAULTOUTPUTDIR$', 'code_inspection'));
end
%% Generate Requirements report
% Tools required: Requirements Toolbox
if includeGenerateRequirementsReport
rqmtTask = pm.addTask(padv.builtin.task.GenerateRequirementsReport());
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Set Task relationships
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Set Task Dependencies
if includeRefGenerateCodeTask && includeRefCodeInspection
slciTask.dependsOn(codegenTask);
end
if includeRefGenerateCodeTask && includeRefAnalyzeModelCode
psbfTask.dependsOn(codegenTask);
end
if includeRefGenerateCodeTask && includeRefProveCodeQuality
pscpTask.dependsOn(codegenTask);
end
if includeRefGenerateCodeTask && includeTopGenerateCodeTask
codegenTopTask.dependsOn(codegenTask);
end
if includeTopGenerateCodeTask && includeTopCodeInspection && ...
includeRefGenerateCodeTask
slciTopTask.dependsOn(codegenTopTask);
end
if includeTopGenerateCodeTask && includeTopAnalyzeModelCode && ...
includeRefGenerateCodeTask
psbfTopTask.dependsOn(codegenTopTask);
end
if includeTopGenerateCodeTask && includeTopProveCodeQuality && ...
includeRefGenerateCodeTask
pscpTopTask.dependsOn(codegenTopTask);
end
if includeTestsPerTestCaseTask && includeMergeTestResultsTask
mergeTestTask.dependsOn(milTask, "WhenStatus",{'Pass','Fail'});
end
%% Set Task Run-Order
if includeMergeTestResultsTask && includeModelTestingMetricTask
mtMetricTask.runsAfter(mergeTestTask);
end
if includeSimulinkWebViewTask && includeModelMaintainabilityMetricTask
slwebTask.runsAfter(mmMetricTask);
end
if includeModelStandardsTask && includeModelMaintainabilityMetricTask
maTask.runsAfter(mmMetricTask);
end
if includeModelStandardsTask && includeSimulinkWebViewTask
maTask.runsAfter(slwebTask);
end
if includeModelStandardsTask && includeFindClones
acrossModelCloneDetectTask.runsAfter(maTask);
libCloneDetectTask.runsAfter(maTask);
end
if includeDesignErrorDetectionTask && includeModelStandardsTask
dedTask.runsAfter(maTask); %#ok<*NODEF>
end
if includeModelComparisonTask && includeModelStandardsTask
mdlCompTask.runsAfter(maTask);
end
if includeSDDTask && includeModelStandardsTask
sddTask.runsAfter(maTask);
end
if includeTestsPerTestCaseTask && includeModelStandardsTask
milTask.runsAfter(maTask);
end
if includeRefGenerateCodeTask && includeRefAnalyzeModelCode && includeRefProveCodeQuality
pscpTask.runsAfter(psbfTask);
end
% Set the code generation task to always run after Model Standards,
% System Design Description and Test tasks
if includeRefGenerateCodeTask && includeModelStandardsTask
codegenTask.runsAfter(maTask);
end
if includeRefGenerateCodeTask && includeFindClones
codegenTask.runsAfter(acrossModelCloneDetectTask);
codegenTask.runsAfter(libCloneDetectTask);
end
if includeRefGenerateCodeTask && includeSDDTask
codegenTask.runsAfter(sddTask);
end
if includeRefGenerateCodeTask && includeTestsPerTestCaseTask
codegenTask.runsAfter(milTask);
end
if includeRefGenerateCodeTask && includeModelTestingMetricTask
codegenTask.runsAfter(mtMetricTask);
end
% Both the Polyspace Bug Finder (PSBF) and the Simulink Code Inspector
% (SLCI) tasks depend on the code generation tasks. SLCI task is set to
% run after the PSBF task without establishing an execution dependency
% by using 'runsAfter'.
if includeRefGenerateCodeTask && includeRefAnalyzeModelCode ...
&& includeRefCodeInspection
slciTask.runsAfter(pscpTask);
end
if includeRefGenerateCodeTask && includeTopGenerateCodeTask ...
&& includeRefCodeInspection
codegenTopTask.runsAfter(slciTask);
end
if includeRefGenerateCodeTask && includeTopGenerateCodeTask ...
&& includeRefAnalyzeModelCode
codegenTopTask.runsAfter(psbfTask);
end
if includeRefGenerateCodeTask && includeTopGenerateCodeTask ...
&& includeRefProveCodeQuality
codegenTopTask.runsAfter(pscpTask);
end
if includeRefGenerateCodeTask && includeTopGenerateCodeTask && ...
includeTopProveCodeQuality && includeTopAnalyzeModelCode
pscpTopTask.runsAfter(psbfTopTask);
end
if includeRefGenerateCodeTask && includeTopGenerateCodeTask && ...
includeRefCodeInspection && includeTopProveCodeQuality
slciTopTask.runsAfter(pscpTopTask);
end
end