Add Fir support (#369)

Author: Malax

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+* When the target app is using [Fir](https://devcenter.heroku.com/articles/generations#fir), a default `project.toml` will now be generated and deployed alongside the app. This ensures that OpenJDK will be installed and `Procfile` works as expected without the need for explicit configuration. ([#369](https://github.com/heroku/heroku-jvm-application-deployer/pull/369))
 
 ## [4.0.7] - 2024-07-17
 

integration-test/src/lib.rs

@@ -6,13 +6,13 @@ use std::path::{Path, PathBuf};
 use std::process::{Command, Output};
 use std::time::Duration;
 
-pub fn prepare_test<F>(fixture_dir: &str, f: F)
+pub fn prepare_test<F>(fixture_dir: &str, space: Option<&str>, f: F)
 where
     F: Fn(TestContext),
 {
     let app_dir = prepare_fixture(fixture_dir);
     initialize_git_repository(&app_dir);
-    let app_create_result = create_heroku_app(&app_dir);
+    let app_create_result = create_heroku_app(&app_dir, space);
 
     f(TestContext {
         app_name: app_create_result.name,
@@ -62,11 +62,16 @@ pub fn http_get_expect_200(url: &str) -> String {
 }
 
 #[must_use]
-pub fn create_heroku_app(path: &Path) -> HerokuAppCreateResult {
+pub fn create_heroku_app(path: &Path, space: Option<&str>) -> HerokuAppCreateResult {
+    let mut args = vec!["create", "--json"];
+
+    if let Some(space) = space {
+        args.push("--space");
+        args.push(space);
+    }
+
     let output = run_command(
-        Command::new("heroku")
-            .args(["create", "--json"])
-            .current_dir(path),
+        Command::new("heroku").args(args).current_dir(path),
         &format!("Could not create Heroku app in {path:?}"),
         true,
     );

integration-test/tests/integration_tests.rs

@@ -6,7 +6,7 @@ use std::process::Command;
 
 #[test]
 fn basic_war_app() {
-    prepare_test("war-app", |context| {
+    prepare_test("war-app", None, |context| {
         create_empty_git_commit(&context.app_dir);
 
         run_command(
@@ -33,7 +33,7 @@ fn basic_war_app() {
 
 #[test]
 fn basic_jar_app() {
-    prepare_test("jar-app", |context| {
+    prepare_test("jar-app", None, |context| {
         create_empty_git_commit(&context.app_dir);
 
         run_command(
@@ -60,7 +60,7 @@ fn basic_jar_app() {
 
 #[test]
 fn basic_jar_app_git_repo_without_commits() {
-    prepare_test("jar-app", |context| {
+    prepare_test("jar-app", None, |context| {
         // Note that no git commit is created
 
         run_command(
@@ -84,3 +84,39 @@ fn basic_jar_app_git_repo_without_commits() {
         assert_eq!(response, String::from("Hello World!"));
     });
 }
+
+#[test]
+#[ignore = "General Fir CI testing strategy for tools is pending"]
+fn basic_war_app_fir() {
+    prepare_test("war-app", Some("heroku-languages-jvm-ci"), |context| {
+        // Note that no project.toml exists in the test fixture and that it will be generated by
+        // the JVM application deployer automatically.
+        assert!(!context.app_dir.join("project.toml").exists());
+
+        create_empty_git_commit(&context.app_dir);
+
+        let output = run_command(
+            Command::new("java")
+                .args([
+                    "-jar",
+                    &heroku_jvm_application_deployer_jar_path().to_string_lossy(),
+                    &context
+                        .app_dir
+                        .join("target/test-1.0-SNAPSHOT.war")
+                        .to_string_lossy(),
+                    "--jdk",
+                    "21",
+                ])
+                .current_dir(&context.app_dir),
+            "Running heroku-jvm-application-deployer failed.",
+            false,
+        );
+
+        assert!(
+            String::from_utf8_lossy(&output.stdout).contains("- including: project.toml (hidden)")
+        );
+
+        let response = http_get_expect_200(&context.app_url);
+        assert_eq!(response, String::from("Hello World!"));
+    });
+}

src/main/java/com/heroku/deployer/Main.java

@@ -1,5 +1,6 @@
 package com.heroku.deployer;
 
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -16,6 +17,7 @@
 import com.heroku.deployer.sourceblob.SourceBlobDescriptor;
 import com.heroku.deployer.sourceblob.SourceBlobPackager;
 import org.apache.commons.codec.digest.DigestUtils;
+import org.apache.commons.io.IOUtils;
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
@@ -87,7 +89,8 @@ public Integer call() throws Exception {
             List<Path> defaultPaths = Arrays.asList(
                 Paths.get("Procfile"),
                 Paths.get("system.properties"),
-                Paths.get(".jdk-overlay")
+                Paths.get(".jdk-overlay"),
+                Paths.get("project.toml")
             );
 
             for (Path defaultPath : defaultPaths) {
@@ -146,6 +149,13 @@ public Integer call() throws Exception {
             sourceBlobDescriptor.addSyntheticFile(procfilePath, defaultProcfile.asString(), true);
         }
 
+        // Add an auto-generated project-toml to the source blob if no project.toml has been added yet.
+        Path projectTomlPath = Paths.get("project.toml");
+        if (!sourceBlobDescriptor.containsPath(projectTomlPath) && HerokuCli.runIsCnb(projectDirectory, appName)) {
+            String defaultProjectToml = IOUtils.toString(getClass().getResourceAsStream("/default-project.toml"), StandardCharsets.UTF_8);
+            sourceBlobDescriptor.addSyntheticFile(projectTomlPath, defaultProjectToml, true);
+        }
+
         // Add an auto-generated system.properties to the source blob if no system.properties has been added yet.
         if (jdkString.isPresent()) {
             Path systemPropertiesPath = Paths.get("system.properties");

src/main/java/com/heroku/deployer/util/HerokuCli.java

@@ -4,10 +4,8 @@
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Optional;
+import java.util.*;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 public class HerokuCli {
@@ -22,6 +20,26 @@ public static Optional<String> runAuthToken(Path workingDirectory) throws IOExce
         }
     }
 
+    public static boolean runIsCnb(Path workingDirectory, Optional<String> appName) throws IOException {
+        List<String> commandArguments = new ArrayList<>();
+        commandArguments.add("info");
+        commandArguments.add("--shell");
+
+        if (appName.isPresent()) {
+            commandArguments.add("--app");
+            commandArguments.add(appName.get());
+        }
+
+        List<String> lines = runRaw(workingDirectory, commandArguments.toArray(new String[0]));
+        for (String line : lines) {
+            if (line.equals("stack=cnb")) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     private static List<String> runRaw(Path workingDirectory, String... command) throws IOException {
         List<String> fullCommand =  new ArrayList<>(Arrays.asList(command));
         fullCommand.add(0, "heroku");

src/main/resources/default-project.toml

@@ -0,0 +1,8 @@
+[_]
+schema-version = "0.2"
+
+[[io.buildpacks.group]]
+id = "heroku/jvm"
+
+[[io.buildpacks.group]]
+id = "heroku/procfile"