Add a command to build a binary of a Quarkus app

* Adds a command that generates, then executes
   a `tasks.json` task that builds a binary
   * After you have used the command once, you can
      build a binary either through the command or
      `<Ctrl>+<Shift>+B` > Quarkus: Generate a binary
* The command checks to make sure GRAALVM_HOME is set before
   building the binary, and provides a link to the Quarkus docs if
   it's not set up.

This PR addresses one aspect of #335

Signed-off-by: David Thompson <davthomp@redhat.com>

Author: datho7561

README.md

@@ -16,6 +16,7 @@ The following commands are supported for both Maven and Gradle Quarkus projects:
   * `Quarkus: Generate a Quarkus project`: Generate a Quarkus project, based on https://code.quarkus.io/
   * `Quarkus: Add extensions to current project`: Add Quarkus extensions to currently opened Quarkus project
   * `Quarkus: Debug current Quarkus project`: Launches the Maven `quarkus:dev` plugin or the Gradle `quarkusDev` command and automatically attaches a debugger
+  * `Quarkus: Build executable`: Launches Maven or Gradle with the correct arguments to build an executable of the application (requires GraalVM or Mandrel to be configured)
 
 ## Quarkus/MicroProfile `properties` Features
 

USAGE_DATA.md

@@ -15,6 +15,7 @@ vscode-quarkus has opt-in telemetry collection, provided by [vscode-commons](htt
     * "Quarkus: Debug current Quarkus project"
     * "Quarkus: Generate a Quarkus project"
     * "Quarkus: Welcome"
+    * "Quarkus: Build executable"
 
 ## How to opt in or out
 

package-lock.json

@@ -135,6 +135,10 @@
         "command": "quarkusTools.debugQuarkusProject",
         "title": "Quarkus: Debug current Quarkus project"
       },
+      {
+        "command": "quarkusTools.buildBinary",
+        "title": "Quarkus: Build executable"
+      },
       {
         "command": "quarkusTools.welcome",
         "title": "Quarkus: Welcome"
@@ -272,6 +276,7 @@
     "@types/request-promise": "^4.1.44",
     "@types/semver": "^6.2.0",
     "@types/vscode": "^1.37.0",
+    "@types/which": "^2.0.1",
     "@types/yauzl": "^2.9.1",
     "chai": "^4.2.0",
     "chai-fs": "^2.0.0",
@@ -301,6 +306,7 @@
     "lodash": "^4.17.21",
     "request": "^2.88.0",
     "request-promise": "^4.2.4",
+    "which": "^2.0.2",
     "yauzl": "^2.10.0"
   }
 }

package.json

@@ -13,18 +13,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import * as path from 'path';
 import * as findUp from 'find-up';
+import * as path from 'path';
 import { Uri, WorkspaceFolder } from 'vscode';
 import { FsUtils } from '../utils/fsUtils';
-import { TaskPattern } from './TaskPattern';
 import { formattedPathForTerminal } from '../utils/shellUtils';
 import { getFilePathsFromFolder } from '../utils/workspaceUtils';
