Adds caching functionality

.circleci/test-deploy.yml

@@ -95,6 +95,42 @@ jobs:
       - matlab/run-command:
           command: "exp='<<parameters.release>>'; assert(strcmp(version('-release'),exp(2:6)))"
 
+  integration-test-install-with-cache:
+    parameters:
+      executor:
+        type: executor
+    executor: <<parameters.executor>>
+    steps:
+      - checkout
+      - run:
+          name: Clean cache directory before first install
+          command: rm -rf $HOME/matlab_ci
+          shell: bash
+      - matlab/install:
+          no-output-timeout: 30m
+          products: Simulink
+          cache: true
+      - run:
+          name: Verify files exist in cache
+          command: |
+            set -e
+            matlab_binary="$HOME/matlab_ci/matlab_root"
+            if [[ "$(uname)" == "Darwin" ]]; then
+              matlab_binary="$matlab_binary/MATLAB.app"
+            fi
+            test -x "$matlab_binary/bin/matlab" || {
+              echo "Missing MATLAB binary at expected cache path!"
+              exit 1
+            }
+            test -x "$HOME/matlab_ci/matlab-batch/matlab-batch"* || {
+              echo "MATLAB Batch not found in cache!"
+              exit 1
+            }
+            echo "All expected files found in cache."
+          shell: bash
+      - matlab/run-command:
+          command: version
+
   integration-test-run-command:
     parameters:
       executor:
@@ -500,6 +536,11 @@ workflows:
               executor: [linux, windows, macos]
               release: [R2023bU1]
 
+      - integration-test-install-with-cache:
+          matrix:
+            parameters:
+              executor: [linux, windows, macos]
+
       - integration-test-run-command:
           matrix:
             parameters:

src/commands/install.yml

@@ -27,13 +27,48 @@ parameters:
       maximum time a job is allowed to run.
     type: string
     default: 10m
+  cache:
+    description: >
+      Option to enable caching, specified as false or true. By default, the value is false and the command does not store MATLAB and the specified products in a cache for future use.
+    type: boolean
+    default: false
 
 steps:
+  - when:
+      condition:
+        equal: [ << parameters.cache >>, true ]
+      steps:
+        - run:
+            name: Prepare cache metadata
+            environment:
+              PARAM_RELEASE: <<parameters.release>>
+              RESOLVE_RELEASE_SH: <<include(scripts/resolve-release.sh)>>
+            command: |
+              eval "$RESOLVE_RELEASE_SH"
+              echo "$mpmrelease" > install-metadata.txt
+              echo "<< parameters.products >>" | tr ' ' '\n' | sort | xargs >> install-metadata.txt
+            shell: bash
+        - restore_cache:
+            name: Restore Cache
+            keys:
+              - matlab-cache-{{ arch }}-{{ checksum "install-metadata.txt" }}
   - run:
       name: Install MATLAB
       environment:
         PARAM_RELEASE: <<parameters.release>>
         PARAM_PRODUCTS: <<parameters.products>>
+        PARAM_CACHE: <<parameters.cache>>
+        RESOLVE_RELEASE_SH: <<include(scripts/resolve-release.sh)>>
       command: <<include(scripts/install.sh)>>
       shell: bash
       no_output_timeout: <<parameters.no-output-timeout>>
+  - when:
+      condition:
+        equal: [ << parameters.cache >>, true ]
+      steps:
+        - save_cache:
+            name: Save Cache
+            key: matlab-cache-{{ arch }}-{{ checksum "install-metadata.txt" }}
+            paths:
+              - ~/matlab_ci/matlab_root
+              - ~/matlab_ci/matlab-batch

src/scripts/install.sh

@@ -17,26 +17,6 @@ sudoIfAvailable() {
     fi
 }
 
