Scenario and Portfolio update (#209)

* Initial commit

* Implemented a new systems of defining and running scenarios / portfolios. Scenarios and Portfolios can now be defined using JSON files similar to topologies. This allows user to define experiments without changing any KotLin code.

* Ran spotlessApply

7 files changed, 0 insertions, 495 deletions

diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/kotlin/org/opendc/experiments/capelin/CapelinIntegrationTest.kt b/opendc-experiments/opendc-experiments-capelin/src/test/kotlin/org/opendc/experiments/capelin/CapelinIntegrationTest.kt
deleted file mode 100644
index 9a00c80e..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/kotlin/org/opendc/experiments/capelin/CapelinIntegrationTest.kt
+++ /dev/null
@@ -1,295 +0,0 @@
-/*
- * Copyright (c) 2020 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.experiments.capelin
-
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.BeforeEach
-import org.junit.jupiter.api.Test
-import org.junit.jupiter.api.assertAll
-import org.opendc.compute.service.ComputeService
-import org.opendc.compute.service.scheduler.FilterScheduler
-import org.opendc.compute.service.scheduler.filters.ComputeFilter
-import org.opendc.compute.service.scheduler.filters.RamFilter
-import org.opendc.compute.service.scheduler.filters.VCpuFilter
-import org.opendc.compute.service.scheduler.weights.CoreRamWeigher
-import org.opendc.compute.simulator.failure.grid5000
-import org.opendc.compute.simulator.provisioner.Provisioner
-import org.opendc.compute.simulator.provisioner.registerComputeMonitor
-import org.opendc.compute.simulator.provisioner.setupComputeService
-import org.opendc.compute.simulator.provisioner.setupHosts
-import org.opendc.compute.telemetry.ComputeMonitor
-import org.opendc.compute.telemetry.table.HostTableReader
-import org.opendc.compute.telemetry.table.ServiceTableReader
-import org.opendc.compute.topology.clusterTopology
-import org.opendc.compute.topology.specs.HostSpec
-import org.opendc.compute.workload.ComputeWorkloadLoader
-import org.opendc.compute.workload.VirtualMachine
-import org.opendc.compute.workload.sampleByLoad
-import org.opendc.compute.workload.trace
-import org.opendc.experiments.base.runner.replay
-import org.opendc.simulator.kotlin.runSimulation
-import java.io.File
-import java.time.Duration
-import java.util.Random
-
-/**
- * An integration test suite for the Capelin experiments.
- */
-class CapelinIntegrationTest {
-    /**
-     * The monitor used to keep track of the metrics.
-     */
-    private lateinit var monitor: TestComputeMonitor
-
-    /**
-     * The [FilterScheduler] to use for all experiments.
-     */
-    private lateinit var computeScheduler: FilterScheduler
-
-    /**
-     * The [ComputeWorkloadLoader] responsible for loading the traces.
-     */
-    private lateinit var workloadLoader: ComputeWorkloadLoader
-
-    /**
-     * Set up the experimental environment.
-     */
-    @BeforeEach
-    fun setUp() {
-        monitor = TestComputeMonitor()
-        computeScheduler =
-            FilterScheduler(
-                filters = listOf(ComputeFilter(), VCpuFilter(16.0), RamFilter(1.0)),
-                weighers = listOf(CoreRamWeigher(multiplier = 1.0)),
-            )
-        workloadLoader = ComputeWorkloadLoader(File("src/test/resources/trace"))
-    }
-
-    /**
-     * Test a large simulation setup.
-     */
-    @Test
-    fun testLarge() =
-        runSimulation {
-            val seed = 0L
-            val workload = createTestWorkload(1.0, seed)
-            val topology = createTopology()
-            val monitor = monitor
-
-            Provisioner(dispatcher, seed).use { provisioner ->
-                provisioner.runSteps(
-                    setupComputeService(serviceDomain = "compute.opendc.org", { computeScheduler }),
-                    registerComputeMonitor(serviceDomain = "compute.opendc.org", monitor),
-                    setupHosts(serviceDomain = "compute.opendc.org", topology),
-                )
-
-                val service = provisioner.registry.resolve("compute.opendc.org", ComputeService::class.java)!!
-                service.replay(timeSource, workload, seed)
-            }
-
-            println(
-                "Scheduler " +
-                    "Success=${monitor.attemptsSuccess} " +
-                    "Failure=${monitor.attemptsFailure} " +
-                    "Error=${monitor.attemptsError} " +
-                    "Pending=${monitor.serversPending} " +
-                    "Active=${monitor.serversActive}",
-            )
-
-            // Note that these values have been verified beforehand
-            assertAll(
-                { assertEquals(50, monitor.attemptsSuccess, "The scheduler should schedule 50 VMs") },
-                { assertEquals(0, monitor.serversActive, "All VMs should finish after a run") },
-                { assertEquals(0, monitor.attemptsFailure, "No VM should be unscheduled") },
-                { assertEquals(0, monitor.serversPending, "No VM should not be in the queue") },
-                { assertEquals(223379991650, monitor.idleTime) { "Incorrect idle time" } },
-                { assertEquals(66977091124, monitor.activeTime) { "Incorrect active time" } },
-                { assertEquals(3160267873, monitor.stealTime) { "Incorrect steal time" } },
-                { assertEquals(0, monitor.lostTime) { "Incorrect lost time" } },
-                { assertEquals(7.767237E9, monitor.energyUsage, 1E4) { "Incorrect power draw" } },
-            )
-        }
-
-    /**
-     * Test a small simulation setup.
-     */
-    @Test
-    fun testSmall() =
-        runSimulation {
-            val seed = 1L
-            val workload = createTestWorkload(0.25, seed)
-            val topology = createTopology("single.json")
-            val monitor = monitor
-
-            Provisioner(dispatcher, seed).use { provisioner ->
-                provisioner.runSteps(
-                    setupComputeService(serviceDomain = "compute.opendc.org", { computeScheduler }),
-                    registerComputeMonitor(serviceDomain = "compute.opendc.org", monitor),
-                    setupHosts(serviceDomain = "compute.opendc.org", topology),
-                )
-
-                val service = provisioner.registry.resolve("compute.opendc.org", ComputeService::class.java)!!
-                service.replay(timeSource, workload, seed)
-            }
-
-            println(
-                "Scheduler " +
-                    "Success=${monitor.attemptsSuccess} " +
-                    "Failure=${monitor.attemptsFailure} " +
-                    "Error=${monitor.attemptsError} " +
-                    "Pending=${monitor.serversPending} " +
-                    "Active=${monitor.serversActive}",
-            )
-
-            // Note that these values have been verified beforehand
-            assertAll(
-                { assertEquals(10996730092, monitor.idleTime) { "Idle time incorrect" } },
-                { assertEquals(9741285381, monitor.activeTime) { "Active time incorrect" } },
-                { assertEquals(152, monitor.stealTime) { "Steal time incorrect" } },
-                { assertEquals(0, monitor.lostTime) { "Lost time incorrect" } },
-                { assertEquals(7.933686E8, monitor.energyUsage, 1E4) { "Incorrect power draw" } },
-            )
-        }
-
-    /**
-     * Test a small simulation setup with interference.
-     */
-    @Test
-    fun testInterference() =
-        runSimulation {
-            val seed = 0L
-            val workload = createTestWorkload(1.0, seed)
-            val topology = createTopology("single.json")
-
-            Provisioner(dispatcher, seed).use { provisioner ->
-                provisioner.runSteps(
-                    setupComputeService(serviceDomain = "compute.opendc.org", { computeScheduler }),
-                    registerComputeMonitor(serviceDomain = "compute.opendc.org", monitor),
-                    setupHosts(serviceDomain = "compute.opendc.org", topology),
-                )
-
-                val service = provisioner.registry.resolve("compute.opendc.org", ComputeService::class.java)!!
-                service.replay(timeSource, workload, seed, interference = true)
-            }
-
-            println(
-                "Scheduler " +
-                    "Success=${monitor.attemptsSuccess} " +
-                    "Failure=${monitor.attemptsFailure} " +
-                    "Error=${monitor.attemptsError} " +
-                    "Pending=${monitor.serversPending} " +
-                    "Active=${monitor.serversActive}",
-            )
-
-            // Note that these values have been verified beforehand
-            assertAll(
-                { assertEquals(42814948316, monitor.idleTime) { "Idle time incorrect" } },
-                { assertEquals(40138266225, monitor.activeTime) { "Active time incorrect" } },
-                { assertEquals(23489356981, monitor.stealTime) { "Steal time incorrect" } },
-                { assertEquals(424267131, monitor.lostTime) { "Lost time incorrect" } },
-            )
-        }
-
-    /**
-     * Test a small simulation setup with failures.
-     */
-    @Test
-    fun testFailures() =
-        runSimulation {
-            val seed = 0L
-            val topology = createTopology("single.json")
-            val workload = createTestWorkload(0.25, seed)
-            val monitor = monitor
-
-            Provisioner(dispatcher, seed).use { provisioner ->
-                provisioner.runSteps(
-                    setupComputeService(serviceDomain = "compute.opendc.org", { computeScheduler }),
-                    registerComputeMonitor(serviceDomain = "compute.opendc.org", monitor),
-                    setupHosts(serviceDomain = "compute.opendc.org", topology),
-                )
-
-                val service = provisioner.registry.resolve("compute.opendc.org", ComputeService::class.java)!!
-                service.replay(timeSource, workload, seed, failureModel = grid5000(Duration.ofDays(7)))
-            }
-
-            // Note that these values have been verified beforehand
-            assertAll(
-                { assertEquals(1404277711, monitor.idleTime) { "Idle time incorrect" } },
-                { assertEquals(1478675712, monitor.activeTime) { "Active time incorrect" } },
-                { assertEquals(152, monitor.stealTime) { "Steal time incorrect" } },
-                { assertEquals(0, monitor.lostTime) { "Lost time incorrect" } },
-                { assertEquals(360369187, monitor.uptime) { "Uptime incorrect" } },
-            )
-        }
-
-    /**
-     * Obtain the trace reader for the test.
-     */
-    private fun createTestWorkload(
-        fraction: Double,
-        seed: Long,
-    ): List<VirtualMachine> {
-        val source = trace("bitbrains-small").sampleByLoad(fraction)
-        return source.resolve(workloadLoader, Random(seed))
-    }
-
-    /**
-     * Obtain the topology factory for the test.
-     */
-    private fun createTopology(name: String = "topology.json"): List<HostSpec> {
-        val stream = checkNotNull(object {}.javaClass.getResourceAsStream("/env/$name"))
-        return stream.use { clusterTopology(stream) }
-    }
-
-    class TestComputeMonitor : ComputeMonitor {
-        var attemptsSuccess = 0
-        var attemptsFailure = 0
-        var attemptsError = 0
-        var serversPending = 0
-        var serversActive = 0
-
-        override fun record(reader: ServiceTableReader) {
-            attemptsSuccess = reader.attemptsSuccess
-            attemptsFailure = reader.attemptsFailure
-            attemptsError = reader.attemptsError
-            serversPending = reader.serversPending
-            serversActive = reader.serversActive
-        }
-
-        var idleTime = 0L
-        var activeTime = 0L
-        var stealTime = 0L
-        var lostTime = 0L
-        var energyUsage = 0.0
-        var uptime = 0L
-
-        override fun record(reader: HostTableReader) {
-            idleTime += reader.cpuIdleTime
-            activeTime += reader.cpuActiveTime
-            stealTime += reader.cpuStealTime
-            lostTime += reader.cpuLostTime
-            energyUsage += reader.energyUsage
-            uptime += reader.uptime
-        }
-    }
-}
diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/kotlin/org/opendc/experiments/capelin/CapelinRunnerTest.kt b/opendc-experiments/opendc-experiments-capelin/src/test/kotlin/org/opendc/experiments/capelin/CapelinRunnerTest.kt
deleted file mode 100644
index 4587f6dc..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/kotlin/org/opendc/experiments/capelin/CapelinRunnerTest.kt
+++ /dev/null
@@ -1,87 +0,0 @@
-/*
- * 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.experiments.capelin
-
-import org.junit.jupiter.api.assertDoesNotThrow
-import org.opendc.compute.workload.trace
-import org.opendc.experiments.base.portfolio.model.OperationalPhenomena
-import org.opendc.experiments.base.portfolio.model.Scenario
-import org.opendc.experiments.base.portfolio.model.Topology
-import org.opendc.experiments.base.portfolio.model.Workload
-import java.io.File
-import java.nio.file.Files
-
-/**
- * Test suite for [CapelinRunner].
- */
-class CapelinRunnerTest {
-    /**
-     * The path to the environments.
-     */
-    private val envPath = File("src/test/resources/env")
-
-    /**
-     * The path to the traces.
-     */
-    private val tracePath = File("src/test/resources/trace")
-
-    /**
-     * Smoke test with output.
-     * fixme: Fix failures and enable
-     */
-    fun testSmoke() {
-        val outputPath = Files.createTempDirectory("output").toFile()
-
-        try {
-            val runner = CapelinRunner(envPath, tracePath, outputPath)
-            val scenario =
-                Scenario(
-                    Topology("topology"),
-                    Workload("bitbrains-small", trace("bitbrains-small")),
-                    OperationalPhenomena(failureFrequency = 24.0 * 7, hasInterference = true),
-                    "active-servers",
-                )
-
-            assertDoesNotThrow { runner.runScenario(scenario, seed = 0L) }
-        } finally {
-            outputPath.delete()
-        }
-    }
-
-    /**
-     * Smoke test without output.
-     * fixme: Fix failures and enable
-     */
-    fun testSmokeNoOutput() {
-        val runner = CapelinRunner(envPath, tracePath, null)
-        val scenario =
-            Scenario(
-                Topology("topology"),
-                Workload("bitbrains-small", trace("bitbrains-small")),
-                OperationalPhenomena(failureFrequency = 24.0 * 7, hasInterference = true),
-                "active-servers",
-            )
-
-        assertDoesNotThrow { runner.runScenario(scenario, seed = 0L) }
-    }
-}
diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/resources/env/single.json b/opendc-experiments/opendc-experiments-capelin/src/test/resources/env/single.json
deleted file mode 100644
index a1c8d95a..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/resources/env/single.json
+++ /dev/null
@@ -1,26 +0,0 @@
-{
-    "clusters":
-    [
-        {
-            "name": "C01",
-            "hosts" :
-            [
-                {
-                    "name": "H01",
-                    "cpus":
-                    [
-                        {
-                            "coreCount": 8,
-                            "coreSpeed": 3200
-                        }
-                    ],
-                    "memory": {
-                        "memorySize": 128000
-                    }
-                }
-            ]
-        }
-    ]
-}
-
-
diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/resources/env/topology.json b/opendc-experiments/opendc-experiments-capelin/src/test/resources/env/topology.json
deleted file mode 100644
index 721005b0..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/resources/env/topology.json
+++ /dev/null
@@ -1,66 +0,0 @@
-{
-    "clusters":
-    [
-        {
-            "name": "C01",
-            "hosts" :
-            [
-                {
-                    "name": "H01",
-                    "cpus":
-                    [
-                        {
-                            "coreCount": 32,
-                            "coreSpeed": 3200
-                        }
-                    ],
-                    "memory": {
-                        "memorySize": 256000
-                    }
-                }
-            ]
-        },
-        {
-            "name": "C02",
-            "hosts" :
-            [
-                {
-                    "name": "H02",
-                    "count": 6,
-                    "cpus":
-                    [
-                        {
-                            "coreCount": 8,
-                            "coreSpeed": 2930
-                        }
-                    ],
-                    "memory": {
-                        "memorySize": 64000
-                    }
-                }
-            ]
-        },
-        {
-            "name": "C03",
-            "hosts" :
-            [
-                {
-                    "name": "H03",
-                    "count": 2,
-                    "cpus":
-                    [
-                        {
-                            "coreCount": 16,
-                            "coreSpeed": 3200
-                        }
-                    ],
-                    "memory": {
-                        "memorySize": 128000
-                    }
-                }
-            ]
-        }
-    ]
-}
-
-
diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/interference-model.json b/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/interference-model.json
deleted file mode 100644
index 51fc6366..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/interference-model.json
+++ /dev/null
@@ -1,21 +0,0 @@
-[
-    {
-        "vms": [
-            "141",
-            "379",
-            "851",
-            "116"
-        ],
-        "minServerLoad": 0.0,
-        "performanceScore": 0.8830158730158756
-    },
-    {
-        "vms": [
-            "205",
-            "116",
-            "463"
-        ],
-        "minServerLoad": 0.0,
-        "performanceScore": 0.7133055555552751
-    }
-]
diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/meta.parquet b/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/meta.parquet
deleted file mode 100644
index 9cded35f..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/meta.parquet
+++ /dev/null
diff --git a/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/trace.parquet b/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/trace.parquet
deleted file mode 100644
index 9d953956..00000000
--- a/opendc-experiments/opendc-experiments-capelin/src/test/resources/trace/bitbrains-small/trace.parquet
+++ /dev/null