001/*
002 * Copyright 2023 the original author or authors.
003 * <p>
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * <p>
008 * https://www.apache.org/licenses/LICENSE-2.0
009 * <p>
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.cuioss.test.valueobjects.junit5.contracts;
017
018import static org.junit.jupiter.api.Assertions.assertTrue;
019
020import java.io.Serializable;
021
022import org.junit.jupiter.api.Test;
023
024import de.cuioss.test.valueobjects.contract.SerializableContractImpl;
025import de.cuioss.test.valueobjects.objects.TestObjectProvider;
026
027/**
028 * Simple check whether the returned {@link TestObjectProvider#getUnderTest()}
029 * implements {@link Serializable} correctly
030 *
031 * @author Oliver Wolff
032 * @param <T> identifying the type to be tested is usually but not necessarily
033 *            at least Serializable.
034 *
035 */
036public interface ShouldBeSerializable<T> extends TestObjectProvider<T> {
037
038    /**
039     * Simple check whether the returned {@link TestObjectProvider#getUnderTest()}
040     * implements {@link Serializable} correctly
041     */
042    @Test
043    default void shouldImplementSerializable() {
044        var underTest = getUnderTest();
045        assertTrue(underTest instanceof Serializable,
046                underTest.getClass().getName() + " does not implement java.io.Serializable");
047        SerializableContractImpl.serializeAndDeserialize(underTest);
048    }
049}