Replace TestNG with JUnit5 (#117)

* Add 8 to matrix for testing

* Replace testng with junit5

Author: matthewelwell

.github/workflows/maven.yml

@@ -26,7 +26,7 @@ jobs:
     strategy:
       matrix:
         distribution: ["zulu", "adopt"]
-        java: ["11"]
+        java: ["8", "11"]
 
     steps:
       - name: Checkout repository

pom.xml

@@ -45,6 +45,7 @@
     <lombok.version>1.18.22</lombok.version>
     <slf4j.version>1.7.30</slf4j.version>
     <maven.checkstyle.version>3.1.0</maven.checkstyle.version>
+    <junit.jupiter.version>5.9.2</junit.jupiter.version>
   </properties>
 
   <dependencies>
@@ -104,9 +105,15 @@
       <scope>test</scope>
     </dependency>
     <dependency>
-      <groupId>org.testng</groupId>
-      <artifactId>testng</artifactId>
-      <version>7.7.0</version>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>${junit.jupiter.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <version>${junit.jupiter.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -122,6 +129,7 @@
       <scope>test</scope>
     </dependency>
     <dependency>
+      <!-- todo: do we need this? -->
       <groupId>io.rest-assured</groupId>
       <artifactId>rest-assured</artifactId>
       <version>4.3.3</version>
@@ -236,6 +244,11 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>2.22.0</version>
+      </plugin>
     </plugins>
   </build>
 

src/test/java/com/flagsmith/FlagsmithApiWrapperCachingTest.java

@@ -1,13 +1,14 @@
 package com.flagsmith;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyBoolean;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
-import static org.testng.Assert.*;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.flagsmith.config.FlagsmithCacheConfig;
@@ -28,11 +29,11 @@
 import okhttp3.Request;
 import okhttp3.RequestBody;
 import okhttp3.mock.MockInterceptor;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.BeforeEach;
 import org.mockito.ArgumentCaptor;
-import org.testng.annotations.BeforeMethod;
-import org.testng.annotations.Test;
 
-@Test(groups = "unit")
+
 public class FlagsmithApiWrapperCachingTest {
   private final String API_KEY = "OUR_API_KEY";
   private final String BASE_URL = "https://unit-test.com";
@@ -45,7 +46,7 @@ public class FlagsmithApiWrapperCachingTest {
   private MockInterceptor interceptor;
   private RequestProcessor requestProcessor;
 
-  @BeforeMethod(groups = "unit")
+  @BeforeEach
   public void init() {
     flagsmithCacheImpl = mock(FlagsmithCacheConfig.FlagsmithCacheImpl.class);
 
@@ -64,13 +65,13 @@ public void init() {
     flagsmithAPIWrapper.setRequestor(requestProcessor);
   }
 
-  @Test(groups = "unit")
+  @Test
   public void getCache_returnsInternalCache() {
     final FlagsmithCache actualInternalCache = flagsmithAPIWrapper.getCache();
     assertEquals(flagsmithCacheImpl, actualInternalCache);
   }
 
-  @Test(groups = "unit")
+  @Test
   public void getFeatureFlags_envFlags_cacheEnabled_dontFetchFlagsWhenInCache() {
     // Arrange
     final String cacheKey = "cacheKey";
@@ -89,7 +90,7 @@ public void getFeatureFlags_envFlags_cacheEnabled_dontFetchFlagsWhenInCache() {
     assertEquals(flagsAndTraits, actualFeatureFlags);
   }
 
-  @Test(groups = "unit")
+  @Test
   public void getFeatureFlags_fetchFlagsFromFlagsmithAndStoreThemInCache() {
     final String cacheKey = "cacheKey";
     when(flagsmithCacheImpl.getEnvFlagsCacheKey()).thenReturn(cacheKey);
@@ -110,7 +111,7 @@ public void getFeatureFlags_fetchFlagsFromFlagsmithAndStoreThemInCache() {
     assertEquals(1, cache.estimatedSize());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void getFeatureFlags_fetchFlagsFromCacheAndNotFromFlagsmith() {
     // Arrange
     final String cacheKey = "cacheKey";
@@ -127,7 +128,7 @@ public void getFeatureFlags_fetchFlagsFromCacheAndNotFromFlagsmith() {
     assertEquals(newFlagsList(flagsAndTraits), actualFeatureFlags);
   }
 
-  @Test(groups = "unit")
+  @Test
   public void identifyUserWithTraits_nullUser() {
     // Act
     assertThrows(IllegalArgumentException.class,
@@ -138,7 +139,7 @@ public void identifyUserWithTraits_nullUser() {
     assertEquals(0, cache.estimatedSize());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void identifyUserWithTraits_nullUserIdentifier() {
     // Act
     assertThrows(IllegalArgumentException.class,
@@ -149,7 +150,7 @@ public void identifyUserWithTraits_nullUserIdentifier() {
     assertEquals(0, cache.estimatedSize());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void identifyUserWithTraits_fetchFlagsFromFlagsmithAndStoreThemInCache_whenCacheEmpty() {
     // Arrange
     String identifier = "test-user";
@@ -169,7 +170,7 @@ public void identifyUserWithTraits_fetchFlagsFromFlagsmithAndStoreThemInCache_wh
     assertEquals(newFlagsList(new ArrayList<>()), actualUserFlagsAndTraits);
   }
 
-  @Test(groups = "unit")
+  @Test
   public void testGetFeatureFlags_ReturnsFeatureFlagsFromApi_IfCacheButNoEnvCacheKey() {
     // Given
     when(flagsmithCacheImpl.getEnvFlagsCacheKey()).thenReturn(null);
@@ -185,7 +186,7 @@ public void testGetFeatureFlags_ReturnsFeatureFlagsFromApi_IfCacheButNoEnvCacheK
     assertEquals(flags, Flags.fromFeatureStateModels(featureStateModels, null));
   }
 
-  @Test(groups = "unit")
+  @Test
   public void verifyRequestBody() {
     String identifier = "test-user";
     final ArrayList<TraitModel> traits = new ArrayList<>();

src/test/java/com/flagsmith/FlagsmithApiWrapperTest.java

@@ -9,8 +9,8 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
-import static org.testng.Assert.assertEquals;
-import static org.testng.Assert.assertNull;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -37,10 +37,10 @@
 import okhttp3.ResponseBody;
 import okhttp3.mock.MockInterceptor;
 import org.bouncycastle.ocsp.Req;
-import org.testng.annotations.BeforeMethod;
-import org.testng.annotations.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
 
-@Test(groups = "unit")
 public class FlagsmithApiWrapperTest {
 
   private final String API_KEY = "OUR_API_KEY";
@@ -51,7 +51,7 @@ public class FlagsmithApiWrapperTest {
   private FlagsmithConfig defaultConfig;
   private MockInterceptor interceptor;
 
-  @BeforeMethod(groups = "unit")
+  @BeforeEach
   public void init() {
     flagsmithLogger = mock(FlagsmithLogger.class);
     doThrow(new FlagsmithException("error Response")).when(flagsmithLogger)
@@ -65,7 +65,7 @@ public void init() {
     sut = new FlagsmithApiWrapper(defaultConfig, null, flagsmithLogger, API_KEY);
   }
 
-  @Test(groups = "unit")
+  @Test
   public void getFeatureFlags_noUser_success() throws JsonProcessingException {
     // Arrange
     interceptor.addRule()
@@ -82,7 +82,7 @@ public void getFeatureFlags_noUser_success() throws JsonProcessingException {
     verify(flagsmithLogger, times(0)).httpError(any(), any(IOException.class), anyBoolean());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void getFeatureFlags_noUser_fail() {
     // Arrange
     interceptor.addRule()
@@ -99,7 +99,7 @@ public void getFeatureFlags_noUser_fail() {
     verify(flagsmithLogger, times(0)).httpError(any(), any(IOException.class), anyBoolean());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void identifyUserWithTraits_success() throws JsonProcessingException {
     // Arrange
     final List<TraitModel> traits = new ArrayList<TraitModel>(Arrays.asList(new TraitModel()));
@@ -124,7 +124,7 @@ public void identifyUserWithTraits_success() throws JsonProcessingException {
     verify(flagsmithLogger, times(0)).httpError(any(), any(IOException.class), anyBoolean());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void identifyUserWithTraits_fail() {
     // Arrange
     final List<TraitModel> traits = new ArrayList<TraitModel>(Arrays.asList(new TraitModel()));
@@ -142,7 +142,7 @@ public void identifyUserWithTraits_fail() {
     verify(flagsmithLogger, times(0)).httpError(any(), any(IOException.class), anyBoolean());
   }
 
-  @Test(groups = "unit")
+  @Test
   public void testClose_ClosesRequestProcessor() {
     // Given
     RequestProcessor mockedRequestProcessor = mock(RequestProcessor.class);
@@ -156,7 +156,7 @@ public void testClose_ClosesRequestProcessor() {
     verify(mockedRequestProcessor, times(1)).close();
   }
 
-  @Test(groups = "unit")
+  @Test
   public void testClose_ClosesAnalyticsProcessor() {
     // Given
     AnalyticsProcessor mockedAnalyticsProcessor = mock(AnalyticsProcessor.class);