com.github.robtimus.junit.support.io.InputStreamDelegateTests Maven / Gradle / Ivy
/*
* InputStreamDelegateTests.java
* Copyright 2020 Rob Spoor
*
* 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
*
* 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 com.github.robtimus.junit.support.io;
import static com.github.robtimus.junit.support.io.IOAssertions.assertDoesNotThrowIOException;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import java.io.InputStream;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
/**
* Base interface for testing that {@link InputStream} implementations correctly delegate to another {@link InputStream}.
*
* @author Rob Spoor
*/
public interface InputStreamDelegateTests {
/**
* Creates the input stream to test.
*
* This method will be called only once for each test. This makes it possible to capture the input stream to test and its delegate, and perform
* additional tests after the pre-defined test has finished.
*
* @param delegate The delegate to test against.
* @return The created input stream.
*/
InputStream wrapInputStream(InputStream delegate);
/**
* Contains tests for {@link InputStream#close()}.
*
* @author Rob Spoor
*/
@DisplayName("close()")
interface CloseTests extends InputStreamDelegateTests {
@Test
@DisplayName("close() delegates")
default void testCloseDelegates() {
assertDoesNotThrowIOException(() -> {
@SuppressWarnings("resource")
InputStream delegate = mock(InputStream.class);
try (InputStream inputStream = wrapInputStream(delegate)) {
// no code necessary
}
verify(delegate).close();
});
}
}
}