-stream() {
-    local url="$1"
-    local status=0
-
-    if command -v wget >/dev/null 2>&1; then
-        wget --retry-connrefused --waitretry=5 -qO- "$url" || status=$?
-    elif command -v curl >/dev/null 2>&1; then
-        curl --retry 5 --retry-connrefused --retry-delay 5 -sSL "$url" || status=$?
-    else
-        echo "Could not find wget or curl command" >&2
-        return 1
-    fi
-
-    if [ $status -ne 0 ]; then
-        echo "Error streaming file from $url" >&2
-    fi
-
-    return $status
-}
-
 download() {
     local url="$1"
     local filename="$2"
@@ -61,34 +41,21 @@ download() {
 os=$(uname)
 arch=$(uname -m)
 binext=""
-tmpdir=$(mktemp -d 2>/dev/null || mktemp -d -t 'install')
-rootdir="$tmpdir/matlab_root"
-batchdir="$tmpdir/matlab-batch"
-mpmdir="$tmpdir/mpm"
+matlabcidir="$HOME/matlab_ci"
+mkdir -p "$matlabcidir"
+rootdir="$matlabcidir/matlab_root"
+batchdir="$matlabcidir/matlab-batch"
+mpmdir="$matlabcidir/mpm"
 batchbaseurl="https://ssd.mathworks.com/supportfiles/ci/matlab-batch/v1"
 mpmbaseurl="https://www.mathworks.com/mpm"
 releasestatus=""
 
-# resolve release
-parsedrelease=$(echo "$PARAM_RELEASE" | tr '[:upper:]' '[:lower:]')
-if [[ "$parsedrelease" = "latest" ]]; then
-    mpmrelease=$(stream https://ssd.mathworks.com/supportfiles/ci/matlab-release/v0/latest)
-elif [[ "$parsedrelease" = "latest-including-prerelease" ]]; then
-    mpmrelease=$(stream https://ssd.mathworks.com/supportfiles/ci/matlab-release/v0/latest-including-prerelease)
-    releasestatus="--release-status=Prerelease"
-else
-    mpmrelease="$parsedrelease"
-fi
-
-# validate release is supported
-if [[ "$mpmrelease" < "r2020b" ]]; then
-    echo "Release '${mpmrelease}' is not supported. Use 'R2020b' or a later release.">&2
-    exit 1
-fi
+eval "$RESOLVE_RELEASE_SH"
 
 # install system dependencies
 if [[ "$os" = "Linux" ]]; then
     # install MATLAB dependencies
+    # shellcheck disable=SC2154
     release=$(echo "${mpmrelease}" | grep -ioE "(r[0-9]{4}[a-b])")
     stream https://ssd.mathworks.com/supportfiles/ci/matlab-deps/v0/install.sh | sudoIfAvailable -s -- "$release"
     # install mpm depencencies
@@ -102,7 +69,7 @@ elif [[ "$os" = "Darwin" && "$arch" = "arm64" ]]; then
         sudoIfAvailable -c "softwareupdate --install-rosetta --agree-to-license"
     else
         # install Java runtime
-        jdkpkg="$tmpdir/jdk.pkg"
+        jdkpkg="$matlabcidir/jdk.pkg"
         download https://corretto.aws/downloads/latest/amazon-corretto-8-aarch64-macos-jdk.pkg "$jdkpkg"
         sudoIfAvailable -c "installer -pkg '$jdkpkg' -target /"
     fi
@@ -131,20 +98,25 @@ mkdir -p "$rootdir"
 mkdir -p "$batchdir"
 mkdir -p "$mpmdir"
 
-# install mpm
-download "$mpmbaseurl/$mwarch/mpm" "$mpmdir/mpm$binext"
-chmod +x "$mpmdir/mpm$binext"
-
-# install matlab-batch
-download "$batchbaseurl/$mwarch/matlab-batch$binext" "$batchdir/matlab-batch$binext"
-chmod +x "$batchdir/matlab-batch$binext"
-
-# install matlab
-"$mpmdir/mpm$binext" install \
-    --release="$mpmrelease" \
-    --destination="$rootdir" \
-    ${releasestatus} \
-    --products ${PARAM_PRODUCTS} MATLAB
+# Short-circuit if MATLAB & matlab-batch already exist and PARAM_CACHE is true
+if [[ "$PARAM_CACHE" == "1" && -x "$batchdir/matlab-batch$binext" && -x "$rootdir/bin/matlab" ]]; then
+    echo "Skipping fresh installation and restoring from Cache."
+else
+    # install mpm
+    download "$mpmbaseurl/$mwarch/mpm" "$mpmdir/mpm$binext"
+    chmod +x "$mpmdir/mpm$binext"
+
+    # install matlab-batch
+    download "$batchbaseurl/$mwarch/matlab-batch$binext" "$batchdir/matlab-batch$binext"
+    chmod +x "$batchdir/matlab-batch$binext"
+
+    # install matlab
+    "$mpmdir/mpm$binext" install \
+        --release="$mpmrelease" \
+        --destination="$rootdir" \
+        ${releasestatus} \
+        --products ${PARAM_PRODUCTS} MATLAB
+fi
 
 # add MATLAB and matlab-batch to path
 echo 'export PATH="'$rootdir'/bin:'$batchdir':$PATH"' >> $BASH_ENV

src/scripts/resolve-release.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+stream() {
+    local url="$1"
+    local status=0
+
+    if command -v wget >/dev/null 2>&1; then
+        wget --retry-connrefused --waitretry=5 -qO- "$url" || status=$?
+    elif command -v curl >/dev/null 2>&1; then
+        curl --retry 5 --retry-connrefused --retry-delay 5 -sSL "$url" || status=$?
+    else
+        echo "Could not find wget or curl command" >&2
+        return 1
+    fi
+
+    if [ $status -ne 0 ]; then
+        echo "Error streaming file from $url" >&2
+    fi
+
+    return $status
+}
+
+parsedrelease=$(echo "$PARAM_RELEASE" | tr '[:upper:]' '[:lower:]')
+if [[ "$parsedrelease" = "latest" ]]; then
+    mpmrelease=$(stream https://ssd.mathworks.com/supportfiles/ci/matlab-release/v0/latest)
+elif [[ "$parsedrelease" = "latest-including-prerelease" ]]; then
+    mpmrelease=$(stream https://ssd.mathworks.com/supportfiles/ci/matlab-release/v0/latest-including-prerelease)
+    # shellcheck disable=SC2034
+    releasestatus="--release-status=Prerelease"
+else
+    mpmrelease="$parsedrelease"
+fi
+
+if [[ "$mpmrelease" < "r2020b" ]]; then
+    echo "Release '${mpmrelease}' is not supported. Use 'R2020b' or a later release." >&2
+    exit 1
+fi