Add resolveInstallDependencies function with tests and run npm run format

Author: Simran-MW

.eslintrc.js

@@ -1,41 +1,31 @@
 module.exports = {
-    "env": {
-        "browser": true,
-        "es2021": true
+    env: {
+        browser: true,
+        es2021: true,
     },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "overrides": [
+    extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+    overrides: [
         {
-            "env": {
-                "node": true
+            env: {
+                node: true,
+            },
+            files: [".eslintrc.{js,cjs}"],
+            parserOptions: {
+                sourceType: "script",
             },
-            "files": [
-                ".eslintrc.{js,cjs}"
-            ],
-            "parserOptions": {
-                "sourceType": "script"
-            }
         },
         {
-            "files": [
-                "**/*.ts"
-            ],
-            "rules": {
-                "prefer-const": "off"
-            }
-        }
+            files: ["**/*.ts"],
+            rules: {
+                "prefer-const": "off",
+            },
+        },
     ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
     },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-    }
-}
+    plugins: ["@typescript-eslint"],
+    rules: {},
+};

.github/workflows/bat.yml

@@ -29,7 +29,7 @@ jobs:
       matrix:
         include:
           - os: ubuntu-latest
-            release: latest 
+            release: latest
             products: Symbolic_Math_Toolbox
             check-matlab: matlabVer = ver('matlab'); assert(~isempty(matlabVer));
             check-toolbox: symbolicVer = ver('symbolic'); assert(~isempty(symbolicVer));
@@ -77,7 +77,7 @@ jobs:
           release: ${{ matrix.release }}
           products: ${{ matrix.products }}
       - name: Check matlabroot output is set
-        run:  'if [[ "${{ steps.setup_matlab.outputs.matlabroot }}" != *"MATLAB"* ]]; then exit 1; fi'
+        run: 'if [[ "${{ steps.setup_matlab.outputs.matlabroot }}" != *"MATLAB"* ]]; then exit 1; fi'
         shell: bash
       - name: Check MATLAB version
         uses: matlab-actions/run-command@v2
@@ -111,4 +111,3 @@ jobs:
         uses: matlab-actions/run-command@v2
         with:
           command: matlabVer = ver('matlab'); assert(strcmp(matlabVer.Release,'(R2023b)'));
-  

.github/workflows/publish.yml

@@ -32,7 +32,7 @@ jobs:
           git add package.json package-lock.json
           git commit -m "[skip ci] Bump $VERSION"
           git push origin HEAD:main
-          
+
       # Now carry on, business as usual
       - name: Perform npm tasks
         run: npm run ci
@@ -61,15 +61,15 @@ jobs:
 
           # Get the commit of the tag you just released
           commitHash=$(git rev-list -n 1 $longVersion)
-          
+
           # Delete the old major and minor version tags locally
           git tag -d $majorVersion || true
           git tag -d $minorVersion || true
-          
+
           # Make new major and minor version tags locally that point to the commit you got from the "git rev-list" above
           git tag -f $majorVersion $commitHash
           git tag -f $minorVersion $commitHash
-          
+
           # Force push the new minor version tag to overwrite the old tag remotely
           echo "Pushing new tags"
           git push -f origin $longVersion

README.md

@@ -1,13 +1,20 @@
 // Copyright 2023-2024 The MathWorks, Inc.
 
-import * as cache from '@actions/cache';
-import * as core from '@actions/core';
+import * as cache from "@actions/cache";
+import * as core from "@actions/core";
 import * as crypto from "crypto";
-import { State } from './cache-state';
-import { Release } from './matlab';
+import { State } from "./cache-state";
+import { Release } from "./matlab";
 
-export async function restoreMATLAB(release: Release, platform: string, architecture: string, products: string[], matlabPath: string, supportPackagesPath?: string): Promise<boolean> {
-    const installHash = crypto.createHash('sha256').update(products.sort().join('|')).digest('hex');
+export async function restoreMATLAB(
+    release: Release,
+    platform: string,
+    architecture: string,
+    products: string[],
+    matlabPath: string,
+    supportPackagesPath?: string,
+): Promise<boolean> {
+    const installHash = crypto.createHash("sha256").update(products.sort().join("|")).digest("hex");
     const keyPrefix = `matlab-cache-${platform}-${architecture}-${release.version}`;
     const primaryKey = `${keyPrefix}-${installHash}`;
     const cachePaths = [matlabPath];
@@ -27,5 +34,5 @@ export async function restoreMATLAB(release: Release, platform: string, architec
 
     core.saveState(State.CacheMatchedKey, cacheKey);
     core.info(`Cache restored from key: ${cacheKey}`);
-    return true
+    return true;
 }

src/cache-restore.ts

@@ -30,16 +30,19 @@ describe("cache-restore", () => {
         restoreCacheMock = cache.restoreCache as jest.Mock;
         saveStateMock = core.saveState as jest.Mock;
     });
-    
+
     it("returns true if cache is found", async () => {
         restoreCacheMock.mockReturnValue("matched-cache-key");
-        await expect(restoreMATLAB(release, platform, arch, products, location)).resolves.toBe(true);
+        await expect(restoreMATLAB(release, platform, arch, products, location)).resolves.toBe(
+            true,
+        );
         expect(saveStateMock).toHaveBeenCalledTimes(4);
     });
 
-
     it("returns false if cache is not found", async () => {
-        await expect(restoreMATLAB(release, platform, arch, products, location)).resolves.toBe(false);
+        await expect(restoreMATLAB(release, platform, arch, products, location)).resolves.toBe(
+            false,
+        );
         expect(saveStateMock).toHaveBeenCalledTimes(3);
     });
 });

