diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2021-05-05 12:23:25 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-05 12:23:25 +0200 |
| commit | e1d892bcbaa7e8361c150f684ca6a0dc5e036a87 (patch) | |
| tree | 99742afbc3cd762ec527f5a6c7e31ee245ee0385 /opendc-harness/src/main/kotlin/org/opendc/harness/engine/ExperimentEngineLauncher.kt | |
| parent | e021d46ab1601d0c3a00724358164483608f6297 (diff) | |
| parent | 7fdfe48439f33abec8aa63fc4ab36fd687d59a43 (diff) | |
harness: Improve OpenDC Experiment Harness (v1)
This pull request contains several improvements to the OpenDC Experiment Harness,
which aims to improve user-experience of users when re-running experiments in the repository.
* Split the harness into separate modules
* Add support for adding additional classpath entries when running experiments via the console
* Initial support for configuration of experiments using HOCON.
Diffstat (limited to 'opendc-harness/src/main/kotlin/org/opendc/harness/engine/ExperimentEngineLauncher.kt')
| -rw-r--r-- | opendc-harness/src/main/kotlin/org/opendc/harness/engine/ExperimentEngineLauncher.kt | 121 |
1 files changed, 0 insertions, 121 deletions
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/engine/ExperimentEngineLauncher.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/engine/ExperimentEngineLauncher.kt deleted file mode 100644 index ddd30483..00000000 --- a/opendc-harness/src/main/kotlin/org/opendc/harness/engine/ExperimentEngineLauncher.kt +++ /dev/null @@ -1,121 +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.harness.engine - -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.collect -import kotlinx.coroutines.runBlocking -import org.opendc.harness.api.ExperimentDefinition -import org.opendc.harness.engine.scheduler.ExperimentScheduler -import org.opendc.harness.engine.scheduler.ThreadPoolExperimentScheduler -import org.opendc.harness.engine.strategy.CartesianExperimentStrategy -import org.opendc.harness.engine.strategy.ExperimentStrategy -import org.opendc.harness.internal.CompositeExperimentExecutionListener - -/** - * A builder class for conducting experiments via the [ExperimentEngine]. - */ -public class ExperimentEngineLauncher private constructor( - private val strategy: ExperimentStrategy?, - private val scheduler: ExperimentScheduler?, - private val listeners: List<ExperimentExecutionListener>, - private val repeats: Int -) { - /** - * Construct an [ExperimentEngineLauncher] instance. - */ - public constructor() : this(null, null, emptyList(), 1) - - /** - * Create an [ExperimentEngineLauncher] with the specified [strategy]. - */ - public fun withScheduler(strategy: ExperimentStrategy): ExperimentEngineLauncher { - return ExperimentEngineLauncher(strategy, scheduler, listeners, repeats) - } - - /** - * Create an [ExperimentEngineLauncher] with the specified [scheduler]. - */ - public fun withScheduler(scheduler: ExperimentScheduler): ExperimentEngineLauncher { - return ExperimentEngineLauncher(strategy, scheduler, listeners, repeats) - } - - /** - * Create an [ExperimentEngineLauncher] with the specified [listener] added. - */ - public fun withListener(listener: ExperimentExecutionListener): ExperimentEngineLauncher { - return ExperimentEngineLauncher(strategy, scheduler, listeners + listener, repeats) - } - - /** - * Create an [ExperimentEngineLauncher] with the specified number of repeats. - */ - public fun withRepeats(repeats: Int): ExperimentEngineLauncher { - require(repeats > 0) { "Invalid number of repeats; must be greater than zero. " } - return ExperimentEngineLauncher(strategy, scheduler, listeners, repeats) - } - - /** - * Launch the specified experiments via the [ExperimentEngine] and block execution until finished. - */ - public suspend fun run(experiments: Flow<ExperimentDefinition>) { - val engine = ExperimentEngine(createStrategy(), createScheduler(), createListener(), repeats) - experiments.collect { experiment -> engine.execute(experiment) } - } - - /** - * Launch the specified experiments via the [ExperimentEngine] and block the current thread until finished. - */ - public fun runBlocking(experiments: Flow<ExperimentDefinition>) { - runBlocking { - run(experiments) - } - } - - /** - * Return a string representation of this instance. - */ - public override fun toString(): String = "ExperimentEngineLauncher" - - /** - * Create the [ExperimentStrategy] that explores the experiment design space. - */ - private fun createStrategy(): ExperimentStrategy { - return strategy ?: CartesianExperimentStrategy - } - - /** - * Create the [ExperimentScheduler] that schedules the trials over the compute resources. - */ - private fun createScheduler(): ExperimentScheduler { - return scheduler ?: ThreadPoolExperimentScheduler(Runtime.getRuntime().availableProcessors()) - } - - /** - * Create the [ExperimentExecutionListener] that listens the to the execution of the experiments. - */ - private fun createListener(): ExperimentExecutionListener { - require(listeners.isNotEmpty()) { "No listeners registered." } - return CompositeExperimentExecutionListener(listeners) - } -} |
