Skip to content

unit test should always verify mock invocation #5317

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

Merged
RussellSpitzer merged 5 commits into from
Jul 26, 2022
Merged

unit test should always verify mock invocation #5317

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5fc011c
Test should verify even if there are no exceptions
Jul 20, 2022
93a3981
refactor as suggested in PR comments
Jul 20, 2022
bfb82ab
refactor as suggested in PR comments
Jul 20, 2022
547cd56
fix formatting
Jul 20, 2022
e34cf82
rever unnecessary formatting
Jul 21, 2022
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
58 changes: 37 additions & 21 deletions aws/src/test/java/org/apache/iceberg/aws/s3/TestS3OutputStream.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import java.util.stream.Stream;
import org.apache.iceberg.aws.AwsProperties;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.assertj.core.api.Assertions;
import org.junit.After;
import org.junit.Before;
import org.junit.ClassRule;
Expand Down Expand Up @@ -72,7 +73,6 @@
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;


Comment thread
abmo-x marked this conversation as resolved.
@RunWith(MockitoJUnitRunner.class)
public class TestS3OutputStream {
private static final Logger LOG = LoggerFactory.getLogger(TestS3OutputStream.class);
Expand Down Expand Up @@ -119,24 +119,35 @@ public void testWrite() {

@Test
public void testAbortAfterFailedPartUpload() {
doThrow(new RuntimeException()).when(s3mock).uploadPart((UploadPartRequest) any(), (RequestBody) any());
RuntimeException mockException = new RuntimeException("mock uploadPart failure");
doThrow(mockException).when(s3mock).uploadPart((UploadPartRequest) any(), (RequestBody) any());

try (S3OutputStream stream = new S3OutputStream(s3mock, randomURI(), properties, nullMetrics())) {
stream.write(randomData(10 * 1024 * 1024));
} catch (Exception e) {
verify(s3mock, atLeastOnce()).abortMultipartUpload((AbortMultipartUploadRequest) any());
}
Assertions.assertThatThrownBy(() -> {
try (S3OutputStream stream = new S3OutputStream(s3mock, randomURI(), properties, nullMetrics())) {
stream.write(randomData(10 * 1024 * 1024));
}
})
.isInstanceOf(mockException.getClass())
.hasMessageContaining(mockException.getMessage());

verify(s3mock, atLeastOnce()).abortMultipartUpload((AbortMultipartUploadRequest) any());
}

@Test
public void testAbortMultipart() {
doThrow(new RuntimeException()).when(s3mock).completeMultipartUpload((CompleteMultipartUploadRequest) any());
RuntimeException mockException = new RuntimeException("mock completeMultipartUpload failure");
doThrow(mockException).when(s3mock)
.completeMultipartUpload((CompleteMultipartUploadRequest) any());

try (S3OutputStream stream = new S3OutputStream(s3mock, randomURI(), properties, nullMetrics())) {
stream.write(randomData(10 * 1024 * 1024));
} catch (Exception e) {
verify(s3mock).abortMultipartUpload((AbortMultipartUploadRequest) any());
}
Assertions.assertThatThrownBy(() -> {
try (S3OutputStream stream = new S3OutputStream(s3mock, randomURI(), properties, nullMetrics())) {
stream.write(randomData(10 * 1024 * 1024));
}
})
.isInstanceOf(mockException.getClass())
.hasMessageContaining(mockException.getMessage());

verify(s3mock).abortMultipartUpload((AbortMultipartUploadRequest) any());
}

@Test
Expand Down Expand Up @@ -168,7 +179,8 @@ private void writeTest() {
writeAndVerify(s3mock, randomURI(), data, arrayWrite);
ArgumentCaptor<PutObjectRequest> putObjectRequestArgumentCaptor =
ArgumentCaptor.forClass(PutObjectRequest.class);
verify(s3mock, times(1)).putObject(putObjectRequestArgumentCaptor.capture(),
verify(s3mock, times(1)).putObject(
Comment thread
abmo-x marked this conversation as resolved.
Outdated
putObjectRequestArgumentCaptor.capture(),
(RequestBody) any());
checkPutObjectRequestContent(data, putObjectRequestArgumentCaptor);
checkTags(putObjectRequestArgumentCaptor);
Expand All @@ -178,7 +190,8 @@ private void writeTest() {
data = randomData(6 * 1024 * 1024);
writeAndVerify(s3mock, randomURI(), data, arrayWrite);
putObjectRequestArgumentCaptor = ArgumentCaptor.forClass(PutObjectRequest.class);
verify(s3mock, times(1)).putObject(putObjectRequestArgumentCaptor.capture(),
verify(s3mock, times(1)).putObject(
putObjectRequestArgumentCaptor.capture(),
(RequestBody) any());
checkPutObjectRequestContent(data, putObjectRequestArgumentCaptor);
checkTags(putObjectRequestArgumentCaptor);
Expand All @@ -189,7 +202,8 @@ private void writeTest() {
writeAndVerify(s3mock, randomURI(), data, arrayWrite);
ArgumentCaptor<UploadPartRequest> uploadPartRequestArgumentCaptor =
ArgumentCaptor.forClass(UploadPartRequest.class);
verify(s3mock, times(2)).uploadPart(uploadPartRequestArgumentCaptor.capture(),
verify(s3mock, times(2)).uploadPart(
uploadPartRequestArgumentCaptor.capture(),
(RequestBody) any());
checkUploadPartRequestContent(data, uploadPartRequestArgumentCaptor);
reset(s3mock);
Expand All @@ -199,7 +213,8 @@ private void writeTest() {
writeAndVerify(s3mock, randomURI(), data, arrayWrite);
uploadPartRequestArgumentCaptor =
ArgumentCaptor.forClass(UploadPartRequest.class);
verify(s3mock, times(5)).uploadPart(uploadPartRequestArgumentCaptor.capture(),
verify(s3mock, times(5)).uploadPart(
uploadPartRequestArgumentCaptor.capture(),
(RequestBody) any());
checkUploadPartRequestContent(data, uploadPartRequestArgumentCaptor);
reset(s3mock);
Expand Down Expand Up @@ -256,7 +271,7 @@ private String getDigest(byte[] data, int offset, int length) {
return null;
}

private void writeAndVerify(S3Client client, S3URI uri, byte [] data, boolean arrayWrite) {
private void writeAndVerify(S3Client client, S3URI uri, byte[] data, boolean arrayWrite) {
try (S3OutputStream stream = new S3OutputStream(client, uri, properties, nullMetrics())) {
if (arrayWrite) {
stream.write(data);
Expand Down Expand Up @@ -284,14 +299,15 @@ private void writeAndVerify(S3Client client, S3URI uri, byte [] data, boolean ar

private byte[] readS3Data(S3URI uri) {
ResponseBytes<GetObjectResponse> data =
s3.getObject(GetObjectRequest.builder().bucket(uri.bucket()).key(uri.key()).build(),
ResponseTransformer.toBytes());
s3.getObject(
GetObjectRequest.builder().bucket(uri.bucket()).key(uri.key()).build(),
ResponseTransformer.toBytes());

return data.asByteArray();
}

private byte[] randomData(int size) {
byte [] result = new byte[size];
byte[] result = new byte[size];
random.nextBytes(result);
return result;
}
Expand Down