fix: triggering gradle on windows (#303)

* fix: triggering gradle on windows

* remove redundant if check

Author: james-snyk

lib/index.ts

@@ -411,21 +411,6 @@ export async function getGradleVersion(
   return gradleVersionOutput;
 }
 
-export function generateWrapperProcessArgs(
-  commandPath: string,
-  args: string[],
-): { command: string; args: string[] } {
-  let parseArgs: string[] = [];
-  let command = commandPath;
-  const isWinLocal = /^win/.test(os.platform());
-  if (isWinLocal && command !== 'gradle') {
-    command = 'cmd.exe';
-    parseArgs.push(commandPath);
-  }
-  parseArgs = parseArgs.concat(args);
-  return { command, args: parseArgs };
-}
-
 async function getAllDepsWithPlugin(
   root: string,
   targetFile: string,
@@ -444,15 +429,11 @@ async function getAllDepsWithPlugin(
     gradleVersion,
   );
 
-  const { command: wrapperedCommand, args: wrapperArgs } =
-    generateWrapperProcessArgs(command, args);
-
-  const fullCommandText =
-    'gradle command: ' + wrapperedCommand + ' ' + wrapperArgs.join(' ');
+  const fullCommandText = 'gradle command: ' + command + ' ' + args.join(' ');
   debugLog('Executing ' + fullCommandText);
   const stdoutText = await subProcess.execute(
-    wrapperedCommand,
-    wrapperArgs,
+    command,
+    args,
     { cwd: root },
     printIfEcho,
   );
@@ -487,13 +468,7 @@ async function getAllDeps(
   snykHttpClient: SnykHttpClient,
 ): Promise<JsonDepsScriptResult> {
   const command = getCommand(root, targetFile);
-  const { command: wrapperedCommand, args: wrapperArgs } =
-    generateWrapperProcessArgs(command, []);
-  const gradleVersion = await getGradleVersion(
-    root,
-    wrapperedCommand,
-    wrapperArgs,
-  );
+  const gradleVersion = await getGradleVersion(root, command, []);
   if (gradleVersion.match(/Gradle 1/)) {
     throw new Error('Gradle 1.x is not supported');
   }

lib/sub-process.ts

@@ -25,11 +25,13 @@ export function execute(
 
   args = escapeAll(args, spawnOptions);
 
-  if (/^win/.test(os.platform()) && command === 'cmd.exe') {
+  if (/^win/.test(os.platform())) {
     spawnOptions.windowsVerbatimArguments = true; // makes windows process " correctly
-    args = ['/c', `"${quoteAll(args).join(' ')}"`];
-  }
 
+    const updated = updateCommandAndArgsForWindows(command, args);
+    command = updated.command;
+    args = updated.args;
+  }
   // Before spawning an external process, we look if we need to restore the system proxy configuration,
   // which overides the cli internal proxy configuration.
   if (process.env.SNYK_SYSTEM_HTTP_PROXY !== undefined) {
@@ -86,3 +88,21 @@ ${stderr}
     });
   });
 }
+
+function updateCommandAndArgsForWindows(
+  command: string,
+  args: string[],
+): { command: string; args: string[] } {
+  args = quoteAll(args); // to handle any spaces in args relating to file path
+
+  if (command !== 'gradle') {
+    // when command is not gradle we need to wrap the command in "
+    // then wrap the combined string of all args to enable windows to interpret the command correctly
+    args = [`"${command}"`, ...args];
+    args = ['/c', `"${args.join(' ')}"`];
+  } else {
+    args = ['/c', command, ...args];
+  }
+
+  return { command: 'cmd.exe', args };
+}

test/system/windows.test.ts

@@ -31,8 +31,8 @@ if (isWinLocal) {
       inspect(subWithWrapper, path.join('app', 'build.gradle')),
     ).rejects.toThrow();
     expect(subProcessExecSpy.mock.calls[0]).toEqual([
-      'cmd.exe',
-      [`${subWithWrapper}\\gradlew.bat`, '-v'],
+      `${subWithWrapper}\\gradlew.bat`,
+      ['-v'],
       {
         cwd: `${subWithWrapper}`,
       },
@@ -42,8 +42,8 @@ if (isWinLocal) {
   test('windows with wrapper invokes wrapper bat', async () => {
     await expect(inspect(rootWithWrapper, 'build.gradle')).rejects.toThrow();
     expect(subProcessExecSpy.mock.calls[0]).toEqual([
-      'cmd.exe',
-      [`${rootWithWrapper}\\gradlew.bat`, '-v'],
+      `${rootWithWrapper}\\gradlew.bat`,
+      ['-v'],
       {
         cwd: `${rootWithWrapper}`,
       },