Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds -H:+GenerateBuildArtifactsFile, copies .so from remote container #41201

Merged
merged 3 commits into from
Jul 10, 2024
Merged

Adds -H:+GenerateBuildArtifactsFile, copies .so from remote container #41201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b8248f
Adds -H:+GenerateBuildArtifactsFile, copies .so from remote container
Karm Jun 14, 2024
59b63bb
Test Lambda and remote container packaging
Karm Jun 14, 2024
3150791
Enables awt-packaging on GHA
Karm Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/native-tests.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,9 @@
"os-name": "ubuntu-latest"
},
{
"category": "AWT, ImageIO and Java2D",
"timeout": 30,
"test-modules": "awt, no-awt",
"category": "AWT, ImageIO and Java2D, Packaging .so files",
"timeout": 40,
"test-modules": "awt, no-awt, awt-packaging",
"os-name": "ubuntu-latest"
}
]
Expand Down
71 changes: 56 additions & 15 deletions .../src/main/java/io/quarkus/deployment/pkg/steps/NativeImageBuildRemoteContainerRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,19 @@
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.jboss.logging.Logger;

import io.quarkus.builder.JsonReader;
import io.quarkus.builder.json.JsonArray;
import io.quarkus.builder.json.JsonObject;
import io.quarkus.builder.json.JsonString;
import io.quarkus.builder.json.JsonValue;
import io.quarkus.deployment.pkg.NativeConfig;

public class NativeImageBuildRemoteContainerRunner extends NativeImageBuildContainerRunner {
Expand All @@ -34,59 +40,94 @@ protected void preBuild(Path outputDir, List<String> buildArgs) throws Interrupt
final List<String> containerRuntimeArgs = Arrays.asList("-v",
CONTAINER_BUILD_VOLUME_NAME + ":" + NativeImageBuildStep.CONTAINER_BUILD_VOLUME_PATH);
final String[] createTempContainerCommand = buildCommand("create", containerRuntimeArgs, Collections.emptyList());
containerId = runCommandAndReadOutput(createTempContainerCommand, "Failed to create temp container.");
try {
containerId = runCommandAndReadOutput(createTempContainerCommand).get(0);
} catch (RuntimeException | InterruptedException | IOException e) {
throw new RuntimeException("Failed to create temp container.", e);
}
// docker cp <files> <containerID>:/project
String[] copyCommand = new String[] { containerRuntime.getExecutableName(), "cp", outputDir.toAbsolutePath() + "/.",
final String[] copyCommand = new String[] {
containerRuntime.getExecutableName(), "cp", outputDir.toAbsolutePath() + "/.",
containerId + ":" + NativeImageBuildStep.CONTAINER_BUILD_VOLUME_PATH };
runCommand(copyCommand, "Failed to copy source-jar and libs from host to builder container", null);
runCommand(copyCommand, "Failed to copy source-jar and libs from host to builder container");
super.preBuild(outputDir, buildArgs);
}

private String runCommandAndReadOutput(String[] command, String errorMsg) throws IOException, InterruptedException {
private List<String> runCommandAndReadOutput(String[] command) throws IOException, InterruptedException {
log.info(String.join(" ", command).replace("$", "\\$"));
Process process = new ProcessBuilder(command).start();
final Process process = new ProcessBuilder(command).start();
if (process.waitFor() != 0) {
throw new RuntimeException(errorMsg);
throw new RuntimeException("Command failed: " + String.join(" ", command));
}
try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))) {
return reader.readLine();
return reader.lines().toList();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the motivation behind this change? I understand that it's more generic this way but since we only use the method in a single place where this is not needed it seems to unnecessarily (for the time being) complicate things.

Copy link
Member Author

@Karm Karm Jun 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zakkak I used that to read the output of exec for find to list the .so files in the started container. Then I abandoned that approach in favor of using the -H:+GenerateBuildArtifactsFile. So strictly speaking, we can leave in the thing that returns only the first line of output, however confusing that might be. Would rename the method though then, to ...readOneLineOutput...

}
}

