requirements-driven-software-development/buildfile.m at main · Wenwen-Olliegi-Li/requirements-driven-software-development · GitHub

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
function plan = buildfile()
%BUILDFILE Build file for the "Best Practices for Requirements-Driven
% Software Development with MATLAB" project.

% Copyright 2025 The MathWorks, Inc.

% Define the build plan.
plan = buildplan( localfunctions() );

% Set the archive task to run by default.
plan.DefaultTasks = "codegen";

% Add a test task to run the unit tests for the project. Generate and save
% a coverage report.
projectRoot = plan.RootFolder;
testsFolder = fullfile( projectRoot, "tests" );
codeFolder = fullfile( projectRoot, "code" );
plan("test") = matlab.buildtool.tasks.TestTask( testsFolder, ...
    "Strict", true, ...
    "Description", "Assert that all project tests pass.", ...
    "SourceFiles", codeFolder, ...
    "CodeCoverageResults", "reports/Coverage.html", ...
    "OutputDetail", "verbose" );

% The MEX-generation task depends on the check task.
plan("mex").Dependencies = "check";

% The test task depends on the MEX task.
plan("test").Dependencies = "mex";

% The code generation task depends on the test task.
plan("codegen").Dependencies = "test";

% The archive task depends on the test task.
plan("archive").Dependencies = "test";

% The requirements-related tasks depend on the test task.
plan("writereqs").Dependencies = "test";
plan("readreqs").Dependencies = "test";
plan("reportreqs").Dependencies = "test";

end % buildfile

function checkTask( context )
% Check the source code and project for any issues.

% Set the project root as the folder in which to check for any static code
% issues.
projectRoot = context.Plan.RootFolder;
codeIssuesTask = matlab.buildtool.tasks.CodeIssuesTask( projectRoot, ...
    "IncludeSubfolders", true, ...
    "Configuration", "factory", ...
    "Description", ...
    "Assert that there are no code issues in the project.", ...
    "WarningThreshold", 0 );
codeIssuesTask.analyze( context )

% Update the project dependencies.
prj = currentProject();
prj.updateDependencies()

% Run the checks.
checkResults = table( prj.runChecks() );

% Log any failed checks.
passed = checkResults.Passed;
notPassed = ~passed;
if any( notPassed )
    disp( checkResults(notPassed, :) )
else
    fprintf( "** All project checks passed.\n\n" )
end % if

% Check that all checks have passed.
assert( all( passed ), "buildfile:ProjectIssue", ...
    "At least one project check has failed. " + ...
    "Resolve the failures shown above to continue." )

end % checkTask

function writereqsTask( ~ )
%Serialize binary requirements sets and link sets to CSV files.

% See writereqs for further details.
writereqs()

end % writereqsTask

function readreqsTask( ~ )
% Create binary requirements and link sets from CSV files.

% See readreqs for further details.
readreqs()

end % readreqsTask

function reportreqsTask( context )
% Generate a report describing the project requirements and links.

% Load the necessary requirements sets (needed for report generation).
rootFolder = context.Plan.RootFolder;
requirementsFolder = fullfile( rootFolder, "requirements" );
requirementsInfo = struct2table( dir( fullfile( requirementsFolder, ...
    "*.slreqx" ) ) );
requirementsFilenames = fullfile( requirementsInfo.folder, ...
    requirementsInfo.name );
for k = 1 : numel( requirementsFilenames )
    requirementsSets(k) = slreq.load( requirementsFilenames{k} ); %#ok<AGROW>
end % for

% Configure the report options.
reportOptions = slreq.getReportOptions();
reportOptions.reportPath = char( fullfile( rootFolder, ...
    "reports", "RequirementsStatus.docx" ) );
reportOptions.includes.emptySections = true;

% Generate the report and tidy up.
slreq.generateReport( requirementsSets, reportOptions );
slreq.clear() % Unload requirements sets from memory

end % reportreqsTask

function mexTask( context )
% Build a MEX-function from the signal processing algorithms.

outputFolder = fullfile( context.Plan.RootFolder, "code", "codegen" );
mexPath = fullfile( context.Plan.RootFolder, "code", "generateWave_mex" );
codegen( "generateWave", "-config:mex", ...
    "-args", num2cell( ones( 1, 7 ) ), ...
    "-d", outputFolder, ...
    "-o", mexPath )

end % mexTask

function codegenTask( context )
% Generate C code from the signal processing algorithms.

outputFolder = fullfile( context.Plan.RootFolder, "code", "codegen" );
codegen( "generateWave", "-config", coderConfiguration(), ...
   "-args", num2cell( ones( 1, 7 ) ), ...
   "-c", ...
   "-d", outputFolder )

end % codegenTask

function archiveTask( ~ )
% Archive the project.

proj = currentProject();
projectRoot = proj.RootFolder;
exportName = fullfile( projectRoot, "Requirements.mlproj" );
proj.export( exportName )

end % archiveTask