Skip to content

Fix potentially flaky S3TransferManagerListenerTests #2801

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 2 commits into from
Oct 28, 2021
Merged
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-S3TransferManager-e4998ee.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "S3TransferManager",
"contributor": "",
"type": "bugfix",
"description": "Fix potentially flaky S3TransferManagerListenerTests"
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.timeout;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
Expand Down Expand Up @@ -93,33 +93,33 @@ public void upload_success_shouldInvokeListener() throws Exception {
.overrideConfiguration(b -> b.addListener(listener))
.build();
Upload upload = tm.upload(uploadRequest);
upload.completionFuture().join();

ArgumentCaptor<TransferListener.Context.TransferInitiated> captor1 =
ArgumentCaptor.forClass(TransferListener.Context.TransferInitiated.class);
verify(listener, times(1)).transferInitiated(captor1.capture());
verify(listener, timeout(1000).times(1)).transferInitiated(captor1.capture());
TransferListener.Context.TransferInitiated ctx1 = captor1.getValue();
assertThat(ctx1.request()).isSameAs(uploadRequest);
assertThat(ctx1.progressSnapshot().transferSizeInBytes()).hasValue(contentLength);
assertThat(ctx1.progressSnapshot().bytesTransferred()).isZero();

ArgumentCaptor<TransferListener.Context.BytesTransferred> captor2 =
ArgumentCaptor.forClass(TransferListener.Context.BytesTransferred.class);
verify(listener, times(1)).bytesTransferred(captor2.capture());
verify(listener, timeout(1000).times(1)).bytesTransferred(captor2.capture());
TransferListener.Context.BytesTransferred ctx2 = captor2.getValue();
assertThat(ctx2.request()).isSameAs(uploadRequest);
assertThat(ctx2.progressSnapshot().transferSizeInBytes()).hasValue(contentLength);
assertThat(ctx2.progressSnapshot().bytesTransferred()).isPositive();

ArgumentCaptor<TransferListener.Context.TransferComplete> captor3 =
ArgumentCaptor.forClass(TransferListener.Context.TransferComplete.class);
verify(listener, times(1)).transferComplete(captor3.capture());
verify(listener, timeout(1000).times(1)).transferComplete(captor3.capture());
TransferListener.Context.TransferComplete ctx3 = captor3.getValue();
assertThat(ctx3.request()).isSameAs(uploadRequest);
assertThat(ctx3.progressSnapshot().transferSizeInBytes()).hasValue(contentLength);
assertThat(ctx3.progressSnapshot().bytesTransferred()).isEqualTo(contentLength);
assertThat(ctx3.completedTransfer()).isSameAs(upload.completionFuture().get());

upload.completionFuture().join();
verifyNoMoreInteractions(listener);
}

Expand All @@ -134,11 +134,10 @@ public void download_success_shouldInvokeListener() throws Exception {
.overrideConfiguration(b -> b.addListener(listener))
.build();
Download download = tm.download(downloadRequest);
download.completionFuture().join();

ArgumentCaptor<TransferListener.Context.TransferInitiated> captor1 =
ArgumentCaptor.forClass(TransferListener.Context.TransferInitiated.class);
verify(listener, times(1)).transferInitiated(captor1.capture());
verify(listener, timeout(1000).times(1)).transferInitiated(captor1.capture());
TransferListener.Context.TransferInitiated ctx1 = captor1.getValue();
assertThat(ctx1.request()).isSameAs(downloadRequest);
// transferSize is not known until we receive GetObjectResponse header
Expand All @@ -147,7 +146,7 @@ public void download_success_shouldInvokeListener() throws Exception {

ArgumentCaptor<TransferListener.Context.BytesTransferred> captor2 =
ArgumentCaptor.forClass(TransferListener.Context.BytesTransferred.class);
verify(listener, times(1)).bytesTransferred(captor2.capture());
verify(listener, timeout(1000).times(1)).bytesTransferred(captor2.capture());
TransferListener.Context.BytesTransferred ctx2 = captor2.getValue();
assertThat(ctx2.request()).isSameAs(downloadRequest);
// transferSize should now be known
Expand All @@ -156,13 +155,14 @@ public void download_success_shouldInvokeListener() throws Exception {

ArgumentCaptor<TransferListener.Context.TransferComplete> captor3 =
ArgumentCaptor.forClass(TransferListener.Context.TransferComplete.class);
verify(listener, times(1)).transferComplete(captor3.capture());
verify(listener, timeout(1000).times(1)).transferComplete(captor3.capture());
TransferListener.Context.TransferComplete ctx3 = captor3.getValue();
assertThat(ctx3.request()).isSameAs(downloadRequest);
assertThat(ctx3.progressSnapshot().transferSizeInBytes()).hasValue(contentLength);
assertThat(ctx3.progressSnapshot().bytesTransferred()).isEqualTo(contentLength);
assertThat(ctx3.completedTransfer()).isSameAs(download.completionFuture().get());

download.completionFuture().join();
verifyNoMoreInteractions(listener);
}

Expand All @@ -188,7 +188,7 @@ public void upload_failure_shouldInvokeListener() throws Exception {

ArgumentCaptor<TransferListener.Context.TransferInitiated> captor1 =
ArgumentCaptor.forClass(TransferListener.Context.TransferInitiated.class);
verify(listener, times(1)).transferInitiated(captor1.capture());
verify(listener, timeout(1000).times(1)).transferInitiated(captor1.capture());
TransferListener.Context.TransferInitiated ctx1 = captor1.getValue();
assertThat(ctx1.request()).isSameAs(uploadRequest);
// transferSize is not known since file did not exist
Expand All @@ -197,13 +197,14 @@ public void upload_failure_shouldInvokeListener() throws Exception {

ArgumentCaptor<TransferListener.Context.TransferFailed> captor2 =
ArgumentCaptor.forClass(TransferListener.Context.TransferFailed.class);
verify(listener, times(1)).transferFailed(captor2.capture());
verify(listener, timeout(1000).times(1)).transferFailed(captor2.capture());
TransferListener.Context.TransferFailed ctx2 = captor2.getValue();
assertThat(ctx2.request()).isSameAs(uploadRequest);
assertThat(ctx2.progressSnapshot().transferSizeInBytes()).isNotPresent();
assertThat(ctx2.progressSnapshot().bytesTransferred()).isZero();
assertThat(ctx2.exception()).isInstanceOf(NoSuchFileException.class);

upload.completionFuture().join();
verifyNoMoreInteractions(listener);
}

Expand All @@ -221,11 +222,12 @@ public void listener_exception_shouldBeSuppressed() throws Exception {
.overrideConfiguration(b -> b.addListener(listener))
.build();
Upload upload = tm.upload(uploadRequest);
upload.completionFuture().join();

verify(listener, times(1)).transferInitiated(any());
verify(listener, times(1)).bytesTransferred(any());
verify(listener, times(1)).transferComplete(any());
verify(listener, timeout(1000).times(1)).transferInitiated(any());
verify(listener, timeout(1000).times(1)).bytesTransferred(any());
verify(listener, timeout(1000).times(1)).transferComplete(any());

upload.completionFuture().join();
verifyNoMoreInteractions(listener);
}

Expand Down