Overhaul heroku-deploy-standalone (#232)

Author: Malax

.github/workflows/ci.yml

@@ -10,6 +10,38 @@ permissions:
   contents: read
 
 jobs:
+  integration-linux:
+    name: "Integration Tests"
+    runs-on: ubuntu-22.04
+    env:
+      HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
+      HEROKU_API_USER: ${{ secrets.HEROKU_API_USER }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: "21"
+      - name: Setup Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "Example"
+      - name: Update Rust toolchain
+        run: rustup update
+      - name: Install Heroku CLI
+        run: curl https://cli-assets.heroku.com/install.sh | sh
+      - name: Package heroku-deploy-standalone
+        run: "./mvnw --batch-mode package"
+      - name: Package integration test fixtures
+        working-directory: "integration-test/fixtures/war-app"
+        run: "./mvnw --batch-mode package"
+      - name: Package integration test fixtures
+        working-directory: "integration-test/fixtures/jar-app"
+        run: "./mvnw --batch-mode package"
+      - name: Run integration tests
+        working-directory: "integration-test"
+        run: "cargo test"
+
   maven:
     name: "Execute build, run tests (Java ${{ matrix.java-version }})"
     runs-on: ubuntu-22.04

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## main
+
+### heroku-deploy-standalone
+
+* Add proper CLI to configure all aspects of app deployment. Previously used Java properties are no longer supported. See `--help` for usage. ([#232](https://github.com/heroku/heroku-maven-plugin/pull/232))
+* Unify usage between WAR and JAR files. heroku-deploy-standalone will now automatically use the correct mode based on file extension. ([#232](https://github.com/heroku/heroku-maven-plugin/pull/232))
+* Default `webapp-runner` version is now always the most recently released version. ([#232](https://github.com/heroku/heroku-maven-plugin/pull/232))
+
 ## 3.0.5
 
 * Update dependencies. ([#142](https://github.com/heroku/heroku-maven-plugin/pull/142))

heroku-deploy-standalone/README.md

@@ -0,0 +1,66 @@
+# Heroku JVM App Deploy   ![License](https://img.shields.io/github/license/heroku/heroku-maven-plugin) ![Maven Central](https://img.shields.io/maven-central/v/com.heroku.sdk/heroku-sdk-parent) [![CI](https://github.com/heroku/heroku-maven-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/heroku/heroku-maven-plugin/actions/workflows/ci.yml)
+
+This command line tool is used to deploy JVM applications directly to Heroku without pushing to a Git repository.
+It uses [Heroku's Platform API](https://devcenter.heroku.com/articles/platform-api-quickstart).
+This can be useful when deploying from a CI server, deploying pre-built JAR or WAR files.
+
+It will automatically include and configure a Tomcat server via [webapp-runner](https://github.com/heroku/webapp-runner) if a WAR file is deployed.
+
+## Table of Contents
+* [Installation](#installation)
+* [Usage](#usage)
+* [Requirements](#requirements)
+* [Configuration](#configuration)
+    + [Heroku API Key](#heroku-api-key)
+
+## Installation
+
+Download the latest release from [Maven Central](https://repo1.maven.org/maven2/com/heroku/sdk/heroku-deploy-standalone/).
+The JAR file contains all required dependencies.
+
+## Usage
+
+```shell
+java -jar heroku-deploy-standalone-0.0.0.jar --help
+```
+
+```
+Usage: heroku-deploy-standalone [-hV] [--disable-auto-includes] [-a=<appName>]
+                                [-j=<jdkString>] [--jar-opts=<jarFileOpts>]
+                                [--webapp-runner-version=<webappRunnerVersion>]
+                                [-b[=<buildpacks>...]]... [-i
+                                [=<includedPaths>...]]... <mainFile>
+Application for deploying Java applications to Heroku.
+      <mainFile>          The JAR or WAR file to deploy.
+  -a, --app=<appName>     The name of the Heroku app to deploy to.
+  -b, --buildpack[=<buildpacks>...]
+
+      --disable-auto-includes
+
+  -h, --help              Show this help message and exit.
+  -i, --include[=<includedPaths>...]
+                          Additional files or directories to include.
+  -j, --jdk=<jdkString>
+      --jar-opts=<jarFileOpts>
+
+  -V, --version           Print version information and exit.
+      --webapp-runner-version=<webappRunnerVersion>
+                          The version of webapp-runner to use. Defaults to the
+                            most recent version (9.0.80.0).
+```
+
+
+## Requirements
+
+- Java 8u101 or higher (versions < u101 might experience difficulties displaying build log output)
+
+## Configuration
+
+### Heroku API Key
+This plugin uses Heroku's Platform API and thus requires an API key to function. If you have the
+[Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed and logged in with `heroku login`, the plugin will automatically
+pick up your API key. Alternatively, you can use the `HEROKU_API_KEY` environment variable to set your API key:
+
+```shell
+$ HEROKU_API_KEY="xxx-xxx-xxxx" java -jar heroku-deploy-standalone-0.0.0.jar ...
+```

heroku-deploy-standalone/pom.xml

@@ -25,6 +25,11 @@
       <artifactId>slf4j-nop</artifactId>
       <version>2.0.9</version>
     </dependency>
+    <dependency>
+      <groupId>info.picocli</groupId>
+      <artifactId>picocli</artifactId>
+      <version>4.7.4</version>
+    </dependency>
   </dependencies>
 
   <build>
@@ -40,7 +45,7 @@
           <appendAssemblyId>false</appendAssemblyId>
           <archive>
             <manifest>
-              <mainClass>com.heroku.sdk.deploy.DeployWar</mainClass>
+              <mainClass>com.heroku.sdk.deploy.standalone.Main</mainClass>
             </manifest>
           </archive>
         </configuration>

heroku-deploy-standalone/src/main/java/com/heroku/sdk/deploy/DeployJar.java

@@ -0,0 +1,30 @@
+package com.heroku.sdk.deploy.standalone;
+
+import com.heroku.sdk.deploy.lib.resolver.AppNameResolver;
+import com.heroku.sdk.deploy.lib.resolver.WebappRunnerResolver;
+import picocli.CommandLine;
+import java.nio.file.Paths;
+import java.util.Optional;
+
+public class DefaultValueProvider implements CommandLine.IDefaultValueProvider {
+    @Override
+    public String defaultValue(CommandLine.Model.ArgSpec argSpec) throws Exception {
+
+        if (argSpec instanceof CommandLine.Model.OptionSpec) {
+            CommandLine.Model.OptionSpec optionSpec = (CommandLine.Model.OptionSpec) argSpec;
+
+            if (optionSpec.shortestName().equalsIgnoreCase("-a")) {
+                Optional<String> appName = AppNameResolver.resolveViaHerokuGitRemote(Paths.get(System.getProperty("user.dir")));
+                if (appName.isPresent()) {
+                    return appName.get();
+                }
+            }
+
+            if (optionSpec.shortestName().equalsIgnoreCase("--webapp-runner-version")) {
+                return WebappRunnerResolver.getLatestVersion();
+            }
+        }
+
+        return null;
+    }
+}