/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.collections4;

import static org.junit.jupiter.api.Assertions.assertSame;

import java.io.IOException;

public final class TestUtils {

    /**
     * Asserts that deserialization of the object returns the same object as the
     * one that was serialized.
     * <p>
     * Effect of method call is the same as:
     * {@code assertSameAfterSerialization(null, o)}.
     * </p>
     *
     * @param o object that will be tested.
     * @throws IOException Thrown on test failure.
     * @throws ClassNotFoundException Thrown on test failure.
     * @see #assertSameAfterSerialization(String, Object)
     */
    public static void assertSameAfterSerialization(final Object o) throws IOException, ClassNotFoundException {
        assertSameAfterSerialization(null, o);
    }

    /**
     * Asserts that deserialization of the object returns the same object as the
     * one that was serialized. Object is first serialized, then deserialized
     * and finally check is performed to see if original and deserialized
     * object references are the same.
     * <p>
     * This method is especially good for testing singleton pattern on classes
     * that support serialization.
     * </p>
     *
     * @param msg The identifying message for the {@code AssertionError}.
     * @param o object that will be tested.
     * @throws IOException Thrown on test failure.
     * @throws ClassNotFoundException Thrown on test failure.
     * @see #assertSameAfterSerialization(Object)
     */
    public static void assertSameAfterSerialization(final String msg, final Object o) throws IOException, ClassNotFoundException {
        // assert that original object and deserialized objects are the same
        assertSame(o, AbstractObjectTest.serializeDeserialize(o), msg);
    }

    private TestUtils() {
        // empty
    }

}
