Skip to content

feat: Improve flaky tests and add error messages #1653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Improve flaky tests and add error messages #1653

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
01c523a
Improve tests
chrfwow Nov 20, 2025
f93627b
Improve tests
chrfwow Nov 20, 2025
9b495fa
Merge branch 'main' into fix-flaky-tests
aepfli Nov 20, 2025
16eee8e
Merge branch 'main' into fix-flaky-tests
aepfli Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions ...src/test/java/dev/openfeature/contrib/providers/flagd/FlagdProviderSyncResourcesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,14 @@ void interruptingWaitingThread_isIgnored() throws InterruptedException {
@Test
void callingInitialize_wakesUpWaitingThread() throws InterruptedException {
final AtomicBoolean isWaiting = new AtomicBoolean();
final AtomicBoolean successfulTest = new AtomicBoolean();
final AtomicLong waitTime = new AtomicLong(Long.MAX_VALUE);
Thread waitingThread = new Thread(() -> {
long start = System.currentTimeMillis();
isWaiting.set(true);
flagdProviderSyncResources.waitForInitialization(10000);
long end = System.currentTimeMillis();
long duration = end - start;
successfulTest.set(duration < MAX_TIME_TOLERANCE * 2);
waitTime.set(duration);
});
waitingThread.start();

Expand All @@ -100,7 +100,11 @@ void callingInitialize_wakesUpWaitingThread() throws InterruptedException {

waitingThread.join();

Assertions.assertTrue(successfulTest.get());
Assertions.assertTrue(
waitTime.get() < MAX_TIME_TOLERANCE * 2,
"Wakeup should be almost instant, but took " + waitTime.get()
+ " ms, which is more than the max of"
+ (MAX_TIME_TOLERANCE * 2) + " ms");
Comment on lines 103 to 107
Copy link

@gemini-code-assist gemini-code-assist bot Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better performance and readability, it's a good practice to use a lambda for the assertion message in JUnit 5. This enables lazy evaluation, meaning the message string is only constructed if the assertion fails. This avoids unnecessary string concatenation in passing tests.

Suggested change
Assertions.assertTrue(
waitTime.get() < MAX_TIME_TOLERANCE * 2,
"Wakeup should be almost instant, but took " + waitTime.get()
+ " ms, which is more than the max of"
+ (MAX_TIME_TOLERANCE * 2) + " ms");
Assertions.assertTrue(
waitTime.get() < MAX_TIME_TOLERANCE * 2,
() -> "Wakeup should be almost instant, but took " + waitTime.get()
+ " ms, which is more than the max of"
+ (MAX_TIME_TOLERANCE * 2) + " ms");

}

@Timeout(2)
Expand Down
5 changes: 2 additions & 3 deletions providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/State.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.FlagEvaluationDetails;
import dev.openfeature.sdk.MutableContext;
import java.util.LinkedList;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.ConcurrentLinkedQueue;

public class State {
public ProviderType providerType;
public Client client;
public FeatureProvider provider;
public List<Event> events = new LinkedList<>();
public ConcurrentLinkedQueue<Event> events = new ConcurrentLinkedQueue<>();
public Optional<Event> lastEvent;
public FlagSteps.Flag flag;
public MutableContext context = new MutableContext();
Expand Down
4 changes: 2 additions & 2 deletions ...ers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/steps/EventSteps.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import io.cucumber.java.en.Given;
import io.cucumber.java.en.Then;
import io.cucumber.java.en.When;
import java.util.LinkedList;
import java.util.concurrent.ConcurrentLinkedQueue;
import lombok.extern.slf4j.Slf4j;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.parallel.Isolated;
Expand All @@ -21,7 +21,7 @@ public class EventSteps extends AbstractSteps {

public EventSteps(State state) {
super(state);
state.events = new LinkedList<>();
state.events = new ConcurrentLinkedQueue<>();
Copy link

@gemini-code-assist gemini-code-assist bot Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The events field in the State class is already initialized where it's declared. Re-initializing it here in the EventSteps constructor is redundant and can introduce flakiness. If other step definitions in the same scenario modify the events list before this constructor is called, those changes will be lost. It's best to remove this line and rely on the single initialization in the State class.

}

@Given("a {} event handler")
Expand Down