Skip to content

chore(bq jdbc): migrate to junit5 #12079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
logachev merged 1 commit into from
Mar 17, 2026
Merged

chore(bq jdbc): migrate to junit5 #12079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions java-bigquery/google-cloud-bigquery-jdbc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<version>0.5.0</version><!-- {x-version-update:google-cloud-bigquery-jdbc:current} -->
<packaging>jar</packaging>
<name>BigQuery JDBC</name>
<url>https://github.com/googleapis/google-cloud-java-jdbc</url>
<url>https://github.com/googleapis/google-cloud-java</url>
<description>JDBC for BigQuery</description>

<properties>
Expand Down Expand Up @@ -179,6 +179,7 @@
</exclusions>
</dependency>

<!-- Transitive Dependencies -->
<dependency>
<groupId>com.google.api</groupId>
<artifactId>api-common</artifactId>
Expand Down Expand Up @@ -268,22 +269,35 @@
<artifactId>httpcore5</artifactId>
</dependency>

<!-- Test Dependencies -->
<dependency>
<groupId>com.google.truth</groupId>
<artifactId>truth</artifactId>
<version>1.1.3</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-params</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>4.11.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
Expand Down
6 changes: 3 additions & 3 deletions .../test/java/com/google/cloud/bigquery/jdbc/ArrowFormatTypeBigQueryCoercionUtilityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@
import org.apache.arrow.vector.util.JsonStringArrayList;
import org.apache.arrow.vector.util.JsonStringHashMap;
import org.apache.arrow.vector.util.Text;
import org.junit.Rule;
import org.junit.Test;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

public class ArrowFormatTypeBigQueryCoercionUtilityTest {

@Rule public final TimeZoneRule timeZoneRule = new TimeZoneRule("UTC");
@RegisterExtension public final TimeZoneRule timeZoneRule = new TimeZoneRule("UTC");

private static final Range RANGE_DATE =
Range.newBuilder()
Expand Down
176 changes: 110 additions & 66 deletions ...jdbc/src/test/java/com/google/cloud/bigquery/jdbc/BigQueryArrowArrayOfPrimitivesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
import static java.time.Month.MARCH;
import static java.util.Arrays.copyOfRange;
import static java.util.Collections.emptyMap;
import static org.junit.Assert.assertThrows;
import static org.junit.jupiter.api.Assertions.assertThrows;

import com.google.cloud.Tuple;
import com.google.cloud.bigquery.Field;
Expand All @@ -62,44 +62,15 @@
import java.util.stream.Stream;
import org.apache.arrow.vector.util.JsonStringArrayList;
import org.apache.arrow.vector.util.Text;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.function.ThrowingRunnable;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.api.function.Executable;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
Comment on lines +65 to +68
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The migration from JUnit 4's @RunWith(Parameterized.class) and @Parameters to JUnit 5's @ParameterizedTest and @MethodSource is correctly implemented. This improves test flexibility and readability.


@RunWith(Parameterized.class)
public class BigQueryArrowArrayOfPrimitivesTest {
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Removing the @RunWith(Parameterized.class) annotation is a necessary step for JUnit 5 migration.


private final Field schema;
private final JsonStringArrayList<?> arrayValues;
private final Object[] expected;
private final int javaSqlTypeCode;
private Array array;
private final StandardSQLTypeName currentType;
@RegisterExtension public static final TimeZoneRule timeZoneRule = new TimeZoneRule("UTC");
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Migrating from @ClassRule to @RegisterExtension for static rules is the correct approach in JUnit 5.


@ClassRule public static final TimeZoneRule timeZoneRule = new TimeZoneRule("UTC");

public BigQueryArrowArrayOfPrimitivesTest(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode) {
this.currentType = currentType;
this.schema = schemaAndValue.x();
this.arrayValues = schemaAndValue.y();
this.expected = expected;
this.javaSqlTypeCode = javaSqlTypeCode;
}

@Before
public void setUp() {
array = new BigQueryArrowArray(this.schema, this.arrayValues);
}

@Parameters(name = "{index}: primitive array of {0}")
public static Collection<Object[]> data() {
timeZoneRule.enforce();
LocalDateTime aTimeStamp = LocalDateTime.of(2023, MARCH, 30, 11, 14, 19, 820227000);
Expand Down Expand Up @@ -254,48 +225,82 @@ STRING, new Text("one"), new Text("two"), new Text("three"), new Text("four")),
});
}

