make locale-related provider tests more generic (#1718)

Author: asolntsev

src/main/java/net/datafaker/providers/base/BaseFaker.java

@@ -436,6 +436,6 @@ public static Method getMethod(AbstractProvider<?> ap, String methodName) {
 
     @Override
     public String toString() {
-        return getClass().getSimpleName() + "@" + Integer.toHexString(hashCode());
+        return getClass().getSimpleName() + "." + getContext().getLocale();
     }
 }

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

@@ -1,7 +1,11 @@
 package net.datafaker.providers.base;
 
+import net.datafaker.Faker;
+import net.datafaker.internal.helper.LazyEvaluated;
+
 import java.util.HashSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Set;
 import java.util.function.Supplier;
 import java.util.regex.Pattern;
@@ -15,27 +19,41 @@
  * @param <T> the type of BaseFaker being tested
  */
 public abstract class AbstractProviderListTest<T extends BaseFaker> {
+    private static final LazyEvaluated<List<Locale>> locales = new LazyEvaluated<>(() ->
+        new Faker().locality().allSupportedLocales().stream()
+            .map(locale -> new Locale(locale))
+            .toList());
+
+    private static final LazyEvaluated<List<BaseFaker>> fakers = new LazyEvaluated<>(() ->
+        locales.get().stream()
+            .map(locale -> new BaseFaker(locale))
+            .toList());
+
+    protected List<BaseFaker> internationalFakers() {
+        return fakers.get();
+    }
+
     protected List<String> getBaseList(T faker, String key) {
         return faker.fakeValuesService().fetchObject(key, faker.getContext());
     }
 
     protected void testProviderList(ProviderListTest.TestSpec testSpec, T faker) {
         // Given
-        Set<String> actual = new HashSet<>(getBaseList(faker, testSpec.key));
+        Set<String> expected = new HashSet<>(getBaseList(faker, testSpec.key));
         // When
-        String item = (String) testSpec.supplier.get();
+        String actual = (String) testSpec.supplier.get();
         // Then
-        assertThat(item).isNotEmpty();
+        assertThat(actual).isNotEmpty();
         String collection = "\"" + testSpec.key + "\"";
-        assertThat(actual)
-            .as(() -> "Check actual list isn't empty and contains the item for the key " + collection)
+        assertThat(expected)
+            .as(() -> "Check expected list isn't empty and contains the actual for the key " + collection)
             .isNotEmpty()
-            .contains(item);
-        assertThat(actual)
+            .contains(actual);
+        assertThat(expected)
             .as(() -> "Actual should not have empty entries. " + collection)
             .noneMatch(String::isBlank);
         if (!testSpec.regex.isEmpty()) {
-            assertThat(item).matches(Pattern.compile(testSpec.regex));
+            assertThat(actual).matches(Pattern.compile(testSpec.regex));
         }
     }
 

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

@@ -2,22 +2,15 @@
 
 import org.junit.jupiter.params.provider.Arguments;
 
-import java.util.List;
 import java.util.stream.Stream;
 
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 
-public class ColorLocaleTest extends BaseFakerLocaleTest {
-
-    private final List<BaseFaker> fakers = List.of(
-        fakerUA, fakerJP, fakerBY, fakerUZ, fakerArabic, fakerCA,
-        fakerCZ, fakerDE, fakerFR, fakerHU, fakerAM, fakerKR,
-        fakerPT, fakerRU, fakerSE, fakerTH, fakerTR, fakerCH,
-        fakerBR, fakerDK);
+public class ColorLocaleTest extends ProviderListLocaleTest {
 
     @Override
     protected Stream<Arguments> localeProviderListTest() {
-        return fakers.stream()
+        return internationalFakers().stream()
             .map(faker -> arguments(TestSpec.of(() -> faker.color().name(), "color.name"), faker));
     }
 }

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

@@ -6,17 +6,18 @@
 
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 
-public class CommerceLocaleTest extends BaseFakerLocaleTest {
-
-    private final Commerce commerceUA = fakerUA.commerce();
-    private final String[] commerceProductNameUA = commerceUA.productName().split(" ");
+public class CommerceLocaleTest extends ProviderListLocaleTest {
 
     @Override
     protected Stream<Arguments> localeProviderListTest() {
-        return Stream.of(
-            arguments(TestSpec.of(commerceUA::material, "commerce.product_name.material"), fakerUA),
-            arguments(TestSpec.of(() -> commerceProductNameUA[0], "commerce.product_name.adjective"), fakerUA),
-            arguments(TestSpec.of(() -> commerceProductNameUA[1], "commerce.product_name.material"), fakerUA),
-            arguments(TestSpec.of(() -> commerceProductNameUA[2], "commerce.product_name.product"), fakerUA));
+        return internationalFakers().stream().flatMap(faker -> {
+                Commerce commerce = faker.commerce();
+                return Stream.of(
+                    arguments(TestSpec.of(commerce::material, "commerce.product_name.material", "[\\p{L}\\p{M}\\p{Pi}\\p{Pf}]{2,}"), faker),
+                    arguments(TestSpec.of(commerce::brand, "commerce.brand", "\\w{2,}"), faker),
+                    arguments(TestSpec.of(commerce::vendor, "commerce.vendor", "[\\w\\s]{6,}"), faker)
+                );
+            }
+        );
     }
 }

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

@@ -5,14 +5,20 @@
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 
+import java.util.Locale;
 import java.util.stream.Stream;
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
-public abstract class ProviderListLocaleTest<T extends BaseFaker> extends AbstractProviderListTest<T> {
+public abstract class ProviderListLocaleTest extends AbstractProviderListTest<BaseFaker> {
+
+    protected final BaseFaker fakerUA = new BaseFaker(new Locale("uk", "UA"));
+    protected final BaseFaker fakerIE = new BaseFaker(new Locale("en", "IE"));
+    protected final BaseFaker fakerUZ = new BaseFaker(new Locale("uz", "UZ"));
+    protected final BaseFaker fakerNZ = new BaseFaker(new Locale("en", "NZ"));
 
     @ParameterizedTest
     @MethodSource("localeProviderListTest")
-    protected void testProviderListFromLocale(TestSpec testSpec, T faker) {
+    protected void testProviderListFromLocale(TestSpec testSpec, BaseFaker faker) {
         testProviderList(testSpec, faker);
     }
 

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

@@ -6,15 +6,11 @@
 
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 
-public class UniversityLocaleTest extends BaseFakerLocaleTest {
-    private final University universityUA = fakerUA.university();
-    private final University universityUZ = fakerUZ.university();
+public class UniversityLocaleTest extends ProviderListLocaleTest {
 
     @Override
     protected Stream<Arguments> localeProviderListTest() {
-        return Stream.of(
-            arguments(TestSpec.of(universityUA::name, "university.name"), fakerUA),
-            arguments(TestSpec.of(universityUZ::name, "university.name"), fakerUZ)
-        );
+        return Stream.of(fakerUA, fakerUZ, fakerNZ)
+            .map(faker -> arguments(TestSpec.of(() -> faker.university().name(), "university.name", ".{15,120}"), faker));
     }
 }

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

@@ -8,19 +8,19 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 
-public class VehicleLocaleTest extends BaseFakerLocaleTest {
+public class VehicleLocaleTest extends ProviderListLocaleTest {
 
     private static final String IRISH_VEHICLE_LICENCE_PLATE_REGEX = "[0-9]{2}[1|2]-[A-Z]{1,2}-[0-9]{1,6}";
     private static final String UKRAINIAN_VEHICLE_LICENCE_PLATE_REGEX = "^(AA|KA|AB|KB|AC|KC|AE|KE|AH|KH|AI|KI|AK|KK|AM|KM|AO|KO|AP|KP|AT|KT|AX|KX|BA|HA|BB|HB|BC|HC|BE|HE|BH|HH|BI|HI|BK|HK|BM|HM|BO|HO|BT|HT|BX|HX|CA|IA|CB|IB|CE|IE|CH|IH)\\d{4}[A-Z]{2}$";
 
-
-    private final Vehicle vehicleUA = fakerUA.vehicle();
-
     @Override
     protected Stream<Arguments> localeProviderListTest() {
-        return Stream.of(
-            arguments(TestSpec.of(vehicleUA::transmission, "vehicle.transmissions"), fakerUA),
-            arguments(TestSpec.of(vehicleUA::fuelType, "vehicle.fuel_types"), fakerUA)
+        return Stream.concat(
+            internationalFakers().stream().map(faker ->
+                arguments(TestSpec.of(() -> faker.vehicle().transmission(), "vehicle.transmissions", "[\\w\\s]{3,15}"), faker)),
+
+            internationalFakers().stream().map(faker ->
+                arguments(TestSpec.of(() -> faker.vehicle().fuelType(), "vehicle.fuel_types", "[\\w\\d\\-\\/\\s]{3,30}"), faker))
         );
     }