From e24f731384e955c622fcf9794707ef3e3a9d247f Mon Sep 17 00:00:00 2001 From: Andrei Solntsev Date: Wed, 22 May 2024 19:55:12 +0300 Subject: [PATCH 1/3] fix flaky test TimeTest Sometimes if failed when "now + 1 minute" was in tomorrow. For example: java.lang.IllegalArgumentException: Invalid time range: the upper bound time (00:00:47.593917390) is before the lower bound (23:59:47.593917390) --- .../net/datafaker/providers/base/Time.java | 2 +- .../datafaker/providers/base/TimeTest.java | 21 ++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/src/main/java/net/datafaker/providers/base/Time.java b/src/main/java/net/datafaker/providers/base/Time.java index 9225a6c05..0ec8939b5 100644 --- a/src/main/java/net/datafaker/providers/base/Time.java +++ b/src/main/java/net/datafaker/providers/base/Time.java @@ -134,7 +134,7 @@ public String past(int atMost, int minimum, ChronoUnit unit, String pattern) { */ public long between(LocalTime from, LocalTime to) throws IllegalArgumentException { if (to.isBefore(from)) { - throw new IllegalArgumentException("Invalid time range, the upper bound time is before the lower bound."); + throw new IllegalArgumentException("Invalid time range: the upper bound time (%s) is before the lower bound (%s)".formatted(to, from)); } if (from.equals(to)) { diff --git a/src/test/java/net/datafaker/providers/base/TimeTest.java b/src/test/java/net/datafaker/providers/base/TimeTest.java index a5a3a1a7e..4b9499fa4 100644 --- a/src/test/java/net/datafaker/providers/base/TimeTest.java +++ b/src/test/java/net/datafaker/providers/base/TimeTest.java @@ -1,16 +1,23 @@ package net.datafaker.providers.base; +import org.junit.jupiter.api.RepeatedTest; import org.junit.jupiter.api.Test; import java.time.LocalTime; import java.time.format.DateTimeFormatter; import java.time.temporal.ChronoUnit; +import java.time.temporal.TemporalAccessor; +import java.util.regex.Pattern; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; public class TimeTest extends BaseFakerTest { + private static final Pattern RE_TIME_BETWEEN = Pattern.compile("[0-2][0-9]:[0-5][0-9]:[0-5][0-9]"); + private static final long NANOSECONDS_IN_DAY = 24L * 60 * 60 * 1000 * 1000_000L; + private static final long NANOSECONDS_IN_MINUTE = 60 * 1000 * 1000_000L; + @Test void testFutureTime() { LocalTime now = LocalTime.now(); @@ -80,16 +87,20 @@ void testBetweenThenLargerThanNow() { LocalTime then = now.plusSeconds(1); assertThatThrownBy(() -> faker.time().between(then, now)) .isInstanceOf(IllegalArgumentException.class) - .hasMessage("Invalid time range, the upper bound time is before the lower bound."); + .hasMessage("Invalid time range: the upper bound time (%s) is before the lower bound (%s)".formatted(now, then)); } - @Test + @RepeatedTest(10) void testBetweenWithMask() { - String pattern = "mm:hh:ss"; - LocalTime now = LocalTime.now(); + String pattern = "HH:mm:ss"; + LocalTime now = LocalTime.ofNanoOfDay((long) (Math.random() * (NANOSECONDS_IN_DAY - NANOSECONDS_IN_MINUTE - 1))); LocalTime then = now.plusMinutes(1); - DateTimeFormatter.ofPattern(pattern).parse(faker.time().between(now, then, pattern)); + String result = faker.time().between(now, then, pattern); + assertThat(result).matches(RE_TIME_BETWEEN); + TemporalAccessor timeBetween = DateTimeFormatter.ofPattern(pattern).parse(result); + assertThat(timeBetween.query(LocalTime::from)).isAfter(now.minusSeconds(1)); + assertThat(timeBetween.query(LocalTime::from)).isBefore(then.plusSeconds(1)); } @Test From 8ac29c9a5210cc9da4d94da549a755e330ad6d76 Mon Sep 17 00:00:00 2001 From: Andrei Solntsev Date: Wed, 22 May 2024 23:02:01 +0300 Subject: [PATCH 2/3] fix flaky test with Locality Sometimes if failed when two paralle threads modify field `shuffledLocales`. For example: ``` net.datafaker.integration.FakerRepeatabilityIntegrationTest.shouldCreateUniqueValues -- Time elapsed: 0.890 s <<< ERROR! java.lang.IndexOutOfBoundsException: Index 69 out of bounds for length 69 at java.base/jdk.internal.util.Preconditions.outOfBounds(Preconditions.java:64) at java.base/jdk.internal.util.Preconditions.outOfBoundsCheckIndex(Preconditions.java:70) at java.base/jdk.internal.util.Preconditions.checkIndex(Preconditions.java:266) at java.base/java.util.Objects.checkIndex(Objects.java:361) at java.base/java.util.ArrayList.remove(ArrayList.java:504) at net.datafaker.providers.base.Locality.localeStringWithoutReplacement(Locality.java:174) at net.datafaker.providers.base.Locality.localeStringWithoutReplacement(Locality.java:156) ``` --- .../java/net/datafaker/providers/base/Locality.java | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/src/main/java/net/datafaker/providers/base/Locality.java b/src/main/java/net/datafaker/providers/base/Locality.java index 225717930..089a3f04e 100644 --- a/src/main/java/net/datafaker/providers/base/Locality.java +++ b/src/main/java/net/datafaker/providers/base/Locality.java @@ -29,7 +29,7 @@ public class Locality extends AbstractProvider { private final List locales; - private List shuffledLocales = new ArrayList<>(); + private final List shuffledLocales = new ArrayList<>(); /** * Constructor for Locality class @@ -162,18 +162,15 @@ public String localeStringWithoutReplacement() { * @param random random number generator (can utilize seed for deterministic random selection) * @return String of a randomly selected locale (eg. "es", "es-MX") */ - public String localeStringWithoutReplacement(Random random) { - if (this.shuffledLocales.isEmpty()) { + public synchronized String localeStringWithoutReplacement(Random random) { + if (shuffledLocales.isEmpty()) { // copy list of locales supported into shuffledLocales - shuffledLocales = new ArrayList<>(this.locales); + shuffledLocales.addAll(this.locales); Collections.shuffle(shuffledLocales, random); } // retrieve next locale in shuffledLocales and remove from list - String pickedLocale = shuffledLocales.get(shuffledLocales.size() - 1); - shuffledLocales.remove(shuffledLocales.size() - 1); - - return pickedLocale; + return shuffledLocales.remove(shuffledLocales.size() - 1); } } From 2efff55f970d662d95212ba0d67482bae2092eb8 Mon Sep 17 00:00:00 2001 From: Andrei Solntsev Date: Wed, 22 May 2024 23:07:40 +0300 Subject: [PATCH 3/3] optimize memory usage by Locality.shuffledLocales it's not needed to remove the element from shuffledLocales and resize the underlying array. It's enough just to keep an index of current element in this list. --- src/main/java/net/datafaker/providers/base/Locality.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/main/java/net/datafaker/providers/base/Locality.java b/src/main/java/net/datafaker/providers/base/Locality.java index 089a3f04e..9c9c4dc81 100644 --- a/src/main/java/net/datafaker/providers/base/Locality.java +++ b/src/main/java/net/datafaker/providers/base/Locality.java @@ -30,6 +30,7 @@ public class Locality extends AbstractProvider { private final List locales; private final List shuffledLocales = new ArrayList<>(); + private int shuffledLocaleIndex = 0; /** * Constructor for Locality class @@ -163,14 +164,16 @@ public String localeStringWithoutReplacement() { * @return String of a randomly selected locale (eg. "es", "es-MX") */ public synchronized String localeStringWithoutReplacement(Random random) { - if (shuffledLocales.isEmpty()) { + if (shuffledLocales.isEmpty() || shuffledLocaleIndex >= shuffledLocales.size() - 1) { // copy list of locales supported into shuffledLocales + shuffledLocales.clear(); shuffledLocales.addAll(this.locales); + shuffledLocaleIndex = 0; Collections.shuffle(shuffledLocales, random); } - // retrieve next locale in shuffledLocales and remove from list - return shuffledLocales.remove(shuffledLocales.size() - 1); + // retrieve next locale in shuffledLocales and increase the index + return shuffledLocales.get(shuffledLocaleIndex++); } }