build: Migrate to flat project structure

This change updates the project structure to become flattened.
Previously, the simulator, frontend and API each lived into their own
directory.

With this change, all modules of the project live in the top-level
directory of the repository. This should improve discoverability of
modules of the project.

6 files changed, 333 insertions, 0 deletions

diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/internal/CompositeDiscovery.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/CompositeDiscovery.kt
new file mode 100644
index 00000000..67a895e4
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/CompositeDiscovery.kt
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2021 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.harness.internal
+
+import kotlinx.coroutines.FlowPreview
+import kotlinx.coroutines.flow.*
+import org.opendc.harness.api.ExperimentDefinition
+import org.opendc.harness.engine.discovery.Discovery
+import org.opendc.harness.engine.discovery.DiscoveryProvider
+import org.opendc.harness.engine.discovery.DiscoveryRequest
+
+/**
+ * A composite [Discovery] instance that combines the results of multiple delegate instances.
+ */
+internal class CompositeDiscovery(providers: Iterable<DiscoveryProvider>) : Discovery {
+    /**
+     * The [Discovery] instances to delegate to.
+     */
+    private val delegates = providers.map { it.create() }
+
+    @OptIn(FlowPreview::class)
+    override fun discover(request: DiscoveryRequest): Flow<ExperimentDefinition> {
+        return delegates.asFlow()
+            .map { it.discover(request) }
+            .flattenMerge(delegates.size)
+    }
+}
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/internal/CompositeExperimentExecutionListener.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/CompositeExperimentExecutionListener.kt
new file mode 100644
index 00000000..a3cd6bd2
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/CompositeExperimentExecutionListener.kt
@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2021 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.harness.internal
+
+import org.opendc.harness.api.ExperimentDefinition
+import org.opendc.harness.api.Scenario
+import org.opendc.harness.api.Trial
+import org.opendc.harness.engine.ExperimentExecutionListener
+
+/**
+ * An [ExperimentExecutionListener] that composes multiple other listeners.
+ */
+public class CompositeExperimentExecutionListener(private val listeners: List<ExperimentExecutionListener>) : ExperimentExecutionListener {
+    override fun experimentStarted(experiment: ExperimentDefinition) {
+        listeners.forEach { it.experimentStarted(experiment) }
+    }
+
+    override fun experimentFinished(experiment: ExperimentDefinition, throwable: Throwable?) {
+        listeners.forEach { it.experimentFinished(experiment, throwable) }
+    }
+
+    override fun scenarioStarted(scenario: Scenario) {
+        listeners.forEach { it.scenarioStarted(scenario) }
+    }
+
+    override fun scenarioFinished(scenario: Scenario, throwable: Throwable?) {
+        listeners.forEach { it.scenarioFinished(scenario, throwable) }
+    }
+
+    override fun trialStarted(trial: Trial) {
+        listeners.forEach { it.trialStarted(trial) }
+    }
+
+    override fun trialFinished(trial: Trial, throwable: Throwable?) {
+        listeners.forEach { it.trialFinished(trial, throwable) }
+    }
+}
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/internal/DslDiscovery.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/DslDiscovery.kt
new file mode 100644
index 00000000..eb6303d6
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/DslDiscovery.kt
@@ -0,0 +1,101 @@
+/*
+ * Copyright (c) 2021 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.harness.internal
+
+import io.github.classgraph.ClassGraph
+import io.github.classgraph.ScanResult
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.asFlow
+import org.opendc.harness.api.ExperimentDefinition
+import org.opendc.harness.dsl.Experiment
+import org.opendc.harness.engine.discovery.Discovery
+import org.opendc.harness.engine.discovery.DiscoveryFilter
+import org.opendc.harness.engine.discovery.DiscoveryRequest
+import org.opendc.harness.engine.discovery.DiscoverySelector
+
+/**
+ * A [Discovery] implementation that discovers [Experiment] instances on the classpath.
+ */
+internal class DslDiscovery : Discovery {
+    /*
+     * Lazily memoize the results of the classpath scan.
+     */
+    private val scanResult by lazy { scan() }
+
+    override fun discover(request: DiscoveryRequest): Flow<ExperimentDefinition> {
+        return findExperiments()
+            .map { cls ->
+                val exp = cls.constructors[0].newInstance() as Experiment
+                exp.toDefinition()
+            }
+            .filter(select(request.selectors))
+            .filter(filter(request.filters))
+            .asFlow()
+    }
+
+    /**
+     * Find the classes on the classpath implementing the [Experiment] class.
+     */
+    private fun findExperiments(): Sequence<Class<out Experiment>> {
+        return scanResult
+            .getSubclasses(Experiment::class.java.name)
+            .filter { !(it.isAbstract || it.isInterface) }
+            .map { it.loadClass() }
+            .filterIsInstance<Class<out Experiment>>()
+            .asSequence()
+    }
+
+    /**
+     * Create a predicate for filtering the experiments based on the specified [filters].
+     */
+    private fun filter(filters: List<DiscoveryFilter>): (ExperimentDefinition) -> Boolean = { def ->
+        filters.isEmpty() || filters.all { it.test(def) }
+    }
+
+    /**
+     * Create a predicate for selecting the experiments based on the specified [selectors].
+     */
+    private fun select(selectors: List<DiscoverySelector>): (ExperimentDefinition) -> Boolean = { def ->
+        selectors.isEmpty() || selectors.any { it.test(def) }
+    }
+
+    /**
+     * Scan the classpath using [ClassGraph].
+     */
+    private fun scan(): ScanResult {
+        return ClassGraph()
+            .enableClassInfo()
+            .enableExternalClasses()
+            .ignoreClassVisibility()
+            .rejectPackages(
+                "java.*",
+                "javax.*",
+                "sun.*",
+                "com.sun.*",
+                "kotlin.*",
+                "androidx.*",
+                "org.jetbrains.kotlin.*",
+                "org.junit.*"
+            ).scan()
+    }
+}
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/internal/DslDiscoveryProvider.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/DslDiscoveryProvider.kt
new file mode 100644
index 00000000..752ba4bb
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/DslDiscoveryProvider.kt
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2021 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.harness.internal
+
+import org.opendc.harness.dsl.Experiment
+import org.opendc.harness.engine.discovery.Discovery
+import org.opendc.harness.engine.discovery.DiscoveryProvider
+
+/**
+ * A [DiscoveryProvider] for the [Experiment]s on the classpath.
+ */
+public class DslDiscoveryProvider : DiscoveryProvider {
+    override val id: String = "dsl"
+
+    override fun create(): Discovery = DslDiscovery()
+}
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/internal/ParameterDelegate.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/ParameterDelegate.kt
new file mode 100644
index 00000000..aaf90b99
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/ParameterDelegate.kt
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2021 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.harness.internal
+
+import org.opendc.harness.api.Parameter
+import org.opendc.harness.dsl.Experiment
+import kotlin.properties.ReadOnlyProperty
+import kotlin.reflect.KProperty
+
+/**
+ * A delegate for an experiment parameter.
+ *
+ * @property parameter The parameter descriptor of this delegate.
+ */
+internal class ParameterDelegate<T>(val parameter: Parameter<T>) : ReadOnlyProperty<Experiment, T> {
+    /**
+     * Obtain the value for the parameter.
+     */
+    override fun getValue(thisRef: Experiment, property: KProperty<*>): T {
+        val scenario = thisRef.scenario ?: throw IllegalStateException("Cannot use parameters before activation")
+        return scenario[parameter]
+    }
+}
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/internal/ScenarioImpl.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/ScenarioImpl.kt
new file mode 100644
index 00000000..d255004d
--- /dev/null
+++ b/opendc-harness/src/main/kotlin/org/opendc/harness/internal/ScenarioImpl.kt
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2021 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.harness.internal
+
+import org.opendc.harness.api.ExperimentDefinition
+import org.opendc.harness.api.Parameter
+import org.opendc.harness.api.Scenario
+
+/**
+ * Internal implementation of a [Scenario].
+ */
+internal data class ScenarioImpl(
+    override val id: Int,
+    override val experiment: ExperimentDefinition,
+    val parameters: Map<Parameter<*>, Any?>
+) : Scenario {
+
+    override fun <T> get(param: Parameter<T>): T {
+        if (!parameters.containsKey(param)) {
+            throw IllegalArgumentException("Unknown parameter for this scenario.")
+        }
+
+        // This cast should always succeed
+        @Suppress("UNCHECKED_CAST")
+        return parameters[param] as T
+    }
+
+    override fun toString(): String = "Scenario"
+}