merge: Restructure experiments and remove legacy harness (#82)

This pull request restructures the experiments present in the `opendc-experiments` directory 
and removes the legacy OpenDC Harness. Previously, the experiments were written against
the OpenDC Harness, which facilitates generation and execution of scenarios.

However, the OpenDC Harness does not integrate well into the web-based workflow of OpenDC,
where users should be able to submit scenarios in the web interface and automatically simulate
it in the cloud, since the harness relied on a special Kotlin DSL to specify experiments.

In future pull request, we'll attempt to introduce a similar approach for specifying and
running experiments as we have done for the Radice experiments, where the entire
experiment is described in a serializable (JSON/YAML) format.

## Implementation Notes :hammer_and_pick:

* Add helper tools for FaaS simulations
* Fix infinite loop due to invalid rounding
* Convert experiment into integration test 
* Add independent Capelin distribution 
* Remove OpenDC Harness modules
* Remove unnecessary dependencies 

## Breaking API Changes :warning:

* Removal of the OpenDC Harness modules. Instead, we now package each experiment individually. 
  We'll focus in the future on extracting common code from the Capelin and Radice experiments 
  so they can be re-used by other experiments as well.

6 files changed, 0 insertions, 356 deletions

diff --git a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/ServerlessExperiment.kt b/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/ServerlessExperiment.kt
deleted file mode 100644
index 1c357f67..00000000
--- a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/ServerlessExperiment.kt
+++ /dev/null
@@ -1,132 +0,0 @@
-/*
- * 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.experiments.serverless
-
-import com.typesafe.config.ConfigFactory
-import kotlinx.coroutines.coroutineScope
-import kotlinx.coroutines.delay
-import kotlinx.coroutines.launch
-import mu.KotlinLogging
-import org.opendc.experiments.serverless.trace.FunctionTraceWorkload
-import org.opendc.experiments.serverless.trace.ServerlessTraceReader
-import org.opendc.faas.service.FaaSService
-import org.opendc.faas.service.autoscaler.FunctionTerminationPolicyFixed
-import org.opendc.faas.service.router.RandomRoutingPolicy
-import org.opendc.faas.simulator.SimFunctionDeployer
-import org.opendc.faas.simulator.delay.ColdStartModel
-import org.opendc.faas.simulator.delay.StochasticDelayInjector
-import org.opendc.harness.dsl.Experiment
-import org.opendc.harness.dsl.anyOf
-import org.opendc.simulator.compute.model.MachineModel
-import org.opendc.simulator.compute.model.MemoryUnit
-import org.opendc.simulator.compute.model.ProcessingNode
-import org.opendc.simulator.compute.model.ProcessingUnit
-import org.opendc.simulator.core.runBlockingSimulation
-import java.io.File
-import java.time.Duration
-import java.util.*
-import kotlin.math.max
-
-/**
- * A reproduction of the experiments of Soufiane Jounaid's BSc Computer Science thesis:
- * OpenDC Serverless: Design, Implementation and Evaluation of a FaaS Platform Simulator.
- */
-public class ServerlessExperiment : Experiment("Serverless") {
-    /**
-     * The logger for this portfolio instance.
-     */
-    private val logger = KotlinLogging.logger {}
-
-    /**
-     * The configuration to use.
-     */
-    private val config = ConfigFactory.load().getConfig("opendc.experiments.serverless20")
-
-    /**
-     * The routing policy to test.
-     */
-    private val routingPolicy by anyOf(RandomRoutingPolicy())
-
-    /**
-     * The cold start models to test.
-     */
-    private val coldStartModel by anyOf(ColdStartModel.LAMBDA, ColdStartModel.AZURE, ColdStartModel.GOOGLE)
-
-    override fun doRun(repeat: Int): Unit = runBlockingSimulation {
-        val trace = ServerlessTraceReader().parse(File(config.getString("trace-path")))
-        val traceById = trace.associateBy { it.id }
-        val delayInjector = StochasticDelayInjector(coldStartModel, Random())
-        val deployer = SimFunctionDeployer(clock, this, createMachineModel(), delayInjector) { FunctionTraceWorkload(traceById.getValue(it.name)) }
-        val service =
-            FaaSService(
-                coroutineContext,
-                clock,
-                deployer,
-                routingPolicy,
-                FunctionTerminationPolicyFixed(coroutineContext, clock, timeout = Duration.ofMinutes(10))
-            )
-        val client = service.newClient()
-
-        coroutineScope {
-            for (entry in trace) {
-                launch {
-                    val function = client.newFunction(entry.id, entry.maxMemory.toLong())
-                    var offset = Long.MIN_VALUE
-
-                    for (sample in entry.samples) {
-                        if (sample.invocations == 0) {
-                            continue
-                        }
-
-                        if (offset < 0) {
-                            offset = sample.timestamp - clock.millis()
-                        }
-
-                        delay(max(0, (sample.timestamp - offset) - clock.millis()))
-
-                        logger.info { "Invoking function ${entry.id} ${sample.invocations} times [${sample.timestamp}]" }
-
-                        repeat(sample.invocations) {
-                            function.invoke()
-                        }
-                    }
-                }
-            }
-        }
-
-        client.close()
-        service.close()
-    }
-
-    /**
-     * Construct the machine model to test with.
-     */
-    private fun createMachineModel(): MachineModel {
-        val cpuNode = ProcessingNode("Intel", "Xeon", "amd64", 2)
-
-        return MachineModel(
-            cpus = List(cpuNode.coreCount) { ProcessingUnit(cpuNode, it, 1000.0) },
-            memory = List(4) { MemoryUnit("Crucial", "MTA18ASF4G72AZ-3G2B1", 3200.0, 32_000) }
-        )
-    }
-}
diff --git a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionSample.kt b/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionSample.kt
deleted file mode 100644
index 492f44b9..00000000
--- a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionSample.kt
+++ /dev/null
@@ -1,44 +0,0 @@
-/*
- * 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.experiments.serverless.trace
-
-/**
- * A sample of a single function.
- *
- * @param timestamp The timestamp of the function.
- * @param duration The average execution time of the function.
- * @param invocations The number of invocations.
- * @param provisionedCpu The provisioned CPU for this function in MHz.
- * @param provisionedMem The amount of memory provisioned for this function in MB.
- * @param cpuUsage The actual CPU usage in MHz.
- * @param memUsage The actual memory usage in MB.
- */
-public data class FunctionSample(
-    val timestamp: Long,
-    val duration: Long,
-    val invocations: Int,
-    val provisionedCpu: Int,
-    val provisionedMem: Int,
-    val cpuUsage: Double,
-    val memUsage: Double
-)
diff --git a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionTrace.kt b/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionTrace.kt
deleted file mode 100644
index 4fea6b96..00000000
--- a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionTrace.kt
+++ /dev/null
@@ -1,28 +0,0 @@
-/*
- * 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.experiments.serverless.trace
-
-/**
- * A trace for a single function
- */
-public data class FunctionTrace(val id: String, val maxMemory: Int, val samples: List<FunctionSample>)
diff --git a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionTraceWorkload.kt b/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionTraceWorkload.kt
deleted file mode 100644
index bbe130e3..00000000
--- a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/FunctionTraceWorkload.kt
+++ /dev/null
@@ -1,37 +0,0 @@
-/*
- * 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.experiments.serverless.trace
-
-import org.opendc.faas.simulator.workload.SimFaaSWorkload
-import org.opendc.simulator.compute.workload.SimTrace
-import org.opendc.simulator.compute.workload.SimTraceFragment
-import org.opendc.simulator.compute.workload.SimTraceWorkload
-import org.opendc.simulator.compute.workload.SimWorkload
-
-/**
- * A [SimFaaSWorkload] for a [FunctionTrace].
- */
-class FunctionTraceWorkload(trace: FunctionTrace) :
-    SimFaaSWorkload, SimWorkload by SimTraceWorkload(SimTrace.ofFragments(trace.samples.map { SimTraceFragment(it.timestamp, it.duration, it.cpuUsage, 1) })) {
-    override suspend fun invoke() {}
-}
diff --git a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/ServerlessTraceReader.kt b/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/ServerlessTraceReader.kt
deleted file mode 100644
index 6dc35c59..00000000
--- a/opendc-experiments/opendc-experiments-serverless20/src/main/kotlin/org/opendc/experiments/serverless/trace/ServerlessTraceReader.kt
+++ /dev/null
@@ -1,107 +0,0 @@
-/*
- * 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.experiments.serverless.trace
-
-import mu.KotlinLogging
-import java.io.File
-import kotlin.math.max
-
-/**
- * A trace reader for the serverless workload trace used in the OpenDC Serverless thesis.
- */
-public class ServerlessTraceReader {
-    /**
-     * The logger for this portfolio instance.
-     */
-    private val logger = KotlinLogging.logger {}
-
-    /**
-     * Parse the traces at the specified [path].
-     */
-    public fun parse(path: File): List<FunctionTrace> {
-        return if (path.isFile) {
-            listOf(parseSingle(path))
-        } else {
-            path.walk()
-                .filterNot { it.isDirectory }
-                .map { file ->
-                    logger.info { "Parsing $file" }
-                    parseSingle(file)
-                }
-                .toList()
-        }
-    }
-
-    /**
-     * Parse a single trace.
-     */
-    private fun parseSingle(path: File): FunctionTrace {
-        val samples = mutableListOf<FunctionSample>()
-        val id = path.nameWithoutExtension
-        var idx = 0
-
-        var timestampCol = 0
-        var invocationsCol = 0
-        var execTimeCol = 0
-        var provCpuCol = 0
-        var provMemCol = 0
-        var cpuUsageCol = 0
-        var memoryUsageCol = 0
-        var maxMemory = 0
-
-        path.forEachLine { line ->
-            if (line.startsWith("#") && line.isNotBlank()) {
-                return@forEachLine
-            }
-
-            val values = line.split(",")
-
-            /* Header parsing */
-            if (idx++ == 0) {
-                val header = values.mapIndexed { col, name -> Pair(name.trim(), col) }.toMap()
-                timestampCol = header["Timestamp [ms]"]!!
-                invocationsCol = header["Invocations"]!!
-                execTimeCol = header["Avg Exec time per Invocation"]!!
-                provCpuCol = header["Provisioned CPU [Mhz]"]!!
-                provMemCol = header["Provisioned Memory [mb]"]!!
-                cpuUsageCol = header["Avg cpu usage per Invocation [Mhz]"]!!
-                memoryUsageCol = header["Avg mem usage per Invocation [mb]"]!!
-                return@forEachLine
-            }
-
-            val timestamp = values[timestampCol].trim().toLong()
-            val invocations = values[invocationsCol].trim().toInt()
-            val execTime = values[execTimeCol].trim().toLong()
-            val provisionedCpu = values[provCpuCol].trim().toInt()
-            val provisionedMemory = values[provMemCol].trim().toInt()
-            val cpuUsage = values[cpuUsageCol].trim().toDouble()
-            val memoryUsage = values[memoryUsageCol].trim().toDouble()
-
-            maxMemory = max(maxMemory, provisionedMemory)
-
-            samples.add(FunctionSample(timestamp, execTime, invocations, provisionedCpu, provisionedMemory, cpuUsage, memoryUsage))
-        }
-
-        return FunctionTrace(id, maxMemory, samples)
-    }
-}
diff --git a/opendc-experiments/opendc-experiments-serverless20/src/main/resources/application.conf b/opendc-experiments/opendc-experiments-serverless20/src/main/resources/application.conf
deleted file mode 100644
index a065c5d6..00000000
--- a/opendc-experiments/opendc-experiments-serverless20/src/main/resources/application.conf
+++ /dev/null
@@ -1,8 +0,0 @@
-# Default configuration for the serverless experiments
-opendc.experiments.serverless20 {
-    # Path to the directory containing the serverless trace
-    trace-path = input/traces/serverless
-
-    # Path to the output directory to write the results to
-    output-path = output
-}