patterntesting.runtime.junit.MapTester Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-rt Show documentation

PatternTesting Runtime (patterntesting-rt) is the runtime component for the PatternTesting framework. It provides the annotations and base classes for the PatternTesting testing framework (e.g. patterntesting-check, patterntesting-concurrent or patterntesting-exception) but can be also used standalone for classpath monitoring or profiling. It uses AOP and AspectJ to perform this feat.

There is a newer version: 2.4.0

Show newest version

/*
 * $Id: MapTester.java,v 1.3 2013/12/19 20:45:39 oboehm Exp $
 *
 * Copyright (c) 2013 by Oliver Boehm
 *
 * 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 18.12.2013 by oliver ([email protected])
 */

package patterntesting.runtime.junit;

import java.util.*;
import java.util.Map.Entry;

import patterntesting.runtime.util.Converter;

/**
 * This class asserts (among other things) that two maps are equals.
 *
 * @author oliver
 * @since 1.4 (18.12.2013)
 */
public class MapTester {

    /** Utility class - no need to instantiate it. */
    private MapTester() {}

    /**
     * Checks if each key-value pair in map m1 is equals to that of map m2. If
     * not this method will tell you which pair is different. If the maps
     * have different size this method will tell you which pair is missing.
     *
     * @param m1 the m1
     * @param m2 the m2
     */
    @SuppressWarnings("unchecked")
    public static void assertEquals(final Map m1, final Map m2) {
       Map map1 = (Map) m1;
       if (m1.size() < m2.size()) {
            assertEquals(m2, m1);
        } else if (m1.size() > m2.size()) {
            for (Entry entry : map1.entrySet()) {
                if (!(m2.containsKey(entry.getKey()))) {
                    throw new AssertionError("<" + entry + "> is missing in "
                            + Converter.toShortString(m2));
                }
            }
        } else {
            for (Entry entry : map1.entrySet()) {
                Object value2 = m2.get(entry.getKey());
                if (value2 == null) {
                    throw new AssertionError("{" + entry + "}> is missing in "
                            + Converter.toShortString(m2));
                } else if (!(value2.equals(entry.getValue()))) {
                    throw new AssertionError("key \"" + entry.getKey()
                            + "\" has different values: " + entry.getValue() + " <--> " + value2);
                }
            }
        }
    }

    /**
     * Checks if each key in map m1 is equals to that of map m2. If not this
     * method will tell you which key is different. If the maps have different
     * size this method will tell you which key is missing.
     *
     * @param m1 the m1
     * @param m2 the m2
     */
    public static void assertEqualKeys(final Map m1, final Map m2) {
        CollectionTester.assertEquals(m1.keySet(), m2.keySet(), "keys differs");
    }

    /**
     * Checks if each value in map m1 is equals to that of map m2. If not this
     * method will tell you which map is different. If the maps have different
     * size this method will tell you which value is missing.
     *
     * @param m1 the m1
     * @param m2 the m2
     */
    public static void assertEqualValues(final Map m1, final Map m2) {
        CollectionTester.assertEquals(m1.values(), m2.values(), "values differs");
    }

}