Update for R2024b maintenance cycle

Author: vboutrou

.github/workflows/ci.yml

@@ -8,35 +8,59 @@ on:
     branches: [ release ]
   workflow_dispatch:
 
+# Add permission to write GitHub pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
 jobs:
   test:
     strategy: 
       fail-fast: false
       matrix:
-        MATLABVersion: [R2021a,R2021b,R2022a,R2022b,R2023a,R2023b]
+        MATLABVersion: [R2024a,R2024b]
     runs-on: ubuntu-latest
     steps:
       # Checks-out your repository
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+      
+      # Sets up a display server
+      - name: Start display server
+        if: ${{ always() }}
+        run: |
+          sudo apt-get install xvfb
+          Xvfb :99 &
+          echo "DISPLAY=:99" >> $GITHUB_ENV
       
       # Sets up MATLAB
       - name: Setup MATLAB
-        uses: matlab-actions/setup-matlab@v1
+        uses: matlab-actions/setup-matlab@v2
         with:
           release: ${{ matrix.MATLABVersion }}
+          products: # Simulink Statistics_and_Machine_Learning_Toolbox
+          # List required products above in the format shown (and uncomment them)
+          # List of product strings:
+          # Simulink
+          # Statistics_and_Machine_Learning_Toolbox
+          # Simulink_Coder
+          # Econometrics_Toolbox
+          # Deep_Learning_Toolbox
+
 
       # Run all the tests
       - name: Run SmokeTests
-        uses: matlab-actions/run-command@v1
+        uses: matlab-actions/run-command@v2
         with:
           command: openProject(pwd); RunAllTests; 
 
       # Upload the test results as artifact
       - name: Upload TestResults
-        uses: actions/upload-artifact@v3.1.3
+        uses: actions/upload-artifact@v4
         with:
-          name: TestResults
-          path: ./SoftwareTests/TestResults_${{ matrix.MATLABVersion }}.txt
+          name: TestResults_${{ matrix.MATLABVersion }}
+          path: ./public/*
+          overwrite: true
 
   badge:
     if: ${{ always() }}
@@ -47,26 +71,38 @@ jobs:
     steps: 
 
       # Checks-out your repository
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # Sets up R2023b
       - name: Setup MATLAB
-        uses: matlab-actions/setup-matlab@v1
+        uses: matlab-actions/setup-matlab@v2
         with:
-          release: R2023b
+          release: R2024b
 
       # Download the test results from artifact
-      - name: Download TestResults
-        uses: actions/download-artifact@v2.1.1
+      - name: Download All TestResults
+        uses: actions/download-artifact@v4
         with:
-          name: TestResults
-          path: ./SoftwareTests/
-
+          path: public
+          pattern: TestResults_*
+          merge-multiple: true
+          
       # Create the test results badge
-      - name: Run CreateBadge
-        uses: matlab-actions/run-command@v1
+      - name: Run PostSmokeTest
+        uses: matlab-actions/run-command@v2
+        with:
+          command: openProject(pwd); PostSmokeTest;
+      
+      # Deploy reports to GitHub pages
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          command: openProject(pwd); CreateBadge;
+          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

.gitignore

@@ -50,5 +50,5 @@ Utilities/ProjectSettings.mat
 # Test results
 SoftwareTests/TestResults_*
 
-# GitLab page fodler
-public/
+# GitLab page folder
+public/

InstructorResources/Solutions/ArcticSeaIceSoln.mlx

@@ -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

InstructorResources/Solutions/GlobalTemperatureSoln.mlx

@@ -1,5 +1,7 @@
 classdef FunctionTests < matlab.unittest.TestCase
 
+    % https://www.mathworks.com/help/matlab/matlab_prog/use-parameters-in-class-based-tests.html
+
     methods(Test)    
 
     end % methods

InstructorResources/Solutions/MultispectralImagingSoln.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for ArcticSeaIce.mlx
+% ---- Post-run commands -----
+ 

InstructorResources/Solutions/MultispectralIndicesSoln.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for ArcticSeaIceSoln.mlx
+% ---- Post-run commands -----
+ 

MainMenu.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for GlobalTemperature.mlx
+% ---- Post-run commands -----
+ 

README.md

@@ -0,0 +1,3 @@
+%  Post-run script for GlobalTemperatureSoln.mlx
+% ---- Post-run commands -----
+ 

Scripts/ArcticSeaIce.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for MultispectralImaging.mlx
+% ---- Post-run commands -----
+ 

Scripts/GlobalTemperature.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for MultispectralImagingSoln.mlx
+% ---- Post-run commands -----
+ 

Scripts/MultispectralImaging.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for MultispectralIndices.mlx
+% ---- Post-run commands -----
+ 

Scripts/MultispectralIndices.mlx

@@ -0,0 +1,3 @@
+%  Post-run script for MultispectralIndicesSoln.mlx
+% ---- Post-run commands -----
+ 

SoftwareTests/CheckTestResults.m

@@ -0,0 +1,5 @@
+%  Pre-run script for ArcticSeaIce.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/CreateBadge.m

@@ -0,0 +1,5 @@
+%  Pre-run script for ArcticSeaIceSoln.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/FunctionTests.m

@@ -0,0 +1,5 @@
+%  Pre-run script for GlobalTemperature.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/PostFiles/PostArcticSeaIce.m

@@ -0,0 +1,5 @@
+%  Pre-run script for GlobalTemperatureSoln.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/PostFiles/PostArcticSeaIceSoln.m

@@ -0,0 +1,5 @@
+%  Pre-run script for MultispectralImaging.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/PostFiles/PostGlobalTemperature.m

@@ -0,0 +1,5 @@
+%  Pre-run script for MultispectralImagingSoln.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/PostFiles/PostGlobalTemperatureSoln.m

@@ -0,0 +1,5 @@
+%  Pre-run script for MultispectralIndices.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/PostFiles/PostMultispectralImaging.m

@@ -0,0 +1,5 @@
+%  Pre-run script for MultispectralIndicesSoln.mlx
+% ---- Known Issues     -----
+KnownIssuesID = "";
+% ---- Pre-run commands -----
+ 

SoftwareTests/PostFiles/PostMultispectralImagingSoln.m

@@ -1,46 +1,42 @@
-function RunAllTest(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"))
-else
-    T = table(Results);
-    disp(newline + "Test summary:")
-    disp(T)
 end
 
 % Format the results in a table and save them
 ResultsTable = table(Results')
-writetable(ResultsTable,fullfile("SoftwareTests","TestResults_"+release_version+".txt"));
+writetable(ResultsTable,fullfile(currentProject().RootFolder,...
+    "public","TestResults_"+version("-release")+".txt"));
 
 % Assert success of test
 assertSuccess(Results);