+import { TaskPattern } from './TaskPattern';
 
 interface BuildSupportData {
   buildFile: string;
   defaultExecutable: string;
   quarkusDev: string;
+  quarkusBinary: string;
   wrapper: string;
   wrapperWindows: string;
   taskBeginsPattern: string;
@@ -56,6 +57,7 @@ export interface TerminalCommandOptions {
 }
 
 export abstract class BuildSupport {
+
   buildSupportData: BuildSupportData;
 
   constructor(buildSupportData: BuildSupportData) {
@@ -77,6 +79,13 @@ export abstract class BuildSupport {
    */
   public abstract getQuarkusDevCommand(folderPath: string, options?: TerminalCommandOptions): Promise<TerminalCommand>;
 
+  /**
+   * Returns a command that builds the Quarkus application into a binary
+   * @param folderPath
+   * @param options
+   */
+  public abstract getQuarkusBinaryCommand(folderPath: string, options?: TerminalCommandOptions): Promise<TerminalCommand>;
+
   /**
    * Returns an appropriate build tool command depending on `options` and `buildFilePath`
    *
@@ -183,9 +192,18 @@ export abstract class BuildSupport {
     return this.buildSupportData.quarkusDev;
   }
 
+  public getQuarkusBinary(): string {
+    return this.buildSupportData.quarkusBinary;
+  }
+
   public getQuarkusDevTaskName(workspaceFolder: WorkspaceFolder, projectFolder: string): string {
     const relativePath: string =  path.relative(workspaceFolder.uri.fsPath, projectFolder);
-    return  this.buildSupportData.quarkusDev + (relativePath.length > 0 ? ` (${relativePath})` : '');
+    return this.buildSupportData.quarkusDev + (relativePath.length > 0 ? ` (${relativePath})` : '');
+  }
+
+  public getQuarkusBinaryTaskName(workspaceFolder: WorkspaceFolder, projectFolder: string): string {
+    const relativePath: string =  path.relative(workspaceFolder.uri.fsPath, projectFolder);
+    return this.buildSupportData.quarkusBinary + (relativePath.length > 0 ? ` (${relativePath})` : '');
   }
 
   public getDefaultExecutable(): string {

src/buildSupport/BuildSupport.ts

@@ -23,6 +23,7 @@ export class GradleBuildSupport extends BuildSupport {
       buildFile: 'build.gradle',
       defaultExecutable: 'gradle',
       quarkusDev: 'quarkusDev',
+      quarkusBinary: 'buildNative',
       wrapper: 'gradlew',
       wrapperWindows: 'gradlew.bat',
       taskBeginsPattern: '^.*Starting a Gradle Daemon*',
@@ -49,4 +50,11 @@ export class GradleBuildSupport extends BuildSupport {
     const gradle: string = await this.getCommand(folderPath, options.buildFilePath, { windows: options.windows });
     return { command: [gradle, quarkusDev].join(' ') };
   }
+
+  public async getQuarkusBinaryCommand(folderPath: string, options?: TerminalCommandOptions): Promise<TerminalCommand> {
+    const quarkusBinary: string = `${this.getQuarkusBinary()} --console=plain`;
+    const gradle: string = await this.getCommand(folderPath, options.buildFilePath, { windows: options.windows });
+    return { command: [gradle, quarkusBinary].join(' ') };
+  }
+
 }

src/buildSupport/GradleBuildSupport.ts

@@ -17,11 +17,13 @@ import { formattedPathForTerminal } from '../utils/shellUtils';
 import { BuildSupport, TerminalCommand, TerminalCommandOptions } from "./BuildSupport";
 
 export class MavenBuildSupport extends BuildSupport {
+
   constructor() {
     super({
       buildFile: 'pom.xml',
       defaultExecutable: 'mvn',
       quarkusDev: 'quarkus:dev',
+      quarkusBinary: 'package -Pnative',
       wrapper: 'mvnw',
       wrapperWindows: 'mvnw.cmd',
       taskBeginsPattern: '^.*Scanning for projects...*',
@@ -46,7 +48,12 @@ export class MavenBuildSupport extends BuildSupport {
     const pomPath: string = options.buildFilePath ? `-f ${await formattedPathForTerminal(options.buildFilePath)}` : '';
     const mvn: string = await this.getCommand(folderPath, options && options.buildFilePath, { windows: options && options.windows });
     return { command: [mvn, this.getQuarkusDev(), pomPath].join(' ') };
+  }
 
+  public async getQuarkusBinaryCommand(folderPath: string, options?: TerminalCommandOptions): Promise<TerminalCommand> {
+    const pomPath: string = options.buildFilePath ? `-f ${await formattedPathForTerminal(options.buildFilePath)}` : '';
+    const mvn: string = await this.getCommand(folderPath, options && options.buildFilePath, { windows: options && options.windows });
+    return { command: [mvn, this.getQuarkusBinary(), pomPath].join(' ') };
   }
 
 }

src/buildSupport/MavenBuildSupport.ts

@@ -5,6 +5,7 @@ import { requestStandardMode } from "../utils/requestStandardMode";
 import { sendCommandFailedTelemetry, sendCommandSucceededTelemetry } from "../utils/telemetryUtils";
 import { WelcomeWebview } from "../webviews/WelcomeWebview";
 import { addExtensionsWizard } from "../wizards/addExtensions/addExtensionsWizard";
+import { buildBinary } from "../wizards/binary/buildBinary";
 import { startDebugging } from "../wizards/debugging/startDebugging";
 import { generateProjectWizard } from "../wizards/generateProject/generationWizard";
 import { deployToOpenShift } from "../wizards/deployToOpenShift/deployToOpenShift";
@@ -43,6 +44,12 @@ export function registerVSCodeCommands(context: ExtensionContext): void {
    * Command for deploying current Quarkus project to OpenShift with OpenShift Connector
    */
   registerCommandWithTelemetry(context, VSCodeCommands.DEPLOY_TO_OPENSHIFT, withStandardMode(deployToOpenShift, "Deploying to OpenShift"));
+
+  /**
+   * Command for building a binary
+   */
+  registerCommandWithTelemetry(context, VSCodeCommands.BUILD_BINARY, withStandardMode(buildBinary, "Building a binary"));
+
 }
 
 /**

src/commands/registerCommands.ts

@@ -19,6 +19,7 @@ export namespace VSCodeCommands {
   export const CREATE_PROJECT = 'quarkusTools.createProject';
   export const ADD_EXTENSIONS = 'quarkusTools.addExtension';
   export const DEBUG_QUARKUS_PROJECT = 'quarkusTools.debugQuarkusProject';
+  export const BUILD_BINARY = 'quarkusTools.buildBinary';
   export const QUARKUS_WELCOME = 'quarkusTools.welcome';
   export const DEPLOY_TO_OPENSHIFT = 'quarkusTools.deployToOpenShift';
 }