1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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 org.opendc.trace.testkit
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)
}
}
}
|