@Override
protected void postBuild(Path outputDir, String nativeImageName, String resultingExecutableName) {
copyFromContainerVolume(outputDir, resultingExecutableName,
"Failed to copy native image from container volume back to the host.");

// Note that podman cp does not support globbing i.e. cp /project/*.so will not work.
// Why only .so? How about .dynlib and .lib? Regardless of the host platform,
// the builder container is always Linux. So, we only need to copy .so files.
//
// We could either start the container again, exec `find' or `ls' to list the .so files,
// stop the container again and use that list. We could also use the build-artifacts.json
// to get the list of artifacts straight away which is what ended up doing here:
copyFromContainerVolume(outputDir, "build-artifacts.json", null);
try {
final Path buildArtifactsFile = outputDir.resolve("build-artifacts.json");
if (Files.exists(buildArtifactsFile)) {
// The file is small enough to afford this read
final String buildArtifactsJson = Files.readString(buildArtifactsFile);
final JsonObject jsonRead = JsonReader.of(buildArtifactsJson).read();
final JsonValue jdkLibraries = jsonRead.get("jdk_libraries");
// The jdk_libraries field is optional, there might not be any.
if (jdkLibraries instanceof JsonArray) {
for (JsonValue lib : ((JsonArray) jdkLibraries).value()) {
copyFromContainerVolume(outputDir, ((JsonString) lib).value(),
"Failed to copy " + lib + " from container volume back to the host.");
}
}
}
} catch (IOException e) {
log.errorf(e, "Failed to list .so files in the build-artifacts.json. Skipping the step.");
}

if (nativeConfig.debug().enabled()) {
copyFromContainerVolume(outputDir, "sources", "Failed to copy sources from container volume back to the host.");
String symbols = String.format("%s.debug", nativeImageName);
copyFromContainerVolume(outputDir, symbols, "Failed to copy debug symbols from container volume back to the host.");
copyFromContainerVolume(outputDir, "sources",
"Failed to copy sources from container volume back to the host.");
final String symbols = String.format("%s.debug", nativeImageName);
copyFromContainerVolume(outputDir, symbols,
"Failed to copy debug symbols from container volume back to the host.");
Comment on lines -61 to +104
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these changes necessary?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes are not necessary to fix the issue.

}
// docker container rm <containerID>
final String[] rmTempContainerCommand = new String[] { containerRuntime.getExecutableName(), "container", "rm",
containerId };
runCommand(rmTempContainerCommand, "Failed to remove container: " + containerId, null);
runCommand(rmTempContainerCommand, "Failed to remove container: " + containerId);
// docker volume rm <volumeID>
rmVolume("Failed to remove volume: " + CONTAINER_BUILD_VOLUME_NAME);
}

private void rmVolume(String errorMsg) {
final String[] rmVolumeCommand = new String[] { containerRuntime.getExecutableName(), "volume", "rm",
CONTAINER_BUILD_VOLUME_NAME };
runCommand(rmVolumeCommand, errorMsg, null);
runCommand(rmVolumeCommand, errorMsg);
}

