org.hobsoft.symmetry.ui.test.AbstractComponentTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of symmetry-ui-test-support Show documentation
The newest version!
/*
 * 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.hobsoft.symmetry.ui.test;

import org.hobsoft.symmetry.ui.Component;
import org.hobsoft.symmetry.ui.traversal.ComponentVisitor;
import org.jmock.Expectations;
import org.jmock.Mockery;
import org.jmock.integration.junit4.JMock;
import org.jmock.integration.junit4.JUnit4Mockery;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import com.google.common.reflect.TypeToken;

import static org.hobsoft.symmetry.ui.test.traversal.MockComponentVisitors.createVisitor;
import static org.hobsoft.symmetry.ui.test.traversal.MockComponentVisitors.createVisitorParameter;
import static org.hobsoft.symmetry.ui.test.traversal.MockComponentVisitors.nullEndVisit;
import static org.hobsoft.symmetry.ui.test.traversal.MockComponentVisitors.nullVisit;
import static org.hobsoft.symmetry.ui.traversal.ComponentVisitors.nullHierarchicalVisitor;
import static org.hobsoft.symmetry.ui.traversal.ComponentVisitors.skipSiblings;
import static org.hobsoft.symmetry.ui.traversal.HierarchicalComponentVisitor.EndVisit.SKIP_SIBLINGS;
import static org.hobsoft.symmetry.ui.traversal.HierarchicalComponentVisitor.EndVisit.VISIT_SIBLINGS;
import static org.junit.Assert.assertEquals;

/**
 * Shared tests for {@code Component} implementations.
 * 
 * @author Mark Hobson
 * @param 
 *            the type of component that this test tests
 * @see Component
 */
@RunWith(JMock.class)
public abstract class AbstractComponentTest
{
	// fields -----------------------------------------------------------------
	
	private Mockery mockery = new JUnit4Mockery();
	
	private TypeToken componentType;
	
	private T component;
	
	// public methods ---------------------------------------------------------
	
	@Before
	public final void setUpAbstractComponentTest()
	{
		componentType = getComponentType();
		component = createComponent();
	}
	
	// tests ------------------------------------------------------------------
	
	@Test
	public void acceptWithSubvisitorReturningVisitSiblings()
	{
		final Object parameter = createVisitorParameter();
		
		final ComponentVisitor visitor = createVisitor(mockery);
		
		mockery.checking(new Expectations() { {
			oneOf(visitor).visit(componentType, component, parameter); will(returnValue(nullHierarchicalVisitor()));
		} });
		
		assertEquals(VISIT_SIBLINGS, component.accept(visitor, parameter));
	}
	
	@Test
	public void acceptWithSubvisitorReturningSkipSiblings()
	{
		final Object parameter = createVisitorParameter();
		
		final ComponentVisitor visitor = createVisitor(mockery);
		
		mockery.checking(new Expectations() { {
			oneOf(visitor).visit(componentType, component, parameter); will(returnValue(skipSiblings()));
		} });
		
		assertEquals(SKIP_SIBLINGS, component.accept(visitor, parameter));
	}
	
	@Test
	public void acceptWithSubvisitorReturningNullVisit()
	{
		final Object parameter = createVisitorParameter();
		
		final ComponentVisitor visitor = createVisitor(mockery);
		
		mockery.checking(new Expectations() { {
			oneOf(visitor).visit(componentType, component, parameter); will(returnValue(nullVisit()));
		} });
		
		assertEquals(VISIT_SIBLINGS, component.accept(visitor, parameter));
	}
	
	@Test
	public void acceptWithSubvisitorReturningNullEndVisit()
	{
		final Object parameter = createVisitorParameter();
		
		final ComponentVisitor visitor = createVisitor(mockery);
		
		mockery.checking(new Expectations() { {
			oneOf(visitor).visit(componentType, component, parameter); will(returnValue(nullEndVisit()));
		} });
		
		assertEquals(VISIT_SIBLINGS, component.accept(visitor, parameter));
	}
	
	@Test
	public void acceptWithNullSubvisitor()
	{
		final Object parameter = createVisitorParameter();
		
		final ComponentVisitor visitor = createVisitor(mockery);
		
		mockery.checking(new Expectations() { {
			oneOf(visitor).visit(componentType, component, parameter); will(returnValue(null));
		} });
		
		assertEquals(VISIT_SIBLINGS, component.accept(visitor, parameter));
	}
	
	@Test(expected = NullPointerException.class)
	public void acceptWithNullVisitor()
	{
		component.accept((ComponentVisitor) null, createVisitorParameter());
	}
	
	// protected methods ------------------------------------------------------
	
	protected final Mockery getMockery()
	{
		return mockery;
	}
	
	protected final T getComponent()
	{
		return component;
	}
	
	protected abstract T createComponent();
	
	protected abstract TypeToken getComponentType();
}