src/cache-restore.unit.test.ts

@@ -1,16 +1,15 @@
 // Copyright 2023-2024 The MathWorks, Inc.
 
-import * as core from '@actions/core';
-import * as cache from '@actions/cache';
-import {State} from './cache-state';
+import * as core from "@actions/core";
+import * as cache from "@actions/cache";
+import { State } from "./cache-state";
 
 export async function cacheMATLAB() {
     const matchedKey = core.getState(State.CacheMatchedKey);
     const primaryKey = core.getState(State.CachePrimaryKey);
     const matlabPath = core.getState(State.MatlabCachePath);
     const supportPackagesPath = core.getState(State.SupportPackagesCachePath);
 
-
     if (primaryKey === matchedKey) {
         core.info(`Cache hit occurred for key: ${primaryKey}, not saving cache.`);
         return;

src/cache-save.ts

@@ -1,8 +1,8 @@
 // Copyright 2023-2024 The MathWorks, Inc.
 
-import * as core from '@actions/core';
-import * as cache from '@actions/cache';
-import { cacheMATLAB } from './cache-save';
+import * as core from "@actions/core";
+import * as cache from "@actions/cache";
+import { cacheMATLAB } from "./cache-save";
 
 jest.mock("@actions/cache");
 jest.mock("@actions/core");
@@ -21,13 +21,13 @@ describe("cache-save", () => {
     });
 
     it("saves cache if key does not equal matched key", async () => {
-        getStateMock.mockReturnValueOnce("matched-key").mockReturnValueOnce("primary-key")
+        getStateMock.mockReturnValueOnce("matched-key").mockReturnValueOnce("primary-key");
         await expect(cacheMATLAB()).resolves.toBeUndefined();
         expect(saveCacheMock).toHaveBeenCalledTimes(1);
     });
 
     it("does not re-save cache if key equals matched key", async () => {
-        getStateMock.mockReturnValueOnce("cache-key").mockReturnValueOnce("cache-key")
+        getStateMock.mockReturnValueOnce("cache-key").mockReturnValueOnce("cache-key");
         await expect(cacheMATLAB()).resolves.toBeUndefined();
         expect(saveCacheMock).toHaveBeenCalledTimes(0);
     });

src/cache-save.unit.test.ts

@@ -1,8 +1,8 @@
 // Copyright 2023-2024 The MathWorks, Inc.
 
 export enum State {
-    CachePrimaryKey = 'MATLAB_CACHE_KEY',
-    CacheMatchedKey = 'MATLAB_CACHE_RESULT',
-    MatlabCachePath = 'MATLAB_CACHE_PATH',
-    SupportPackagesCachePath = 'MATLAB_SUPPORT_FILES_CACHE_PATH',
+    CachePrimaryKey = "MATLAB_CACHE_KEY",
+    CacheMatchedKey = "MATLAB_CACHE_RESULT",
+    MatlabCachePath = "MATLAB_CACHE_PATH",
+    SupportPackagesCachePath = "MATLAB_SUPPORT_FILES_CACHE_PATH",
 }

src/cache-state.ts

@@ -3,38 +3,6 @@
 import * as core from "@actions/core";
 import * as install from "./install";
 
-//function resolving whether to install dependencies based on the input and runner type
-export function resolveInstallDependencies(input: string): boolean {
-    if (input.toLowerCase() === 'true') {
-        core.info(`install-system-dependencies explicitly set to true`);
-        return true;
-    }
-    if (input.toLowerCase() === 'false') {
-        core.info(`install-system-dependencies explicitly set to false`);
-        return false;
-    }
-    
-    // when expliciatlly not set to true or false then detecting based on the runner type
-    if (input.toLowerCase() === 'auto' || input === '') {
-        //using the same detection method for github hosted runner as in install.ts
-        const runnerEnvironment = process.env["RUNNER_ENVIRONMENT"];
-        const agentIsSelfHosted = process.env["AGENT_ISSELFHOSTED"];
-        
-        const isGitHubHosted = runnerEnvironment === "github-hosted" && agentIsSelfHosted !== "1";
-      
-        // shouldInstall will return true for github-hosted and false for self-hosted
-        const shouldInstall = isGitHubHosted;
-        
-        core.info(`Auto-detected runner type: ${isGitHubHosted ? 'GitHub-hosted' : 'self-hosted'}`);
-        core.info(`System dependencies will ${shouldInstall ? 'be' : 'not be'} installed (auto mode)`);
-        
-        return shouldInstall;
-    }
-    
-    // default set to false for invalid input type
-    core.warning(`Invalid value for install-system-dependencies: ${input}. Defaulting to false.`);
-    return false;
-}
 
 /**
  * Gather action inputs and then run action.
@@ -45,8 +13,7 @@ export async function run() {
     const release = core.getInput("release");
     const products = core.getMultilineInput("products");
     const cache = core.getBooleanInput("cache");
-    const installDepsInput = core.getInput("install-system-dependencies") || 'auto';
-    const installSystemDependencies = resolveInstallDependencies(installDepsInput);
+    const installSystemDependencies = core.getInput("install-system-dependencies");
 
     return install.install(platform, architecture, release, products, cache, installSystemDependencies);
 }