chore: Migrate tests to JUnit5 (#4052)

* feat: Migrate to JUnit 5 and add parallel test execution

* feat: Migrate tests to JUnit5

* chore: Add surefire-junit-platform dep for ITs

* chore: Fix broken tests

* chore: Upgrade existing integration tests to JUnit 5 syntax and features

* chore: Upgrade ITNightlyBigQueryTest to JUnit 5 features and package-private

* chore: Make the tests package-private

* feat: migrate tests to JUnit 5 assertThrows and static imports

* chore: Remove wildcard imports

* chore: revert samples to use junit4

* chore: Address code comments

* chore: Close connection after test

---------

Co-authored-by: AbgarSim <[email protected]>

Author: lqiu96

google-cloud-bigquery/pom.xml

@@ -162,8 +162,18 @@
       <scope>test</scope>
     </dependency>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
+      <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.mockito</groupId>
+      <artifactId>mockito-junit-jupiter</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -207,6 +217,20 @@
 
   <build>
     <plugins>
+      <!-- Declare `surefire-junit-platform` here as shared-configs pulls in surefire-junit47 -->
+      <!-- which is for JUnit4 and not JUnit5. Declare this here until upstream is fixed -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-failsafe-plugin</artifactId>
+        <version>3.5.2</version>
+        <dependencies>
+          <dependency>
+            <groupId>org.apache.maven.surefire</groupId>
+            <artifactId>surefire-junit-platform</artifactId>
+            <version>${surefire.version}</version>
+          </dependency>
+        </dependencies>
+      </plugin>
       <plugin>
         <!-- Allow script to run, so we can run benchmarks. -->
         <groupId>org.codehaus.mojo</groupId>

google-cloud-bigquery/src/test/java/MetadataCacheStatsTest.java

@@ -16,16 +16,16 @@
 
 package com.google.cloud.bigquery;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import com.google.api.services.bigquery.model.MetadataCacheStatistics;
 import com.google.common.collect.ImmutableList;
 import com.google.common.truth.Truth;
 import java.util.List;
 import java.util.stream.Collectors;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-public class MetadataCacheStatsTest {
+class MetadataCacheStatsTest {
   private static List<com.google.api.services.bigquery.model.TableMetadataCacheUsage>
       TABLE_METADATA_CACHE_USAGE_PB_LIST =
           ImmutableList.of(
@@ -44,7 +44,7 @@ public class MetadataCacheStatsTest {
       new MetadataCacheStatistics().setTableMetadataCacheUsage(TABLE_METADATA_CACHE_USAGE_PB_LIST);
 
   @Test
-  public void testToPbAndFromPb() {
+  void testToPbAndFromPb() {
     assertEquals(METADATA_CACHE_STATISTICS_PB, METADATA_CACHE_STATS.toPb());
     compareMetadataCacheStats(
         METADATA_CACHE_STATS, MetadataCacheStats.fromPb(METADATA_CACHE_STATISTICS_PB));

google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/AclTest.java

@@ -16,7 +16,7 @@
 
 package com.google.cloud.bigquery;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import com.google.api.services.bigquery.model.Dataset;
 import com.google.cloud.bigquery.Acl.DatasetAclEntity;
@@ -31,12 +31,12 @@
 import com.google.cloud.bigquery.Acl.View;
 import com.google.common.collect.ImmutableList;
 import java.util.List;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-public class AclTest {
+class AclTest {
 
   @Test
-  public void testDatasetEntity() {
+  void testDatasetEntity() {
     DatasetId datasetId = DatasetId.of("dataset");
     List<String> targetTypes = ImmutableList.of("VIEWS");
     DatasetAclEntity entity = new DatasetAclEntity(datasetId, targetTypes);
@@ -47,7 +47,7 @@ public void testDatasetEntity() {
   }
 
   @Test
-  public void testDomainEntity() {
+  void testDomainEntity() {
     Domain entity = new Domain("d1");
     assertEquals("d1", entity.getDomain());
     assertEquals(Type.DOMAIN, entity.getType());
@@ -56,7 +56,7 @@ public void testDomainEntity() {
   }
 
   @Test
-  public void testGroupEntity() {
+  void testGroupEntity() {
     Group entity = new Group("g1");
     assertEquals("g1", entity.getIdentifier());
     assertEquals(Type.GROUP, entity.getType());
@@ -65,7 +65,7 @@ public void testGroupEntity() {
   }
 
   @Test
-  public void testSpecialGroupEntity() {
+  void testSpecialGroupEntity() {
     Group entity = Group.ofAllAuthenticatedUsers();
     assertEquals("allAuthenticatedUsers", entity.getIdentifier());
     Dataset.Access pb = entity.toPb();
@@ -85,7 +85,7 @@ public void testSpecialGroupEntity() {
   }
 
   @Test
-  public void testUserEntity() {
+  void testUserEntity() {
     User entity = new User("u1");
     assertEquals("u1", entity.getEmail());
     assertEquals(Type.USER, entity.getType());
@@ -94,7 +94,7 @@ public void testUserEntity() {
   }
 
   @Test
-  public void testViewEntity() {
+  void testViewEntity() {
     TableId viewId = TableId.of("project", "dataset", "view");
     View entity = new View(viewId);
     assertEquals(viewId, entity.getId());
@@ -104,7 +104,7 @@ public void testViewEntity() {
   }
 
   @Test
-  public void testRoutineEntity() {
+  void testRoutineEntity() {
     RoutineId routineId = RoutineId.of("project", "dataset", "routine");
     Acl.Routine entity = new Acl.Routine(routineId);
     assertEquals(routineId, entity.getId());
@@ -114,15 +114,15 @@ public void testRoutineEntity() {
   }
 
   @Test
-  public void testIamMemberEntity() {
+  void testIamMemberEntity() {
     IamMember entity = new IamMember("member1");
     assertEquals("member1", entity.getIamMember());
     Dataset.Access pb = entity.toPb();
     assertEquals(entity, Entity.fromPb(pb));
   }
 
   @Test
-  public void testOf() {
+  void testOf() {
     Acl acl = Acl.of(Group.ofAllAuthenticatedUsers(), Role.READER);
     assertEquals(Group.ofAllAuthenticatedUsers(), acl.getEntity());
     assertEquals(Role.READER, acl.getRole());
@@ -139,7 +139,7 @@ public void testOf() {
   }
 
   @Test
-  public void testOfWithCondition() {
+  void testOfWithCondition() {
     Expr expr = new Expr("expression", "title", "description", "location");
     Acl acl = Acl.of(Group.ofAllAuthenticatedUsers(), Role.READER, expr);
     Dataset.Access pb = acl.toPb();

google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/AnnotationsTest.java

@@ -17,17 +17,17 @@
 package com.google.cloud.bigquery;
 
 import static com.google.common.truth.Truth.assertThat;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import com.google.api.client.util.Data;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class AnnotationsTest {
   @Test
-  public void testFromUser() {
+  void testFromUser() {
     assertThat(Annotations.fromUser(null).userMap()).isNull();
 
     HashMap<String, String> user = new HashMap<>();
@@ -43,7 +43,7 @@ public void testFromUser() {
   }
 
   @Test
-  public void testFromToPb() {
+  void testFromToPb() {
     assertThat(Annotations.fromPb(null).toPb()).isNull();
 
     HashMap<String, String> pb = new HashMap<>();
@@ -60,17 +60,13 @@ public void testFromToPb() {
   }
 
   @Test
-  public void testNullKey() {
-    try {
-      Annotations.fromUser(Collections.singletonMap((String) null, "foo"));
-      fail("null key shouldn't work");
-    } catch (IllegalArgumentException e) {
-    }
+  void testNullKey() {
+    assertThrows(
+        IllegalArgumentException.class,
+        () -> Annotations.fromUser(Collections.singletonMap((String) null, "foo")));
 
-    try {
-      Annotations.fromPb(Collections.singletonMap((String) null, "foo"));
-      fail("null key shouldn't work");
-    } catch (IllegalArgumentException e) {
-    }
+    assertThrows(
+        IllegalArgumentException.class,
+        () -> Annotations.fromPb(Collections.singletonMap((String) null, "foo")));
   }
 }

google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/AvroOptionsTest.java

@@ -16,9 +16,9 @@
 
 package com.google.cloud.bigquery;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class AvroOptionsTest {
 
@@ -27,7 +27,7 @@ public class AvroOptionsTest {
       AvroOptions.newBuilder().setUseAvroLogicalTypes(USE_AVRO_LOGICAL_TYPES).build();
 
   @Test
-  public void testToBuilder() {
+  void testToBuilder() {
     compareAvroOptions(AVRO_OPTIONS, AVRO_OPTIONS.toBuilder().build());
     AvroOptions avroOptions = AVRO_OPTIONS.toBuilder().setUseAvroLogicalTypes(false).build();
     assertEquals(false, avroOptions.useAvroLogicalTypes());
@@ -36,13 +36,13 @@ public void testToBuilder() {
   }
 
   @Test
-  public void testBuilder() {
+  void testBuilder() {
     assertEquals(FormatOptions.AVRO, AVRO_OPTIONS.getType());
     assertEquals(USE_AVRO_LOGICAL_TYPES, AVRO_OPTIONS.useAvroLogicalTypes());
   }
 
   @Test
-  public void testToAndFromPb() {
+  void testToAndFromPb() {
     compareAvroOptions(AVRO_OPTIONS, AvroOptions.fromPb(AVRO_OPTIONS.toPb()));
     AvroOptions avroOptions =
         AvroOptions.newBuilder().setUseAvroLogicalTypes(USE_AVRO_LOGICAL_TYPES).build();

google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/BigLakeConfigurationTest.java

@@ -16,11 +16,11 @@
 
 package com.google.cloud.bigquery;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-public class BigLakeConfigurationTest {
+class BigLakeConfigurationTest {
 
   private static final String STORAGE_URI = "gs://storage-uri";
   private static final String FILE_FORMAT = "PARQUET";
@@ -43,20 +43,20 @@ public class BigLakeConfigurationTest {
               .setConnectionId(CONNECTION_ID);
 
   @Test
-  public void testToBuilder() {
+  void testToBuilder() {
     assertEquals(STORAGE_URI, BIG_LAKE_CONFIGURATION.getStorageUri());
     assertEquals(FILE_FORMAT, BIG_LAKE_CONFIGURATION.getFileFormat());
     assertEquals(TABLE_FORMAT, BIG_LAKE_CONFIGURATION.getTableFormat());
     assertEquals(CONNECTION_ID, BIG_LAKE_CONFIGURATION.getConnectionId());
   }
 
   @Test
-  public void testToPb() {
+  void testToPb() {
     assertBigLakeConfiguration(BIG_LAKE_CONFIGURATION_PB, BIG_LAKE_CONFIGURATION.toPb());
   }
 
   @Test
-  public void testFromPb() {
+  void testFromPb() {
     assertBigLakeConfiguration(
         BIG_LAKE_CONFIGURATION, BigLakeConfiguration.fromPb(BIG_LAKE_CONFIGURATION_PB));
   }

google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/BigQueryErrorTest.java

@@ -16,9 +16,9 @@
 
 package com.google.cloud.bigquery;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class BigQueryErrorTest {
 
@@ -32,7 +32,7 @@ public class BigQueryErrorTest {
       new BigQueryError(REASON, LOCATION, MESSAGE);
 
   @Test
-  public void testConstructor() {
+  void testConstructor() {
     assertEquals(REASON, ERROR.getReason());
     assertEquals(LOCATION, ERROR.getLocation());
     assertEquals(DEBUG_INFO, ERROR.getDebugInfo());
@@ -44,7 +44,7 @@ public void testConstructor() {
   }
 
   @Test
-  public void testToAndFromPb() {
+  void testToAndFromPb() {
     compareBigQueryError(ERROR, BigQueryError.fromPb(ERROR.toPb()));
     compareBigQueryError(ERROR_INCOMPLETE, BigQueryError.fromPb(ERROR_INCOMPLETE.toPb()));
   }