Maintenance for R2024b

1) Update .gitattributes and .gitignore
2) Update CI workflow files
3) Rename all local functions we provide to be PascalCase while leaving
   some student-written functions in camelCase
4) Add Solutions to InstructorResources and make sure Script and
   Solution version match
5) Move some functions to a better location in the file per MATLAB
   language changes in R2024a to allow local functions to be defined in
   more places
6) Update the startup app, and update the project startup/shutdown
   process to match
7) Update the SoftwareTests to be more standardized and write
   appropriate pre/post files to set up and tear down testing conditions
8) Update the README.md with more precise Open in MATLAB Online links

Author: eszmw

.gitattributes

@@ -16,7 +16,7 @@
 *.slmx binary merge=mlAutoMerge
 *.sltx binary
 *.slxc binary
-*.slx binary merge=mlAutoMerge
+*.slx binary merge=mlAutoMerge linguist-language=Simulink
 *.slxp binary
 
 ## Other common binary file types

.github/workflows/ci.yml

@@ -8,41 +8,60 @@ on:
     branches: [ release ]
   workflow_dispatch:
 
+# Add permission to write GitHub pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
 jobs:
   test:
     strategy: 
-      fail-fast: true
+      fail-fast: false
       matrix:
-        MATLABVersion: [R2021b,R2023a,R2023b]
+        MATLABVersion: [R2024a,R2024b]
     runs-on: ubuntu-latest
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
+      # Checks-out your repository
+      - uses: actions/checkout@v4
 
-      # Sets up MATLAB on the GitHub Actions runner
+      # 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 SmokeTests
+      # Run all the tests
       - name: Run SmokeTests
-        uses: matlab-actions/run-command@v1
+        uses: matlab-actions/run-command@v2
         with:
-          command: openProject(pwd); setenv('EDITOR','emacs'); results = runtests(fullfile("SoftwareTests","SmokeTests.m")); assertSuccess(results); 
-     
-      # Run FunctionTests
-      - name: Run FunctionTests
-        uses: matlab-actions/run-command@v1
-        with:
-          command: openProject(pwd); results = runtests(fullfile("SoftwareTests","FunctionTests.m")); assertSuccess(results); 
+          command: openProject(pwd); RunAllTests; 
 
       # Upload the test results as artifact
       - name: Upload TestResults
-        uses: actions/[email protected]
+        if: ${{ always() }}
+        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() }}
@@ -53,33 +72,47 @@ 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
         continue-on-error: true
         run: |
           git config user.name "${{ github.workflow }} by ${{ github.actor }}"
           git config user.email "<>"
+          git pull
+          git add Images/TestedWith.json
           git commit Images/TestedWith.json -m "Update CI badges ${{  github.ref_name }}"
           git fetch
           git push

.gitignore

@@ -47,3 +47,5 @@ codegen/
 # Project settings
 Utilities/ProjectSettings.mat
 
+# GitLab page folder
+public/

.gitlab-ci.yml

@@ -0,0 +1,87 @@
+stages:         
+# Set up two testing paths
+  - setup
+  - test
+  - deploy
+  - release
+
+setup-job:
+    tags:
+      - matlab
+    stage: setup
+    script:
+      - cd ..
+      - if (test-path utilities) { rm -r -force utilities }
+      - git clone [email protected]:modular-curriculum-content/utilities.git
+      - cd $CI_PROJECT_NAME 
+    allow_failure: false
+
+
+smoke-test:
+# Smoke tests should run all the time
+    tags:
+    # Add additional tags like (e.g. - arduino) as required
+    # Make sure that the runner you plan to use matches the tags
+      - matlab
+    stage: test
+    parallel:
+      matrix:
+        - VERSION: [R2024a,R2024b]
+    script: 
+      - Set-Alias -Name matlab -Value "C:\Program Files\MATLAB\$VERSION\bin\matlab.exe"
+      - matlab -batch "openProject(pwd);RunAllTests"
+    when: always
+    allow_failure: true
+    artifacts:
+      name: "$VERSION"
+      paths:
+        - public/*
+      when:  always
+
+
+pages:
+    tags:
+      - matlab
+    stage: deploy
+    script:
+      - matlab -batch "openProject(pwd);PostSmokeTest;"
+    artifacts:
+        paths:
+            - public
+        
+file-test:   
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        addpath(proj.RootFolder+'/InternalFiles/Tests/CI');
+        results = runtests('OpenCloseFileTest.m');
+        disp(table(results)); assertSuccess(results);"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true
+
+release-testing:
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        cd ..;
+        addpath(genpath(fullfile('utilities','TestingResources')));
+        addpath(genpath(fullfile('utilities','Tools')));
+        runCMTests"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true