Add AbstractResourceWriter base class containing operations common to all ResourceWriters.
Resolves gh-92.
This commit is contained in:
John Blum
@@ -0,0 +1,94 @@
|
||||
/*
|
||||
* Copyright 2020 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.geode.core.io;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.OutputStream;
|
||||
import java.util.Optional;
|
||||
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.core.io.WritableResource;
|
||||
import org.springframework.dao.DataAccessResourceFailureException;
|
||||
import org.springframework.geode.core.io.support.ResourceUtils;
|
||||
import org.springframework.lang.NonNull;
|
||||
import org.springframework.lang.Nullable;
|
||||
|
||||
/**
|
||||
* Abstract base class providing functionality common to all {@link ResourceWriter} implementations.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.io.OutputStream
|
||||
* @see org.springframework.core.io.Resource
|
||||
* @see org.springframework.core.io.WritableResource
|
||||
* @see ResourceWriter
|
||||
* @since 1.3.1
|
||||
*/
|
||||
public abstract class AbstractResourceWriter implements ResourceWriter {
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
@Override
|
||||
public void write(@NonNull Resource resource, byte[] data) {
|
||||
|
||||
Optional.ofNullable(ResourceUtils.getWritableResource(resource))
|
||||
.filter(this::isAbleToHandle)
|
||||
.map(it -> {
|
||||
try (OutputStream out = it.getOutputStream()) {
|
||||
doWrite(out, data);
|
||||
return true;
|
||||
}
|
||||
catch (IOException cause) {
|
||||
throw new DataAccessResourceFailureException(String.format("Failed to write to Resource [%s]",
|
||||
it.getDescription()), cause);
|
||||
}
|
||||
})
|
||||
.orElseThrow(() -> new UnhandledResourceException(String.format("Unable to handle Resource [%s]",
|
||||
ResourceUtils.nullSafeGetDescription(resource))));
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines whether this writer is able to handle and write to the target {@link Resource}.
|
||||
*
|
||||
* The default implementation determines that the {@link Resource} can be handled if the {@link Resource} handle
|
||||
* is not {@literal null}.
|
||||
*
|
||||
* @param resource {@link Resource} to evaluate.
|
||||
* @return a boolean value indicating whether this writer is able to handle and write to the target {@link Resource}.
|
||||
* @see org.springframework.core.io.Resource
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
protected boolean isAbleToHandle(@Nullable Resource resource) {
|
||||
return resource != null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the given data to the target {@link Resource} (intentionally) by using the {@link OutputStream}
|
||||
* returned by {@link WritableResource#getOutputStream()}.
|
||||
*
|
||||
* However, other algorithm/strategy implementations are free to write to the {@link Resource} as is appropriate
|
||||
* for the given context (e.g. cloud environment). In those cases, implementors should override
|
||||
* the {@link #write(Resource, byte[])} method.
|
||||
*
|
||||
* @param resourceOutputStream {@link OutputStream} returned from {@link WritableResource#getOutputStream()}
|
||||
* used to write the given data to the locations identified by the target {@link Resource}.
|
||||
* @param data array of bytes containing the data to write.
|
||||
* @throws IOException if an I/O error occurs while writing to the target {@link Resource}.
|
||||
* @see java.io.OutputStream
|
||||
*/
|
||||
protected abstract void doWrite(OutputStream resourceOutputStream, byte[] data) throws IOException;
|
||||
|
||||
}
|
||||
@@ -0,0 +1,230 @@
|
||||
/*
|
||||
* Copyright 2020 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.geode.core.io;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.eq;
|
||||
import static org.mockito.Mockito.doCallRealMethod;
|
||||
import static org.mockito.Mockito.doReturn;
|
||||
import static org.mockito.Mockito.doThrow;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.verifyNoInteractions;
|
||||
import static org.mockito.Mockito.verifyNoMoreInteractions;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.OutputStream;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.core.io.WritableResource;
|
||||
import org.springframework.dao.DataAccessResourceFailureException;
|
||||
|
||||
/**
|
||||
* Unit Tests for {@link AbstractResourceWriter}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see org.junit.Test
|
||||
* @see org.mockito.Mockito
|
||||
* @see org.springframework.core.io.Resource
|
||||
* @see org.springframework.core.io.WritableResource
|
||||
* @see org.springframework.geode.core.io.AbstractResourceWriter
|
||||
* @since 1.3.1
|
||||
*/
|
||||
public class AbstractResourceWriterUnitTests {
|
||||
|
||||
@Test
|
||||
public void writeCallsDoWrite() throws IOException {
|
||||
|
||||
byte[] array = { (byte) 0xCA, (byte) 0xFE, (byte) 0xBA, (byte) 0xBE };
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
OutputStream mockOutputStream = mock(OutputStream.class);
|
||||
|
||||
WritableResource mockResource = mock(WritableResource.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).write(eq(mockResource), eq(array));
|
||||
doReturn(true).when(mockResourceWriter).isAbleToHandle(eq(mockResource));
|
||||
doReturn(mockOutputStream).when(mockResource).getOutputStream();
|
||||
doReturn(true).when(mockResource).isWritable();
|
||||
|
||||
mockResourceWriter.write(mockResource, array);
|
||||
|
||||
verify(mockResourceWriter, times(1)).isAbleToHandle(eq(mockResource));
|
||||
verify(mockResourceWriter, times(1)).doWrite(eq(mockOutputStream), eq(array));
|
||||
verify(mockResource, times(1)).isWritable();
|
||||
verify(mockResource, times(1)).getOutputStream();
|
||||
verify(mockOutputStream, times(1)).close();
|
||||
verifyNoMoreInteractions(mockOutputStream, mockResource);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalStateException.class)
|
||||
public void writeNonWritableResourceThrowsIllegalStateException() throws IOException {
|
||||
|
||||
byte[] array = { (byte) 0x01 };
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
Resource mockResource = mock(Resource.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).write(any(), any(byte[].class));
|
||||
doReturn("MOCK").when(mockResource).getDescription();
|
||||
|
||||
try {
|
||||
mockResourceWriter.write(mockResource, array);
|
||||
}
|
||||
catch (IllegalStateException expected) {
|
||||
|
||||
assertThat(expected).hasMessage("Resource [MOCK] is not writable");
|
||||
assertThat(expected).hasNoCause();
|
||||
|
||||
throw expected;
|
||||
}
|
||||
finally {
|
||||
verify(mockResourceWriter, never()).isAbleToHandle(any());
|
||||
verify(mockResourceWriter, never()).doWrite(any(), any());
|
||||
verify(mockResource, times(1)).getDescription();
|
||||
verifyNoMoreInteractions(mockResource);
|
||||
}
|
||||
}
|
||||
|
||||
@Test(expected = IllegalStateException.class)
|
||||
public void writeNullResourceThrowsIllegalStateException() throws IOException {
|
||||
|
||||
byte[] array = { (byte) 0x02 };
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).write(any(), any(byte[].class));
|
||||
|
||||
try {
|
||||
mockResourceWriter.write(null, array);
|
||||
}
|
||||
catch (IllegalStateException expected) {
|
||||
|
||||
assertThat(expected).hasMessage("Resource [null] is not writable");
|
||||
assertThat(expected).hasNoCause();
|
||||
|
||||
throw expected;
|
||||
}
|
||||
finally {
|
||||
verify(mockResourceWriter, never()).isAbleToHandle(any());
|
||||
verify(mockResourceWriter, never()).doWrite(any(), any());
|
||||
}
|
||||
}
|
||||
|
||||
@Test(expected = UnhandledResourceException.class)
|
||||
public void writeUnhandledResourceThrowsUnhandledResourceException() throws IOException {
|
||||
|
||||
byte[] array = { (byte) 0x04 };
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
WritableResource mockResource = mock(WritableResource.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).write(any(), any(byte[].class));
|
||||
doReturn(true).when(mockResource).isWritable();
|
||||
doReturn("MOCK").when(mockResource).getDescription();
|
||||
doReturn(false).when(mockResourceWriter).isAbleToHandle(eq(mockResource));
|
||||
|
||||
try {
|
||||
mockResourceWriter.write(mockResource, array);
|
||||
}
|
||||
catch (UnhandledResourceException expected) {
|
||||
|
||||
assertThat(expected).hasMessage("Unable to handle Resource [MOCK]");
|
||||
assertThat(expected).hasNoCause();
|
||||
|
||||
throw expected;
|
||||
}
|
||||
finally {
|
||||
verify(mockResource, times(1)).isWritable();
|
||||
verify(mockResource, times(1)).getDescription();
|
||||
verify(mockResourceWriter, never()).doWrite(any(), any());
|
||||
verifyNoMoreInteractions(mockResource);
|
||||
}
|
||||
}
|
||||
|
||||
@Test(expected = DataAccessResourceFailureException.class)
|
||||
public void writeThrowsDataAccessResourceFailureExceptionForIoException() throws IOException {
|
||||
|
||||
byte[] array = { (byte) 0x08 };
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
OutputStream mockOutputStream = mock(OutputStream.class);
|
||||
|
||||
WritableResource mockResource = mock(WritableResource.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).write(any(), any(byte[].class));
|
||||
doReturn(true).when(mockResource).isWritable();
|
||||
doReturn("MOCK").when(mockResource).getDescription();
|
||||
doReturn(mockOutputStream).when(mockResource).getOutputStream();
|
||||
doReturn(true).when(mockResourceWriter).isAbleToHandle(eq(mockResource));
|
||||
doThrow(new IOException("TEST")).when(mockResourceWriter).doWrite(eq(mockOutputStream), eq(array));
|
||||
|
||||
try {
|
||||
mockResourceWriter.write(mockResource, array);
|
||||
}
|
||||
catch (DataAccessResourceFailureException expected) {
|
||||
|
||||
assertThat(expected).hasMessageStartingWith("Failed to write to Resource [MOCK]");
|
||||
assertThat(expected).hasCauseInstanceOf(IOException.class);
|
||||
assertThat(expected.getCause()).hasMessage("TEST");
|
||||
assertThat(expected.getCause()).hasNoCause();
|
||||
|
||||
throw expected;
|
||||
}
|
||||
finally {
|
||||
verify(mockResourceWriter, times(1)).isAbleToHandle(eq(mockResource));
|
||||
verify(mockResourceWriter, times(1)).doWrite(eq(mockOutputStream), eq(array));
|
||||
verify(mockResource, times(1)).isWritable();
|
||||
verify(mockResource, times(1)).getDescription();
|
||||
verify(mockResource, times(1)).getOutputStream();
|
||||
verify(mockOutputStream, times(1)).close();
|
||||
verifyNoMoreInteractions(mockOutputStream, mockResource);
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isAbleToHandleNonNullResourceReturnsTrue() {
|
||||
|
||||
Resource mockResource = mock(Resource.class);
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).isAbleToHandle(any());
|
||||
|
||||
assertThat(mockResourceWriter.isAbleToHandle(mockResource)).isTrue();
|
||||
|
||||
verifyNoInteractions(mockResource);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isAbleToHandleNullResourceReturnsFalse() {
|
||||
|
||||
AbstractResourceWriter mockResourceWriter = mock(AbstractResourceWriter.class);
|
||||
|
||||
doCallRealMethod().when(mockResourceWriter).isAbleToHandle(any());
|
||||
|
||||
assertThat(mockResourceWriter.isAbleToHandle(null)).isFalse();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user