@Test
public void getArray() throws SQLException {
assertThat(array.getArray()).isEqualTo(this.expected);
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getArray(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
assertThat(array.getArray()).isEqualTo(expected);
Comment on lines +228 to +237
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The test method getArray has been correctly refactored to use @ParameterizedTest and receive its data from the data() method. Instantiating Array array inside the test method ensures proper test isolation for each parameter set.

}

@Test
public void getSlicedArray() throws SQLException {
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getSlicedArray(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
int fromIndex = 1;
int toIndexExclusive = 3;
Object[] expectedSlicedArray =
copyOfRange(this.expected, fromIndex, toIndexExclusive); // copying index(1,2)
copyOfRange(expected, fromIndex, toIndexExclusive); // copying index(1,2)

// the first element is at index 1
assertThat(array.getArray(fromIndex + 1, 2)).isEqualTo(expectedSlicedArray);
}

@Test
public void getSlicedArrayWhenCountIsGreaterThanOriginalArrayLength() {
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getSlicedArrayWhenCountIsGreaterThanOriginalArrayLength(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode) {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
IllegalArgumentException illegalArgumentException =
assertThrows(IllegalArgumentException.class, () -> array.getArray(2, 10));
assertThat(illegalArgumentException.getMessage())
.isEqualTo("The array index is out of range: 12, number of elements: 4.");
}

@Test
public void getResultSet() throws SQLException {
ResultSet resultSet = this.array.getResultSet();
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getResultSet(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
ResultSet resultSet = array.getResultSet();
Tuple<ArrayList<Object>, ArrayList<Object>> indexAndValues =
nestedResultSetToColumnLists(resultSet);
ArrayList<Object> indexList = indexAndValues.x();
ArrayList<Object> columnValues = indexAndValues.y();

assertThat(indexList.toArray()).isEqualTo(new Object[] {1, 2, 3, 4});
assertThat(columnValues.toArray()).isEqualTo(this.expected);
assertThat(columnValues.toArray()).isEqualTo(expected);
}

@Test
public void getSlicedResultSet() throws SQLException {
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getSlicedResultSet(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
int fromIndex = 1;
int toIndexExclusive = 3;
Object[] expectedSlicedArray =
copyOfRange(this.expected, fromIndex, toIndexExclusive); // copying index(1,2)
copyOfRange(expected, fromIndex, toIndexExclusive); // copying index(1,2)

// the first element is at index 1
ResultSet resultSet = array.getResultSet(fromIndex + 1, 2);
Expand All @@ -309,27 +314,54 @@ public void getSlicedResultSet() throws SQLException {
assertThat(columnValues.toArray()).isEqualTo(expectedSlicedArray);
}

@Test
public void getSlicedResultSetWhenCountIsGreaterThanOriginalArrayLength() {
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getSlicedResultSetWhenCountIsGreaterThanOriginalArrayLength(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode) {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
IllegalArgumentException illegalArgumentException =
assertThrows(IllegalArgumentException.class, () -> array.getResultSet(2, 10));
assertThat(illegalArgumentException.getMessage())
.isEqualTo("The array index is out of range: 12, number of elements: 4.");
}

@Test
public void getBaseTypeName() throws SQLException {
assertThat(array.getBaseTypeName()).isEqualTo(this.currentType.name());
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getBaseTypeName(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
assertThat(array.getBaseTypeName()).isEqualTo(currentType.name());
}

@Test
public void getBaseType() throws SQLException {
assertThat(array.getBaseType()).isEqualTo(this.javaSqlTypeCode);
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getBaseType(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
assertThat(array.getBaseType()).isEqualTo(javaSqlTypeCode);
}

@Test
public void free() throws SQLException {
this.array.free();
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void free(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode)
throws SQLException {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
array.free();

ensureArrayIsInvalid(() -> array.getArray());
ensureArrayIsInvalid(() -> array.getArray(1, 2));
Expand All @@ -339,8 +371,14 @@ public void free() throws SQLException {
ensureArrayIsInvalid(() -> array.getBaseType());
}

@Test
public void getArrayWithCustomTypeMappingsIsNotSupported() {
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getArrayWithCustomTypeMappingsIsNotSupported(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode) {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
Exception exception1 =
assertThrows(SQLFeatureNotSupportedException.class, () -> array.getArray(emptyMap()));
Exception exception2 =
Expand All @@ -349,8 +387,14 @@ public void getArrayWithCustomTypeMappingsIsNotSupported() {
assertThat(exception2.getMessage()).isEqualTo(CUSTOMER_TYPE_MAPPING_NOT_SUPPORTED);
}

@Test
public void getResultSetWithCustomTypeMappingsIsNotSupported() {
@ParameterizedTest(name = "{index}: primitive array of {0}")
@MethodSource("data")
public void getResultSetWithCustomTypeMappingsIsNotSupported(
StandardSQLTypeName currentType,
Tuple<Field, JsonStringArrayList<?>> schemaAndValue,
Object[] expected,
int javaSqlTypeCode) {
Array array = new BigQueryArrowArray(schemaAndValue.x(), schemaAndValue.y());
Exception exception1 =
assertThrows(SQLFeatureNotSupportedException.class, () -> array.getResultSet(emptyMap()));
Exception exception2 =
Expand All @@ -360,7 +404,7 @@ public void getResultSetWithCustomTypeMappingsIsNotSupported() {
assertThat(exception2.getMessage()).isEqualTo(CUSTOMER_TYPE_MAPPING_NOT_SUPPORTED);
}

private void ensureArrayIsInvalid(ThrowingRunnable block) {
private void ensureArrayIsInvalid(Executable block) {
Exception exception = assertThrows(IllegalStateException.class, block);
assertThat(exception.getMessage()).isEqualTo(INVALID_ARRAY);
}
Expand Down
12 changes: 6 additions & 6 deletions ...ery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/BigQueryArrowArrayOfStructTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import static java.lang.Boolean.TRUE;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyMap;
import static org.junit.Assert.assertThrows;
import static org.junit.jupiter.api.Assertions.assertThrows;

import com.google.cloud.Tuple;
import com.google.cloud.bigquery.Field;
Expand All @@ -48,15 +48,15 @@
import org.apache.arrow.vector.util.JsonStringArrayList;
import org.apache.arrow.vector.util.JsonStringHashMap;
import org.apache.arrow.vector.util.Text;
import org.junit.Before;
import org.junit.Test;
import org.junit.function.ThrowingRunnable;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.function.Executable;

public class BigQueryArrowArrayOfStructTest {

private Array array;

@Before
@BeforeEach
public void setUp() {
FieldList profileSchema =
FieldList.of(
Expand Down Expand Up @@ -198,7 +198,7 @@ public void getResultSetWithCustomTypeMappingsIsNotSupported() {
assertThat(exception2.getMessage()).isEqualTo(CUSTOMER_TYPE_MAPPING_NOT_SUPPORTED);
}

private void ensureArrayIsInvalid(ThrowingRunnable block) {
private void ensureArrayIsInvalid(Executable block) {
Exception exception = assertThrows(IllegalStateException.class, block);
assertThat(exception.getMessage()).isEqualTo(INVALID_ARRAY);
}
Expand Down
6 changes: 3 additions & 3 deletions ...igquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/BigQueryArrowResultSetTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@
import org.apache.arrow.vector.types.pojo.FieldType;
import org.apache.arrow.vector.util.JsonStringArrayList;
import org.apache.arrow.vector.util.Text;
import org.junit.Before;
import org.junit.Test;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class BigQueryArrowResultSetTest {

Expand Down Expand Up @@ -194,7 +194,7 @@ private JsonStringArrayList<Long> getJsonStringArrayList() {
return jsonStringArrayList;
}

@Before
@BeforeEach
public void setUp() throws SQLException, IOException {
buffer = new LinkedBlockingDeque<>();
bufferWithTwoRows = new LinkedBlockingDeque<>();
Expand Down
Loading
Loading