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.assertNotNull;
019
020import org.junit.jupiter.api.Test;
021
022import de.cuioss.test.valueobjects.contract.ReflectionUtil;
023import de.cuioss.test.valueobjects.objects.TestObjectProvider;
024
025/**
026 * Simple check whether the {@link TestObjectProvider#getUnderTest()} implements
027 * {@link Object#equals(Object)} and {@link Object#hashCode()}
028 *
029 * @author Oliver Wolff
030 * @param <T> identifying the type to be tested is usually but not necessarily
031 *            at least Serializable.
032 *
033 */
034public interface ShouldImplementToString<T> extends TestObjectProvider<T> {
035
036    /**
037     * Simple check whether the {@link TestObjectProvider#getUnderTest()} implements
038     * {@link Object#equals(Object)} and {@link Object#hashCode()}
039     */
040    @Test
041    default void shouldImplementToString() {
042        var underTest = getUnderTest();
043        ReflectionUtil.assertToStringMethodIsOverriden(underTest.getClass());
044        assertNotNull(underTest.toString(), "toString must not return 'null'");
045    }
046}