refactor(trace): Move GWF trace reader into separate module

This change starts the process of moving the different trace formats into
separate modules. This change in particular moves the GWF trace format
into a new module, opendc-trace-gwf.

Furthermore, this change also implements the trace API for the GWF
module.

2 files changed, 180 insertions, 0 deletions

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
new file mode 100644
index 00000000..6b0568fe
--- /dev/null
+++ b/opendc-trace/opendc-trace-gwf/src/test/kotlin/org/opendc/trace/gwf/GwfTraceFormatTest.kt
@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.trace.gwf
+
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertAll
+import org.junit.jupiter.api.assertDoesNotThrow
+import org.junit.jupiter.api.assertThrows
+import org.opendc.trace.*
+import java.net.URL
+
+/**
+ * Test suite for the [GwfTraceFormat] class.
+ */
+internal class GwfTraceFormatTest {
+    @Test
+    fun testTraceExists() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        assertDoesNotThrow {
+            format.open(input)
+        }
+    }
+
+    @Test
+    fun testTraceDoesNotExists() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        assertThrows<IllegalArgumentException> {
+            format.open(URL(input.toString() + "help"))
+        }
+    }
+
+    @Test
+    fun testTables() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        val trace = format.open(input)
+
+        assertEquals(listOf(TABLE_TASKS), trace.tables)
+    }
+
+    @Test
+    fun testTableExists() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        val table = format.open(input).getTable(TABLE_TASKS)
+
+        assertNotNull(table)
+        assertDoesNotThrow { table!!.newReader() }
+    }
+
+    @Test
+    fun testTableDoesNotExist() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        val trace = format.open(input)
+
+        assertFalse(trace.containsTable("test"))
+        assertNull(trace.getTable("test"))
+    }
+
+    @Test
+    fun testTableReader() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        val table = format.open(input).getTable(TABLE_TASKS)!!
+        val reader = table.newReader()
+
+        assertAll(
+            { assertTrue(reader.nextRow()) },
+            { assertEquals(0L, reader.getLong(TASK_WORKFLOW_ID)) },
+            { assertEquals(1L, reader.getLong(TASK_ID)) },
+            { assertEquals(16, reader.getLong(TASK_SUBMIT_TIME)) },
+            { assertEquals(11, reader.getLong(TASK_RUNTIME)) },
+            { assertEquals(setOf<Long>(), reader.get(TASK_PARENTS)) },
+        )
+    }
+
+    @Test
+    fun testTableReaderPartition() {
+        val input = checkNotNull(GwfTraceFormatTest::class.java.getResource("/trace.gwf"))
+        val format = GwfTraceFormat()
+        val table = format.open(input).getTable(TABLE_TASKS)!!
+
+        assertThrows<IllegalArgumentException> { table.newReader("test") }
+    }
+}
diff --git a/opendc-trace/opendc-trace-gwf/src/test/resources/trace.gwf b/opendc-trace/opendc-trace-gwf/src/test/resources/trace.gwf
new file mode 100644
index 00000000..2f99616d
--- /dev/null
+++ b/opendc-trace/opendc-trace-gwf/src/test/resources/trace.gwf
@@ -0,0 +1,71 @@
+WorkflowID, JobID     , SubmitTime, RunTime   , NProcs    , ReqNProcs , Dependencies
+0         , 1         , 16        , 11        , 1         , 1         ,           
+0         , 2         , 40        , 11        , 1         , 1         , 1         
+0         , 3         , 40        , 11        , 1         , 1         , 1         
+0         , 4         , 64        , 11        , 1         , 1         , 2         
+0         , 5         , 63        , 11        , 1         , 1         , 3         
+0         , 6         , 64        , 11        , 1         , 1         , 3         
+0         , 7         , 87        , 11        , 1         , 1         , 4 5 6     
+1         , 8         , 4         , 11        , 1         , 1         ,           
+1         , 9         , 15        , 11        , 1         , 1         , 8         
+1         , 10        , 15        , 11        , 1         , 1         , 8         
+1         , 11        , 27        , 11        , 1         , 1         , 9         
+1         , 12        , 27        , 11        , 1         , 1         , 10        
+1         , 13        , 27        , 11        , 1         , 1         , 10        
+1         , 14        , 38        , 11        , 1         , 1         , 12 11 13  
+2         , 15        , 3         , 11        , 1         , 1         ,           
+2         , 16        , 27        , 11        , 1         , 1         , 15        
+2         , 17        , 27        , 11        , 1         , 1         , 15        
+2         , 18        , 52        , 11        , 1         , 1         , 16        
+2         , 19        , 51        , 11        , 1         , 1         , 17        
+2         , 20        , 51        , 11        , 1         , 1         , 17        
+2         , 21        , 75        , 11        , 1         , 1         , 20 18 19  
+3         , 22        , 3         , 11        , 1         , 1         ,           
+3         , 23        , 27        , 11        , 1         , 1         , 22        
+3         , 24        , 27        , 11        , 1         , 1         , 22        
+3         , 25        , 51        , 11        , 1         , 1         , 23        
+3         , 26        , 50        , 11        , 1         , 1         , 24        
+3         , 27        , 51        , 11        , 1         , 1         , 24        
+3         , 28        , 75        , 11        , 1         , 1         , 25 27 26  
+4         , 29        , 3         , 11        , 1         , 1         ,           
+4         , 30        , 27        , 11        , 1         , 1         , 29        
+4         , 31        , 27        , 11        , 1         , 1         , 29        
+4         , 32        , 50        , 11        , 1         , 1         , 30        
+4         , 33        , 50        , 11        , 1         , 1         , 31        
+4         , 34        , 51        , 11        , 1         , 1         , 31        
+4         , 35        , 74        , 11        , 1         , 1         , 33 32 34  
+5         , 36        , 3         , 11        , 1         , 1         ,           
+5         , 37        , 27        , 11        , 1         , 1         , 36        
+5         , 38        , 26        , 11        , 1         , 1         , 36        
+5         , 39        , 51        , 11        , 1         , 1         , 37        
+5         , 40        , 50        , 11        , 1         , 1         , 38        
+5         , 41        , 50        , 11        , 1         , 1         , 38        
+5         , 42        , 74        , 11        , 1         , 1         , 39 40 41  
+6         , 43        , 4         , 11        , 1         , 1         ,           
+6         , 44        , 27        , 11        , 1         , 1         , 43        
+6         , 45        , 27        , 11        , 1         , 1         , 43        
+6         , 46        , 51        , 11        , 1         , 1         , 44        
+6         , 47        , 51        , 11        , 1         , 1         , 45        
+6         , 48        , 51        , 11        , 1         , 1         , 45        
+6         , 49        , 75        , 11        , 1         , 1         , 46 47 48  
+7         , 50        , 3         , 0         , 1         , 1         ,           
+7         , 51        , 17        , 0         , 1         , 1         , 50        
+7         , 52        , 17        , 0         , 1         , 1         , 50        
+7         , 53        , 30        , 0         , 1         , 1         , 51        
+7         , 54        , 30        , 0         , 1         , 1         , 52        
+7         , 55        , 31        , 0         , 1         , 1         , 52        
+7         , 56        , 44        , 0         , 1         , 1         , 55 54 53  
+8         , 57        , 3         , 11        , 1         , 1         ,           
+8         , 58        , 26        , 11        , 1         , 1         , 57        
+8         , 59        , 27        , 11        , 1         , 1         , 57        
+8         , 60        , 50        , 11        , 1         , 1         , 58        
+8         , 61        , 51        , 11        , 1         , 1         , 59        
+8         , 62        , 50        , 11        , 1         , 1         , 59        
+8         , 63        , 74        , 11        , 1         , 1         , 62 61 60  
+9         , 64        , 3         , 11        , 1         , 1         ,           
+9         , 65        , 27        , 11        , 1         , 1         , 64        
+9         , 66        , 27        , 11        , 1         , 1         , 64        
+9         , 67        , 51        , 11        , 1         , 1         , 65        
+9         , 68        , 50        , 11        , 1         , 1         , 66        
+9         , 69        , 51        , 11        , 1         , 1         , 66        
+9         , 70        , 74        , 11        , 1         , 1         , 68 69 67