From 9d759c9bc987965fae8b0c16c000772c546bf3a2 Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Wed, 8 Jun 2022 15:06:14 +0200 Subject: 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. --- .../trace/azure/AzureResourceStateTableReader.kt | 19 +++++++++++ .../opendc/trace/azure/AzureResourceTableReader.kt | 21 ++++++++++++ .../org/opendc/trace/azure/AzureTraceFormatTest.kt | 38 ++++++++++++++++++++-- 3 files changed, 76 insertions(+), 2 deletions(-) (limited to 'opendc-trace/opendc-trace-azure/src') diff --git a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt index e9017b35..c0c67329 100644 --- a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt +++ b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceStateTableReader.kt @@ -37,11 +37,20 @@ import java.util.* * A [TableReader] for the Azure v1 VM resource state table. */ internal class AzureResourceStateTableReader(private val parser: CsvParser) : TableReader { + /** + * A flag to indicate whether a single row has been read already. + */ + private var isStarted = false + init { parser.schema = schema } override fun nextRow(): Boolean { + if (!isStarted) { + isStarted = true + } + reset() if (!nextStart()) { @@ -100,6 +109,7 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } override fun getDouble(index: Int): Double { + checkActive() return when (index) { COL_CPU_USAGE_PCT -> cpuUsagePct else -> throw IllegalArgumentException("Invalid column") @@ -107,6 +117,7 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } override fun getString(index: Int): String? { + checkActive() return when (index) { COL_ID -> id else -> throw IllegalArgumentException("Invalid column") @@ -118,6 +129,7 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta } override fun getInstant(index: Int): Instant? { + checkActive() return when (index) { COL_TIMESTAMP -> timestamp else -> throw IllegalArgumentException("Invalid column") @@ -144,6 +156,13 @@ internal class AzureResourceStateTableReader(private val parser: CsvParser) : Ta parser.close() } + /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + /** * Advance the parser until the next object start. */ diff --git a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt index 456a2536..a8451301 100644 --- a/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt +++ b/opendc-trace/opendc-trace-azure/src/main/kotlin/org/opendc/trace/azure/AzureResourceTableReader.kt @@ -35,11 +35,20 @@ import java.util.* * A [TableReader] for the Azure v1 VM resources table. */ internal class AzureResourceTableReader(private val parser: CsvParser) : TableReader { + /** + * A flag to indicate whether a single row has been read already. + */ + private var isStarted = false + init { parser.schema = schema } override fun nextRow(): Boolean { + if (!isStarted) { + isStarted = true + } + reset() if (!nextStart()) { @@ -92,6 +101,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getInt(index: Int): Int { + checkActive() return when (index) { COL_CPU_COUNT -> cpuCores else -> throw IllegalArgumentException("Invalid column") @@ -99,6 +109,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getLong(index: Int): Long { + checkActive() return when (index) { COL_CPU_COUNT -> cpuCores.toLong() else -> throw IllegalArgumentException("Invalid column") @@ -110,6 +121,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getDouble(index: Int): Double { + checkActive() return when (index) { COL_MEM_CAPACITY -> memCapacity else -> throw IllegalArgumentException("Invalid column") @@ -117,6 +129,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getString(index: Int): String? { + checkActive() return when (index) { COL_ID -> id else -> throw IllegalArgumentException("Invalid column") @@ -128,6 +141,7 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe } override fun getInstant(index: Int): Instant? { + checkActive() return when (index) { COL_START_TIME -> startTime COL_STOP_TIME -> stopTime @@ -155,6 +169,13 @@ internal class AzureResourceTableReader(private val parser: CsvParser) : TableRe parser.close() } + /** + * Helper method to check if the reader is active. + */ + private fun checkActive() { + check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" } + } + /** * Advance the parser until the next object start. */ diff --git a/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt b/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt index 932858f8..06ba047a 100644 --- a/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt +++ b/opendc-trace/opendc-trace-azure/src/test/kotlin/org/opendc/trace/azure/AzureTraceFormatTest.kt @@ -22,15 +22,19 @@ package org.opendc.trace.azure +import org.junit.jupiter.api.* import org.junit.jupiter.api.Assertions.* -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows +import org.junit.jupiter.api.Assertions.assertAll +import org.opendc.trace.TableColumn +import org.opendc.trace.TableReader import org.opendc.trace.conv.* +import org.opendc.trace.testkit.TableReaderTestKit import java.nio.file.Paths /** * Test suite for the [AzureTraceFormat] class. */ +@DisplayName("Azure VM TraceFormat") class AzureTraceFormatTest { private val format = AzureTraceFormat() @@ -82,4 +86,34 @@ class AzureTraceFormatTest { reader.close() } + + @DisplayName("TableReader for Resources") + @Nested + inner class ResourcesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace") + + columns = format.getDetails(path, TABLE_RESOURCES).columns + reader = format.newReader(path, TABLE_RESOURCES, null) + } + } + + @DisplayName("TableReader for Resource States") + @Nested + inner class ResourceStatesTableReaderTest : TableReaderTestKit() { + override lateinit var reader: TableReader + override lateinit var columns: List + + @BeforeEach + fun setUp() { + val path = Paths.get("src/test/resources/trace") + + columns = format.getDetails(path, TABLE_RESOURCE_STATES).columns + reader = format.newReader(path, TABLE_RESOURCE_STATES, null) + } + } } -- cgit v1.2.3