Skip to content

Fix flakyness in LoggingTransferListenerTest where LogCaptor captures logs from other parrallely running test cases #5948

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.

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

Merged
merged 3 commits into from
Mar 11, 2025
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static org.mockito.Mockito.mock;

import java.util.List;
import java.util.stream.Collectors;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.core.LogEvent;
import org.junit.jupiter.api.BeforeEach;
Expand All @@ -31,7 +32,7 @@
import software.amazon.awssdk.transfer.s3.internal.progress.DefaultTransferProgressSnapshot;
import software.amazon.awssdk.transfer.s3.internal.progress.TransferListenerContext;

public class LoggingTransferListenerTest {
class LoggingTransferListenerTest {

private static final long TRANSFER_SIZE_IN_BYTES = 1024L;

Expand All @@ -54,52 +55,61 @@ public void setUp() throws Exception {
}

@Test
public void test_defaultListener_successfulTransfer() {
void test_defaultListener_successfulTransfer() {
try (LogCaptor logCaptor = LogCaptor.create()) {
invokeSuccessfulLifecycle();
List<LogEvent> events = logCaptor.loggedEvents();
assertLogged(events, Level.INFO, "Transfer initiated...");
assertLogged(events, Level.INFO, "| | 0.0%");
assertLogged(events, Level.INFO, "|= | 5.0%");
assertLogged(events, Level.INFO, "|== | 10.0%");
assertLogged(events, Level.INFO, "|=== | 15.0%");
assertLogged(events, Level.INFO, "|==== | 20.0%");
assertLogged(events, Level.INFO, "|===== | 25.0%");
assertLogged(events, Level.INFO, "|====== | 30.0%");
assertLogged(events, Level.INFO, "|======= | 35.0%");
assertLogged(events, Level.INFO, "|======== | 40.0%");
assertLogged(events, Level.INFO, "|========= | 45.0%");
assertLogged(events, Level.INFO, "|========== | 50.0%");
assertLogged(events, Level.INFO, "|=========== | 55.0%");
assertLogged(events, Level.INFO, "|============ | 60.0%");
assertLogged(events, Level.INFO, "|============= | 65.0%");
assertLogged(events, Level.INFO, "|============== | 70.0%");
assertLogged(events, Level.INFO, "|=============== | 75.0%");
assertLogged(events, Level.INFO, "|================ | 80.0%");
assertLogged(events, Level.INFO, "|================= | 85.0%");
assertLogged(events, Level.INFO, "|================== | 90.0%");
assertLogged(events, Level.INFO, "|=================== | 95.0%");
assertLogged(events, Level.INFO, "|====================| 100.0%");
assertLogged(events, Level.INFO, "Transfer complete!");
assertThat(events).isEmpty();
String loggerName = LoggingTransferListener.class.getName();
List<LogEvent> filteredEvents = events.stream()
.filter(e -> e.getLoggerName().equals(loggerName))
.collect(Collectors.toList());
assertLogged(filteredEvents, Level.INFO, "Transfer initiated...");
assertLogged(filteredEvents, Level.INFO, "| | 0.0%");
assertLogged(filteredEvents, Level.INFO, "|= | 5.0%");
assertLogged(filteredEvents, Level.INFO, "|== | 10.0%");
assertLogged(filteredEvents, Level.INFO, "|=== | 15.0%");
assertLogged(filteredEvents, Level.INFO, "|==== | 20.0%");
assertLogged(filteredEvents, Level.INFO, "|===== | 25.0%");
assertLogged(filteredEvents, Level.INFO, "|====== | 30.0%");
assertLogged(filteredEvents, Level.INFO, "|======= | 35.0%");
assertLogged(filteredEvents, Level.INFO, "|======== | 40.0%");
assertLogged(filteredEvents, Level.INFO, "|========= | 45.0%");
assertLogged(filteredEvents, Level.INFO, "|========== | 50.0%");
assertLogged(filteredEvents, Level.INFO, "|=========== | 55.0%");
assertLogged(filteredEvents, Level.INFO, "|============ | 60.0%");
assertLogged(filteredEvents, Level.INFO, "|============= | 65.0%");
assertLogged(filteredEvents, Level.INFO, "|============== | 70.0%");
assertLogged(filteredEvents, Level.INFO, "|=============== | 75.0%");
assertLogged(filteredEvents, Level.INFO, "|================ | 80.0%");
assertLogged(filteredEvents, Level.INFO, "|================= | 85.0%");
assertLogged(filteredEvents, Level.INFO, "|================== | 90.0%");
assertLogged(filteredEvents, Level.INFO, "|=================== | 95.0%");
assertLogged(filteredEvents, Level.INFO, "|====================| 100.0%");
assertLogged(filteredEvents, Level.INFO, "Transfer complete!");
assertThat(filteredEvents).isEmpty();
}
}

@Test
public void test_customTicksListener_successfulTransfer() {
void test_customTicksListener_successfulTransfer() {
try (LogCaptor logCaptor = LogCaptor.create()) {
listener = LoggingTransferListener.create(5);
invokeSuccessfulLifecycle();
List<LogEvent> events = logCaptor.loggedEvents();
assertLogged(events, Level.INFO, "Transfer initiated...");
assertLogged(events, Level.INFO, "| | 0.0%");
assertLogged(events, Level.INFO, "|= | 20.0%");
assertLogged(events, Level.INFO, "|== | 40.0%");
assertLogged(events, Level.INFO, "|=== | 60.0%");
assertLogged(events, Level.INFO, "|==== | 80.0%");
assertLogged(events, Level.INFO, "|=====| 100.0%");
assertLogged(events, Level.INFO, "Transfer complete!");
assertThat(events).isEmpty();
String loggerName = LoggingTransferListener.class.getName();
List<LogEvent> filteredEvents = events.stream()
.filter(e -> e.getLoggerName().equals(loggerName))
.collect(Collectors.toList());

assertLogged(filteredEvents, Level.INFO, "Transfer initiated...");
assertLogged(filteredEvents, Level.INFO, "| | 0.0%");
assertLogged(filteredEvents, Level.INFO, "|= | 20.0%");
assertLogged(filteredEvents, Level.INFO, "|== | 40.0%");
assertLogged(filteredEvents, Level.INFO, "|=== | 60.0%");
assertLogged(filteredEvents, Level.INFO, "|==== | 80.0%");
assertLogged(filteredEvents, Level.INFO, "|=====| 100.0%");
assertLogged(filteredEvents, Level.INFO, "Transfer complete!");
assertThat(filteredEvents).isEmpty();
}
}

Expand Down
Loading