merge: Add support for SQL via Apache Calcite (#78)

This pull request integrates initial support for SQL queries via Apache Calcite into the OpenDC codebase. 
Our vision is that users of OpenDC should be able to use SQL queries to access and process most 
of the experiment data generated by simulations.

This pull request moves towards this goal by adding the ability to query workload traces supported 
by OpenDC using SQL. We also provide a CLI for querying the data in workload traces via `opendc-trace-tools`:

```bash
opendc-trace-tools query -i data/bitbrains-small  -f opendc-vm "SELECT MAX(cpu_count) FROM resource_states"
```

## Implementation Notes :hammer_and_pick:

* Add Calcite (SQL) integration
* Add support for writing via SQL 
* Add support for writing via SQL 
* Support custom Parquet ReadSupport implementations
* Read records using low-level Parquet API 
* Do not use Avro when exporting experiment data
* Do not use Avro when reading WTF trace
* Drop dependency on Avro
* Add support for projections

## External Dependencies :four_leaf_clover:

* Apache Calcite

## Breaking API Changes :warning:

* The existing code for reading Parquet traces using Apache Avro has been removed.
* `TraceFormat.newReader` now accepts a nullable `projection` parameter 

6 files changed, 271 insertions, 0 deletions

diff --git a/opendc-trace/opendc-trace-calcite/src/test/kotlin/org/opendc/trace/calcite/CalciteTest.kt b/opendc-trace/opendc-trace-calcite/src/test/kotlin/org/opendc/trace/calcite/CalciteTest.kt
new file mode 100644
index 00000000..d2877d7c
--- /dev/null
+++ b/opendc-trace/opendc-trace-calcite/src/test/kotlin/org/opendc/trace/calcite/CalciteTest.kt
@@ -0,0 +1,158 @@
+/*
+ * Copyright (c) 2022 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.calcite
+
+import org.apache.calcite.jdbc.CalciteConnection
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+import org.opendc.trace.Trace
+import java.nio.file.Files
+import java.nio.file.Paths
+import java.sql.DriverManager
+import java.sql.ResultSet
+import java.sql.Statement
+import java.sql.Timestamp
+import java.util.*
+
+/**
+ * Smoke test for Apache Calcite integration.
+ */
+class CalciteTest {
+    /**
+     * The trace to experiment with.
+     */
+    private val trace = Trace.open(Paths.get("src/test/resources/trace"), format = "opendc-vm")
+
+    @Test
+    fun testResources() {
+        runQuery(trace, "SELECT * FROM trace.resources") { rs ->
+            assertAll(
+                { assertTrue(rs.next()) },
+                { assertEquals("1019", rs.getString("id")) },
+                { assertEquals(1, rs.getInt("cpu_count")) },
+                { assertEquals(Timestamp.valueOf("2013-08-12 13:40:46.0"), rs.getTimestamp("start_time")) },
+                { assertEquals(181352.0, rs.getDouble("mem_capacity")) },
+                { assertTrue(rs.next()) },
+                { assertEquals("1023", rs.getString("id")) },
+                { assertTrue(rs.next()) },
+                { assertEquals("1052", rs.getString("id")) },
+                { assertTrue(rs.next()) },
+                { assertEquals("1073", rs.getString("id")) },
+                { assertFalse(rs.next()) }
+            )
+        }
+    }
+
+    @Test
+    fun testResourceStates() {
+        runQuery(trace, "SELECT * FROM trace.resource_states") { rs ->
+            assertAll(
+                { assertTrue(rs.next()) },
+                { assertEquals("1019", rs.getString("id")) },
+                { assertEquals(Timestamp.valueOf("2013-08-12 13:40:46.0"), rs.getTimestamp("timestamp")) },
+                { assertEquals(300000, rs.getLong("duration")) },
+                { assertEquals(0.0, rs.getDouble("cpu_usage")) },
+                { assertTrue(rs.next()) },
+                { assertEquals("1019", rs.getString("id")) },
+            )
+        }
+    }
+
+    @Test
+    fun testInterferenceGroups() {
+        runQuery(trace, "SELECT * FROM trace.interference_groups") { rs ->
+            assertAll(
+                { assertTrue(rs.next()) },
+                { assertArrayEquals(arrayOf("1019", "1023", "1052"), rs.getArray("members").array as Array<*>) },
+                { assertEquals(0.0, rs.getDouble("target")) },
+                { assertEquals(0.8830158730158756, rs.getDouble("score")) },
+            )
+        }
+    }
+
+    @Test
+    fun testComplexQuery() {
+        runQuery(trace, "SELECT max(cpu_usage) as max_cpu_usage, avg(cpu_usage) as avg_cpu_usage FROM trace.resource_states") { rs ->
+            assertAll(
+                { assertTrue(rs.next()) },
+                { assertEquals(249.59993808, rs.getDouble("max_cpu_usage")) },
+                { assertEquals(5.387240309118493, rs.getDouble("avg_cpu_usage")) },
+            )
+        }
+    }
+
+    @Test
+    fun testInsert() {
+        val tmp = Files.createTempDirectory("opendc")
+        val newTrace = Trace.create(tmp, "opendc-vm")
+
+        runStatement(newTrace) { stmt ->
+            val count = stmt.executeUpdate(
+                """
+                INSERT INTO trace.resources (id, start_time, stop_time, cpu_count, cpu_capacity, mem_capacity)
+                VALUES (1234, '2013-08-12 13:35:46.0', '2013-09-11 13:39:58.0', 1, 2926.0, 1024.0)
+                """.trimIndent()
+            )
+            assertEquals(1, count)
+        }
+
+        runQuery(newTrace, "SELECT * FROM trace.resources") { rs ->
+            assertAll(
+                { assertTrue(rs.next()) },
+                { assertEquals("1234", rs.getString("id")) },
+                { assertEquals(1, rs.getInt("cpu_count")) },
+                { assertEquals(Timestamp.valueOf("2013-08-12 13:35:46.0"), rs.getTimestamp("start_time")) },
+                { assertEquals(2926.0, rs.getDouble("cpu_capacity")) },
+                { assertEquals(1024.0, rs.getDouble("mem_capacity")) }
+            )
+        }
+    }
+
+    /**
+     * Helper function to run statement for the specified trace.
+     */
+    private fun runQuery(trace: Trace, query: String, block: (ResultSet) -> Unit) {
+        runStatement(trace) { stmt ->
+            val rs = stmt.executeQuery(query)
+            rs.use { block(rs) }
+        }
+    }
+
+    /**
+     * Helper function to run statement for the specified trace.
+     */
+    private fun runStatement(trace: Trace, block: (Statement) -> Unit) {
+        val info = Properties()
+        info.setProperty("lex", "JAVA")
+        val connection = DriverManager.getConnection("jdbc:calcite:", info).unwrap(CalciteConnection::class.java)
+        connection.rootSchema.add("trace", TraceSchema(trace))
+
+        val stmt = connection.createStatement()
+        try {
+            block(stmt)
+        } finally {
+            stmt.close()
+            connection.close()
+        }
+    }
+}
diff --git a/opendc-trace/opendc-trace-calcite/src/test/kotlin/org/opendc/trace/calcite/TraceSchemaFactoryTest.kt b/opendc-trace/opendc-trace-calcite/src/test/kotlin/org/opendc/trace/calcite/TraceSchemaFactoryTest.kt
new file mode 100644
index 00000000..0a552e74
--- /dev/null
+++ b/opendc-trace/opendc-trace-calcite/src/test/kotlin/org/opendc/trace/calcite/TraceSchemaFactoryTest.kt
@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2022 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.calcite
+
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+import java.sql.DriverManager
+import java.sql.Timestamp
+import java.util.*
+
+/**
+ * Test suite for [TraceSchemaFactory].
+ */
+class TraceSchemaFactoryTest {
+    @Test
+    fun testSmoke() {
+        val info = Properties()
+        info.setProperty("lex", "JAVA")
+        val connection = DriverManager.getConnection("jdbc:calcite:model=src/test/resources/model.json", info)
+        val stmt = connection.createStatement()
+        val rs = stmt.executeQuery("SELECT * FROM trace.resources")
+        try {
+            assertAll(
+                { assertTrue(rs.next()) },
+                { assertEquals("1019", rs.getString("id")) },
+                { assertEquals(1, rs.getInt("cpu_count")) },
+                { assertEquals(Timestamp.valueOf("2013-08-12 13:40:46.0"), rs.getTimestamp("start_time")) },
+                { assertEquals(181352.0, rs.getDouble("mem_capacity")) },
+            )
+        } finally {
+            rs.close()
+            stmt.close()
+            connection.close()
+        }
+    }
+
+    @Test
+    fun testWithoutParams() {
+        assertThrows<java.lang.RuntimeException> {
+            DriverManager.getConnection("jdbc:calcite:schemaFactory=org.opendc.trace.calcite.TraceSchemaFactory")
+        }
+    }
+
+    @Test
+    fun testWithoutPath() {
+        assertThrows<java.lang.RuntimeException> {
+            DriverManager.getConnection("jdbc:calcite:schemaFactory=org.opendc.trace.calcite.TraceSchemaFactory; schema.format=opendc-vm")
+        }
+    }
+
+    @Test
+    fun testWithoutFormat() {
+        assertThrows<java.lang.RuntimeException> {
+            DriverManager.getConnection("jdbc:calcite:schemaFactory=org.opendc.trace.calcite.TraceSchemaFactory; schema.path=trace")
+        }
+    }
+}
diff --git a/opendc-trace/opendc-trace-calcite/src/test/resources/model.json b/opendc-trace/opendc-trace-calcite/src/test/resources/model.json
new file mode 100644
index 00000000..91e2657f
--- /dev/null
+++ b/opendc-trace/opendc-trace-calcite/src/test/resources/model.json
@@ -0,0 +1,15 @@
+{
+    "version": "1.0",
+    "defaultSchema": "trace",
+    "schemas": [
+        {
+            "name": "trace",
+            "type": "custom",
+            "factory": "org.opendc.trace.calcite.TraceSchemaFactory",
+            "operand": {
+                "path": "trace",
+                "format": "opendc-vm"
+            }
+        }
+    ]
+}
diff --git a/opendc-trace/opendc-trace-calcite/src/test/resources/trace/interference-model.json b/opendc-trace/opendc-trace-calcite/src/test/resources/trace/interference-model.json
new file mode 100644
index 00000000..6a0616d9
--- /dev/null
+++ b/opendc-trace/opendc-trace-calcite/src/test/resources/trace/interference-model.json
@@ -0,0 +1,20 @@
+[
+    {
+        "vms": [
+            "1019",
+            "1023",
+            "1052"
+        ],
+        "minServerLoad": 0.0,
+        "performanceScore": 0.8830158730158756
+    },
+    {
+        "vms": [
+            "1023",
+            "1052",
+            "1073"
+        ],
+        "minServerLoad": 0.0,
+        "performanceScore": 0.7133055555552751
+    }
+]
diff --git a/opendc-trace/opendc-trace-calcite/src/test/resources/trace/meta.parquet b/opendc-trace/opendc-trace-calcite/src/test/resources/trace/meta.parquet
new file mode 100644
index 00000000..d8184945
--- /dev/null
+++ b/opendc-trace/opendc-trace-calcite/src/test/resources/trace/meta.parquet
diff --git a/opendc-trace/opendc-trace-calcite/src/test/resources/trace/trace.parquet b/opendc-trace/opendc-trace-calcite/src/test/resources/trace/trace.parquet
new file mode 100644
index 00000000..00ab5835
--- /dev/null
+++ b/opendc-trace/opendc-trace-calcite/src/test/resources/trace/trace.parquet