private void copyFromContainerVolume(Path outputDir, String path, String errorMsg) {
// docker cp <containerID>:/project/<path> <dest>
String[] copyCommand = new String[] { containerRuntime.getExecutableName(), "cp",
final String[] copyCommand = new String[] { containerRuntime.getExecutableName(), "cp",
containerId + ":" + NativeImageBuildStep.CONTAINER_BUILD_VOLUME_PATH + "/" + path,
outputDir.toAbsolutePath().toString() };
runCommand(copyCommand, errorMsg, null);
runCommand(copyCommand, errorMsg);
}

@Override
protected List<String> getContainerRuntimeBuildArgs(Path outputDir) {
List<String> containerRuntimeArgs = super.getContainerRuntimeBuildArgs(outputDir);
final List<String> containerRuntimeArgs = super.getContainerRuntimeBuildArgs(outputDir);
Collections.addAll(containerRuntimeArgs, "-v",
CONTAINER_BUILD_VOLUME_NAME + ":" + NativeImageBuildStep.CONTAINER_BUILD_VOLUME_PATH);
return containerRuntimeArgs;
Expand Down
25 changes: 21 additions & 4 deletions core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/NativeImageBuildRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.stream.Collectors;

import org.apache.commons.lang3.SystemUtils;
import org.jboss.logging.Logger;
Expand Down Expand Up @@ -132,22 +133,28 @@ static void runCommand(String[] command, String errorMsg, File workingDirectory)
log.info(String.join(" ", command).replace("$", "\\$"));
Process process = null;
try {
final ProcessBuilder processBuilder = new ProcessBuilder(command);
final ProcessBuilder processBuilder = new ProcessBuilder(command)
.redirectErrorStream(true);
if (workingDirectory != null) {
processBuilder.directory(workingDirectory);
}
process = processBuilder.start();
final int exitCode = process.waitFor();
if (exitCode != 0) {
final String out;
try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))) {
out = reader.lines().collect(Collectors.joining("\n"));
}
if (errorMsg != null) {
log.error(errorMsg);
log.error(errorMsg + " Output: " + out);
} else {
log.debugf("Command: " + String.join(" ", command) + " failed with exit code " + exitCode);
log.debugf(
"Command: " + String.join(" ", command) + " failed with exit code " + exitCode + " Output: " + out);
}
}
} catch (IOException | InterruptedException e) {
if (errorMsg != null) {
log.error(errorMsg);
log.errorf(e, errorMsg);
} else {
log.debugf(e, "Command: " + String.join(" ", command) + " failed.");
}
Expand All @@ -158,6 +165,16 @@ static void runCommand(String[] command, String errorMsg, File workingDirectory)
}
}

/**
* Run {@code command} and log error if {@code errorMsg} is not null.
*
* @param command
* @param errorMsg
*/
static void runCommand(String[] command, String errorMsg) {
runCommand(command, errorMsg, null);
}

static class Result {
private final int exitCode;

Expand Down
5 changes: 5 additions & 0 deletions core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/NativeImageBuildStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,6 +815,11 @@ public NativeImageInvokerInfo build() {
"-H:BuildOutputJSONFile=" + nativeImageName + "-build-output-stats.json");
}

// only available in GraalVM 23.0+, we want a file with the list of built artifacts
if (graalVMVersion.compareTo(GraalVM.Version.VERSION_23_0_0) >= 0) {
addExperimentalVMOption(nativeImageArgs, "-H:+GenerateBuildArtifactsFile");
}

// only available in GraalVM 23.1.0+
if (graalVMVersion.compareTo(GraalVM.Version.VERSION_23_1_0) >= 0) {
if (graalVMVersion.compareTo(GraalVM.Version.VERSION_24_0_0) < 0) {
Expand Down
125 changes: 125 additions & 0 deletions integration-tests/awt-packaging/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>quarkus-integration-tests-parent</artifactId>
<groupId>io.quarkus</groupId>
<version>999-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

<artifactId>quarkus-integration-test-awt-packaging</artifactId>
<name>Quarkus - Integration Tests - AWT Packaging</name>

<dependencies>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy-jaxb</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-awt</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-amazon-lambda</artifactId>
</dependency>

<!-- test dependencies -->
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-junit5-mockito</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>rest-assured</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-test-amazon-lambda</artifactId>
<scope>test</scope>
</dependency>

<!-- Minimal test dependencies to *-deployment artifacts for consistent build order -->
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy-deployment</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy-jaxb-deployment</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-awt-deployment</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-amazon-lambda-deployment</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>build</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
36 changes: 36 additions & 0 deletions integration-tests/awt-packaging/src/main/java/io/quarkus/it/jaxb/Book.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package io.quarkus.it.jaxb;

import java.awt.Image;

import jakarta.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Book {

private String title;
private Image cover;

public Book() {
}

public Book(String title, Image cover) {
this.title = title;
this.cover = cover;
}

public String getTitle() {
return title;
}

public void setTitle(String title) {
this.title = title;
}

public Image getCover() {
return cover;
}

public void setCover(Image cover) {
this.cover = cover;
}
}
Loading
Loading