Support script arguments for environmentSetupScript in form of "script path" [arg...] (#4764)

Author: huangqinjin

docs/kits.md

@@ -157,7 +157,8 @@ The following additional options may be specified:
 
 `environmentSetupScript`
 
-> The absolute path to a script that modifies/adds environment variables for the kit. Uses `call` on Windows and `source` in `bash` otherwise.
+> The absolute path to a script or a string in form of `"script path" [arg ...]`that modifies/adds environment variables for the kit. 
+Uses `call` on Windows and `source` in `bash` otherwise.
 
 `description`
 

src/kits/kit.ts

@@ -695,18 +695,24 @@ export async function getShellScriptEnvironment(kit: Kit, opts?: expand.Expansio
     let script = '';
     let run_command = '';
 
-    let environmentSetupScript = kit.environmentSetupScript?.trim();
+    let environmentSetupScript = kit.environmentSetupScript!.trim();
     if (opts) {
-        environmentSetupScript = await expand.expandString(environmentSetupScript!, opts);
+        environmentSetupScript = await expand.expandString(environmentSetupScript, opts);
+    }
+
+    // If the string doesn't start with a quote, assume it is a path to a script file, so we quote it in case there are spaces in the path.
+    // Otherwise, assume it is in form of `"script path" [arg ...]`, we will not add extra quotes, to avoid breaking the command.
+    if (!environmentSetupScript.startsWith('"')) {
+        environmentSetupScript = `"${environmentSetupScript}"`;
     }
 
     if (process.platform === 'win32') { // windows
-        script += `call "${environmentSetupScript}"\r\n`; // call the user batch script
+        script += `call ${environmentSetupScript}\r\n`; // call the user batch script
         script += `set >> "${environment_path}"`; // write env vars to temp file
         // Quote the script file path before running it, in case there are spaces.
         run_command = `call "${script_path}"`;
     } else { // non-windows
-        script += `source "${environmentSetupScript}"\n`; // run the user shell script
+        script += `source ${environmentSetupScript}\n`; // run the user shell script
         script += `printenv >> ${environment_path}`; // write env vars to temp file
         run_command = `/bin/bash -c "source ${script_path}"`; // run script in bash to enable bash-builtin commands like 'source'
     }

test/unit-tests/kitmanager.test.ts

@@ -68,4 +68,29 @@ suite('Kits test', () => {
             expect(env_vars_arr).to.deep.include(['TESTVAR13', 'cde']);
         }
     });
+
+    test('Test load env vars from shell script with arguments', async () => {
+        const fname_extension = process.platform === 'win32' ? 'bat' : 'sh';
+        const fname = `cmake-kit-test-${Math.random().toString()}.${fname_extension}`;
+        const script_path = path.join(paths.tmpDir, fname);
+        // generate a file with test batch / shell script that sets two env vars
+        if (process.platform === 'win32') {
+            await fs.writeFile(script_path, `set "TESTVAR12=%~1"\r\nset "TESTVAR13=%~2"`);
+        } else {
+            await fs.writeFile(script_path, `export "TESTVAR12=$1"\nexport "TESTVAR13=$2"`);
+        }
+
+        const kit = { name: "Test Kit 2", environmentSetupScript: `"${script_path}" abc cde`, isTrusted: true };
+        const env_vars = await getShellScriptEnvironment(kit);
+        await fs.unlink(script_path);
+        expect(env_vars).to.not.be.undefined;
+
+        if (env_vars) {
+            const env_vars_arr = Array.from(Object.entries(env_vars));
+            // must contain all env vars, not only the ones we defined!
+            expect(env_vars_arr.length).to.be.greaterThan(2);
+            expect(env_vars_arr).to.deep.include(['TESTVAR12', 'abc']);
+            expect(env_vars_arr).to.deep.include(['TESTVAR13', 'cde']);
+        }
+    });
 });