Merge pull request #1607 from datafaker-net/refactoring/provider-list-test

Author: kingthorin

src/test/java/net/datafaker/FakerTest.java

@@ -381,12 +381,12 @@ void testDeterministicAndNonDeterministicProvidersReturnValues() {
                 }
                 if (m.isAnnotationPresent(Deterministic.class)) {
                     assertThat(set)
-                        .as("Class: " + ap.getClass().getName()
+                        .as(() -> "Class: " + ap.getClass().getName()
                             + ", method: " + m.getName() + " should have the same return value")
                         .hasSize(1);
                 } else {
                     assertThat(set)
-                        .as("Class: " + ap.getClass().getName()
+                        .as(() -> "Class: " + ap.getClass().getName()
                             + ", method: " + m.getName() + " should generate different return values")
                         .hasSizeGreaterThan(1);
                 }

src/test/java/net/datafaker/providers/base/AncientTest.java

@@ -6,7 +6,7 @@
 import java.util.List;
 import java.util.Locale;
 
-class AncientTest extends BaseFakerTest<BaseFaker> {
+class AncientTest extends BaseFakerTest {
 
     private static Collection<TestSpec> getProviderListTests(Ancient ancient) {
         return List.of(
@@ -24,11 +24,13 @@ protected Collection<TestSpec> providerListTest() {
     }
 
     @Nested
-    class AncientInGreekTest extends BaseFakerTest<BaseFaker> {
+    final class AncientInGreekTest extends ProviderListTest<BaseFaker> {
+
+        private final BaseFaker faker = new BaseFaker(new Locale("el", "GR"));
 
         @Override
         protected BaseFaker getFaker() {
-            return new BaseFaker(new Locale("el", "GR"));
+            return faker;
         }
 
         @Override

src/test/java/net/datafaker/providers/base/AnimalTest.java

@@ -6,7 +6,7 @@
 import java.util.List;
 import java.util.Collection;
 
-class AnimalTest extends BaseFakerTest<BaseFaker> {
+class AnimalTest extends BaseFakerTest {
 
     private final Animal animal = faker.animal();
 

src/test/java/net/datafaker/providers/base/AppTest.java

@@ -8,7 +8,7 @@
 import java.util.List;
 import java.util.Collection;
 
-class AppTest extends BaseFakerTest<BaseFaker> {
+class AppTest extends BaseFakerTest {
 
     private final App app = faker.app();
 

src/test/java/net/datafaker/providers/base/ApplianceTest.java

@@ -3,7 +3,7 @@
 import java.util.List;
 import java.util.Collection;
 
-class ApplianceTest extends BaseFakerTest<BaseFaker> {
+final class ApplianceTest extends BaseFakerTest {
 
     @Override
     protected Collection<TestSpec> providerListTest() {

src/test/java/net/datafaker/providers/base/ArtistTest.java

@@ -3,7 +3,7 @@
 import java.util.List;
 import java.util.Collection;
 
-class ArtistTest extends BaseFakerTest<BaseFaker> {
+class ArtistTest extends BaseFakerTest {
 
     @Override
     protected Collection<TestSpec> providerListTest() {

src/test/java/net/datafaker/providers/base/AustraliaTest.java

@@ -3,7 +3,7 @@
 import java.util.List;
 import java.util.Collection;
 
-class AustraliaTest extends BaseFakerTest<BaseFaker> {
+class AustraliaTest extends BaseFakerTest {
 
     @Override
     protected Collection<TestSpec> providerListTest() {

src/test/java/net/datafaker/providers/base/AviationTest.java

@@ -8,7 +8,7 @@
 import java.util.Collection;
 import java.util.regex.Pattern;
 
-class AviationTest extends BaseFakerTest<BaseFaker> {
+class AviationTest extends BaseFakerTest {
 
     private final Aviation aviation = faker.aviation();
 

src/test/java/net/datafaker/providers/base/AwsTest.java

@@ -7,7 +7,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-class AwsTest extends BaseFakerTest<BaseFaker> {
+class AwsTest extends BaseFakerTest {
 
     @Test
     void testAccountId() {

src/test/java/net/datafaker/providers/base/BaseFakerTest.java

@@ -1,93 +1,11 @@
 package net.datafaker.providers.base;
 
-import org.junit.jupiter.api.TestInstance;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.MethodSource;
+public abstract class BaseFakerTest extends ProviderListTest<BaseFaker> {
+    protected final BaseFaker faker = new BaseFaker();
 
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-import java.util.function.Supplier;
-import java.util.regex.Pattern;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-@TestInstance(TestInstance.Lifecycle.PER_CLASS)
-public abstract class BaseFakerTest<T extends BaseFaker> {
-
-    protected final T faker = getFaker();
-
-    @SuppressWarnings("unchecked")
-    protected T getFaker() {
-        return (T) new BaseFaker();
+    @Override
+    protected final BaseFaker getFaker() {
+        return faker;
     }
 
-    protected List<String> getBaseList(String key) {
-        return faker.fakeValuesService().fetchObject(key, faker.getContext());
-    }
-
-    @ParameterizedTest
-    @MethodSource("providerListTest")
-    protected void testProviderList(TestSpec testSpec) {
-        // Given
-        Set<String> actual = new HashSet<>(getBaseList(testSpec.key));
-        // When
-        String item = (String) testSpec.supplier.get();
-        // Then
-        assertThat(item).as("Check item isn't empty").isNotEmpty();
-        String collection = "\"" + testSpec.key + "\"";
-        assertThat(actual).as("Check actual list isn't empty and contains the item for the key " + collection).isNotEmpty()
-            .anyMatch(item::equals);
-        assertThat(actual).as("Actual should not have empty entries. " + collection).noneMatch(single -> single.isBlank());
-        if (!testSpec.regex.isEmpty()) {
-            assertThat(item).as("Check item matches regex").matches(Pattern.compile(testSpec.regex));
-        }
-    }
-
-    @ParameterizedTest
-    @MethodSource("providerListTest")
-    void testNoDuplications(TestSpec testSpec) {
-        var terms = getBaseList(testSpec.key);
-
-        Set<String> uniques = new HashSet<>();
-        Set<String> duplicates = new HashSet<>();
-        for (String term : terms) {
-            if (!uniques.add(term)) {
-                duplicates.add(term);
-            }
-        }
-        assertThat(duplicates)
-            .as("Check no duplications in " + testSpec.key + " with terms " + terms)
-            .isEmpty();
-    }
-
-    protected abstract Collection<TestSpec> providerListTest();
-
-    protected static class TestSpec {
-        private final Supplier<?> supplier;
-        private final String key;
-        @SuppressWarnings("unused")
-        private final String regex;
-
-        private TestSpec(Supplier<?> supplier, String key, String regex) {
-            this.supplier = supplier;
-            this.key = key;
-            this.regex = regex;
-        }
-
-        public static TestSpec of(Supplier<?> supplier, String key) {
-            return new TestSpec(supplier, key, "");
-        }
-
-        public static TestSpec of(Supplier<?> supplier, String key, String regex) {
-            return new TestSpec(supplier, key, regex);
-        }
-
-        @Override
-        public String toString() {
-            // The result of this toString will be used by IDE in test report
-            return "Key: " + key;
-        }
-    }
 }