Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*****************************************************************************
* Copyright (C) PicoContainer Organization. All rights reserved. *
* ------------------------------------------------------------------------- *
* The software in this package is published under the terms of the BSD *
* style license a copy of which has been included with this distribution in *
* the LICENSE.txt file. *
* *
* Original code by Joerg Schaible *
*****************************************************************************/
package org.picocontainer.tck;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Constructor;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import junit.framework.Assert;
import junit.framework.AssertionFailedError;
import org.junit.Test;
import org.picocontainer.ComponentAdapter;
import org.picocontainer.ComponentFactory;
import org.picocontainer.DefaultPicoContainer;
import org.picocontainer.LifecycleStrategy;
import org.picocontainer.MutablePicoContainer;
import org.picocontainer.ObjectReference;
import org.picocontainer.Parameter;
import org.picocontainer.PicoCompositionException;
import org.picocontainer.PicoContainer;
import org.picocontainer.behaviors.AbstractBehavior;
import org.picocontainer.injectors.AbstractInjector;
import org.picocontainer.injectors.AdaptingInjection;
import org.picocontainer.injectors.ConstructorInjection;
import org.picocontainer.parameters.ConstantParameter;
import org.picocontainer.references.SimpleReference;
import org.picocontainer.visitors.AbstractPicoVisitor;
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.converters.reflection.PureJavaReflectionProvider;
import com.thoughtworks.xstream.io.xml.XppDriver;
/**
* Test suite for a ComponentAdapter implementation.
*
* @author Jörg Schaible
*/
public abstract class AbstractComponentAdapterTest {
public static final int SERIALIZABLE = 1;
public static final int VERIFYING = 2;
public static final int INSTANTIATING = 4;
public static final int RESOLVING = 8;
protected abstract Class getComponentAdapterType();
protected int getComponentAdapterNature() {
return SERIALIZABLE | VERIFYING | INSTANTIATING | RESOLVING;
}
protected ComponentFactory createDefaultComponentFactory() {
return new AdaptingInjection();
}
// ============================================
// Default
// ============================================
/**
* Prepare the test verifyWithoutDependencyWorks.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test for a component without dependencies. Registration in the pico is
* not necessary.
*/
protected abstract ComponentAdapter prepDEF_verifyWithoutDependencyWorks(MutablePicoContainer picoContainer);
final @Test public void testDEF_verifyWithoutDependencyWorks() {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepDEF_verifyWithoutDependencyWorks(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
componentAdapter.verify(picoContainer);
}
/**
* Prepare the test verifyDoesNotInstantiate.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test for a component that may throw on instantiation. Registration in
* the pico is not necessary.
*/
protected abstract ComponentAdapter prepDEF_verifyDoesNotInstantiate(MutablePicoContainer picoContainer);
final @Test public void testDEF_verifyDoesNotInstantiate() {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepDEF_verifyDoesNotInstantiate(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
final ComponentAdapter notInstantiatablecomponentAdapter = new NotInstantiatableBehavior(
componentAdapter);
final PicoContainer wrappedPicoContainer = wrapComponentInstances(
NotInstantiatableBehavior.class, picoContainer, null);
notInstantiatablecomponentAdapter.verify(wrappedPicoContainer);
}
/**
* Prepare the test visitable.
*
* @return a ComponentAdapter of the type to test. If the ComponentAdapter supports {@link Parameter}, you have to
* select a component, that have some.
*/
protected abstract ComponentAdapter prepDEF_visitable();
final @Test public void testDEF_visitable() {
final ComponentAdapter componentAdapter = prepDEF_visitable();
final Class type = getComponentAdapterType();
assertSame(type, componentAdapter.getClass());
boolean hasParameters = supportsParameters(type);
final RecordingVisitor visitor = new RecordingVisitor();
visitor.traverse(componentAdapter);
final List visitedElements = new ArrayList(visitor.getVisitedElements());
assertSame(componentAdapter, visitedElements.get(0));
if (hasParameters) {
hasParameters = false;
for (final Iterator iter = visitedElements.iterator(); iter.hasNext() && !hasParameters;) {
hasParameters = Parameter.class.isAssignableFrom(iter.next().getClass());
}
assertTrue("ComponentAdapter " + type + " supports parameters, provide some", hasParameters);
}
}
/**
* Prepare the test isAbleToTakeParameters. Overload this function, if the ComponentAdapter to test
* supports {@link Parameter}.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test. Select a component, that has some parameters. Registration in the
* pico is not necessary.
*/
protected ComponentAdapter prepDEF_isAbleToTakeParameters(MutablePicoContainer picoContainer) {
final Class type = getComponentAdapterType();
boolean hasParameters = supportsParameters(type);
if (hasParameters) {
fail("You have to overwrite this method for a useful test");
}
return null;
}
final @Test public void testDEF_isAbleToTakeParameters() {
final Class type = getComponentAdapterType();
boolean hasParameters = supportsParameters(type);
if (hasParameters) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepDEF_isAbleToTakeParameters(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
final RecordingVisitor visitor = new RecordingVisitor();
visitor.traverse(componentAdapter);
final List visitedElements = visitor.getVisitedElements();
if (hasParameters) {
hasParameters = false;
for (final Iterator iter = visitedElements.iterator(); iter.hasNext() && !hasParameters;) {
hasParameters = Parameter.class.isAssignableFrom(iter.next().getClass());
}
assertTrue("ComponentAdapter " + type + " supports parameters, provide some", hasParameters);
}
final Object instance = componentAdapter.getComponentInstance(picoContainer);
assertNotNull(instance);
}
}
// ============================================
// Serializable
// ============================================
/**
* Prepare the test isSerializable. Overload this function, if the ComponentAdapter supports
* serialization.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test. Registration in the pico is not necessary.
*/
protected ComponentAdapter prepSER_isSerializable(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testSER_isSerializable() throws IOException, ClassNotFoundException {
if ((getComponentAdapterNature() & SERIALIZABLE) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepSER_isSerializable(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
final Object instance = componentAdapter.getComponentInstance(picoContainer);
assertNotNull(instance);
final ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
final ObjectOutputStream outputStream = new ObjectOutputStream(byteArrayOutputStream);
outputStream.writeObject(componentAdapter);
outputStream.close();
final ObjectInputStream inputStream = new ObjectInputStream(new ByteArrayInputStream(byteArrayOutputStream
.toByteArray()));
final ComponentAdapter serializedComponentAdapter = (ComponentAdapter)inputStream.readObject();
inputStream.close();
assertEquals(componentAdapter.getComponentKey(), serializedComponentAdapter.getComponentKey());
final Object instanceAfterSerialization = serializedComponentAdapter.getComponentInstance(picoContainer);
assertNotNull(instanceAfterSerialization);
assertSame(instance.getClass(), instanceAfterSerialization.getClass());
}
}
/**
* Prepare the test isXStreamSerializable. Overload this function, if the ComponentAdapter supports
* serialization.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test. Registration in the pico is not necessary.
*/
protected ComponentAdapter prepSER_isXStreamSerializable(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testSER_isXStreamSerializableWithPureReflection() {
if ((getComponentAdapterNature() & SERIALIZABLE) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepSER_isXStreamSerializable(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
final Object instance = componentAdapter.getComponentInstance(picoContainer);
assertNotNull(instance);
final XStream xstream = new XStream(new PureJavaReflectionProvider(), new XppDriver());
final String xml = xstream.toXML(componentAdapter);
final ComponentAdapter serializedComponentAdapter = (ComponentAdapter)xstream.fromXML(xml);
assertEquals(componentAdapter.getComponentKey(), serializedComponentAdapter.getComponentKey());
final Object instanceAfterSerialization = serializedComponentAdapter.getComponentInstance(picoContainer);
assertNotNull(instanceAfterSerialization);
assertSame(instance.getClass(), instanceAfterSerialization.getClass());
}
}
final @Test public void testSER_isXStreamSerializable() {
if ((getComponentAdapterNature() & SERIALIZABLE) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepSER_isXStreamSerializable(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
final Object instance = componentAdapter.getComponentInstance(picoContainer);
assertNotNull(instance);
final XStream xstream = new XStream(new XppDriver());
final String xml = xstream.toXML(componentAdapter);
final ComponentAdapter serializedComponentAdapter = (ComponentAdapter)xstream.fromXML(xml);
assertEquals(componentAdapter.getComponentKey(), serializedComponentAdapter.getComponentKey());
final Object instanceAfterSerialization = serializedComponentAdapter.getComponentInstance(picoContainer);
assertNotNull(instanceAfterSerialization);
assertSame(instance.getClass(), instanceAfterSerialization.getClass());
}
}
// ============================================
// Verifying
// ============================================
/**
* Prepare the test verificationFailsWithUnsatisfiedDependency. Overload this function, if the
* ComponentAdapter's verification can fail e.g. due to an unresolved dependency.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test, that fails for the verification, e.g. because of a compoennt with
* missing dependencies. Registration in the pico is not necessary.
*/
protected ComponentAdapter prepVER_verificationFails(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testVER_verificationFails() {
if ((getComponentAdapterNature() & VERIFYING) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer();
final ComponentAdapter componentAdapter = prepVER_verificationFails(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
try {
componentAdapter.verify(picoContainer);
fail("PicoCompositionException expected");
} catch (PicoCompositionException e) {
} catch (Exception e) {
fail("PicoCompositionException expected, but got " + e.getClass().getName());
}
try {
componentAdapter.getComponentInstance(picoContainer);
fail("PicoCompositionException or PicoCompositionException expected");
} catch (PicoCompositionException e) {
} catch (Exception e) {
fail("PicoCompositionException or PicoCompositionException expected, but got "
+ e.getClass().getName());
}
}
}
// ============================================
// Instantiating
// ============================================
/**
* Prepare the test createsNewInstances. Overload this function, if the ComponentAdapter is
* instantiating. It should create a new instance with every call.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test. Registration in the pico is not necessary.
*/
protected ComponentAdapter prepINS_createsNewInstances(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testINS_createsNewInstances() {
if ((getComponentAdapterNature() & INSTANTIATING) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepINS_createsNewInstances(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
final Object instance = componentAdapter.getComponentInstance(picoContainer);
assertNotNull(instance);
assertNotSame(instance, componentAdapter.getComponentInstance(picoContainer));
assertSame(instance.getClass(), componentAdapter.getComponentInstance(picoContainer).getClass());
}
}
/**
* Prepare the test errorIsRethrown. Overload this function, if the ComponentAdapter is instantiating.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test with a component that fails with an {@link Error} at
* instantiation. Registration in the pico is not necessary.
*/
protected ComponentAdapter prepINS_errorIsRethrown(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testINS_errorIsRethrown() {
if ((getComponentAdapterNature() & INSTANTIATING) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepINS_errorIsRethrown(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
try {
componentAdapter.getComponentInstance(picoContainer);
fail("Thrown Error excpected");
} catch (final Error e) {
assertEquals("test", e.getMessage());
}
}
}
/**
* Prepare the test runtimeExceptionIsRethrown. Overload this function, if the ComponentAdapter is
* instantiating.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test with a component that fails with a {@link RuntimeException} at
* instantiation. Registration in the pico is not necessary.
*/
protected ComponentAdapter prepINS_runtimeExceptionIsRethrown(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testINS_runtimeExceptionIsRethrown() {
if ((getComponentAdapterNature() & INSTANTIATING) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepINS_runtimeExceptionIsRethrown(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
try {
componentAdapter.getComponentInstance(picoContainer);
fail("Thrown RuntimeException excpected");
} catch (final RuntimeException e) {
assertEquals("test", e.getMessage());
}
}
}
/**
* Prepare the test normalExceptionIsRethrownInsidePicoInvocationTargetInitializationException. Overload
* this function, if the ComponentAdapter is instantiating.
*
* @param picoContainer container, may probably not be used.
* @return a ComponentAdapter of the type to test with a component that fails with a
* {@link PicoCompositionException} at instantiation. Registration in the pico is not
* necessary.
*/
protected ComponentAdapter prepINS_normalExceptionIsRethrownInsidePicoInitializationException(
MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testINS_normalExceptionIsRethrownInsidePicoInitializationException() {
if ((getComponentAdapterNature() & INSTANTIATING) > 0) {
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepINS_normalExceptionIsRethrownInsidePicoInitializationException(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
try {
componentAdapter.getComponentInstance(picoContainer);
fail("Thrown PicoCompositionException excpected");
} catch (final PicoCompositionException e) {
assertTrue(e.getCause() instanceof Exception);
assertTrue(e.getCause().getMessage().endsWith("test"));
}
}
}
// ============================================
// Resolving
// ============================================
/**
* Prepare the test dependenciesAreResolved. Overload this function, if the ComponentAdapter is resolves
* dependencies.
*
* @param picoContainer container, used to register dependencies.
* @return a ComponentAdapter of the type to test with a component that has dependencies. Registration in the pico
* is not necessary.
*/
protected ComponentAdapter prepRES_dependenciesAreResolved(MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testRES_dependenciesAreResolved() {
if ((getComponentAdapterNature() & RESOLVING) > 0) {
final List dependencies = new LinkedList();
final Object[] wrapperDependencies = new Object[]{dependencies};
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepRES_dependenciesAreResolved(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
assertFalse(picoContainer.getComponentAdapters().contains(componentAdapter));
final PicoContainer wrappedPicoContainer = wrapComponentInstances(
CollectingBehavior.class, picoContainer, wrapperDependencies);
final Object instance = componentAdapter.getComponentInstance(wrappedPicoContainer);
assertNotNull(instance);
assertTrue(dependencies.size() > 0);
}
}
/**
* Prepare the test failingVerificationWithCyclicDependencyException. Overload this function, if the
* ComponentAdapter is resolves dependencies.
*
* @param picoContainer container, used to register dependencies.
* @return a ComponentAdapter of the type to test with a component that has cyclic dependencies. You have to
* register the component itself in the pico.
*/
protected ComponentAdapter prepRES_failingVerificationWithCyclicDependencyException(
MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testRES_failingVerificationWithCyclicDependencyException() {
if ((getComponentAdapterNature() & RESOLVING) > 0) {
final Set cycleInstances = new HashSet();
final ObjectReference cycleCheck = new SimpleReference();
final Object[] wrapperDependencies = new Object[]{cycleInstances, cycleCheck};
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepRES_failingVerificationWithCyclicDependencyException(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
assertTrue(picoContainer.getComponentAdapters().contains(componentAdapter));
final PicoContainer wrappedPicoContainer = wrapComponentInstances(
CycleDetectorBehavior.class, picoContainer, wrapperDependencies);
try {
componentAdapter.verify(wrappedPicoContainer);
fail("Thrown PicoVerificationException excpected");
} catch (final AbstractInjector.CyclicDependencyException cycle) {
final Class[] dependencies = cycle.getDependencies();
assertSame(dependencies[0], dependencies[dependencies.length - 1]);
}
}
}
/**
* Prepare the test failingInstantiationWithCyclicDependencyException. Overload this function, if the
* ComponentAdapter is resolves dependencies.
*
* @param picoContainer container, used to register dependencies.
* @return a ComponentAdapter of the type to test with a component that has cyclic dependencies. You have to
* register the component itself in the pico.
*/
protected ComponentAdapter prepRES_failingInstantiationWithCyclicDependencyException(
MutablePicoContainer picoContainer) {
throw new AssertionFailedError("You have to overwrite this method for a useful test");
}
final @Test public void testRES_failingInstantiationWithCyclicDependencyException() {
if ((getComponentAdapterNature() & RESOLVING) > 0) {
final Set cycleInstances = new HashSet();
final ObjectReference cycleCheck = new SimpleReference();
final Object[] wrapperDependencies = new Object[]{cycleInstances, cycleCheck};
final MutablePicoContainer picoContainer = new DefaultPicoContainer(createDefaultComponentFactory());
final ComponentAdapter componentAdapter = prepRES_failingInstantiationWithCyclicDependencyException(picoContainer);
assertSame(getComponentAdapterType(), componentAdapter.getClass());
assertTrue(picoContainer.getComponentAdapters().contains(componentAdapter));
final PicoContainer wrappedPicoContainer = wrapComponentInstances(
CycleDetectorBehavior.class, picoContainer, wrapperDependencies);
try {
componentAdapter.getComponentInstance(wrappedPicoContainer);
fail("Thrown CyclicDependencyException excpected");
} catch (final AbstractInjector.CyclicDependencyException e) {
final Class[] dependencies = e.getDependencies();
assertSame(dependencies[0], dependencies[dependencies.length - 1]);
}
}
}
// ============================================
// Model & Helpers
// ============================================
static class RecordingVisitor extends AbstractPicoVisitor {
private final List visitedElements = new LinkedList();
public void visitContainer(PicoContainer pico) {
visitedElements.add(pico);
}
public void visitComponentAdapter(ComponentAdapter componentAdapter) {
visitedElements.add(componentAdapter);
}
public void visitComponentFactory(ComponentFactory componentFactory) {
visitedElements.add(componentFactory);
}
public void visitParameter(Parameter parameter) {
visitedElements.add(parameter);
}
List getVisitedElements() {
return visitedElements;
}
}
static public class NotInstantiatableBehavior extends AbstractBehavior {
public NotInstantiatableBehavior(final ComponentAdapter delegate) {
super(delegate);
}
public Object getComponentInstance(final PicoContainer container, Type into) {
Assert.fail("Not instantiatable");
return null;
}
public String getDescriptor() {
return null;
}
}
static public class CollectingBehavior extends AbstractBehavior {
final List list;
public CollectingBehavior(final ComponentAdapter delegate, final List list) {
super(delegate);
this.list = list;
}
public Object getComponentInstance(final PicoContainer container, Type into) {
final Object result = super.getComponentInstance(container, into);
list.add(result);
return result;
}
public String getDescriptor() {
return "xxx";
}
}
static public class CycleDetectorBehavior extends AbstractBehavior {
private final Set set;
private final ObjectReference reference;
public CycleDetectorBehavior(
final ComponentAdapter delegate, final Set set, final ObjectReference reference) {
super(delegate);
this.set = set;
this.reference = reference;
}
public Object getComponentInstance(final PicoContainer container, Type into) {
if (set.contains(this)) {
reference.set(this);
} else {
set.add(this);
}
return super.getComponentInstance(container, into);
}
public String getDescriptor() {
return "xxx";
}
}
public static final class RecordingLifecycleStrategy implements LifecycleStrategy {
private final StringBuffer recorder;
public RecordingLifecycleStrategy(StringBuffer recorder) {
this.recorder = recorder;
}
public void start(Object component) {
recorder.append("
