feat: support for maven wrapper (mvnw)

lib/index.ts

@@ -4,11 +4,42 @@ import * as path from 'path';
 import * as subProcess from './sub-process';
 import { legacyPlugin } from '@snyk/cli-interface';
 import { containsJar, createPomForJar, createPomForJars, isJar } from './jar';
+import * as os from 'os';
 
 export interface MavenOptions extends legacyPlugin.BaseInspectOptions {
   scanAllUnmanaged?: boolean;
 }
 
+export function getCommand(root: string, targetFile: string | undefined) {
+  if (!targetFile) {
+    return 'mvn';
+  }
+  const isWinLocal = /^win/.test(os.platform()); // local check, can be stubbed in tests
+  const wrapperScript = isWinLocal ? 'mvnw.cmd' : './mvnw';
+  // try to find a sibling wrapper script first
+  let pathToWrapper = path.resolve(
+    root,
+    path.dirname(targetFile),
+    wrapperScript,
+  );
+  if (fs.existsSync(pathToWrapper)) {
+    return wrapperScript;
+  }
+  // now try to find a wrapper in the root
+  pathToWrapper = path.resolve(root, wrapperScript);
+  if (fs.existsSync(pathToWrapper)) {
+    return wrapperScript;
+  }
+  return 'mvn';
+}
+
+// When we have `mvn`, we can run the subProcess from anywhere.
+// However due to https://github.com/takari/maven-wrapper/issues/133, `mvnw` can only be run
+// within the directory where `mvnw` exists
+function calculateTargetFilePath(mavenCommand, root: string, targetPath) {
+  return mavenCommand === 'mvn' ? root : path.dirname(targetPath);
+}
+
 export async function inspect(
   root: string,
   targetFile?: string,
@@ -38,11 +69,23 @@ export async function inspect(
   }
 
   const mvnArgs = buildArgs(targetFile, options.args);
+  const mavenCommand = getCommand(root, targetFile);
+  const targetFilePath = calculateTargetFilePath(
+    mavenCommand,
+    root,
+    targetPath,
+  );
   try {
-    const result = await subProcess.execute('mvn', mvnArgs, { cwd: root });
-    const versionResult = await subProcess.execute('mvn --version', [], {
-      cwd: root,
+    const result = await subProcess.execute(mavenCommand, mvnArgs, {
+      cwd: targetFilePath,
     });
+    const versionResult = await subProcess.execute(
+      `${mavenCommand} --version`,
+      [],
+      {
+        cwd: targetFilePath,
+      },
+    );
     const parseResult = parseTree(result, options.dev);
     const { javaVersion, mavenVersion } = parseVersions(versionResult);
     return {
@@ -61,19 +104,7 @@ export async function inspect(
       package: parseResult.data,
     };
   } catch (error) {
-    error.message =
-      error.message +
-      '\n\n' +
-      'Please make sure that Apache Maven Dependency Plugin ' +
-      'version 2.2 or above is installed, and that ' +
-      '`mvn ' +
-      mvnArgs.join(' ') +
-      '` executes successfully ' +
-      'on this project.\n\n' +
-      'If the problem persists, collect the output of ' +
-      '`mvn ' +
-      mvnArgs.join(' ') +
-      '` and contact [email protected]\n';
+    error.message = buildErrorMessage(error, mvnArgs, mavenCommand);
     throw error;
   }
 }
@@ -92,3 +123,27 @@ export function buildArgs(
   }
   return args;
 }
+
+function buildErrorMessage(
+  error: Error,
+  mvnArgs: string[],
+  mavenCommand: string,
+): string {
+  const mavenArguments: string = mvnArgs.join(' ');
+  const fullCommand = `${mavenCommand} ${mavenArguments}`;
+  const mvnwCommandTipMessage =
+    'Currently, you cannot run `mvnw` outside your current directory, you will have to go inside the directory of your project (see: https://github.com/takari/maven-wrapper/issues/133)\n\n';
+  return (
+    error.message +
+    '\n\n' +
+    'Please make sure that Apache Maven Dependency Plugin ' +
+    'version 2.2 or above is installed, and that `' +
+    fullCommand +
+    '` executes successfully ' +
+    'on this project.\n\n' +
+    (mavenCommand.indexOf('mvnw') >= 0 ? mvnwCommandTipMessage : '') +
+    'If the problem persists, collect the output of `' +
+    fullCommand +
+    '` and contact [email protected]\n'
+  );
+}

package.json

@@ -32,7 +32,9 @@
     "eslint": "^6.6.0",
     "eslint-config-prettier": "^6.7.0",
     "prettier": "^1.19.1",
+    "@types/sinon": "^7.0.10",
     "semantic-release": "^15",
+    "sinon": "^2.4.1",
     "tap": "^12.0.1",
     "tap-only": "0.0.5"
   },

tests/fixtures/bad-maven-with-mvnw/.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

tests/fixtures/bad-maven-with-mvnw/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar