Skip to content

chore(bigquery-jdbc): Force integration tests to use per-run datasets #13278

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

Open
logachev wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore(bigquery-jdbc): Force integration tests to use per-run datasets #13278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
547464a
chore(bigquery-jdbc): Force integration tests to use unique dataset f…
logachev May 26, 2026
0815df0
lint
logachev May 27, 2026
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
144 changes: 144 additions & 0 deletions java-bigquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,150 @@

public class ITBase extends BigQueryJdbcBaseTest {

private static String sharedDataset;
private static String sharedDataset2;

private static final String DDL_IT_CALLABLE_STMT_PROC_DML_TABLE =
"CREATE TABLE IF NOT EXISTS `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_TABLE`\n"
+ "(\n"
+ " name STRING,\n"
+ " id INT64,\n"
+ " result STRING\n"
+ ");\n";

private static final String DDL_IT_CALLABLE_STMT_PROC_TABLE =
"CREATE TABLE IF NOT EXISTS `%1$s.%2$s.IT_CALLABLE_STMT_PROC_TABLE`\n"
+ "(\n"
+ " name STRING,\n"
+ " id INT64,\n"
+ " result STRING\n"
+ ");\n";

private static final String DDL_IT_CALLABLE_STMT_PROC_DML_INSERT_TEST =
"CREATE OR REPLACE PROCEDURE `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_INSERT_TEST`(in_name STRING, in_id INT64, in_result STRING)\n"
+ "BEGIN\n"
+ " INSERT INTO `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_TABLE` VALUES(in_name, in_id, in_result);\n"
+ "END;\n";

private static final String DDL_IT_CALLABLE_STMT_PROC_DML_UPDATE_TEST =
"CREATE OR REPLACE PROCEDURE `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_UPDATE_TEST`(in_name STRING, in_id INT64, in_result STRING)\n"
+ "BEGIN\n"
+ " UPDATE `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_TABLE` SET name = in_name, result = in_result WHERE id = in_id;\n"
+ "END;\n";

private static final String DDL_IT_CALLABLE_STMT_PROC_DML_DELETE_TEST =
"CREATE OR REPLACE PROCEDURE `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_DELETE_TEST`(in_id INT64)\n"
+ "BEGIN\n"
+ " DELETE FROM `%1$s.%2$s.IT_CALLABLE_STMT_PROC_DML_TABLE` WHERE id = in_id;\n"
+ "END;\n";

private static final String DDL_IT_CALLABLE_STMT_PROC_TEST =
"CREATE OR REPLACE PROCEDURE `%1$s.%2$s.IT_CALLABLE_STMT_PROC_TEST`(name STRING, id INT64, OUT result STRING)\n"
+ "BEGIN\n"
+ " SET result = CONCAT(name, '-', id);\n"
+ " INSERT INTO `%1$s.%2$s.IT_CALLABLE_STMT_PROC_TABLE` VALUES(name, id, result);\n"
+ "END;\n";

private static final String DDL_JDBC_CONSTRAINTS_TEST_TABLE3 =
"CREATE TABLE IF NOT EXISTS `%1$s.%2$s.JDBC_CONSTRAINTS_TEST_TABLE3`\n"
+ "(\n"
+ " address STRING,\n"
+ " PRIMARY KEY (address) NOT ENFORCED\n"
+ ");\n";

private static final String DDL_JDBC_CONSTRAINTS_TEST_TABLE2 =
"CREATE TABLE IF NOT EXISTS `%1$s.%2$s.JDBC_CONSTRAINTS_TEST_TABLE2`\n"
+ "(\n"
+ " first_name STRING,\n"
+ " last_name STRING,\n"
+ " PRIMARY KEY (first_name, last_name) NOT ENFORCED\n"
+ ");\n";

private static final String DDL_JDBC_CONSTRAINTS_TEST_TABLE =
"CREATE TABLE IF NOT EXISTS `%1$s.%2$s.JDBC_CONSTRAINTS_TEST_TABLE`\n"
+ "(\n"
+ " id INT64,\n"
+ " name STRING,\n"
+ " second_name STRING,\n"
+ " address STRING,\n"
+ " PRIMARY KEY (id) NOT ENFORCED,\n"
+ " CONSTRAINT my_fk FOREIGN KEY (name, second_name) REFERENCES `%1$s.%2$s.JDBC_CONSTRAINTS_TEST_TABLE2`(first_name, last_name) NOT ENFORCED,\n"
+ " CONSTRAINT my_fk2 FOREIGN KEY (address) REFERENCES `%1$s.%2$s.JDBC_CONSTRAINTS_TEST_TABLE3`(address) NOT ENFORCED\n"
+ ");\n";

private static final String CREATE_RESOURCES_SCRIPT =
DDL_IT_CALLABLE_STMT_PROC_DML_TABLE
+ DDL_IT_CALLABLE_STMT_PROC_TABLE
+ DDL_JDBC_CONSTRAINTS_TEST_TABLE3
+ DDL_JDBC_CONSTRAINTS_TEST_TABLE2
+ DDL_JDBC_CONSTRAINTS_TEST_TABLE
+ DDL_IT_CALLABLE_STMT_PROC_DML_INSERT_TEST
+ DDL_IT_CALLABLE_STMT_PROC_DML_UPDATE_TEST
+ DDL_IT_CALLABLE_STMT_PROC_DML_DELETE_TEST
+ DDL_IT_CALLABLE_STMT_PROC_TEST;

public static synchronized String getSharedDataset() {
if (sharedDataset == null) {
sharedDataset =
"JDBC_IT_SHARED_"
+ System.currentTimeMillis()
+ "_"
+ (100 + new java.util.Random().nextInt(900));
try {
setUpDataset(sharedDataset);
registerShutdownHook(sharedDataset);
createSharedResources(sharedDataset);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new RuntimeException(e);
}
}
return sharedDataset;
}

public static synchronized String getSharedDataset2() {
if (sharedDataset2 == null) {
sharedDataset2 =
"JDBC_IT_SHARED_2_"
+ System.currentTimeMillis()
+ "_"
+ (100 + new java.util.Random().nextInt(900));
try {
setUpDataset(sharedDataset2);
registerShutdownHook(sharedDataset2);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new RuntimeException(e);
}
}
return sharedDataset2;
}
Comment on lines +151 to +152
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 26, 2026

Choose a reason for hiding this comment

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

high

Sharing a single dataset across multiple concurrent or sequential test classes can lead to test interference, especially for metadata queries (like DatabaseMetaData.getTables) which list all tables in a dataset. Since tables created by other tests are not cleaned up until JVM shutdown, they will be visible to any test querying the shared dataset.

To ensure proper test isolation, we should introduce a getUniqueDataset() helper method in ITBase that creates a new, isolated dataset for each test class's private tables, while registering it for automatic cleanup on shutdown. This allows test classes to use isolated datasets for their own tables, while still using getSharedDataset() for shared resources (like constraints and procedures).

    return sharedDataset2;
  }

  public static String getUniqueDataset() {
    String uniqueDataset = "JDBC_IT_UNIQUE_" + System.currentTimeMillis() + "_" + (100 + new java.util.Random().nextInt(900));
    try {
      setUpDataset(uniqueDataset);
      registerShutdownHook(uniqueDataset);
    } catch (InterruptedException e) {
      Thread.currentThread().interrupt();
      throw new RuntimeException(e);
    }
    return uniqueDataset;
  }


private static void createSharedResources(String dataset) throws InterruptedException {
BigQuery bigQuery = BigQueryOptions.getDefaultInstance().getService();
String project = DEFAULT_CATALOG;
String script = String.format(CREATE_RESOURCES_SCRIPT, project, dataset);
bigQuery.query(QueryJobConfiguration.of(script));
}

private static void registerShutdownHook(final String dataset) {
Runtime.getRuntime()
.addShutdownHook(
new Thread(
() -> {
try {
BigQuery bigQuery = BigQueryOptions.getDefaultInstance().getService();
bigQuery.query(
QueryJobConfiguration.of(
String.format(dropSchema, DEFAULT_CATALOG, dataset)));
System.out.println("Cleaned up shared dataset: " + dataset);
} catch (Exception e) {
System.err.println(
"Failed to cleanup shared dataset " + dataset + ": " + e.getMessage());
}
}));
}

public static final String DEFAULT_CATALOG = ServiceOptions.getDefaultProjectId();
public static String connectionUrl =
"jdbc:bigquery://https://www.googleapis.com/bigquery/v2:443;ProjectId="
Expand Down
8 changes: 3 additions & 5 deletions java-bigquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITBigQueryJDBCTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
import java.sql.Statement;
import java.sql.Time;
import java.sql.Timestamp;
import java.time.Instant;
import java.time.LocalTime;
import java.util.Properties;
import java.util.Random;
Expand All @@ -76,7 +75,7 @@ public class ITBigQueryJDBCTest extends ITBase {
+ " trip_distance asc LIMIT %s";
private static final Random random = new Random();
private static final int randomNumber = random.nextInt(9999);
private static final String DATASET = "JDBC_PRESUBMIT_INTEGRATION_DATASET";
private static String DATASET;
private static final Object EXCEPTION_REPLACEMENT = "EXCEPTION-WAS-RAISED";
static Connection bigQueryConnection;
static BigQuery bigQuery;
Expand All @@ -86,6 +85,7 @@ public class ITBigQueryJDBCTest extends ITBase {

@BeforeAll
public static void beforeClass() throws SQLException {
DATASET = ITBase.getSharedDataset();
bigQueryConnection = DriverManager.getConnection(connection_uri, new Properties());
bigQueryStatement = bigQueryConnection.createStatement();

Expand Down Expand Up @@ -1567,7 +1567,6 @@ public void testPreparedStatementSmallSelect() throws SQLException {
@Test
public void testPreparedStatementExecuteUpdate() throws SQLException {
Random random = new Random();
String DATASET = "JDBC_INTEGRATION_DATASET";
String TABLE_NAME1 = "Inventory" + random.nextInt(9999);
String TABLE_NAME2 = "DetailedInventory" + random.nextInt(9999);

Expand Down Expand Up @@ -1658,7 +1657,6 @@ public void testPreparedStatementExecuteUpdate() throws SQLException {
@Test
public void testPreparedStatementDateTimeValues() throws SQLException {
Random random = new Random();
String DATASET = "JDBC_INTEGRATION_DATASET";
String TABLE_NAME1 = "DateTimeTestTable" + random.nextInt(9999);

final String createTableQuery =
Expand All @@ -1680,7 +1678,7 @@ public void testPreparedStatementDateTimeValues() throws SQLException {
PreparedStatement insertPs = bigQueryConnection.prepareStatement(insertQuery);
insertPs.setString(1, "dishwasher");
insertPs.setInt(2, 1);
insertPs.setTimestamp(3, Timestamp.from(Instant.now()));
insertPs.setTimestamp(3, new Timestamp(System.currentTimeMillis()));
insertPs.setTime(4, Time.valueOf(LocalTime.NOON));
insertPs.setDate(5, Date.valueOf("2025-12-3"));

Expand Down
3 changes: 2 additions & 1 deletion ...igquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITCallableStatementTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public class ITCallableStatementTest extends ITBase {
+ PROJECT_ID
+ ";OAUTHTYPE=3";
private static final Random random = new Random();
private static final String DATASET = "JDBC_PRESUBMIT_INTEGRATION_DATASET";
private static String DATASET;
private static final String CALLABLE_STMT_PROC_NAME = "IT_CALLABLE_STMT_PROC_TEST";
private static final String CALLABLE_STMT_TABLE_NAME = "IT_CALLABLE_STMT_PROC_TABLE";
private static final String CALLABLE_STMT_PARAM_KEY = "CALL_STMT_PARAM_KEY";
Expand All @@ -71,6 +71,7 @@ public class ITCallableStatementTest extends ITBase {

@BeforeAll
public static void beforeClass() throws SQLException {
DATASET = ITBase.getSharedDataset();
bigQueryConnection = DriverManager.getConnection(connection_uri, new Properties());
bigQueryStatement = bigQueryConnection.createStatement();
bigQuery = BigQueryOptions.newBuilder().build().getService();
Expand Down
7 changes: 3 additions & 4 deletions java-bigquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITConnectionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class ITConnectionTest {

private static final String DATASET = "JDBC_CONNECTION_TEST_DATASET";
private static String DATASET;
private static final String DEFAULT_CATALOG = ServiceOptions.getDefaultProjectId();
static Random random = new Random();
static int randomNumber = random.nextInt(999);
Expand All @@ -53,15 +53,14 @@ public class ITConnectionTest {

@BeforeClass
public static void beforeClass() throws InterruptedException {

ITBase.setUpDataset(DATASET);
DATASET = ITBase.getSharedDataset();
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 26, 2026

Choose a reason for hiding this comment

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

high

Using getSharedDataset() here exposes ITConnectionTest's tables and procedures to other tests running in the same JVM. Using getUniqueDataset() ensures proper test isolation.

Suggested change
DATASET = ITBase.getSharedDataset();
DATASET = ITBase.getUniqueDataset();

ITBase.setUpTable(DATASET, TABLE_NAME);
ITBase.setUpProcedure(DATASET, TABLE_NAME);
}

@AfterClass
public static void afterClass() throws InterruptedException {
ITBase.cleanUp(DATASET);
// Shared dataset cleanup is handled by shutdown hook
}

@Test
Expand Down
9 changes: 6 additions & 3 deletions ...bigquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITDatabaseMetadataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ public class ITDatabaseMetadataTest extends ITBase {
+ ";OAUTHTYPE=3";
private static final Random random = new Random();
private static final int randomNumber = random.nextInt(9999);
private static final String DATASET = "JDBC_PRESUBMIT_INTEGRATION_DATASET";
private static final String DATASET2 = "JDBC_PRESUBMIT_INTEGRATION_DATASET_2";
private static final String CONSTRAINTS_DATASET = "JDBC_CONSTRAINTS_TEST_DATASET";
private static String DATASET;
private static String DATASET2;
private static String CONSTRAINTS_DATASET;
private static final String CONSTRAINTS_TABLE_NAME = "JDBC_CONSTRAINTS_TEST_TABLE";
private static final String CONSTRAINTS_TABLE_NAME2 = "JDBC_CONSTRAINTS_TEST_TABLE2";
private static final String CONSTRAINTS_TABLE_NAME3 = "JDBC_CONSTRAINTS_TEST_TABLE3";
Expand All @@ -70,6 +70,9 @@ public class ITDatabaseMetadataTest extends ITBase {

@BeforeClass
public static void beforeClass() throws InterruptedException, SQLException {
DATASET = ITBase.getSharedDataset();
DATASET2 = ITBase.getSharedDataset2();
CONSTRAINTS_DATASET = ITBase.getSharedDataset();
Comment on lines +73 to +75
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 26, 2026

Choose a reason for hiding this comment

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

high

By assigning both DATASET and CONSTRAINTS_DATASET to ITBase.getSharedDataset(), they point to the exact same dataset. This causes the constraints tables and the metadata test tables to coexist in the same dataset, which can interfere with metadata queries that expect these datasets to be isolated.

Using the new getUniqueDataset() helper ensures that DATASET and DATASET2 are isolated, unique datasets for this test class, while CONSTRAINTS_DATASET correctly points to the shared dataset containing the pre-created constraints tables.

Suggested change
DATASET = ITBase.getSharedDataset();
DATASET2 = ITBase.getSharedDataset2();
CONSTRAINTS_DATASET = ITBase.getSharedDataset();
DATASET = ITBase.getUniqueDataset();
DATASET2 = ITBase.getUniqueDataset();
CONSTRAINTS_DATASET = ITBase.getSharedDataset();

// Set up Dataset
ITBase.setUpTable(DATASET, TABLE_NAME);
}
Expand Down
8 changes: 4 additions & 4 deletions ...-bigquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITNightlyBigQueryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ public class ITNightlyBigQueryTest {
private static final String CALLABLE_STMT_DML_DELETE_PROC_NAME =
"IT_CALLABLE_STMT_PROC_DML_DELETE_TEST";
private static final String CALLABLE_STMT_DML_TABLE_NAME = "IT_CALLABLE_STMT_PROC_DML_TABLE";
private static final String DATASET = "JDBC_NIGHTLY_IT_DATASET";
private static final String DATASET2 = "JDBC_PRESUBMIT_INTEGRATION_DATASET_2";
private static String DATASET;
private static String DATASET2;
static final String session_enabled_connection_uri =
"jdbc:bigquery://https://www.googleapis.com/bigquery/v2:443;PROJECTID="
+ PROJECT_ID
Expand All @@ -93,6 +93,8 @@ public class ITNightlyBigQueryTest {

@BeforeAll
public static void beforeClass() throws SQLException {
DATASET = ITBase.getSharedDataset();
DATASET2 = ITBase.getSharedDataset2();
bigQueryConnection = DriverManager.getConnection(connection_uri, new Properties());
bigQueryStatement = bigQueryConnection.createStatement();
bigQuery = BigQueryOptions.newBuilder().build().getService();
Expand All @@ -107,7 +109,6 @@ public static void afterClass() throws SQLException {
@Test
public void testMergeInExecuteBatch() throws SQLException {
Random random = new Random();
String DATASET = "JDBC_INTEGRATION_DATASET";
String TABLE_NAME1 = "Inventory" + random.nextInt(9999);
String TABLE_NAME2 = "DetailedInventory" + random.nextInt(9999);

Expand Down Expand Up @@ -577,7 +578,6 @@ public void testValidExecuteBatchWithMultipleTables() throws SQLException {
@Test
public void testPreparedStatementExecuteUpdate() throws SQLException {
Random random = new Random();
String DATASET = "JDBC_INTEGRATION_DATASET";
String TABLE_NAME1 = "Inventory" + random.nextInt(9999);
String TABLE_NAME2 = "DetailedInventory" + random.nextInt(9999);

Expand Down
6 changes: 3 additions & 3 deletions ...igquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITResultSetMetadataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ public class ITResultSetMetadataTest {
static Random random = new Random();
static int randomNumber = random.nextInt(999);
private static final String TABLE_NAME = "JDBC_RSMETADATA_TEST_TABLE" + randomNumber;
private static final String DATASET = "JDBC_RSMETADATA_TEST_DATASET";
private static String DATASET;
private static ResultSetMetaData metaData;

@BeforeClass
public static void beforeClass() throws InterruptedException {
ITBase.setUpDataset(DATASET);
DATASET = ITBase.getSharedDataset();
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 26, 2026

Choose a reason for hiding this comment

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

high

Using getSharedDataset() here means ITResultSetMetadataTest shares its dataset with other test classes. Any tables created here will persist until JVM shutdown and could interfere with metadata queries in other tests. Using getUniqueDataset() ensures complete isolation.

Suggested change
DATASET = ITBase.getSharedDataset();
DATASET = ITBase.getUniqueDataset();

ITBase.setUpTable(DATASET, TABLE_NAME);
}

@AfterClass
public static void afterClass() throws InterruptedException {
ITBase.cleanUp(DATASET);
// Shared dataset cleanup is handled by shutdown hook
}

@Test
Expand Down
6 changes: 3 additions & 3 deletions java-bigquery-jdbc/src/test/java/com/google/cloud/bigquery/jdbc/it/ITStatementTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

public class ITStatementTest {
private static final String DEFAULT_CATALOG = ServiceOptions.getDefaultProjectId();
private static final String DATASET = "JDBC_STATEMENT_TEST_DATASET";
private static String DATASET;
private static String connectionUrl =
"jdbc:bigquery://https://www.googleapis.com/bigquery/v2:443;ProjectId=%s;OAuthType=3;Timeout=3600;";
private static Random random = new Random();
Expand All @@ -50,13 +50,13 @@ public class ITStatementTest {

@BeforeClass
public static void beforeClass() throws InterruptedException {
ITBase.setUpDataset(DATASET);
DATASET = ITBase.getSharedDataset();
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 26, 2026

Choose a reason for hiding this comment

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

high

Using getSharedDataset() here exposes ITStatementTest's tables to other tests running in the same JVM. Using getUniqueDataset() ensures proper test isolation.

Suggested change
DATASET = ITBase.getSharedDataset();
DATASET = ITBase.getUniqueDataset();

ITBase.setUpTable(DATASET, TABLE_NAME);
}

@AfterClass
public static void afterClass() throws InterruptedException {
ITBase.cleanUp(DATASET);
// Shared dataset cleanup is handled by shutdown hook
}

@Test
Expand Down
Loading