feat(trace): Add support for extended Bitbrains trace format

This change adds support in the trace library for the extended Bitbrains
format. This format is slightly different than the CSV format used by
the original Bitbrains traces and contains more fields.

8 files changed, 115 insertions, 18 deletions

diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt
index bae7cb22..02666cc7 100644
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt
+++ b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt
@@ -37,8 +37,8 @@ import org.apache.parquet.hadoop.metadata.CompressionCodecName
 import org.opendc.compute.workload.trace.azure.AzureTraceFormat
 import org.opendc.compute.workload.trace.bp.BP_RESOURCES_SCHEMA
 import org.opendc.compute.workload.trace.bp.BP_RESOURCE_STATES_SCHEMA
-import org.opendc.compute.workload.trace.sv.SvTraceFormat
 import org.opendc.trace.*
+import org.opendc.trace.bitbrains.BitbrainsExTraceFormat
 import org.opendc.trace.bitbrains.BitbrainsTraceFormat
 import org.opendc.trace.util.parquet.LocalOutputFile
 import java.io.File
@@ -79,7 +79,7 @@ internal class TraceConverterCli : CliktCommand(name = "trace-converter") {
      */
     private val format by option("-f", "--format", help = "input format of trace")
         .choice(
-            "solvinity" to SvTraceFormat(),
+            "solvinity" to BitbrainsExTraceFormat(),
             "bitbrains" to BitbrainsTraceFormat(),
             "azure" to AzureTraceFormat()
         )
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTable.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTable.kt
index 3ff69d36..4db2bace 100644
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTable.kt
+++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTable.kt
@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-package org.opendc.compute.workload.trace.sv
+package org.opendc.trace.bitbrains
 
 import org.opendc.trace.*
 import java.nio.file.Files
@@ -33,7 +33,7 @@ import kotlin.io.path.nameWithoutExtension
 /**
  * The resource state [Table] in the extended Bitbrains format.
  */
-internal class SvResourceStateTable(path: Path) : Table {
+internal class BitbrainsExResourceStateTable(path: Path) : Table {
     /**
      * The partitions that belong to the table.
      */
@@ -118,7 +118,7 @@ internal class SvResourceStateTable(path: Path) : Table {
                 return if (it.hasNext()) {
                     val (_, path) = it.next()
                     val reader = path.bufferedReader()
-                    return SvResourceStateTableReader(reader)
+                    return BitbrainsExResourceStateTableReader(reader)
                 } else {
                     null
                 }
@@ -131,8 +131,8 @@ internal class SvResourceStateTable(path: Path) : Table {
     override fun newReader(partition: String): TableReader {
         val path = requireNotNull(partitions[partition]) { "Invalid partition $partition" }
         val reader = path.bufferedReader()
-        return SvResourceStateTableReader(reader)
+        return BitbrainsExResourceStateTableReader(reader)
     }
 
-    override fun toString(): String = "SvResourceStateTable"
+    override fun toString(): String = "BitbrainsExResourceStateTable"
 }
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTableReader.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTableReader.kt
index 487be950..6fe5d397 100644
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTableReader.kt
+++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExResourceStateTableReader.kt
@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-package org.opendc.compute.workload.trace.sv
+package org.opendc.trace.bitbrains
 
 import org.opendc.trace.*
 import java.io.BufferedReader
@@ -29,7 +29,7 @@ import java.time.Instant
 /**
  * A [TableReader] for the Bitbrains resource state table.
  */
-internal class SvResourceStateTableReader(private val reader: BufferedReader) : TableReader {
+internal class BitbrainsExResourceStateTableReader(private val reader: BufferedReader) : TableReader {
     override fun nextRow(): Boolean {
         reset()
 
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTrace.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExTrace.kt
index 932c73ab..f16c493d 100644
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTrace.kt
+++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExTrace.kt
@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-package org.opendc.compute.workload.trace.sv
+package org.opendc.trace.bitbrains
 
 import org.opendc.trace.*
 import java.nio.file.Path
@@ -28,7 +28,7 @@ import java.nio.file.Path
 /**
  * [Trace] implementation for the extended Bitbrains format.
  */
-public class SvTrace internal constructor(private val path: Path) : Trace {
+public class BitbrainsExTrace internal constructor(private val path: Path) : Trace {
     override val tables: List<String> = listOf(TABLE_RESOURCE_STATES)
 
     override fun containsTable(name: String): Boolean = TABLE_RESOURCE_STATES == name
@@ -38,8 +38,8 @@ public class SvTrace internal constructor(private val path: Path) : Trace {
             return null
         }
 
-        return SvResourceStateTable(path)
+        return BitbrainsExResourceStateTable(path)
     }
 
-    override fun toString(): String = "SvTrace[$path]"
+    override fun toString(): String = "BitbrainsExTrace[$path]"
 }
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTraceFormat.kt b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormat.kt
index ba673b5f..06388a84 100644
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTraceFormat.kt
+++ b/opendc-trace/opendc-trace-bitbrains/src/main/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormat.kt
@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-package org.opendc.compute.workload.trace.sv
+package org.opendc.trace.bitbrains
 
 import org.opendc.trace.spi.TraceFormat
 import java.net.URL
@@ -30,18 +30,18 @@ import kotlin.io.path.exists
 /**
  * A format implementation for the extended Bitbrains trace format.
  */
-public class SvTraceFormat : TraceFormat {
+public class BitbrainsExTraceFormat : TraceFormat {
     /**
      * The name of this trace format.
      */
-    override val name: String = "sv"
+    override val name: String = "bitbrains-ex"
 
     /**
      * Open the trace file.
      */
-    override fun open(url: URL): SvTrace {
+    override fun open(url: URL): BitbrainsExTrace {
         val path = Paths.get(url.toURI())
         require(path.exists()) { "URL $url does not exist" }
-        return SvTrace(path)
+        return BitbrainsExTrace(path)
     }
 }
diff --git a/opendc-trace/opendc-trace-bitbrains/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat b/opendc-trace/opendc-trace-bitbrains/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
index f18135d0..fd6a2180 100644
--- a/opendc-trace/opendc-trace-bitbrains/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
+++ b/opendc-trace/opendc-trace-bitbrains/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
@@ -1 +1,2 @@
 org.opendc.trace.bitbrains.BitbrainsTraceFormat
+org.opendc.trace.bitbrains.BitbrainsExTraceFormat
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
new file mode 100644
index 00000000..2e4f176a
--- /dev/null
+++ b/opendc-trace/opendc-trace-bitbrains/src/test/kotlin/org/opendc/trace/bitbrains/BitbrainsExTraceFormatTest.kt
@@ -0,0 +1,94 @@
+/*
+ * 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.bitbrains
+
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+import org.opendc.trace.*
+import java.net.URL
+
+/**
+ * Test suite for the [BitbrainsExTraceFormat] class.
+ */
+class BitbrainsExTraceFormatTest {
+    private val format = BitbrainsExTraceFormat()
+
+    @Test
+    fun testTraceExists() {
+        val url = checkNotNull(BitbrainsExTraceFormatTest::class.java.getResource("/vm.txt"))
+        assertDoesNotThrow {
+            format.open(url)
+        }
+    }
+
+    @Test
+    fun testTraceDoesNotExists() {
+        val url = checkNotNull(BitbrainsExTraceFormatTest::class.java.getResource("/vm.txt"))
+        assertThrows<IllegalArgumentException> {
+            format.open(URL(url.toString() + "help"))
+        }
+    }
+
+    @Test
+    fun testTables() {
+        val url = checkNotNull(BitbrainsExTraceFormatTest::class.java.getResource("/vm.txt"))
+        val trace = format.open(url)
+
+        assertEquals(listOf(TABLE_RESOURCE_STATES), trace.tables)
+    }
+
+    @Test
+    fun testTableExists() {
+        val url = checkNotNull(BitbrainsExTraceFormatTest::class.java.getResource("/vm.txt"))
+        val table = format.open(url).getTable(TABLE_RESOURCE_STATES)
+
+        assertNotNull(table)
+        assertDoesNotThrow { table!!.newReader() }
+    }
+
+    @Test
+    fun testTableDoesNotExist() {
+        val url = checkNotNull(BitbrainsExTraceFormatTest::class.java.getResource("/vm.txt"))
+        val trace = format.open(url)
+
+        assertFalse(trace.containsTable("test"))
+        assertNull(trace.getTable("test"))
+    }
+
+    @Test
+    fun testSmoke() {
+        val url = checkNotNull(BitbrainsExTraceFormatTest::class.java.getResource("/vm.txt"))
+        val trace = format.open(url)
+
+        val reader = trace.getTable(TABLE_RESOURCE_STATES)!!.newReader()
+
+        assertAll(
+            { assertTrue(reader.nextRow()) },
+            { assertEquals(1631911500, reader.get(RESOURCE_STATE_TIMESTAMP).epochSecond) },
+            { assertEquals(21.2, reader.getDouble(RESOURCE_STATE_CPU_USAGE), 0.01) }
+        )
+
+        reader.close()
+    }
+}
diff --git a/opendc-trace/opendc-trace-bitbrains/src/test/resources/vm.txt b/opendc-trace/opendc-trace-bitbrains/src/test/resources/vm.txt
new file mode 100644
index 00000000..28bebb0c
--- /dev/null
+++ b/opendc-trace/opendc-trace-bitbrains/src/test/resources/vm.txt
@@ -0,0 +1,2 @@
+1631911500    21.2    22.10    0.0    0.0    0.67    1.2    0.0    0.0    5    1    abc    1    0.01    1    10    0.0    0.0  2699    vm    4096
+1631911800    30.4    31.80    0.0    0.0    0.56    1.3    0.0    0.0    5    1    abc    1    0.02    1    10    0.0    0.0    2699    vm    4096