Clarify overall project structure.

[gpl/argeo-slc.git] / legacy / org.argeo.slc.spring / src / org / argeo / slc / spring / unit / AbstractSpringTestCase.java

diff --git a/legacy/org.argeo.slc.spring/src/org/argeo/slc/spring/unit/AbstractSpringTestCase.java b/legacy/org.argeo.slc.spring/src/org/argeo/slc/spring/unit/AbstractSpringTestCase.java
new file mode 100644 (file)
index 0000000..ec532eb
--- /dev/null
+++ b/legacy/org.argeo.slc.spring/src/org/argeo/slc/spring/unit/AbstractSpringTestCase.java
@@ -0,0 +1,100 @@
+package org.argeo.slc.spring.unit;
+
+import java.util.Map;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.argeo.slc.SlcException;
+import org.springframework.beans.factory.BeanFactoryUtils;
+import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+
+import junit.framework.TestCase;
+
+/** Helper for tests using a Spring application co,text. */
+public abstract class AbstractSpringTestCase extends TestCase {
+       protected final Log log = LogFactory.getLog(getClass());
+       private ConfigurableApplicationContext context;
+
+       /**
+        * Gets (and create if necessary) the application context to use. Default
+        * implementation uses a class path xml application context and calls
+        * {@link #getApplicationContextLocation()}.
+        */
+       protected ConfigurableApplicationContext getContext() {
+               if (context == null) {
+                       context = new ClassPathXmlApplicationContext(
+                                       getApplicationContextLocation());
+                       if (getIsStartContext())
+                               context.start();
+               }
+               return context;
+       }
+
+       @Override
+       protected void tearDown() throws Exception {
+               if (context != null && context.isActive())
+                       context.close();
+               super.tearDown();
+       }
+
+       /** Whether the context should be started after being created. */
+       protected Boolean getIsStartContext() {
+               return false;
+       }
+
+       /** Returns a bean from the underlying context */
+       @SuppressWarnings(value = { "unchecked" })
+       protected <T> T getBean(String beanId) {
+               return (T) getContext().getBean(beanId);
+       }
+
+       protected <T> T getBean(Class<? extends T> clss) {
+               T bean = loadSingleFromContext(getContext(), clss);
+               if (bean == null) {
+                       throw new SlcException("Cannot retrieve a unique bean of type "
+                                       + clss);
+               } else {
+                       return bean;
+               }
+       }
+
+       /**
+        * Th location of the application to load. The default implementation
+        * returns <i>applicationContext.xml</i> found in the same package as the
+        * test.
+        */
+       protected String getApplicationContextLocation() {
+               return inPackage("applicationContext.xml");
+       }
+
+       /**
+        * Prefixes the package of the class after converting the '.' to '/' in
+        * order to have a resource path.
+        */
+       protected String inPackage(String suffix) {
+               String prefix = getClass().getPackage().getName().replace('.', '/');
+               return prefix + '/' + suffix;
+       }
+
+       @SuppressWarnings(value = { "unchecked" })
+       protected <T> T loadSingleFromContext(ListableBeanFactory context,
+                       Class<T> clss) {
+               Map<String, T> beans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
+                               context, clss, false, false);
+               if (beans.size() == 1) {
+                       return beans.values().iterator().next();
+               } else if (beans.size() > 1) {
+                       if (log.isDebugEnabled()) {
+                               log
+                                               .debug(("Found more that on bean for type " + clss
+                                                               + ": " + beans.keySet()));
+                       }
+                       return null;
+               } else {
+                       return null;
+               }
+       }
+
+}