Merge pull request #38 from matlab-actions/startupoptions

Add ability to pass MATLAB startup options

Author: sameagen-MW

.github/workflows/bat.yml

@@ -55,6 +55,17 @@ jobs:
         uses: ./
         with:
           command: exp = getenv('GITHUB_WORKSPACE'), act = pwd, assert(strcmp(act, exp), strjoin({act exp}, '\n'));
+
+      - name: Run MATLAB statement with arguments
+        uses: ./
+        with:
+          command: disp("Hello world!!")
+          startup-options: -nojvm -nodesktop -logfile mylog.log
+          
+      - name: Validate that previous command ran with arguments
+        uses: ./
+        with:
+          command: assert(isfile("mylog.log"));
 
       - run: echo 'onetyone = 11' > startup.m
         shell: bash

action.yml

@@ -1,4 +1,4 @@
-# Copyright 2020 The MathWorks, Inc.
+# Copyright 2020-2023 The MathWorks, Inc.
 
 name: Run MATLAB Command
 description: >-
@@ -8,6 +8,11 @@ inputs:
     description: >-
       Script, function, or statement to execute
     required: true
+  startup-options:
+    description: >-
+      Startup options for MATLAB
+    required: false
+    default: ""
 runs:
   using: node16
   main: dist/index.js

package-lock.json

@@ -28,7 +28,7 @@
         "@types/node": "^15.12.4",
         "@types/uuid": "^8.3.0",
         "@vercel/ncc": "^0.28.6",
-        "jest": "^27.0.5",
+        "jest": "^27.5.1",
         "jest-circus": "^27.0.5",
         "prettier": "2.3.1",
         "ts-jest": "^27.0.3",

package.json

@@ -14,6 +14,7 @@ async function run() {
     const architecture = process.arch;
     const workspaceDir = process.cwd();
     const command = core.getInput("command");
+    const startupOpts = core.getInput("startup-options").split(" ");
 
     const helperScript = await core.group("Generate script", async () => {
         const helperScript = await matlab.generateScript(workspaceDir, command);
@@ -22,7 +23,7 @@ async function run() {
     });
 
     await core.group("Run command", async () => {
-        await matlab.runCommand(helperScript, platform, architecture, exec.exec);
+        await matlab.runCommand(helperScript, platform, architecture, exec.exec, startupOpts);
     });
 }
 

src/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2020 The MathWorks, Inc.
+// Copyright 2020-2023 The MathWorks, Inc.
 
 import { promises as fs } from "fs";
 import * as os from "os";
@@ -50,13 +50,19 @@ export async function generateScript(workspaceDir: string, command: string): Pro
  * @param architecture Architecture of the runner (e.g., "x64")
  * @param fn ExecFn that will execute a command on the runner
  */
-export async function runCommand(hs: HelperScript, platform: string, architecture: string, fn: ExecFn): Promise<void> {
+export async function runCommand(hs: HelperScript, platform: string, architecture: string, fn: ExecFn, args?: string[]): Promise<void> {
     const rmcPath = getRunMATLABCommandScriptPath(platform, architecture);
     await fs.chmod(rmcPath, 0o777);
 
     const rmcArg = script.cdAndCall(hs.dir, hs.command);
 
-    const exitCode = await fn(rmcPath, [rmcArg]);
+    let execArgs = [rmcArg];
+
+    if (args) {
+       execArgs = execArgs.concat(args);
+    }
+
+    const exitCode = await fn(rmcPath, execArgs);
     if (exitCode !== 0) {
         return Promise.reject(Error(`Exited with non-zero code ${exitCode}`));
     }

src/matlab.ts

@@ -1,4 +1,4 @@
-// Copyright 2020 The MathWorks, Inc.
+// Copyright 2020-2023 The MathWorks, Inc.
 
 import { promises as fs } from "fs";
 import * as path from "path";
@@ -71,6 +71,20 @@ describe("run command", () => {
         await expect(actual).resolves.toBeUndefined();
     });
 
+    it("ideally works with arguments", async () => {
+        const chmod = jest.spyOn(fs, "chmod");
+        const execFn = jest.fn();
+
+        chmod.mockResolvedValue(undefined);
+        execFn.mockResolvedValue(0);
+
+        const actual = matlab.runCommand(helperScript, platform, architecture, execFn, ["-nojvm", "-logfile", "file"]);
+        await expect(actual).resolves.toBeUndefined();
+        expect(execFn.mock.calls[0][1][1]).toBe("-nojvm");
+        expect(execFn.mock.calls[0][1][2]).toBe("-logfile");
+        expect(execFn.mock.calls[0][1][3]).toBe("file");
+    });
+
     it("fails when chmod fails", async () => {
         const chmod = jest.spyOn(fs, "chmod");
         const execFn = jest.fn();