[JUnit 5] Migrate to JUnit 5 Platform (with existing JUnit 4 test cases) (aws#2850)

* [JUnit 5] Migrate to JUnit 5 Platform (with existing JUnit 4 test cases)

## Motivation

We would like to leverage JUnit 5's concept of global hooks which can be
installed and detected as part of the class path:

https://junit.org/junit5/docs/current/user-guide/#extensions-registration-automatic

However, our current codebase uses JUnit 4 almost everywhere, except for
the stability tests, which leverage JUnit 5. Besides wishing to take
advantage of newer features, there is additional value in making sure
our tests are consistent and up-to-date as well.

JUnit 5 offers the junit-vintage-engine module to support legacy JUnit 4
style tests. Simply having it available on the class path will allow
JUnit 4 tests be executed with the JUnit 5 Platform launcher:

https://junit.org/junit5/docs/current/user-guide/#migrating-from-junit4

JUnit 4 -> 5 migrations are often done in a 3-step process:

1. Update dependencies to JUnit 5, including the vintage module, causing
all tests to leverage the new JUnit 5 Platform
2. Incrementally migrate JUnit 4 tests to JUnit 5 tests
3. Once no JUnit 4 usage remains, remove the dependency on the vintage
module

This commit achieves the first step in the above process, which will
also allow us to immediately leverage JUnit 5-specific features, like
global/classpath hooks.

## Modifications

* Upgrade JUnit 5 version from 5.4.2 to 5.8.1 (latest)
* For all existing usages of junit, replace them with a dependency on
junit-jupiter and junit-vintage-engine
* Upgrade Maven Surefire version from 2.22.2 to 3.0.0-M5,
which has better support for JUnit 5

https://maven.apache.org/surefire/maven-surefire-plugin/examples/junit-platform.html

Author: Bennett-Lynch

archetypes/archetype-app-quickstart/src/main/resources/archetype-resources/pom.xml

@@ -17,7 +17,7 @@
         <aws.java.sdk.version>${javaSdkVersion}</aws.java.sdk.version>
         <slf4j.version>1.7.28</slf4j.version>
         <graalvm.version>21.0.0</graalvm.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-app-quickstart/src/test/resources/projects/apachehttpclient/reference/pom.xml

@@ -16,7 +16,7 @@
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <slf4j.version>1.7.28</slf4j.version>
         <graalvm.version>21.0.0</graalvm.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-app-quickstart/src/test/resources/projects/apachehttpclientwithoutnativeimage/reference/pom.xml

@@ -16,7 +16,7 @@
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <slf4j.version>1.7.28</slf4j.version>
         <graalvm.version>21.0.0</graalvm.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-app-quickstart/src/test/resources/projects/nettyclient/reference/pom.xml

@@ -16,7 +16,7 @@
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <slf4j.version>1.7.28</slf4j.version>
         <graalvm.version>21.0.0</graalvm.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-app-quickstart/src/test/resources/projects/urlhttpclient/reference/pom.xml

@@ -16,7 +16,7 @@
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <slf4j.version>1.7.28</slf4j.version>
         <graalvm.version>21.0.0</graalvm.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-lambda/src/main/resources/archetype-resources/pom.xml

@@ -16,7 +16,7 @@
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
         <aws.java.sdk.version>${javaSdkVersion}</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
 #if( $httpClient == 'netty-nio-client')
         <netty.openssl.version>${nettyOpenSslVersion}</netty.openssl.version>
 #end

archetypes/archetype-lambda/src/test/resources/projects/apachehttpclient/reference/pom.xml

@@ -15,7 +15,7 @@
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-lambda/src/test/resources/projects/dynamodbstreamsclient/reference/pom.xml

@@ -15,7 +15,7 @@
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-lambda/src/test/resources/projects/nettyclient/reference/pom.xml

@@ -15,7 +15,7 @@
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
         <netty.openssl.version>2.0.29.Final</netty.openssl.version>
     </properties>
 

archetypes/archetype-lambda/src/test/resources/projects/urlhttpclient/reference/pom.xml

@@ -15,7 +15,7 @@
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

archetypes/archetype-lambda/src/test/resources/projects/wafregionalclient/reference/pom.xml

@@ -15,7 +15,7 @@
         <exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
-        <junit5.version>5.4.2</junit5.version>
+        <junit5.version>5.8.1</junit5.version>
     </properties>
 
     <dependencyManagement>

bom-internal/pom.xml

@@ -295,9 +295,15 @@
                 <scope>test</scope>
             </dependency>
             <dependency>
-                <groupId>junit</groupId>
-                <artifactId>junit</artifactId>
-                <version>${junit.version}</version>
+                <groupId>org.junit.jupiter</groupId>
+                <artifactId>junit-jupiter</artifactId>
+                <version>${junit5.version}</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.junit.vintage</groupId>
+                <artifactId>junit-vintage-engine</artifactId>
+                <version>${junit5.version}</version>
                 <scope>test</scope>
             </dependency>
             <dependency>

codegen-lite/pom.xml

@@ -94,8 +94,13 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
     </dependencies>

codegen/pom.xml

@@ -156,8 +156,13 @@
         </dependency>
 
         <dependency>
-            <artifactId>junit</artifactId>
-            <groupId>junit</groupId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/arns/pom.xml

@@ -44,8 +44,13 @@
         </dependency>
 
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/auth-crt/pom.xml

@@ -69,8 +69,13 @@
         </dependency>
 
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/auth/pom.xml

@@ -73,8 +73,13 @@
         </dependency>
 
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/aws-core/pom.xml

@@ -85,8 +85,13 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/json-utils/pom.xml

@@ -57,8 +57,13 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/metrics-spi/pom.xml

@@ -33,8 +33,13 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/protocols/aws-cbor-protocol/pom.xml

@@ -57,8 +57,13 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/protocols/aws-json-protocol/pom.xml

@@ -72,8 +72,13 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/protocols/aws-query-protocol/pom.xml

@@ -62,8 +62,13 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/protocols/aws-xml-protocol/pom.xml

@@ -67,8 +67,13 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/protocols/protocol-core/pom.xml

@@ -53,8 +53,13 @@
             <version>${awsjavasdk.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/regions/pom.xml

@@ -64,8 +64,13 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/sdk-core/pom.xml

@@ -72,8 +72,13 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

http-client-spi/pom.xml

@@ -61,8 +61,13 @@
             <version>${reactive-streams.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

http-clients/apache-client/pom.xml

@@ -64,8 +64,13 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>