diff options
34 files changed, 856 insertions, 32 deletions
diff --git a/opendc-trace/opendc-trace-azure/build.gradle.kts b/opendc-trace/opendc-trace-azure/build.gradle.kts index a237f08a..ee53c583 100644 --- a/opendc-trace/opendc-trace-azure/build.gradle.kts +++ b/opendc-trace/opendc-trace-azure/build.gradle.kts @@ -31,4 +31,6 @@ plugins { dependencies { api(projects.opendcTrace.opendcTraceApi) implementation(libs.jackson.dataformat.csv) + + testImplementation(projects.opendcTrace.opendcTraceTestkit) } diff --git a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt index e9017b35..c0c67329 100644 --- a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt +++ b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt @@ -37,11 +37,20 @@ import java.util.* * A [TableReader] for the Azure v1 VM resource state table. */ internal class AzureResourceStateTableReader(private val parser: CsvParser) : TableReader { + /** + * A flag to indicate whether a single row has been read already. + */ + private var isStarted = false + init { parser.schema = schema } override fun nextRow(): Boolean { + if (!isStarted) { + isStarted = true + } + reset() if (!nextStart()) { @@ -100,6 +109,7 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } override fun getDouble(index: Int): Double { + checkActive() return when (index) { COL_CPU_USAGE_PCT -> cpuUsagePct else -> throw IllegalArgumentException("Invalid column") @@ -107,6 +117,7 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } override fun getString(index: Int): String? { + checkActive() return when (index) { COL_ID -> id else -> throw IllegalArgumentException("Invalid column") @@ -118,6 +129,7 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } override fun getInstant(index: Int): Instant? { + checkActive() return when (index) { COL_TIMESTAMP -> timestamp else -> throw IllegalArgumentException("Invalid column") @@ -145,6 +157,13 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + + /** * Advance the parser until the next object start. */ private fun nextStart(): Boolean { diff --git a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt index 456a2536..a8451301 100644 --- a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt +++ b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt @@ -35,11 +35,20 @@ import java.util.* * A [TableReader] for the Azure v1 VM resources table. */ internal class AzureResourceTableReader(private val parser: CsvParser) : TableReader { + /** + * A flag to indicate whether a single row has been read already. + */ + private var isStarted = false + init { parser.schema = schema } override fun nextRow(): Boolean { + if (!isStarted) { + isStarted = true + } + reset() if (!nextStart()) { @@ -92,6 +101,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getInt(index: Int): Int { + checkActive() return when (index) { COL_CPU_COUNT -> cpuCores else -> throw IllegalArgumentException("Invalid column") @@ -99,6 +109,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getLong(index: Int): Long { + checkActive() return when (index) { COL_CPU_COUNT -> cpuCores.toLong() else -> throw IllegalArgumentException("Invalid column") @@ -110,6 +121,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getDouble(index: Int): Double { + checkActive() return when (index) { COL_MEM_CAPACITY -> memCapacity else -> throw IllegalArgumentException("Invalid column") @@ -117,6 +129,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getString(index: Int): String? { + checkActive() return when (index) { COL_ID -> id else -> throw IllegalArgumentException("Invalid column") @@ -128,6 +141,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getInstant(index: Int): Instant? { + checkActive() return when (index) { COL_START_TIME -> startTime COL_STOP_TIME -> stopTime @@ -156,6 +170,13 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + + /** * Advance the parser until the next object start. */ private fun nextStart(): Boolean { diff --git a/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt b/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt index 932858f8..06ba047a 100644 --- a/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt @@ -22,15 +22,19 @@ package org.opendc.trace.azure +import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows +import org.junit.jupiter.api.Assertions.assertAll +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths /** * Test suite for the [AzureTraceFormat] class. */ +@DisplayName("Azure VM TraceFormat") class AzureTraceFormatTest { private val format = AzureTraceFormat() @@ -82,4 +86,34 @@ class AzureTraceFormatTest { reader.close() } + + @DisplayName("TableReader for Resources") + @Nested + inner class ResourcesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace") + + columns = format.getDetails(path, TABLE_RESOURCES).columns + reader = format.newReader(path, TABLE_RESOURCES, null) + } + } + + @DisplayName("TableReader for Resource States") + @Nested + inner class ResourceStatesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace") + + columns = format.getDetails(path, TABLE_RESOURCE_STATES).columns + reader = format.newReader(path, TABLE_RESOURCE_STATES, null) + } + } } diff --git a/opendc-trace/opendc-trace-bitbrains/build.gradle.kts b/opendc-trace/opendc-trace-bitbrains/build.gradle.kts index 5211ec30..502b052a 100644 --- a/opendc-trace/opendc-trace-bitbrains/build.gradle.kts +++ b/opendc-trace/opendc-trace-bitbrains/build.gradle.kts @@ -30,4 +30,6 @@ plugins { dependencies { api(projects.opendcTrace.opendcTraceApi) implementation(libs.jackson.dataformat.csv) + + testImplementation(projects.opendcTrace.opendcTraceTestkit) } diff --git a/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTableReader.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTableReader.kt index f9bd6200..df7a1c91 100644 --- a/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTableReader.kt +++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTableReader.kt @@ -33,14 +33,29 @@ import java.util.* * A [TableReader] for the Bitbrains resource state table. */ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedReader) : TableReader { + private var state = State.Pending + override fun nextRow(): Boolean { + val state = state + if (state == State.Closed) { + return false + } else if (state == State.Pending) { + this.state = State.Active + } + reset() - var line: String + var line: String? var num = 0 while (true) { - line = reader.readLine() ?: return false + line = reader.readLine() + + if (line == null) { + this.state = State.Closed + return false + } + num++ if (line[0] == '#' || line.isBlank()) { @@ -51,7 +66,7 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR break } - line = line.trim() + line = line!!.trim() val length = line.length var col = 0 @@ -115,6 +130,7 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR } override fun getBoolean(index: Int): Boolean { + check(state == State.Active) { "No active row" } return when (index) { COL_POWERED_ON -> poweredOn else -> throw IllegalArgumentException("Invalid column") @@ -122,6 +138,7 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR } override fun getInt(index: Int): Int { + check(state == State.Active) { "No active row" } return when (index) { COL_NCPUS -> cpuCores else -> throw IllegalArgumentException("Invalid column") @@ -137,6 +154,7 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR } override fun getDouble(index: Int): Double { + check(state == State.Active) { "No active row" } return when (index) { COL_CPU_CAPACITY -> cpuCapacity COL_CPU_USAGE -> cpuUsage @@ -151,6 +169,7 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR } override fun getString(index: Int): String? { + check(state == State.Active) { "No active row" } return when (index) { COL_ID -> id COL_CLUSTER_ID -> cluster @@ -163,6 +182,7 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR } override fun getInstant(index: Int): Instant? { + check(state == State.Active) { "No active row" } return when (index) { COL_TIMESTAMP -> timestamp else -> throw IllegalArgumentException("Invalid column") @@ -187,6 +207,8 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR override fun close() { reader.close() + reset() + state = State.Closed } /** @@ -240,4 +262,8 @@ internal class BitbrainsExResourceStateTableReader(private val reader: BufferedR private val COL_MEM_CAPACITY = 20 private val COL_CPU_USAGE_PCT = 21 private val COL_MAX = COL_CPU_USAGE_PCT + 1 + + private enum class State { + Pending, Active, Closed + } } diff --git a/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceStateTableReader.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceStateTableReader.kt index 14c1f801..4d8cf758 100644 --- a/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceStateTableReader.kt +++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceStateTableReader.kt @@ -42,6 +42,11 @@ import java.util.* */ internal class BitbrainsResourceStateTableReader(private val partition: String, private val parser: CsvParser) : TableReader { /** + * A flag to indicate whether a single row has been read already. + */ + private var isStarted = false + + /** * The [DateTimeFormatter] used to parse the timestamps in case of the Materna trace. */ private val formatter = DateTimeFormatter.ofPattern("dd.MM.yyyy HH:mm:ss") @@ -66,6 +71,10 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } override fun nextRow(): Boolean { + if (!isStarted) { + isStarted = true + } + // Reset the row state reset() @@ -145,7 +154,7 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } override fun isNull(index: Int): Boolean { - check(index in 0..COL_NET_TX) { "Invalid column index" } + require(index in 0..COL_ID) { "Invalid column index" } return false } @@ -154,6 +163,7 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } override fun getInt(index: Int): Int { + checkActive() return when (index) { COL_CPU_COUNT -> cpuCores else -> throw IllegalArgumentException("Invalid column") @@ -169,6 +179,7 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } override fun getDouble(index: Int): Double { + checkActive() return when (index) { COL_CPU_CAPACITY -> cpuCapacity COL_CPU_USAGE -> cpuUsage @@ -184,6 +195,7 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } override fun getString(index: Int): String { + checkActive() return when (index) { COL_ID -> partition else -> throw IllegalArgumentException("Invalid column") @@ -195,6 +207,7 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } override fun getInstant(index: Int): Instant? { + checkActive() return when (index) { COL_TIMESTAMP -> timestamp else -> throw IllegalArgumentException("Invalid column") @@ -222,6 +235,13 @@ internal class BitbrainsResourceStateTableReader(private val partition: String, } /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + + /** * Advance the parser until the next object start. */ private fun nextStart(): Boolean { diff --git a/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceTableReader.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceTableReader.kt index c57c4cb2..7454c40f 100644 --- a/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceTableReader.kt +++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsResourceTableReader.kt @@ -39,7 +39,16 @@ internal class BitbrainsResourceTableReader(private val factory: CsvFactory, vms */ private val it = vms.iterator() + /** + * The state of the reader. + */ + private var state = State.Pending + override fun nextRow(): Boolean { + if (state == State.Pending) { + state = State.Active + } + reset() while (it.hasNext()) { @@ -61,6 +70,7 @@ internal class BitbrainsResourceTableReader(private val factory: CsvFactory, vms } } + state = State.Closed return false } @@ -74,7 +84,7 @@ internal class BitbrainsResourceTableReader(private val factory: CsvFactory, vms } override fun isNull(index: Int): Boolean { - check(index in 0..COL_ID) { "Invalid column index" } + require(index in 0..COL_ID) { "Invalid column index" } return false } @@ -99,6 +109,7 @@ internal class BitbrainsResourceTableReader(private val factory: CsvFactory, vms } override fun getString(index: Int): String? { + check(state == State.Active) { "No active row" } return when (index) { COL_ID -> id else -> throw IllegalArgumentException("Invalid column") @@ -129,7 +140,10 @@ internal class BitbrainsResourceTableReader(private val factory: CsvFactory, vms throw IllegalArgumentException("Invalid column") } - override fun close() {} + override fun close() { + reset() + state = State.Closed + } /** * State fields of the reader. @@ -142,4 +156,8 @@ internal class BitbrainsResourceTableReader(private val factory: CsvFactory, vms private fun reset() { id = null } + + private enum class State { + Pending, Active, Closed + } } diff --git a/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormatTest.kt b/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormatTest.kt index 870129e4..dbb75c50 100644 --- a/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormatTest.kt @@ -22,12 +22,15 @@ package org.opendc.trace.bitbrains +import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows +import org.junit.jupiter.api.Assertions.assertAll +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.RESOURCE_STATE_CPU_USAGE import org.opendc.trace.conv.RESOURCE_STATE_TIMESTAMP import org.opendc.trace.conv.TABLE_RESOURCE_STATES +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths /** @@ -69,4 +72,19 @@ internal class BitbrainsExTraceFormatTest { reader.close() } + + @DisplayName("TableReader for Resource States") + @Nested + inner class ResourceStatesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/vm.txt") + + columns = format.getDetails(path, TABLE_RESOURCE_STATES).columns + reader = format.newReader(path, TABLE_RESOURCE_STATES, null) + } + } } diff --git a/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsTraceFormatTest.kt b/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsTraceFormatTest.kt index 557f8c21..712e1fcb 100644 --- a/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsTraceFormatTest.kt @@ -22,10 +22,13 @@ package org.opendc.trace.bitbrains +import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows +import org.junit.jupiter.api.Assertions.assertAll +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths /** @@ -81,4 +84,34 @@ class BitbrainsTraceFormatTest { reader.close() } + + @DisplayName("TableReader for Resources") + @Nested + inner class ResourcesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/bitbrains.csv") + + columns = format.getDetails(path, TABLE_RESOURCES).columns + reader = format.newReader(path, TABLE_RESOURCES, null) + } + } + + @DisplayName("TableReader for Resource States") + @Nested + inner class ResourceStatesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/bitbrains.csv") + + columns = format.getDetails(path, TABLE_RESOURCE_STATES).columns + reader = format.newReader(path, TABLE_RESOURCE_STATES, null) + } + } } diff --git a/opendc-trace/opendc-trace-gwf/build.gradle.kts b/opendc-trace/opendc-trace-gwf/build.gradle.kts index 1105a465..0c041439 100644 --- a/opendc-trace/opendc-trace-gwf/build.gradle.kts +++ b/opendc-trace/opendc-trace-gwf/build.gradle.kts @@ -31,4 +31,6 @@ dependencies { api(projects.opendcTrace.opendcTraceApi) implementation(libs.jackson.dataformat.csv) + + testImplementation(projects.opendcTrace.opendcTraceTestkit) } diff --git a/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt b/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt index 007ab90a..f9a171e9 100644 --- a/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt +++ b/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt @@ -37,15 +37,24 @@ import java.util.regex.Pattern * A [TableReader] implementation for the GWF format. */ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { + /** + * A flag to indicate whether a single row has been read already. + */ + private var isStarted = false + init { parser.schema = schema } override fun nextRow(): Boolean { + if (!isStarted) { + isStarted = true + } + // Reset the row state reset() - if (!nextStart()) { + if (parser.isClosed || !nextStart()) { return false } @@ -84,7 +93,7 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } override fun isNull(index: Int): Boolean { - check(index in 0..COL_DEPS) { "Invalid column" } + require(index in 0..COL_DEPS) { "Invalid column" } return false } @@ -93,6 +102,7 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } override fun getInt(index: Int): Int { + checkActive() return when (index) { COL_REQ_NPROC -> reqNProcs COL_NPROC -> nProcs @@ -113,6 +123,7 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } override fun getString(index: Int): String? { + checkActive() return when (index) { COL_JOB_ID -> jobId COL_WORKFLOW_ID -> workflowId @@ -125,6 +136,7 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } override fun getInstant(index: Int): Instant? { + checkActive() return when (index) { COL_SUBMIT_TIME -> submitTime else -> throw IllegalArgumentException("Invalid column") @@ -132,6 +144,7 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } override fun getDuration(index: Int): Duration? { + checkActive() return when (index) { COL_RUNTIME -> runtime else -> throw IllegalArgumentException("Invalid column") @@ -147,6 +160,7 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } override fun <T> getSet(index: Int, elementType: Class<T>): Set<T>? { + checkActive() return when (index) { COL_DEPS -> TYPE_DEPS.convertTo(dependencies, elementType) else -> throw IllegalArgumentException("Invalid column") @@ -158,6 +172,13 @@ internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader { } /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + + /** * The pattern used to parse the parents. */ private val pattern = Pattern.compile("\\s+") diff --git a/opendc-trace/opendc-trace-gwf/src/test/kotlin/org/opendc/trace/gwf/GwfTraceFormatTest.kt b/opendc-trace/opendc-trace-gwf/src/test/kotlin/org/opendc/trace/gwf/GwfTraceFormatTest.kt index dd0e6066..a8c3a715 100644 --- a/opendc-trace/opendc-trace-gwf/src/test/kotlin/org/opendc/trace/gwf/GwfTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-gwf/src/test/kotlin/org/opendc/trace/gwf/GwfTraceFormatTest.kt @@ -24,7 +24,10 @@ package org.opendc.trace.gwf import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths import java.time.Duration import java.time.Instant @@ -32,6 +35,7 @@ import java.time.Instant /** * Test suite for the [GwfTraceFormat] class. */ +@DisplayName("GWF TraceFormat") internal class GwfTraceFormatTest { private val format = GwfTraceFormat() @@ -88,4 +92,19 @@ internal class GwfTraceFormatTest { { assertEquals(setOf("4", "5", "6"), reader.getSet(TASK_PARENTS, String::class.java)) }, ) } + + @DisplayName("TableReader for Tasks") + @Nested + inner class TasksTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get(checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf")).toURI()) + + columns = format.getDetails(path, TABLE_TASKS).columns + reader = format.newReader(path, TABLE_TASKS, null) + } + } } diff --git a/opendc-trace/opendc-trace-opendc/build.gradle.kts b/opendc-trace/opendc-trace-opendc/build.gradle.kts index fad6d9e7..236bdedc 100644 --- a/opendc-trace/opendc-trace-opendc/build.gradle.kts +++ b/opendc-trace/opendc-trace-opendc/build.gradle.kts @@ -33,5 +33,6 @@ dependencies { implementation(projects.opendcTrace.opendcTraceParquet) + testImplementation(projects.opendcTrace.opendcTraceTestkit) testRuntimeOnly(libs.slf4j.simple) } diff --git a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmInterferenceJsonTableReader.kt b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmInterferenceJsonTableReader.kt index 920daeea..1841c486 100644 --- a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmInterferenceJsonTableReader.kt +++ b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmInterferenceJsonTableReader.kt @@ -54,12 +54,13 @@ internal class OdcVmInterferenceJsonTableReader(private val parser: JsonParser) } } - return if (parser.nextToken() != JsonToken.END_ARRAY) { - parseGroup(parser) - true - } else { + return if (parser.isClosed || parser.nextToken() == JsonToken.END_ARRAY) { + parser.close() reset() false + } else { + parseGroup(parser) + true } } @@ -102,6 +103,7 @@ internal class OdcVmInterferenceJsonTableReader(private val parser: JsonParser) } override fun getDouble(index: Int): Double { + checkActive() return when (index) { COL_TARGET -> targetLoad COL_SCORE -> score @@ -130,6 +132,7 @@ internal class OdcVmInterferenceJsonTableReader(private val parser: JsonParser) } override fun <T> getSet(index: Int, elementType: Class<T>): Set<T>? { + checkActive() return when (index) { COL_MEMBERS -> TYPE_MEMBERS.convertTo(members, elementType) else -> throw IllegalArgumentException("Invalid column $index") @@ -149,6 +152,13 @@ internal class OdcVmInterferenceJsonTableReader(private val parser: JsonParser) private var score = 1.0 /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + + /** * Reset the state. */ private fun reset() { diff --git a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableReader.kt b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableReader.kt index 599f46f1..b256047f 100644 --- a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableReader.kt +++ b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableReader.kt @@ -69,7 +69,7 @@ internal class OdcVmResourceStateTableReader(private val reader: LocalParquetRea } override fun isNull(index: Int): Boolean { - check(index in 0..COL_CPU_USAGE) { "Invalid column index" } + require(index in 0..COL_CPU_USAGE) { "Invalid column index" } return false } diff --git a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableWriter.kt b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableWriter.kt index f5e8b863..30375de0 100644 --- a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableWriter.kt +++ b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceStateTableWriter.kt @@ -109,6 +109,7 @@ internal class OdcVmResourceStateTableWriter(private val writer: ParquetWriter<R when (index) { COL_ID -> _id = value + else -> throw IllegalArgumentException("Invalid column or type [index $index]") } } @@ -130,6 +131,7 @@ internal class OdcVmResourceStateTableWriter(private val writer: ParquetWriter<R when (index) { COL_DURATION -> _duration = value + else -> throw IllegalArgumentException("Invalid column or type [index $index]") } } diff --git a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceTableReader.kt b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceTableReader.kt index 88f9b781..76fdbca8 100644 --- a/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceTableReader.kt +++ b/opendc-trace/opendc-trace-opendc/src/main/kotlin/org/opendc/trace/opendc/OdcVmResourceTableReader.kt @@ -71,7 +71,7 @@ internal class OdcVmResourceTableReader(private val reader: LocalParquetReader<R } override fun isNull(index: Int): Boolean { - check(index in 0..COL_MEM_CAPACITY) { "Invalid column index" } + require(index in 0..COL_MEM_CAPACITY) { "Invalid column index" } return false } diff --git a/opendc-trace/opendc-trace-opendc/src/test/kotlin/org/opendc/trace/opendc/OdcVmTraceFormatTest.kt b/opendc-trace/opendc-trace-opendc/src/test/kotlin/org/opendc/trace/opendc/OdcVmTraceFormatTest.kt index ae6e62d8..9fdffb2b 100644 --- a/opendc-trace/opendc-trace-opendc/src/test/kotlin/org/opendc/trace/opendc/OdcVmTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-opendc/src/test/kotlin/org/opendc/trace/opendc/OdcVmTraceFormatTest.kt @@ -23,12 +23,20 @@ package org.opendc.trace.opendc import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.DisplayName +import org.junit.jupiter.api.Nested import org.junit.jupiter.api.Test import org.junit.jupiter.api.assertDoesNotThrow import org.junit.jupiter.api.assertThrows import org.junit.jupiter.params.ParameterizedTest import org.junit.jupiter.params.provider.ValueSource +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader +import org.opendc.trace.TableWriter import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit +import org.opendc.trace.testkit.TableWriterTestKit import java.nio.file.Files import java.nio.file.Paths import java.time.Instant @@ -36,6 +44,7 @@ import java.time.Instant /** * Test suite for the [OdcVmTraceFormat] implementation. */ +@DisplayName("OdcVmTraceFormat") internal class OdcVmTraceFormatTest { private val format = OdcVmTraceFormat() @@ -191,4 +200,130 @@ internal class OdcVmTraceFormatTest { assertFalse(reader.nextRow()) reader.close() } + + @Test + fun testInterferenceGroupsWrite() { + val path = Files.createTempDirectory("opendc") + val writer = format.newWriter(path, TABLE_INTERFERENCE_GROUPS) + + writer.startRow() + writer.setSet(INTERFERENCE_GROUP_MEMBERS, setOf("a", "b", "c")) + writer.setDouble(INTERFERENCE_GROUP_TARGET, 0.5) + writer.setDouble(INTERFERENCE_GROUP_SCORE, 0.8) + writer.endRow() + writer.flush() + + writer.startRow() + writer.setSet(INTERFERENCE_GROUP_MEMBERS, setOf("a", "b", "d")) + writer.setDouble(INTERFERENCE_GROUP_TARGET, 0.5) + writer.setDouble(INTERFERENCE_GROUP_SCORE, 0.9) + writer.endRow() + writer.close() + + val reader = format.newReader(path, TABLE_INTERFERENCE_GROUPS, null) + + assertAll( + { assertTrue(reader.nextRow()) }, + { assertEquals(setOf("a", "b", "c"), reader.getSet(INTERFERENCE_GROUP_MEMBERS, String::class.java)) }, + { assertEquals(0.5, reader.getDouble(INTERFERENCE_GROUP_TARGET)) }, + { assertEquals(0.8, reader.getDouble(INTERFERENCE_GROUP_SCORE)) }, + { assertTrue(reader.nextRow()) }, + { assertEquals(setOf("a", "b", "d"), reader.getSet(INTERFERENCE_GROUP_MEMBERS, String::class.java)) }, + { assertEquals(0.5, reader.getDouble(INTERFERENCE_GROUP_TARGET)) }, + { assertEquals(0.9, reader.getDouble(INTERFERENCE_GROUP_SCORE)) }, + { assertFalse(reader.nextRow()) }, + ) + + reader.close() + } + + @DisplayName("TableReader for Resources") + @Nested + inner class ResourcesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace-v2.1") + + columns = format.getDetails(path, TABLE_RESOURCES).columns + reader = format.newReader(path, TABLE_RESOURCES, null) + } + } + + @DisplayName("TableWriter for Resources") + @Nested + inner class ResourcesTableWriterTest : TableWriterTestKit() { + override lateinit var writer: TableWriter + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Files.createTempDirectory("opendc") + + columns = format.getDetails(Paths.get("src/test/resources/trace-v2.1"), TABLE_RESOURCES).columns + writer = format.newWriter(path, TABLE_RESOURCES) + } + } + + @DisplayName("TableReader for Resource States") + @Nested + inner class ResourceStatesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace-v2.1") + + columns = format.getDetails(path, TABLE_RESOURCE_STATES).columns + reader = format.newReader(path, TABLE_RESOURCE_STATES, null) + } + } + + @DisplayName("TableWriter for Resource States") + @Nested + inner class ResourceStatesTableWriterTest : TableWriterTestKit() { + override lateinit var writer: TableWriter + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Files.createTempDirectory("opendc") + + columns = format.getDetails(Paths.get("src/test/resources/trace-v2.1"), TABLE_RESOURCE_STATES).columns + writer = format.newWriter(path, TABLE_RESOURCE_STATES) + } + } + + @DisplayName("TableReader for Interference Groups") + @Nested + inner class InterferenceGroupsTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace-v2.1") + + columns = format.getDetails(path, TABLE_INTERFERENCE_GROUPS).columns + reader = format.newReader(path, TABLE_INTERFERENCE_GROUPS, null) + } + } + + @DisplayName("TableWriter for Interference Groups") + @Nested + inner class InterferenceGroupsTableWriterTest : TableWriterTestKit() { + override lateinit var writer: TableWriter + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Files.createTempDirectory("opendc") + + columns = format.getDetails(Paths.get("src/test/resources/trace-v2.1"), TABLE_INTERFERENCE_GROUPS).columns + writer = format.newWriter(path, TABLE_INTERFERENCE_GROUPS) + } + } } diff --git a/opendc-trace/opendc-trace-parquet/src/test/kotlin/org/opendc/trace/util/parquet/ParquetTest.kt b/opendc-trace/opendc-trace-parquet/src/test/kotlin/org/opendc/trace/util/parquet/ParquetTest.kt index be354319..29fcac96 100644 --- a/opendc-trace/opendc-trace-parquet/src/test/kotlin/org/opendc/trace/util/parquet/ParquetTest.kt +++ b/opendc-trace/opendc-trace-parquet/src/test/kotlin/org/opendc/trace/util/parquet/ParquetTest.kt @@ -77,6 +77,7 @@ internal class ParquetTest { } private val readSupport = object : ReadSupport<Int>() { + @Suppress("OVERRIDE_DEPRECATION") override fun init( configuration: Configuration, keyValueMetaData: Map<String, String>, diff --git a/opendc-trace/opendc-trace-swf/build.gradle.kts b/opendc-trace/opendc-trace-swf/build.gradle.kts index 20b03c80..d3bc5aa6 100644 --- a/opendc-trace/opendc-trace-swf/build.gradle.kts +++ b/opendc-trace/opendc-trace-swf/build.gradle.kts @@ -29,4 +29,6 @@ plugins { dependencies { api(projects.opendcTrace.opendcTraceApi) + + testImplementation(projects.opendcTrace.opendcTraceTestkit) } diff --git a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt b/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt index 4d0a9008..b2734fe7 100644 --- a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt +++ b/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt @@ -34,6 +34,11 @@ import java.util.* */ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableReader { /** + * A flag to indicate the state of the reader + */ + private var state = State.Pending + + /** * The current row. */ private var fields = emptyList<String>() @@ -44,11 +49,23 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea private val whitespace = "\\s+".toRegex() override fun nextRow(): Boolean { - var line: String + var line: String? var num = 0 + val state = state + if (state == State.Closed) { + return false + } else if (state == State.Pending) { + this.state = State.Active + } + while (true) { - line = reader.readLine() ?: return false + line = reader.readLine() + + if (line == null) { + this.state = State.Closed + return false + } num++ if (line.isBlank()) { @@ -62,7 +79,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea break } - fields = line.trim().split(whitespace) + fields = line!!.trim().split(whitespace) if (fields.size < 18) { throw IllegalArgumentException("Invalid format at line $line") @@ -97,6 +114,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea } override fun getInt(index: Int): Int { + check(state == State.Active) { "No active row" } return when (index) { COL_REQ_NCPUS, COL_ALLOC_NCPUS, COL_STATUS, COL_GROUP_ID, COL_USER_ID -> fields[index].toInt(10) else -> throw IllegalArgumentException("Invalid column") @@ -116,6 +134,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea } override fun getString(index: Int): String { + check(state == State.Active) { "No active row" } return when (index) { COL_JOB_ID -> fields[index] else -> throw IllegalArgumentException("Invalid column") @@ -127,6 +146,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea } override fun getInstant(index: Int): Instant? { + check(state == State.Active) { "No active row" } return when (index) { COL_SUBMIT_TIME -> Instant.ofEpochSecond(fields[index].toLong(10)) else -> throw IllegalArgumentException("Invalid column") @@ -134,6 +154,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea } override fun getDuration(index: Int): Duration? { + check(state == State.Active) { "No active row" } return when (index) { COL_WAIT_TIME, COL_RUN_TIME -> Duration.ofSeconds(fields[index].toLong(10)) else -> throw IllegalArgumentException("Invalid column") @@ -145,6 +166,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea } override fun <T> getSet(index: Int, elementType: Class<T>): Set<T>? { + check(state == State.Active) { "No active row" } @Suppress("UNCHECKED_CAST") return when (index) { COL_PARENT_JOB -> { @@ -162,6 +184,7 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea override fun close() { reader.close() + state = State.Closed } /** @@ -185,4 +208,8 @@ internal class SwfTaskTableReader(private val reader: BufferedReader) : TableRea private val COL_PART_NUM = 15 private val COL_PARENT_JOB = 16 private val COL_PARENT_THINK_TIME = 17 + + private enum class State { + Pending, Active, Closed + } } diff --git a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt b/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt index 40f98a01..575a1740 100644 --- a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt +++ b/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt @@ -54,7 +54,7 @@ public class SwfTraceFormat : TraceFormat { TableColumn(TASK_REQ_NCPUS, TableColumnType.Int), TableColumn(TASK_ALLOC_NCPUS, TableColumnType.Int), TableColumn(TASK_PARENTS, TableColumnType.Set(TableColumnType.String)), - TableColumn(TASK_STATUS, TableColumnType.String), + TableColumn(TASK_STATUS, TableColumnType.Int), TableColumn(TASK_GROUP_ID, TableColumnType.Int), TableColumn(TASK_USER_ID, TableColumnType.Int) ) diff --git a/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt b/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt index afecdbb9..06a500d8 100644 --- a/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt @@ -24,14 +24,18 @@ package org.opendc.trace.swf import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.TABLE_TASKS import org.opendc.trace.conv.TASK_ALLOC_NCPUS import org.opendc.trace.conv.TASK_ID +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths /** * Test suite for the [SwfTraceFormat] class. */ +@DisplayName("SWF TraceFormat") internal class SwfTraceFormatTest { private val format = SwfTraceFormat() @@ -71,4 +75,19 @@ internal class SwfTraceFormatTest { reader.close() } + + @DisplayName("TableReader for Tasks") + @Nested + inner class TasksTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get(checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf")).toURI()) + + columns = format.getDetails(path, TABLE_TASKS).columns + reader = format.newReader(path, TABLE_TASKS, null) + } + } } diff --git a/opendc-trace/opendc-trace-testkit/build.gradle.kts b/opendc-trace/opendc-trace-testkit/build.gradle.kts new file mode 100644 index 00000000..f6b7222c --- /dev/null +++ b/opendc-trace/opendc-trace-testkit/build.gradle.kts @@ -0,0 +1,34 @@ +/* + * 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. + */ + +description = "Reusable test suite for implementors" + +/* Build configuration */ +plugins { + `kotlin-library-conventions` +} + +dependencies { + api(projects.opendcTrace.opendcTraceApi) + implementation(libs.junit.jupiter.api) + implementation(libs.junit.jupiter.params) +} diff --git a/opendc-trace/opendc-trace-testkit/src/main/kotlin/org/opendc/trace/testkit/TableReaderTestKit.kt b/opendc-trace/opendc-trace-testkit/src/main/kotlin/org/opendc/trace/testkit/TableReaderTestKit.kt new file mode 100644 index 00000000..291ca2b1 --- /dev/null +++ b/opendc-trace/opendc-trace-testkit/src/main/kotlin/org/opendc/trace/testkit/TableReaderTestKit.kt @@ -0,0 +1,174 @@ +/* + * 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.trace.testkit + +import org.junit.jupiter.api.* +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Assumptions.assumeTrue +import org.junit.jupiter.api.assertAll +import org.junit.jupiter.api.assertDoesNotThrow +import org.opendc.trace.TableColumn +import org.opendc.trace.TableColumnType +import org.opendc.trace.TableReader + +/** + * A test suite for implementations of the [TableReader] interface. + */ +public abstract class TableReaderTestKit { + /** + * The [TableReader] instance to test. + */ + public abstract val reader: TableReader + + /** + * The columns of the table. + */ + public abstract val columns: List<TableColumn> + + @AfterEach + public fun tearDown() { + reader.close() + } + + /** + * Test that we can resolve the columns of a table successfully. + */ + @Test + public fun testResolve() { + assertAll(columns.map { column -> { assertNotEquals(-1, reader.resolve(column.name)) } }) + } + + /** + * Test that resolving an empty column name fails + */ + @Test + public fun testResolveEmpty() { + assertEquals(-1, reader.resolve("")) + } + + /** + * Test that reading non-existent columns fails. + */ + @Test + public fun testReadNonExistentColumns() { + assumeTrue(reader.nextRow()) + assertAll( + { assertThrows<IllegalArgumentException> { reader.isNull(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getBoolean(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getInt(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getLong(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getFloat(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getDouble(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getString(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getUUID(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getInstant(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getDuration(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getList(-1, Any::class.java) } }, + { assertThrows<IllegalArgumentException> { reader.getSet(-1, Any::class.java) } }, + { assertThrows<IllegalArgumentException> { reader.getMap(-1, Any::class.java, Any::class.java) } }, + ) + } + + /** + * Test that ensures [TableReader.isNull] reports the correct value. + */ + @Test + public fun testVerifyNullColumns() { + while (reader.nextRow()) { + assertAll( + columns.map { column -> + { + when (column.type) { + is TableColumnType.Boolean -> assertFalse(reader.isNull(column.name) && !reader.getBoolean(column.name)) + is TableColumnType.Int -> assertFalse(reader.isNull(column.name) && reader.getInt(column.name) != 0) + is TableColumnType.Long -> assertFalse(reader.isNull(column.name) && reader.getLong(column.name) != 0L) + is TableColumnType.Float -> assertFalse(reader.isNull(column.name) && reader.getFloat(column.name) != 0f) + is TableColumnType.Double -> assertFalse(reader.isNull(column.name) && reader.getDouble(column.name) != 0.0) + is TableColumnType.String -> assertFalse(reader.isNull(column.name) && reader.getString(column.name) != null) + is TableColumnType.UUID -> assertFalse(reader.isNull(column.name) && reader.getUUID(column.name) != null) + is TableColumnType.Instant -> assertFalse(reader.isNull(column.name) && reader.getInstant(column.name) != null) + is TableColumnType.Duration -> assertFalse(reader.isNull(column.name) && reader.getDuration(column.name) != null) + is TableColumnType.List -> assertFalse(reader.isNull(column.name) && reader.getList(column.name, Any::class.java) != null) + is TableColumnType.Set -> assertFalse(reader.isNull(column.name) && reader.getSet(column.name, Any::class.java) != null) + is TableColumnType.Map -> assertFalse(reader.isNull(column.name) && reader.getMap(column.name, Any::class.java, Any::class.java) != null) + } + } + } + ) + } + } + + /** + * Test that we can read the entire table without any issue. + */ + @Test + public fun testReadFully() { + assertDoesNotThrow { + while (reader.nextRow()) { + assertAll(columns.map { column -> { assertDoesNotThrow { reader.get(column) } } }) + } + reader.close() + } + + assertFalse(reader.nextRow()) { "Reader does not reset" } + } + + /** + * Test that the reader throws an exception when the columns are read without a call to [TableReader.nextRow] + */ + @Test + public fun testReadWithoutNextRow() { + assertAll(columns.map { column -> { assertThrows<IllegalStateException> { reader.get(column) } } }) + } + + /** + * Test that the reader throws an exception when the columns are read after the [TableReader] is finished. + */ + @Test + public fun testReadAfterFinish() { + @Suppress("ControlFlowWithEmptyBody") + while (reader.nextRow()) {} + + testReadWithoutNextRow() + } + + /** + * Helper method to map a [TableColumn] to a read. + */ + private fun TableReader.get(column: TableColumn): Any? { + return when (column.type) { + is TableColumnType.Boolean -> getBoolean(column.name) + is TableColumnType.Int -> getInt(column.name) + is TableColumnType.Long -> getLong(column.name) + is TableColumnType.Float -> getFloat(column.name) + is TableColumnType.Double -> getDouble(column.name) + is TableColumnType.String -> getString(column.name) + is TableColumnType.UUID -> getUUID(column.name) + is TableColumnType.Instant -> getInstant(column.name) + is TableColumnType.Duration -> getDuration(column.name) + is TableColumnType.List -> getList(column.name, Any::class.java) + is TableColumnType.Set -> getSet(column.name, Any::class.java) + is TableColumnType.Map -> getMap(column.name, Any::class.java, Any::class.java) + } + } +} diff --git a/opendc-trace/opendc-trace-testkit/src/main/kotlin/org/opendc/trace/testkit/TableWriterTestKit.kt b/opendc-trace/opendc-trace-testkit/src/main/kotlin/org/opendc/trace/testkit/TableWriterTestKit.kt new file mode 100644 index 00000000..fab992f0 --- /dev/null +++ b/opendc-trace/opendc-trace-testkit/src/main/kotlin/org/opendc/trace/testkit/TableWriterTestKit.kt @@ -0,0 +1,130 @@ +/* + * 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.trace.testkit + +import org.junit.jupiter.api.AfterEach +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.assertAll +import org.junit.jupiter.api.assertThrows +import org.opendc.trace.TableColumn +import org.opendc.trace.TableColumnType +import org.opendc.trace.TableWriter +import java.time.Duration +import java.time.Instant +import java.util.* + +/** + * A test suite for implementations of the [TableWriter] interface. + */ +public abstract class TableWriterTestKit { + /** + * The [TableWriter] instance to test. + */ + public abstract val writer: TableWriter + + /** + * The columns of the table. + */ + public abstract val columns: List<TableColumn> + + @AfterEach + public fun tearDown() { + writer.close() + } + + /** + * Test that we can resolve the columns of a table successfully. + */ + @Test + public fun testResolve() { + assertAll(columns.map { column -> { assertNotEquals(-1, writer.resolve(column.name)) } }) + } + + /** + * Test that resolving an empty column name fails + */ + @Test + public fun testResolveEmpty() { + assertEquals(-1, writer.resolve("")) + } + + /** + * Test that writing non-existent columns fails. + */ + @Test + public fun testWriteNonExistentColumns() { + writer.startRow() + assertAll( + { assertThrows<IllegalArgumentException> { writer.setBoolean(-1, false) } }, + { assertThrows<IllegalArgumentException> { writer.setInt(-1, 1) } }, + { assertThrows<IllegalArgumentException> { writer.setLong(-1, 1) } }, + { assertThrows<IllegalArgumentException> { writer.setFloat(-1, 1f) } }, + { assertThrows<IllegalArgumentException> { writer.setDouble(-1, 1.0) } }, + { assertThrows<IllegalArgumentException> { writer.setString(-1, "test") } }, + { assertThrows<IllegalArgumentException> { writer.setUUID(-1, UUID.randomUUID()) } }, + { assertThrows<IllegalArgumentException> { writer.setInstant(-1, Instant.now()) } }, + { assertThrows<IllegalArgumentException> { writer.setDuration(-1, Duration.ofMinutes(5)) } }, + { assertThrows<IllegalArgumentException> { writer.setList(-1, listOf("test")) } }, + { assertThrows<IllegalArgumentException> { writer.setSet(-1, setOf("test")) } }, + { assertThrows<IllegalArgumentException> { writer.setMap(-1, mapOf("test" to "test")) } }, + ) + } + + /** + * Test that writing columns without a row fails. + */ + @Test + public fun testWriteWithoutRow() { + assertAll( + columns.map { column -> + { + assertThrows<IllegalStateException> { + when (column.type) { + is TableColumnType.Boolean -> writer.setBoolean(column.name, true) + is TableColumnType.Int -> writer.setInt(column.name, 21) + is TableColumnType.Long -> writer.setLong(column.name, 21) + is TableColumnType.Float -> writer.setFloat(column.name, 42f) + is TableColumnType.Double -> writer.setDouble(column.name, 42.0) + is TableColumnType.String -> writer.setString(column.name, "test") + is TableColumnType.UUID -> writer.setUUID(column.name, UUID.randomUUID()) + is TableColumnType.Instant -> writer.setInstant(column.name, Instant.now()) + is TableColumnType.Duration -> writer.setDuration(column.name, Duration.ofMinutes(5)) + is TableColumnType.List -> writer.setList(column.name, emptyList<String>()) + is TableColumnType.Set -> writer.setSet(column.name, emptySet<String>()) + is TableColumnType.Map -> writer.setMap(column.name, emptyMap<String, String>()) + } + } + } + } + ) + } + + /** + * Test to verify we cannot end a row without starting it. + */ + @Test + public fun testEndRowWithoutStart() { + assertThrows<IllegalStateException> { writer.endRow() } + } +} diff --git a/opendc-trace/opendc-trace-wfformat/build.gradle.kts b/opendc-trace/opendc-trace-wfformat/build.gradle.kts index 875f7915..a0e22b16 100644 --- a/opendc-trace/opendc-trace-wfformat/build.gradle.kts +++ b/opendc-trace/opendc-trace-wfformat/build.gradle.kts @@ -31,4 +31,6 @@ dependencies { api(projects.opendcTrace.opendcTraceApi) implementation(libs.jackson.core) + + testImplementation(projects.opendcTrace.opendcTraceTestkit) } diff --git a/opendc-trace/opendc-trace-wfformat/src/main/kotlin/org/opendc/trace/wfformat/WfFormatTaskTableReader.kt b/opendc-trace/opendc-trace-wfformat/src/main/kotlin/org/opendc/trace/wfformat/WfFormatTaskTableReader.kt index 0be9dec6..ca1a29d0 100644 --- a/opendc-trace/opendc-trace-wfformat/src/main/kotlin/org/opendc/trace/wfformat/WfFormatTaskTableReader.kt +++ b/opendc-trace/opendc-trace-wfformat/src/main/kotlin/org/opendc/trace/wfformat/WfFormatTaskTableReader.kt @@ -54,6 +54,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe // Check whether the document is not empty and starts with an object if (token == null) { + parser.close() break } else if (token != JsonToken.START_OBJECT) { throw JsonParseException(parser, "Expected object", parser.currentLocation) @@ -64,6 +65,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe ParserLevel.TRACE -> { // Seek for the workflow object in the file if (!seekWorkflow()) { + parser.close() break } else if (!parser.isExpectedStartObjectToken) { throw JsonParseException(parser, "Expected object", parser.currentLocation) @@ -111,7 +113,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe } override fun isNull(index: Int): Boolean { - check(index in 0..COL_CHILDREN) { "Invalid column value" } + require(index in 0..COL_CHILDREN) { "Invalid column value" } return false } @@ -120,6 +122,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe } override fun getInt(index: Int): Int { + checkActive() return when (index) { COL_NPROC -> cores else -> throw IllegalArgumentException("Invalid column") @@ -139,6 +142,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe } override fun getString(index: Int): String? { + checkActive() return when (index) { COL_ID -> id COL_WORKFLOW_ID -> workflowId @@ -155,6 +159,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe } override fun getDuration(index: Int): Duration? { + checkActive() return when (index) { COL_RUNTIME -> runtime else -> throw IllegalArgumentException("Invalid column") @@ -166,6 +171,7 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe } override fun <T> getSet(index: Int, elementType: Class<T>): Set<T>? { + checkActive() return when (index) { COL_PARENTS -> TYPE_PARENTS.convertTo(parents, elementType) COL_CHILDREN -> TYPE_CHILDREN.convertTo(children, elementType) @@ -182,10 +188,17 @@ internal class WfFormatTaskTableReader(private val parser: JsonParser) : TableRe } /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(level != ParserLevel.TOP && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + + /** * Parse the trace and seek until the workflow description. */ private fun seekWorkflow(): Boolean { - while (parser.nextValue() != JsonToken.END_OBJECT) { + while (parser.nextValue() != JsonToken.END_OBJECT && !parser.isClosed) { when (parser.currentName) { "name" -> workflowId = parser.text "workflow" -> return true diff --git a/opendc-trace/opendc-trace-wfformat/src/test/kotlin/org/opendc/trace/wfformat/WfFormatTraceFormatTest.kt b/opendc-trace/opendc-trace-wfformat/src/test/kotlin/org/opendc/trace/wfformat/WfFormatTraceFormatTest.kt index a460c5f6..40506d59 100644 --- a/opendc-trace/opendc-trace-wfformat/src/test/kotlin/org/opendc/trace/wfformat/WfFormatTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-wfformat/src/test/kotlin/org/opendc/trace/wfformat/WfFormatTraceFormatTest.kt @@ -22,17 +22,20 @@ package org.opendc.trace.wfformat -import org.junit.jupiter.api.Assertions +import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* -import org.junit.jupiter.api.Test +import org.junit.jupiter.api.Assertions.assertAll import org.junit.jupiter.api.assertDoesNotThrow -import org.junit.jupiter.api.assertThrows +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths /** * Test suite for the [WfFormatTraceFormat] class. */ +@DisplayName("WfFormat TraceFormat") class WfFormatTraceFormatTest { private val format = WfFormatTraceFormat() @@ -98,4 +101,19 @@ class WfFormatTraceFormatTest { reader.close() } } + + @DisplayName("TableReader for Tasks") + @Nested + inner class TasksTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace.json") + + columns = format.getDetails(path, TABLE_TASKS).columns + reader = format.newReader(path, TABLE_TASKS, null) + } + } } diff --git a/opendc-trace/opendc-trace-wtf/build.gradle.kts b/opendc-trace/opendc-trace-wtf/build.gradle.kts index 35eb32e5..599087e1 100644 --- a/opendc-trace/opendc-trace-wtf/build.gradle.kts +++ b/opendc-trace/opendc-trace-wtf/build.gradle.kts @@ -32,5 +32,6 @@ dependencies { implementation(projects.opendcTrace.opendcTraceParquet) + testImplementation(projects.opendcTrace.opendcTraceTestkit) testRuntimeOnly(libs.slf4j.simple) } diff --git a/opendc-trace/opendc-trace-wtf/src/main/kotlin/org/opendc/trace/wtf/WtfTaskTableReader.kt b/opendc-trace/opendc-trace-wtf/src/main/kotlin/org/opendc/trace/wtf/WtfTaskTableReader.kt index bb5eb668..7d2005b2 100644 --- a/opendc-trace/opendc-trace-wtf/src/main/kotlin/org/opendc/trace/wtf/WtfTaskTableReader.kt +++ b/opendc-trace/opendc-trace-wtf/src/main/kotlin/org/opendc/trace/wtf/WtfTaskTableReader.kt @@ -83,7 +83,7 @@ internal class WtfTaskTableReader(private val reader: LocalParquetReader<Task>) } override fun isNull(index: Int): Boolean { - check(index in COL_ID..COL_USER_ID) { "Invalid column index" } + require(index in COL_ID..COL_USER_ID) { "Invalid column index" } return false } diff --git a/opendc-trace/opendc-trace-wtf/src/test/kotlin/org/opendc/trace/wtf/WtfTraceFormatTest.kt b/opendc-trace/opendc-trace-wtf/src/test/kotlin/org/opendc/trace/wtf/WtfTraceFormatTest.kt index 2312035a..f6b821c2 100644 --- a/opendc-trace/opendc-trace-wtf/src/test/kotlin/org/opendc/trace/wtf/WtfTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-wtf/src/test/kotlin/org/opendc/trace/wtf/WtfTraceFormatTest.kt @@ -22,10 +22,13 @@ package org.opendc.trace.wtf +import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows +import org.junit.jupiter.api.Assertions.assertAll +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths import java.time.Duration import java.time.Instant @@ -33,6 +36,7 @@ import java.time.Instant /** * Test suite for the [WtfTraceFormat] class. */ +@DisplayName("WTF TraceFormat") class WtfTraceFormatTest { private val format = WtfTraceFormat() @@ -93,4 +97,19 @@ class WtfTraceFormatTest { reader.close() } + + @DisplayName("TableReader for Tasks") + @Nested + inner class TasksTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/wtf-trace") + + columns = format.getDetails(path, TABLE_TASKS).columns + reader = format.newReader(path, TABLE_TASKS, null) + } + } } diff --git a/settings.gradle.kts b/settings.gradle.kts index 88c3ffb6..170267a5 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -50,6 +50,7 @@ include(":opendc-simulator:opendc-simulator-power") include(":opendc-simulator:opendc-simulator-network") include(":opendc-simulator:opendc-simulator-compute") include(":opendc-trace:opendc-trace-api") +include(":opendc-trace:opendc-trace-testkit") include(":opendc-trace:opendc-trace-gwf") include(":opendc-trace:opendc-trace-swf") include(":opendc-trace:opendc-trace-wtf") |