Spring Framework example source code file (ModelAndViewAssert.java)

This example Spring Framework source code file (ModelAndViewAssert.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Spring Framework tags/keywords

assertionerror, assertionerror, iterator, list, list, model, modelandview, modelandview, object, object, set, size, string, stringbuffer, util

The Spring Framework ModelAndViewAssert.java source code

/*
 * Copyright 2002-2007 the original author or authors.
 *
 * 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 or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.test.web;

import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.springframework.web.servlet.ModelAndView;

/**
 * <p>
 * A collection of assertions intended to simplify testing scenarios
 * dealing with Spring Web MVC
 * {@link org.springframework.web.servlet.ModelAndView ModelAndView} objects.
 * Intended for use with JUnit 4 and TestNG.
 * </p>
 * <p>
 * All <code>assert*() methods throw {@link AssertionError}s.
 * </p>
 *
 * @author Sam Brannen
 * @author Alef Arendsen
 * @author Bram Smeets
 * @since 2.5
 * @see org.springframework.web.servlet.ModelAndView
 */
public abstract class ModelAndViewAssert {

	/**
	 * Checks whether the model value under the given <code>modelName
	 * exists and checks it type, based on the <code>expectedType. If
	 * the model entry exists and the type matches, the model value is returned.
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param modelName name of the object to add to the model (never
	 * <code>null)
	 * @param expectedType expected type of the model value
	 * @return the model value
	 */
	public static Object assertAndReturnModelAttributeOfType(ModelAndView mav, Object modelName, Class expectedType)
			throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		assertCondition(mav.getModel() != null, "Model is null");
		final Object obj = mav.getModel().get(modelName);
		assertCondition(obj != null, "Model attribute with name '" + modelName + "' is null");

		assertCondition(expectedType.isAssignableFrom(obj.getClass()), "Model attribute is not of expected type '"
				+ expectedType.getName() + "' but rather of type '" + obj.getClass().getName() + "'");
		return obj;
	}

	/**
	 * Compare each individual entry in a list, without first sorting the lists.
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param modelName name of the object to add to the model (never
	 * <code>null)
	 * @param expectedList the expected list
	 */
	public static void assertCompareListModelAttribute(ModelAndView mav, Object modelName, List expectedList)
			throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		List modelList = (List) assertAndReturnModelAttributeOfType(mav, modelName, List.class);
		assertCondition(expectedList.size() == modelList.size(), "Size of model list is '" + modelList.size()
				+ "' while size of expected list is '" + expectedList.size() + "'");
		assertCondition(expectedList.equals(modelList), "List in model under name '" + modelName
				+ "' is not equal to the expected list.");
	}

	/**
	 * Assert whether or not a model attribute is available.
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param modelName name of the object to add to the model (never
	 * <code>null)
	 */
	public static void assertModelAttributeAvailable(ModelAndView mav, Object modelName) throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		assertCondition(mav.getModel() != null, "Model is null");
		assertCondition(mav.getModel().containsKey(modelName), "Model attribute with name '" + modelName
				+ "' is not available");
	}

	/**
	 * Compare a given <code>expectedValue to the value from the model
	 * bound under the given <code>modelName.
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param modelName name of the object to add to the model (never
	 * <code>null)
	 * @param expectedValue the model value
	 */
	public static void assertModelAttributeValue(ModelAndView mav, Object modelName, Object expectedValue)
			throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		Object modelValue = assertAndReturnModelAttributeOfType(mav, modelName, Object.class);
		assertCondition(modelValue.equals(expectedValue), "Model value with name '" + modelName
				+ "' is not the same as the expected value which was '" + expectedValue + "'");
	}

	/**
	 * Inspect the <code>expectedModel to see if all elements in the
	 * model appear and are equal.
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param expectedModel the expected model
	 */
	public static void assertModelAttributeValues(ModelAndView mav, Map expectedModel) throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		assertCondition(mav.getModel() != null, "Model is null");

		if (!mav.getModel().keySet().equals(expectedModel.keySet())) {
			StringBuffer buf = new StringBuffer("Keyset of expected model does not match.\n");
			appendNonMatchingSetsErrorMessage(expectedModel.keySet(), mav.getModel().keySet(), buf);
			fail(buf.toString());
		}

		StringBuffer buf = new StringBuffer();
		Iterator it = mav.getModel().keySet().iterator();
		while (it.hasNext()) {
			Object modelName = it.next();
			Object assertionValue = expectedModel.get(modelName);
			Object mavValue = mav.getModel().get(modelName);
			if (!assertionValue.equals(mavValue)) {
				buf.append("Value under name '" + modelName + "' differs, should have been '" + assertionValue
						+ "' but was '" + mavValue + "'\n");
			}
		}

		if (buf.length() != 0) {
			buf.insert(0, "Values of expected model do not match.\n");
			fail(buf.toString());
		}
	}

	/**
	 * Compare each individual entry in a list after having sorted both lists
	 * (optionally using a comparator).
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param modelName name of the object to add to the model (never
	 * <code>null)
	 * @param expectedList the expected list
	 * @param comparator the comparator to use (may be <code>null). If
	 * not specifying the comparator, both lists will be sorted not using
	 * any comparator.
	 */
	public static void assertSortAndCompareListModelAttribute(
			ModelAndView mav, Object modelName, List expectedList, Comparator comparator) throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		List modelList = (List) assertAndReturnModelAttributeOfType(mav, modelName, List.class);

		assertCondition(expectedList.size() == modelList.size(), "Size of model list is '" + modelList.size()
				+ "' while size of expected list is '" + expectedList.size() + "'");

		if (comparator != null) {
			Collections.sort(modelList, comparator);
			Collections.sort(expectedList, comparator);
		}
		else {
			Collections.sort(modelList);
			Collections.sort(expectedList);
		}

		assertCondition(expectedList.equals(modelList), "List in model under name '" + modelName
				+ "' is not equal to the expected list.");
	}

	/**
	 * Check to see if the view name in the ModelAndView matches the given
	 * <code>expectedName.
	 *
	 * @param mav ModelAndView to test against (never <code>null)
	 * @param expectedName the name of the model value
	 */
	public static void assertViewName(ModelAndView mav, String expectedName) throws AssertionError {

		assertCondition(mav != null, "ModelAndView is null");
		assertCondition(expectedName.equals(mav.getViewName()), "View name is not equal to '" + expectedName
				+ "' but was '" + mav.getViewName() + "'");
	}


	/**
	 * Fails by throwing an <code>AssertionError with the supplied
	 * <code>message.
	 *
	 * @param message the exception message to use
	 * @see #assertCondition(boolean,String)
	 */
	private static void fail(String message) throws AssertionError {

		throw new AssertionError(message);
	}

	/**
	 * Assert the provided boolean <code>condition, throwing
	 * <code>AssertionError with the supplied message if
	 * the test result is <code>false.
	 *
	 * @param condition a boolean expression
	 * @param message the exception message to use if the assertion fails
	 * @throws AssertionError if condition is <code>false
	 * @see #fail(String)
	 */
	private static void assertCondition(boolean condition, String message) throws AssertionError {

		if (!condition) {
			fail(message);
		}
	}

	private static void appendNonMatchingSetsErrorMessage(Set assertionSet, Set incorrectSet, StringBuffer buf) {

		Set tempSet = new HashSet();
		tempSet.addAll(incorrectSet);
		tempSet.removeAll(assertionSet);

		if (tempSet.size() > 0) {
			buf.append("Set has too many elements:\n");
			Iterator it = tempSet.iterator();
			while (it.hasNext()) {
				Object o = it.next();
				buf.append('-');
				buf.append(o.toString());
				buf.append('\n');
			}
		}

		tempSet = new HashSet();
		tempSet.addAll(assertionSet);
		tempSet.removeAll(incorrectSet);

		if (tempSet.size() > 0) {
			buf.append("Set is missing elements:\n");
			Iterator it = tempSet.iterator();
			while (it.hasNext()) {
				Object o = it.next();
				buf.append('-');
				buf.append(o.toString());
				buf.append('\n');
			}
		}
	}

}