test(trace): Add conformance suite for OpenDC trace API

This change adds a re-usable test suite for the interface of the OpenDC
trace API, so implementors can verify whether they match the
specification of the interfaces.

6 files changed, 154 insertions, 6 deletions

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)
+        }
+    }
 }