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.

5 files changed, 125 insertions, 10 deletions

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