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.

4 files changed, 52 insertions, 4 deletions

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