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