tflobbe commented on code in PR #1773: URL: https://github.com/apache/solr/pull/1773#discussion_r1265658173
########## solr/modules/s3-repository/src/test/org/apache/solr/s3/S3OutputStreamMockitoTest.java: ########## @@ -0,0 +1,130 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.solr.s3; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; +import static org.mockito.internal.verification.VerificationModeFactory.times; + +import com.carrotsearch.randomizedtesting.generators.RandomStrings; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.function.Consumer; +import org.apache.solr.SolrTestCaseJ4; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import software.amazon.awssdk.core.sync.RequestBody; +import software.amazon.awssdk.services.s3.S3Client; +import software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest; +import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest; +import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest; +import software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse; +import software.amazon.awssdk.services.s3.model.S3Exception; +import software.amazon.awssdk.services.s3.model.UploadPartRequest; +import software.amazon.awssdk.services.s3.model.UploadPartResponse; + +public class S3OutputStreamMockitoTest extends SolrTestCaseJ4 { + + private S3Client clientMock; + + private static byte[] largeBuffer; + + @BeforeClass + public static void setUpClass() { + assumeWorkingMockito(); + String content = + RandomStrings.randomAsciiAlphanumOfLength(random(), S3OutputStream.PART_SIZE + 1024); + largeBuffer = content.getBytes(StandardCharsets.UTF_8); + // pre-check -- ensure that our test string isn't too small + assertTrue(largeBuffer.length > S3OutputStream.PART_SIZE); + } + + @AfterClass + public static void tearDownClass() { + largeBuffer = null; + } + + @Override + public void setUp() throws Exception { + super.setUp(); + clientMock = mock(S3Client.class); + } + + @SuppressWarnings("unchecked") + public void testMultiPartUploadCompleted() throws IOException { + when(clientMock.createMultipartUpload((Consumer<CreateMultipartUploadRequest.Builder>) any())) + .thenReturn(CreateMultipartUploadResponse.builder().build()); + when(clientMock.uploadPart((UploadPartRequest) any(), (RequestBody) any())) + .thenReturn(UploadPartResponse.builder().build()); + S3OutputStream stream = new S3OutputStream(clientMock, "key", "bucket"); + stream.write(largeBuffer); + verify(clientMock) + .createMultipartUpload((Consumer<CreateMultipartUploadRequest.Builder>) any()); + verify(clientMock).uploadPart((UploadPartRequest) any(), (RequestBody) any()); + verify(clientMock, never()) + .completeMultipartUpload((Consumer<CompleteMultipartUploadRequest.Builder>) any()); + verify(clientMock, never()) + .abortMultipartUpload((Consumer<AbortMultipartUploadRequest.Builder>) any()); + + stream.close(); + verify(clientMock) + .completeMultipartUpload((Consumer<CompleteMultipartUploadRequest.Builder>) any()); + verify(clientMock, never()) + .abortMultipartUpload((Consumer<AbortMultipartUploadRequest.Builder>) any()); + } + + @SuppressWarnings("unchecked") + public void testMultiPartUploadAborted() throws IOException { + when(clientMock.createMultipartUpload((Consumer<CreateMultipartUploadRequest.Builder>) any())) + .thenReturn(CreateMultipartUploadResponse.builder().build()); + when(clientMock.uploadPart((UploadPartRequest) any(), (RequestBody) any())) + .thenThrow(S3Exception.builder().message("fake exception").build()); + S3OutputStream stream = new S3OutputStream(clientMock, "key", "bucket"); + // first time it should throw the exception from S3Client + org.apache.solr.s3.S3Exception solrS3Exception = + assertThrows(org.apache.solr.s3.S3Exception.class, () -> stream.write(largeBuffer)); + assertEquals(S3Exception.class, solrS3Exception.getCause().getClass()); + assertEquals("fake exception", solrS3Exception.getCause().getMessage()); + verify(clientMock).abortMultipartUpload((Consumer<AbortMultipartUploadRequest.Builder>) any()); + + // after that, the exception should be because the MPU is aborted + solrS3Exception = + assertThrows(org.apache.solr.s3.S3Exception.class, () -> stream.write(largeBuffer)); + assertEquals(IllegalStateException.class, solrS3Exception.getCause().getClass()); + assertTrue( + "Unexpected exception message: " + solrS3Exception.getCause().getMessage(), + solrS3Exception + .getCause() + .getMessage() + .contains("Can't upload new parts on a MultipartUpload that was aborted")); + + verify(clientMock) + .createMultipartUpload((Consumer<CreateMultipartUploadRequest.Builder>) any()); + verify(clientMock).uploadPart((UploadPartRequest) any(), (RequestBody) any()); + verify(clientMock, never()) + .completeMultipartUpload((Consumer<CompleteMultipartUploadRequest.Builder>) any()); + verify(clientMock, times(2)) Review Comment: The first time is after calling `write` for the first time (in line 102 in this test). The S3 client's `uploadPart` will fail, and after that our `S3OutputStream` will capture the exception and call abort. The second time is because we call `write` again in line 109 of this test, in this case, the exception i thrown by our `MultipartUpload` code (the `IllegalStateException`) because MPU has already been aborted. This will call abort again. This shouldn't be a problem, since one can call abort on the same ID multiple times (in fact, the javadocs say that one should, to ensure better cleanup of multipart objects, but this isn't really addressing that part) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
