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.

3 files changed, 179 insertions, 0 deletions

diff --git a/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerBuildItem.java b/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerBuildItem.java
new file mode 100644
index 00000000..3be15ee3
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerBuildItem.java
@@ -0,0 +1,42 @@
+/*
+ * 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.deployment;
+
+import io.quarkus.builder.item.SimpleBuildItem;
+import io.quarkus.runtime.RuntimeValue;
+import org.opendc.web.runner.OpenDCRunner;
+
+/**
+ * A {@link SimpleBuildItem} that produces an {@link OpenDCRunner} instance.
+ */
+public final class OpenDCRunnerBuildItem extends SimpleBuildItem {
+    private final RuntimeValue<OpenDCRunner> runner;
+
+    public OpenDCRunnerBuildItem(RuntimeValue<OpenDCRunner> runner) {
+        this.runner = runner;
+    }
+
+    public RuntimeValue<OpenDCRunner> getRunner() {
+        return runner;
+    }
+}
diff --git a/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerConfig.java b/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerConfig.java
new file mode 100644
index 00000000..ccbc5e19
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerConfig.java
@@ -0,0 +1,38 @@
+/*
+ * 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.deployment;
+
+import io.quarkus.runtime.annotations.ConfigItem;
+import io.quarkus.runtime.annotations.ConfigRoot;
+
+/**
+ * Build-time configuration for the OpenDC web runner extension.
+ */
+@ConfigRoot(name = "opendc-runner")
+public class OpenDCRunnerConfig {
+    /**
+     * A flag to include the OpenDC web runner extension into the build.
+     */
+    @ConfigItem(defaultValue = "true")
+    boolean include;
+}
diff --git a/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerProcessor.java b/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerProcessor.java
new file mode 100644
index 00000000..b9a334ac
--- /dev/null
+++ b/opendc-web/opendc-web-runner-quarkus-deployment/src/main/java/org/opendc/web/runner/deployment/OpenDCRunnerProcessor.java
@@ -0,0 +1,99 @@
+/*
+ * 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.deployment;
+
+import io.quarkus.deployment.annotations.BuildProducer;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.annotations.Record;
+import io.quarkus.deployment.builditem.*;
+import io.quarkus.runtime.RuntimeValue;
+import org.opendc.web.runner.OpenDCRunner;
+import org.opendc.web.runner.runtime.OpenDCRunnerRecorder;
+import org.opendc.web.runner.runtime.OpenDCRunnerRuntimeConfig;
+
+import java.util.function.BooleanSupplier;
+
+import static io.quarkus.deployment.annotations.ExecutionTime.RUNTIME_INIT;
+
+/**
+ * Build processor for the OpenDC web runner Quarkus extension.
+ */
+public class OpenDCRunnerProcessor {
+
+    private static final String FEATURE = "opendc-runner";
+
+    /**
+     * Provide the {@link FeatureBuildItem} for this Quarkus extension.
+     */
+    @BuildStep(onlyIf = IsIncluded.class)
+    public FeatureBuildItem feature() {
+        return new FeatureBuildItem(FEATURE);
+    }
+
+    /**
+     * Build step to index the necessary dependencies for the OpenDC runner.
+     */
+    @BuildStep
+    void addDependencies(BuildProducer<IndexDependencyBuildItem> indexDependency) {
+        indexDependency.produce(new IndexDependencyBuildItem("org.opendc.trace", "opendc-trace-opendc"));
+        indexDependency.produce(new IndexDependencyBuildItem("org.opendc.trace", "opendc-trace-bitbrains"));
+    }
+
+    /**
+     * Build step to create the runner service.
+     */
+    @BuildStep(onlyIf = IsIncluded.class)
+    @Record(RUNTIME_INIT)
+    ServiceStartBuildItem createRunnerService(OpenDCRunnerRecorder recorder,
+                                              OpenDCRunnerRuntimeConfig config,
+                                              BuildProducer<OpenDCRunnerBuildItem> runnerBuildItem) {
+        RuntimeValue<OpenDCRunner> runner = recorder.createRunner(config);
+        runnerBuildItem.produce(new OpenDCRunnerBuildItem(runner));
+        return new ServiceStartBuildItem("OpenDCRunnerService");
+    }
+
+    /**
+     * Build step to start the runner service.
+     */
+    @BuildStep(onlyIf = IsIncluded.class)
+    @Record(RUNTIME_INIT)
+    void startRunnerService(ApplicationStartBuildItem start,
+                            OpenDCRunnerBuildItem runnerBuildItem,
+                            OpenDCRunnerRecorder recorder,
+                            OpenDCRunnerRuntimeConfig config,
+                            ShutdownContextBuildItem shutdownContextBuildItem) {
+        recorder.startRunner(runnerBuildItem.getRunner(), config,shutdownContextBuildItem);
+    }
+
+    /**
+     * A {@link BooleanSupplier} to determine if the OpenDC web runner extension should be included.
+     */
+    private static class IsIncluded implements BooleanSupplier {
+        OpenDCRunnerConfig config;
+
+        @Override
+        public boolean getAsBoolean() {
+            return config.include;
+        }
+    }
+}