feat(web/runner): Add Quarkus extension for OpenDC runner

This change adds a Quarkus extension that hosts the OpenDC web runner
for a (potentially local) OpenDC API instance. This functionality
enables a simplified developer experience by allowing users to spawn the
complete OpenDC stack with a single command.

4 files changed, 213 insertions, 0 deletions

diff --git a/opendc-web/opendc-web-runner-quarkus/build.gradle.kts b/opendc-web/opendc-web-runner-quarkus/build.gradle.kts
new file mode 100644
index 00000000..a92e03f2
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus/build.gradle.kts
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2022 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+description = "Quarkus extension for the OpenDC experiment runner"
+
+plugins {
+    `java-library-conventions`
+    id("io.quarkus.extension")
+}
+
+quarkusExtension {
+    deploymentModule = "opendc-web-runner-quarkus-deployment"
+}
+
+dependencies {
+    modules {
+        module("javax.annotation:javax.annotation-api") {
+            replacedBy("jakarta.annotation:jakarta.annotation-api", "javax has been replaced by Jakarta")
+        }
+    }
+
+    api(projects.opendcWeb.opendcWebRunner)
+
+    implementation(platform(libs.quarkus.bom))
+    implementation(libs.quarkus.core.runtime)
+}
+
+evaluationDependsOn(projects.opendcWeb.opendcWebRunnerQuarkusDeployment.dependencyProject.path)
diff --git a/opendc-web/opendc-web-runner-quarkus/src/main/java/org/opendc/web/runner/runtime/OpenDCRunnerRecorder.java b/opendc-web/opendc-web-runner-quarkus/src/main/java/org/opendc/web/runner/runtime/OpenDCRunnerRecorder.java
new file mode 100644
index 00000000..b243dbc3
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus/src/main/java/org/opendc/web/runner/runtime/OpenDCRunnerRecorder.java
@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2022 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.web.runner.runtime;
+
+import io.quarkus.runtime.RuntimeValue;
+import io.quarkus.runtime.ShutdownContext;
+import io.quarkus.runtime.annotations.Recorder;
+import org.jboss.logging.Logger;
+import org.opendc.web.client.runner.OpenDCRunnerClient;
+import org.opendc.web.runner.OpenDCRunner;
+
+import java.io.File;
+import java.net.URI;
+
+/**
+ * Helper class for starting the OpenDC web runner.
+ */
+@Recorder
+public class OpenDCRunnerRecorder {
+    private static final Logger LOGGER = Logger.getLogger(OpenDCRunnerRecorder.class.getName());
+
+    /**
+     * Helper method to create an {@link OpenDCRunner} instance.
+     */
+    public RuntimeValue<OpenDCRunner> createRunner(OpenDCRunnerRuntimeConfig config) {
+        URI apiUrl = URI.create(config.apiUrl);
+        OpenDCRunnerClient client = new OpenDCRunnerClient(apiUrl, null);
+        OpenDCRunner runner = new OpenDCRunner(
+            client,
+            new File(config.tracePath),
+            config.parallelism,
+            config.jobTimeout,
+            config.pollInterval,
+            config.heartbeatInterval
+        );
+
+        return new RuntimeValue<>(runner);
+    }
+
+    /**
+     * Helper method to start the OpenDC runner service.
+     */
+    public void startRunner(RuntimeValue<OpenDCRunner> runner,
+                            OpenDCRunnerRuntimeConfig config,
+                            ShutdownContext shutdownContext) {
+        if (config.enable) {
+            LOGGER.info("Starting OpenDC Runner in background (polling " + config.apiUrl + ")");
+
+            Thread thread = new Thread(() -> {
+                try {
+                    // Wait for some time to allow Vert.x to bind to the local port
+                    Thread.sleep(1000);
+                } catch (InterruptedException e) {
+                    throw new RuntimeException(e);
+                }
+
+                runner.getValue().run();
+            });
+            thread.start();
+
+            shutdownContext.addShutdownTask(thread::interrupt);
+        }
+    }
+}
diff --git a/opendc-web/opendc-web-runner-quarkus/src/main/java/org/opendc/web/runner/runtime/OpenDCRunnerRuntimeConfig.java b/opendc-web/opendc-web-runner-quarkus/src/main/java/org/opendc/web/runner/runtime/OpenDCRunnerRuntimeConfig.java
new file mode 100644
index 00000000..e1dbf0a8
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus/src/main/java/org/opendc/web/runner/runtime/OpenDCRunnerRuntimeConfig.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2022 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.web.runner.runtime;
+
+import io.quarkus.runtime.annotations.ConfigItem;
+import io.quarkus.runtime.annotations.ConfigPhase;
+import io.quarkus.runtime.annotations.ConfigRoot;
+
+import java.time.Duration;
+
+/**
+ * Configuration for the OpenDC web runner.
+ */
+@ConfigRoot(phase = ConfigPhase.RUN_TIME, name = "opendc-runner")
+public class OpenDCRunnerRuntimeConfig {
+    /**
+     * Flag to indicate whether the runner should be enabled.
+     */
+    @ConfigItem(defaultValue = "true")
+    public boolean enable;
+
+    /**
+     * The URI to the (local) API to communicate with.
+     */
+    @ConfigItem(defaultValue = "http://${quarkus.http.host}:${quarkus.http.port}${quarkus.resteasy.path:}")
+    public String apiUrl;
+
+    /**
+     * The path where the workload traces are located.
+     */
+    @ConfigItem(defaultValue = "traces")
+    public String tracePath;
+
+    /**
+     * The number of concurrent simulations
+     */
+    @ConfigItem(defaultValue = "1")
+    public int parallelism;
+
+    /**
+     * The maximum duration of a job.
+     */
+    @ConfigItem(defaultValue = "10m")
+    public Duration jobTimeout;
+
+    /**
+     * The interval between successive polls to the API.
+     */
+    @ConfigItem(defaultValue = "30s")
+    public Duration pollInterval;
+
+    /**
+     * The interval between successive heartbeats to the API.
+     */
+    @ConfigItem(defaultValue = "1m")
+    public Duration heartbeatInterval;
+}
diff --git a/opendc-web/opendc-web-runner-quarkus/src/main/resources/META-INF/quarkus-extension.yaml b/opendc-web/opendc-web-runner-quarkus/src/main/resources/META-INF/quarkus-extension.yaml
new file mode 100644
index 00000000..b93b467a
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus/src/main/resources/META-INF/quarkus-extension.yaml
@@ -0,0 +1,5 @@
+---
+name: "OpenDC Web Runner"
+metadata:
+  status: "preview"
+  unlisted: true