TestUtils.java

/*
 * Copyright 2013, 2014, 2015 EnergyOS.org
 *
 *    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.energyos.espi.common.support;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;

import javax.persistence.Column;
import javax.validation.constraints.Size;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;

@SuppressWarnings("rawtypes")
public class TestUtils {

	public static void assertAnnotationPresent(Class clazz,
			Class annotationClass) {
		if (getClassAnnotation(clazz, annotationClass) == null)
			throw new AssertionError(String.format(
					"'%s' annotation is missing for class '%s'",
					annotationClass.getCanonicalName(),
					clazz.getCanonicalName()));
	}

	public static void assertAnnotationPresent(Class clazz, String fieldName,
			Class annotationClass) {
		if (getAnnotation(clazz, fieldName, annotationClass) == null)
			throw new AssertionError(String.format(
					"'%s' annotation is missing for field '%s'",
					annotationClass.getCanonicalName(), fieldName));
	}

	public static void assertColumnAnnotation(Class clazz, String fieldName,
			String columnName) {
		Annotation annotation = assertAndGetAnnotation(clazz, fieldName,
				Column.class);

		String name = ((Column) annotation).name();
		if (!name.equals(columnName))
			throw new AssertionError(
					String.format(
							"Column name in @Column annotation not match expected '%s'",
							name));
	}

	public static void assertSizeValidation(Class clazz, String fieldName,
			int min, int max) {
		Annotation annotation = assertAndGetAnnotation(clazz, fieldName,
				Size.class);

		int minValue = ((javax.validation.constraints.Size) annotation).min();
		if (min != minValue)
			throw new AssertionError(String.format(
					"@Size annotation minimum does not match expected '%s'",
					min));

		int maxValue = ((javax.validation.constraints.Size) annotation).max();
		if (max != maxValue)
			throw new AssertionError(String.format(
					"@Size annotation maximum does not match expected '%s'",
					max));
	}

	public static void assertXmlElement(Class clazz, String fieldName,
			Class type) {
		Annotation annotation = assertAndGetAnnotation(clazz, fieldName,
				XmlElement.class);

		Class annotationType = ((XmlElement) annotation).type();
		if (type != annotationType)
			throw new AssertionError(String.format(
					"@XmlElement annotation type does not match expected '%s'",
					type));
	}

	private static Annotation assertAndGetAnnotation(Class clazz,
			String fieldName, Class annotationClass) {
		assertAnnotationPresent(clazz, fieldName, annotationClass);
		return getAnnotation(clazz, fieldName, annotationClass);
	}

	private static Annotation getAnnotation(Class clazz, String fieldName,
			Class annotationClass) {
		Field field;

		try {
			field = clazz.getDeclaredField(fieldName);
		} catch (NoSuchFieldException e) {
			throw new AssertionError(String.format(
					"'%s' is missing field '%s'", clazz.getCanonicalName(),
					fieldName));
		}

		Annotation foundAnnotation = null;

		for (Annotation annotation : field.getAnnotations()) {
			if (annotation.annotationType().equals(annotationClass)) {
				foundAnnotation = annotation;
				break;
			}
		}

		return foundAnnotation;
	}

	private static Annotation getClassAnnotation(Class clazz,
			Class annotationClass) {
		Annotation foundAnnotation = null;

		for (Annotation annotation : clazz.getAnnotations()) {
			if (annotation.annotationType().equals(annotationClass)) {
				foundAnnotation = annotation;
				break;
			}
		}

		return foundAnnotation;
	}

	public static void assertFieldNotMarshallable(Class clazz, String field) {
		assertAnnotationPresent(clazz, field, XmlTransient.class);
	}
}