diff options
Diffstat (limited to 'opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf')
3 files changed, 462 insertions, 0 deletions
diff --git a/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/TableReaderTestKit.kt b/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/TableReaderTestKit.kt new file mode 100644 index 00000000..cb6db43f --- /dev/null +++ b/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/TableReaderTestKit.kt @@ -0,0 +1,190 @@ +/* + * 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 formats.wtf + +import org.junit.jupiter.api.AfterEach +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Assertions.assertFalse +import org.junit.jupiter.api.Assertions.assertNotEquals +import org.junit.jupiter.api.Assumptions.assumeTrue +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.TableColumn +import org.opendc.trace.TableColumnType +import org.opendc.trace.TableReader + +/** + * A test suite for implementations of the [TableReader] interface. + */ +public abstract class TableReaderTestKit { + /** + * The [TableReader] instance to test. + */ + public abstract val reader: TableReader + + /** + * The columns of the table. + */ + public abstract val columns: List<TableColumn> + + @AfterEach + public fun tearDown() { + reader.close() + } + + /** + * Test that we can resolve the columns of a table successfully. + */ + @Test + public fun testResolve() { + assertAll(columns.map { column -> { assertNotEquals(-1, reader.resolve(column.name)) } }) + } + + /** + * Test that resolving an empty column name fails + */ + @Test + public fun testResolveEmpty() { + assertEquals(-1, reader.resolve("")) + } + + /** + * Test that reading non-existent columns fails. + */ + @Test + public fun testReadNonExistentColumns() { + assumeTrue(reader.nextRow()) + assertAll( + { assertThrows<IllegalArgumentException> { reader.isNull(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getBoolean(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getInt(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getLong(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getFloat(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getDouble(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getString(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getUUID(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getInstant(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getDuration(-1) } }, + { assertThrows<IllegalArgumentException> { reader.getList(-1, Any::class.java) } }, + { assertThrows<IllegalArgumentException> { reader.getSet(-1, Any::class.java) } }, + { assertThrows<IllegalArgumentException> { reader.getMap(-1, Any::class.java, Any::class.java) } }, + ) + } + + /** + * Test that ensures [TableReader.isNull] reports the correct value. + */ + @Test + public fun testVerifyNullColumns() { + while (reader.nextRow()) { + assertAll( + columns.map { column -> + { + when (column.type) { + is TableColumnType.Boolean -> assertFalse(reader.isNull(column.name) && !reader.getBoolean(column.name)) + is TableColumnType.Int -> assertFalse(reader.isNull(column.name) && reader.getInt(column.name) != 0) + is TableColumnType.Long -> assertFalse(reader.isNull(column.name) && reader.getLong(column.name) != 0L) + is TableColumnType.Float -> assertFalse(reader.isNull(column.name) && reader.getFloat(column.name) != 0f) + is TableColumnType.Double -> assertFalse(reader.isNull(column.name) && reader.getDouble(column.name) != 0.0) + is TableColumnType.String -> assertFalse(reader.isNull(column.name) && reader.getString(column.name) != null) + is TableColumnType.UUID -> assertFalse(reader.isNull(column.name) && reader.getUUID(column.name) != null) + is TableColumnType.Instant -> assertFalse(reader.isNull(column.name) && reader.getInstant(column.name) != null) + is TableColumnType.Duration -> + assertFalse( + reader.isNull(column.name) && reader.getDuration(column.name) != null, + ) + is TableColumnType.List -> + assertFalse( + reader.isNull(column.name) && reader.getList(column.name, Any::class.java) != null, + ) + is TableColumnType.Set -> + assertFalse( + reader.isNull(column.name) && reader.getSet(column.name, Any::class.java) != null, + ) + is TableColumnType.Map -> + assertFalse( + reader.isNull(column.name) && reader.getMap(column.name, Any::class.java, Any::class.java) != null, + ) + } + } + }, + ) + } + } + + /** + * Test that we can read the entire table without any issue. + */ + @Test + public fun testReadFully() { + assertDoesNotThrow { + while (reader.nextRow()) { + assertAll(columns.map { column -> { assertDoesNotThrow { reader.get(column) } } }) + } + reader.close() + } + + assertFalse(reader.nextRow()) { "Reader does not reset" } + } + + /** + * Test that the reader throws an exception when the columns are read without a call to [TableReader.nextRow] + */ + @Test + public fun testReadWithoutNextRow() { + assertAll(columns.map { column -> { assertThrows<IllegalStateException> { reader.get(column) } } }) + } + + /** + * Test that the reader throws an exception when the columns are read after the [TableReader] is finished. + */ + @Test + public fun testReadAfterFinish() { + @Suppress("ControlFlowWithEmptyBody") + while (reader.nextRow()) {} + + testReadWithoutNextRow() + } + + /** + * Helper method to map a [TableColumn] to a read. + */ + private fun TableReader.get(column: TableColumn): Any? { + return when (column.type) { + is TableColumnType.Boolean -> getBoolean(column.name) + is TableColumnType.Int -> getInt(column.name) + is TableColumnType.Long -> getLong(column.name) + is TableColumnType.Float -> getFloat(column.name) + is TableColumnType.Double -> getDouble(column.name) + is TableColumnType.String -> getString(column.name) + is TableColumnType.UUID -> getUUID(column.name) + is TableColumnType.Instant -> getInstant(column.name) + is TableColumnType.Duration -> getDuration(column.name) + is TableColumnType.List -> getList(column.name, Any::class.java) + is TableColumnType.Set -> getSet(column.name, Any::class.java) + is TableColumnType.Map -> getMap(column.name, Any::class.java, Any::class.java) + } + } +} diff --git a/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/TableWriterTestKit.kt b/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/TableWriterTestKit.kt new file mode 100644 index 00000000..1c819fff --- /dev/null +++ b/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/TableWriterTestKit.kt @@ -0,0 +1,131 @@ +/* + * 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 formats.wtf + +import org.junit.jupiter.api.AfterEach +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Assertions.assertNotEquals +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.assertAll +import org.junit.jupiter.api.assertThrows +import org.opendc.trace.TableColumn +import org.opendc.trace.TableColumnType +import org.opendc.trace.TableWriter +import java.time.Duration +import java.time.Instant +import java.util.UUID + +/** + * A test suite for implementations of the [TableWriter] interface. + */ +public abstract class TableWriterTestKit { + /** + * The [TableWriter] instance to test. + */ + public abstract val writer: TableWriter + + /** + * The columns of the table. + */ + public abstract val columns: List<TableColumn> + + @AfterEach + public fun tearDown() { + writer.close() + } + + /** + * Test that we can resolve the columns of a table successfully. + */ + @Test + public fun testResolve() { + assertAll(columns.map { column -> { assertNotEquals(-1, writer.resolve(column.name)) } }) + } + + /** + * Test that resolving an empty column name fails + */ + @Test + public fun testResolveEmpty() { + assertEquals(-1, writer.resolve("")) + } + + /** + * Test that writing non-existent columns fails. + */ + @Test + public fun testWriteNonExistentColumns() { + writer.startRow() + assertAll( + { assertThrows<IllegalArgumentException> { writer.setBoolean(-1, false) } }, + { assertThrows<IllegalArgumentException> { writer.setInt(-1, 1) } }, + { assertThrows<IllegalArgumentException> { writer.setLong(-1, 1) } }, + { assertThrows<IllegalArgumentException> { writer.setFloat(-1, 1f) } }, + { assertThrows<IllegalArgumentException> { writer.setDouble(-1, 1.0) } }, + { assertThrows<IllegalArgumentException> { writer.setString(-1, "test") } }, + { assertThrows<IllegalArgumentException> { writer.setUUID(-1, UUID.randomUUID()) } }, + { assertThrows<IllegalArgumentException> { writer.setInstant(-1, Instant.now()) } }, + { assertThrows<IllegalArgumentException> { writer.setDuration(-1, Duration.ofMinutes(5)) } }, + { assertThrows<IllegalArgumentException> { writer.setList(-1, listOf("test")) } }, + { assertThrows<IllegalArgumentException> { writer.setSet(-1, setOf("test")) } }, + { assertThrows<IllegalArgumentException> { writer.setMap(-1, mapOf("test" to "test")) } }, + ) + } + + /** + * Test that writing columns without a row fails. + */ + @Test + public fun testWriteWithoutRow() { + assertAll( + columns.map { column -> + { + assertThrows<IllegalStateException> { + when (column.type) { + is TableColumnType.Boolean -> writer.setBoolean(column.name, true) + is TableColumnType.Int -> writer.setInt(column.name, 21) + is TableColumnType.Long -> writer.setLong(column.name, 21) + is TableColumnType.Float -> writer.setFloat(column.name, 42f) + is TableColumnType.Double -> writer.setDouble(column.name, 42.0) + is TableColumnType.String -> writer.setString(column.name, "test") + is TableColumnType.UUID -> writer.setUUID(column.name, UUID.randomUUID()) + is TableColumnType.Instant -> writer.setInstant(column.name, Instant.now()) + is TableColumnType.Duration -> writer.setDuration(column.name, Duration.ofMinutes(5)) + is TableColumnType.List -> writer.setList(column.name, emptyList<String>()) + is TableColumnType.Set -> writer.setSet(column.name, emptySet<String>()) + is TableColumnType.Map -> writer.setMap(column.name, emptyMap<String, String>()) + } + } + } + }, + ) + } + + /** + * Test to verify we cannot end a row without starting it. + */ + @Test + public fun testEndRowWithoutStart() { + assertThrows<IllegalStateException> { writer.endRow() } + } +} diff --git a/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/WtfTraceFormatTest.kt b/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/WtfTraceFormatTest.kt new file mode 100644 index 00000000..d218fbf3 --- /dev/null +++ b/opendc-trace/opendc-trace-api/src/test/kotlin/formats/wtf/WtfTraceFormatTest.kt @@ -0,0 +1,141 @@ +/* + * 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.wtf + +import formats.wtf.TableReaderTestKit +import org.junit.jupiter.api.Assertions.assertAll +import org.junit.jupiter.api.Assertions.assertDoesNotThrow +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Assertions.assertTrue +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.DisplayName +import org.junit.jupiter.api.Nested +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.assertThrows +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader +import org.opendc.trace.conv.TABLE_TASKS +import org.opendc.trace.conv.TASK_ID +import org.opendc.trace.conv.TASK_PARENTS +import org.opendc.trace.conv.TASK_RUNTIME +import org.opendc.trace.conv.TASK_SUBMIT_TIME +import org.opendc.trace.conv.TASK_WORKFLOW_ID +import java.nio.file.Paths +import java.time.Duration +import java.time.Instant + +/** + * Test suite for the [WtfTraceFormat] class. + */ +@DisplayName("WTF TraceFormat") +class WtfTraceFormatTest { + private val format = WtfTraceFormat() + + @Test + fun testTables() { + val path = Paths.get("src/test/resources/wtf/schema-1.0") + assertEquals(listOf(TABLE_TASKS), format.getTables(path)) + } + + @Test + fun testTableExists() { + val path = Paths.get("src/test/resources/wtf/wtf-trace") + assertDoesNotThrow { format.getDetails(path, TABLE_TASKS) } + } + + @Test + fun testTableDoesNotExist() { + val path = Paths.get("src/test/resources/wtf/wtf-trace") + + assertThrows<IllegalArgumentException> { format.getDetails(path, "test") } + } + + /** + * Smoke test for parsing WTF traces. + */ + @Test + fun testTableReader() { + val path = Paths.get("src/test/resources/wtf/wtf-trace") + val reader = format.newReader(path, TABLE_TASKS, listOf(TASK_ID, TASK_WORKFLOW_ID, TASK_SUBMIT_TIME, TASK_RUNTIME, TASK_PARENTS)) + + assertAll( + { assertTrue(reader.nextRow()) }, + { assertEquals("362334516345962206", reader.getString(TASK_ID)) }, + { assertEquals("1078341553348591493", reader.getString(TASK_WORKFLOW_ID)) }, + { assertEquals(Instant.ofEpochMilli(245604), reader.getInstant(TASK_SUBMIT_TIME)) }, + { assertEquals(Duration.ofMillis(8163), reader.getDuration(TASK_RUNTIME)) }, + { + assertEquals( + setOf("584055316413447529", "133113685133695608", "1008582348422865408"), + reader.getSet(TASK_PARENTS, String::class.java), + ) + }, + ) + + assertAll( + { assertTrue(reader.nextRow()) }, + { assertEquals("502010169100446658", reader.getString(TASK_ID)) }, + { assertEquals("1078341553348591493", reader.getString(TASK_WORKFLOW_ID)) }, + { assertEquals(Instant.ofEpochMilli(251325), reader.getInstant(TASK_SUBMIT_TIME)) }, + { assertEquals(Duration.ofMillis(8216), reader.getDuration(TASK_RUNTIME)) }, + { + assertEquals( + setOf("584055316413447529", "133113685133695608", "1008582348422865408"), + reader.getSet(TASK_PARENTS, String::class.java), + ) + }, + ) + + 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("src/test/resources/wtf/wtf-trace") + + columns = format.getDetails(path, TABLE_TASKS).columns + reader = format.newReader(path, TABLE_TASKS, null) + } + } + + @DisplayName("TableReader for Tasks (Shell trace)") + @Nested + inner class ShellTasksTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List<TableColumn> + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/wtf/shell") + + columns = format.getDetails(path, TABLE_TASKS).columns + reader = format.newReader(path, TABLE_TASKS, null) + } + } +} |