Modify CI

vboutrou · vboutrou · commit 8b88730c8477 · 2024-10-01T13:42:47.000-04:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,6 +8,11 @@ on:
     branches: [ release ]
   workflow_dispatch:
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   test:
     strategy: 
@@ -32,23 +37,21 @@ jobs:
         uses: matlab-actions/setup-matlab@v2
         with:
           release: ${{ matrix.MATLABVersion }}
-          products: Simulink Signal_Processing_Toolbox Symbolic_Math_Toolbox
 
       # Run all the tests
       - name: Run SmokeTests
         uses: matlab-actions/run-command@v2
         with:
-          command: openProject(pwd); RunAllTests(true); 
+          command: openProject(pwd); RunAllTests; 
 
       # Upload the test results as artifact
       - name: Upload TestResults
         uses: actions/upload-artifact@v4
         with:
           name: TestResults_${{ matrix.MATLABVersion }}
-          path: ./SoftwareTests/TestResults_${{ matrix.MATLABVersion }}.txt
+          path: ./public/*
           overwrite: true
 
-
   badge:
     if: ${{ always() }}
     needs: [test]
@@ -60,7 +63,7 @@ jobs:
       # Checks-out your repository
       - uses: actions/checkout@v4
       
-      # Sets up R2024b
+      # Sets up R2023b
       - name: Setup MATLAB
         uses: matlab-actions/setup-matlab@v2
         with:
@@ -70,15 +73,25 @@ jobs:
       - name: Download All TestResults
         uses: actions/download-artifact@v4
         with:
-          path: SoftwareTests
+          path: public
           pattern: TestResults_*
           merge-multiple: true
-
+          
       # Create the test results badge
-      - name: Run CreateBadge
+      - name: Run PostSmokeTest
         uses: matlab-actions/run-command@v2
         with:
-          command: openProject(pwd); CreateBadge;
+          command: openProject(pwd); PostSmokeTest;
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: public
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
 
       # Commit the JSON for the MATLAB releases badge 
       - name: Commit changed files
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ The instructions inside the live scripts will guide you through the exercises an
 
 ## Contact Us
 
-Solutions are available upon instructor request. Contact the [MathWorks teaching resources team](mailto:onlineteaching@mathworks.com) if you would like to request solutions, provide feedback, or if you have a question.
+Contact the [MathWorks teaching resources team](mailto:onlineteaching@mathworks.com) if you would like to request solutions, provide feedback, or if you have a question.
 
 <a name="H_30BC7141"></a>
 
diff --git a/README.mlx b/README.mlx
diff --git a/Scripts/FilteringIntro.mlx b/Scripts/FilteringIntro.mlx
diff --git a/SoftwareTests/CheckTestResults.m b/SoftwareTests/CheckTestResults.m
@@ -4,7 +4,7 @@
     end
 
     properties (ClassSetupParameter)
-        Project = {''};
+        Project = {currentProject()};
     end
 
     properties (TestParameter)
@@ -15,8 +15,8 @@
     methods (TestParameterDefinition,Static)
 
         function Version = GetResults(Project)
-            RootFolder = currentProject().RootFolder;
-            Version = dir(fullfile(RootFolder,"SoftwareTests","TestResults*.txt"));
+            RootFolder = Project.RootFolder;
+            Version = dir(fullfile(RootFolder,"public","TestResults*.txt"));
             Version = extractBetween([Version.name],"TestResults_",".txt");
         end
 
@@ -37,9 +37,11 @@ function SetUpSmokeTest(testCase,Project)
     methods(Test)
 
         function CheckResults(testCase,Version)
-            File = fullfile("SoftwareTests","TestResults_"+Version+".txt");
+            File = fullfile("public","TestResults_"+Version+".txt");
             Results = readtable(File,TextType="string");
-            testCase.verifyTrue(all(Results.Passed));
+            if ~all(Results.Passed)
+                error("Some of the tests did not pass.")
+            end
         end
 
     end
diff --git a/SoftwareTests/CreateBadge.m b/SoftwareTests/CreateBadge.m
diff --git a/SoftwareTests/PostFiles/PostAnalogToDigitalConversionSoln.m b/SoftwareTests/PostFiles/PostAnalogToDigitalConversionSoln.m
@@ -0,0 +1,3 @@
+%  Post-run script for AnalogToDigitalConversionSoln.mlx
+% ---- Post-run commands -----
+ 
diff --git a/SoftwareTests/PostFiles/PostBuildFilteringAppSoln.m b/SoftwareTests/PostFiles/PostBuildFilteringAppSoln.m
@@ -0,0 +1,3 @@
+%  Post-run script for BuildFilteringAppSoln.mlx
+% ---- Post-run commands -----
+ 
diff --git a/SoftwareTests/PostFiles/PostFilterDesignSoln.m b/SoftwareTests/PostFiles/PostFilterDesignSoln.m
@@ -0,0 +1,3 @@
+%  Post-run script for FilterDesignSoln.mlx
+% ---- Post-run commands -----
+ 
diff --git a/SoftwareTests/PostFiles/PostFilteringIntroSoln.m b/SoftwareTests/PostFiles/PostFilteringIntroSoln.m
@@ -0,0 +1,3 @@
+%  Post-run script for FilteringIntroSoln.mlx
+% ---- Post-run commands -----
+ 
diff --git a/SoftwareTests/PostSmokeTest.m b/SoftwareTests/PostSmokeTest.m
@@ -0,0 +1,63 @@
+function PostSmokeTest(ShowReport)
+arguments
+    ShowReport (1,1) logical = false;
+end
+
+import matlab.unittest.plugins.TestRunnerPlugin;
+
+% Create the runner:
+Runner = matlab.unittest.TestRunner.withTextOutput;
+
+% Create report folder:
+Folder = fullfile(currentProject().RootFolder,"public");
+if ~isfolder(Folder)
+    mkdir(Folder)
+end
+
+% Add HTML plugin:
+Plugin = matlab.unittest.plugins.TestReportPlugin.producingHTML(Folder,...
+    "IncludingPassingDiagnostics",true,...
+    "IncludingCommandWindowText",false,...
+    "LoggingLevel",matlab.automation.Verbosity(1));
+Runner.addPlugin(Plugin);
+
+
+% Create Test Suite
+Suite = testsuite("CheckTestResults");
+
+% Run the test suite
+Results = Runner.run(Suite);
+
+
+% Format the results in a table and save them
+Results = table(Results');
+Results = Results(Results.Passed,:);
+Version = extractBetween(string(Results.Name),"Version=",")");
+
+% Add link to other report
+File = fileread(fullfile("public","index.html"));
+for iVer = 1:length(Version)
+    File = replace(File,"Version="+Version(iVer),...
+        sprintf('<a href="%s/index.html">%s</a>',Version(iVer),"Version="+Version(iVer)));
+end
+writelines(File,fullfile("public","index.html"),"WriteMode","overwrite");
+
+% Format the JSON file
+Badge = struct;
+Badge.schemaVersion = 1;
+Badge.label = "Tested with";
+if size(Results,1) >= 1
+    Badge.color = "success"
+    Badge.message = join("R"+Version," | ");
+else
+    Badge.color = "failure";
+    Badge.message = "Pipeline fails";
+end
+Badge = jsonencode(Badge);
+writelines(Badge,fullfile("Images","TestedWith.json"));
+
+if ShowReport
+    web(fullfile(Folder,"index.html"))
+end
+
+end
diff --git a/SoftwareTests/PreFiles/PreAnalogToDigitalConversion.m b/SoftwareTests/PreFiles/PreAnalogToDigitalConversion.m
@@ -1,5 +1,4 @@
 %  Initialization script for AnalogToDigitalConversion.mlx
-OnSolution = true;
 % ---- Known Issues     -----
 KnownIssuesID = "MATLAB:minrhs";
 % ---- Pre-run commands -----
diff --git a/SoftwareTests/PreFiles/PreAnalogToDigitalConversionSoln.m b/SoftwareTests/PreFiles/PreAnalogToDigitalConversionSoln.m
@@ -0,0 +1,16 @@
+%  Initialization script for AnalogToDigitalConversion.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "MATLAB:minrhs";
+% ---- Pre-run commands -----
+play = @(x) disp("Playing audio");
+stop = @(x) disp("Stop audio player");
+audioread = @(x) NewAudioRead(x);
+audioplayer = @(x,y) NewAudioPlayer(x,y);
+function varargout=NewAudioRead(varargin)
+load(fullfile(currentProject().RootFolder,"SoftwareTests","PreFiles","PreAnalogToDigitalConversion.mat"));
+varargout={JazzSignal,JazzSamplingFreq};
+end
+function varargout=NewAudioPlayer(varargin)
+disp("Create audio player")
+varargout={1};
+end
diff --git a/SoftwareTests/PreFiles/PreBuildFilteringApp.m b/SoftwareTests/PreFiles/PreBuildFilteringApp.m
@@ -1,5 +1,4 @@
 %  Initialization script for BuildFilteringApp.mlx
-OnSolution = true;
 % ---- Known Issues     -----
 KnownIssuesID = "";
 % ---- Pre-run commands -----
diff --git a/SoftwareTests/PreFiles/PreBuildFilteringAppSoln.m b/SoftwareTests/PreFiles/PreBuildFilteringAppSoln.m
@@ -0,0 +1,5 @@
+%  Initialization script for BuildFilteringApp.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+appdesigner = @(varargin) disp("Opening App Designer");
diff --git a/SoftwareTests/PreFiles/PreFilterDesign.m b/SoftwareTests/PreFiles/PreFilterDesign.m
@@ -1,5 +1,4 @@
 %  Initialization script for FilterDesign.mlx
-OnSolution = true;
 % ---- Known Issues     -----
 KnownIssuesID = "MATLAB:minrhs";
 % ---- Pre-run commands -----
diff --git a/SoftwareTests/PreFiles/PreFilterDesignSoln.m b/SoftwareTests/PreFiles/PreFilterDesignSoln.m
@@ -0,0 +1,10 @@
+%  Initialization script for FilterDesign.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "MATLAB:minrhs";
+% ---- Pre-run commands -----
+play = @(x) disp("Playing audio");
+audioread = @(x) NewAudioRead(x);
+function varargout=NewAudioRead(varargin)
+load(fullfile(currentProject().RootFolder,"SoftwareTests","PreFiles","PreFilterDesign.mat"));
+varargout={Signal,SamplingFreq};
+end
diff --git a/SoftwareTests/PreFiles/PreFilteringIntro.m b/SoftwareTests/PreFiles/PreFilteringIntro.m
@@ -1,5 +1,4 @@
 %  Initialization script for FilteringIntro.mlx
-OnSolution = true;
 % ---- Known Issues     -----
 KnownIssuesID = "MATLAB:minrhs";
 % ---- Pre-run commands -----
diff --git a/SoftwareTests/PreFiles/PreFilteringIntroSoln.m b/SoftwareTests/PreFiles/PreFilteringIntroSoln.m
@@ -0,0 +1,16 @@
+%  Initialization script for FilteringIntro.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "MATLAB:minrhs";
+% ---- Pre-run commands -----
+play = @(x) disp("Playing audio");
+stop = @(x) disp("Stop audio player");
+audioread = @(x) NewAudioRead(x);
+audioplayer = @(x,y) NewAudioPlayer(x,y);
+function varargout=NewAudioRead(varargin)
+load(fullfile(currentProject().RootFolder,"SoftwareTests","PreFiles","PreFilteringIntro.mat"));
+varargout={Signal,SamplingFrequency};
+end
+function varargout=NewAudioPlayer(varargin)
+disp("Create audio player")
+varargout={1};
+end
diff --git a/SoftwareTests/RunAllTests.m b/SoftwareTests/RunAllTests.m
@@ -1,43 +1,42 @@
-function RunAllTests(EnableReport,ReportFolder)
+function RunAllTests(ShowReport)
 arguments
-    EnableReport (1,1) logical = false;
-    ReportFolder (1,1) string = "public";
+    ShowReport (1,1) logical = false;
 end
 
 import matlab.unittest.plugins.TestReportPlugin;
 
 % Create a runner
 Runner = matlab.unittest.TestRunner.withTextOutput;
-if EnableReport
-    Folder = fullfile(currentProject().RootFolder,ReportFolder);
-    if ~isfolder(Folder)
-        mkdir(Folder)
-    else
-        rmdir(Folder,'s')
-        mkdir(Folder)
-    end
-    Plugin = TestReportPlugin.producingHTML(Folder,...
-        "IncludingPassingDiagnostics",true,...
-        "IncludingCommandWindowText",true,...
-        "LoggingLevel",matlab.automation.Verbosity(1));
-        Runner.addPlugin(Plugin);
+Folder = fullfile(currentProject().RootFolder,"public",version("-release"));
+if ~isfolder(Folder)
+    mkdir(Folder)
+else
+    rmdir(Folder,'s')
+    mkdir(Folder)
 end
+Plugin = TestReportPlugin.producingHTML(Folder,...
+    "IncludingPassingDiagnostics",true,...
+    "IncludingCommandWindowText",true,...
+    "LoggingLevel",matlab.automation.Verbosity(1));
+Runner.addPlugin(Plugin);
+
 
 % Create the test suite with SmokeTest and Function test if they exist
 Suite = testsuite("SmokeTests");
 Suite = [Suite testsuite("FunctionTests")];
+Suite = [Suite testsuite("SolnSmokeTests")];
 
 % Run the test suite
 Results = Runner.run(Suite);
 
-if EnableReport
+if ShowReport
     web(fullfile(Folder,"index.html"))
 end
 
 % Format the results in a table and save them
 ResultsTable = table(Results')
 writetable(ResultsTable,fullfile(currentProject().RootFolder,...
-    "SoftwareTests","TestResults_R"+version("-release")+".txt"));
+    "public","TestResults_"+version("-release")+".txt"));
 
 % Assert success of test
 assertSuccess(Results);
diff --git a/SoftwareTests/SmokeTests.m b/SoftwareTests/SmokeTests.m
diff --git a/SoftwareTests/SolnSmokeTests.m b/SoftwareTests/SolnSmokeTests.m
diff --git a/resources/project/ZN2RlSIbyWXhOxbxxI4hOawbMD4/EyDhXb-HjEIhAYfuSMUxquCH4aYd.xml b/resources/project/ZN2RlSIbyWXhOxbxxI4hOawbMD4/EyDhXb-HjEIhAYfuSMUxquCH4aYd.xml
diff --git a/resources/project/ZN2RlSIbyWXhOxbxxI4hOawbMD4/EyDhXb-HjEIhAYfuSMUxquCH4aYp.xml b/resources/project/ZN2RlSIbyWXhOxbxxI4hOawbMD4/EyDhXb-HjEIhAYfuSMUxquCH4aYp.xml

-Original file line number
+Diff line change
 ## Contact Us
 -Solutions are available upon instructor request. Contact the [MathWorks teaching resources team](mailto:[email protected]) if you would like to request solutions, provide feedback, or if you have a question.
 +Contact the [MathWorks teaching resources team](mailto:[email protected]) if you would like to request solutions, provide feedback, or if you have a question.
 <a name="H_30BC7141"></a>
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+% Post-run script for AnalogToDigitalConversionSoln.mlx`
	`2`	`+% ---- Post-run commands -----`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+% Post-run script for BuildFilteringAppSoln.mlx`
	`2`	`+% ---- Post-run commands -----`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+% Post-run script for FilterDesignSoln.mlx`
	`2`	`+% ---- Post-run commands -----`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+% Post-run script for FilteringIntroSoln.mlx`
	`2`	`+% ---- Post-run commands -----`
	`3`	`+`