org.dbflute.utflute.lastadi.LastaDiTestCase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of utflute-lastaflute Show documentation
Show all versions of utflute-lastaflute Show documentation
The unit test library for LastaFlute (with DBFlute)
The newest version!
/*
* Copyright 2014-2024 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.dbflute.utflute.lastadi;
import java.lang.annotation.Annotation;
import java.util.Map;
import org.dbflute.utflute.core.InjectionTestCase;
import org.dbflute.utflute.core.binding.BindingAnnotationRule;
import org.dbflute.utflute.core.transaction.TransactionFailureException;
import org.dbflute.utflute.core.transaction.TransactionResource;
import org.dbflute.util.Srl;
import org.lastaflute.di.core.SingletonLaContainer;
import org.lastaflute.di.core.exception.ComponentNotFoundException;
import org.lastaflute.di.core.factory.SingletonLaContainerFactory;
import org.lastaflute.di.core.smart.SmartDeployMode;
import org.lastaflute.di.naming.NamingConvention;
import jakarta.annotation.Resource;
import jakarta.transaction.NotSupportedException;
import jakarta.transaction.Status;
import jakarta.transaction.SystemException;
import jakarta.transaction.Transaction;
import jakarta.transaction.TransactionManager;
import jakarta.transaction.UserTransaction;
/**
* The base class of test cases with Lasta Di (without LastaFlute).
* @author jflute
* @since 0.5.1 (2015/03/22 Sunday)
*/
public abstract class LastaDiTestCase extends InjectionTestCase {
// ===================================================================================
// Attribute
// =========
// -----------------------------------------------------
// Static Cached
// -------------
/** The cached configuration file of DI container. (NullAllowed: null means beginning or ending) */
private static String _xcachedConfigFile;
// ===================================================================================
// Settings
// ========
// -----------------------------------------------------
// Before Container
// ----------------
@Override
protected void xsetupBeforeTestCaseContainer() {
super.xsetupBeforeTestCaseContainer();
xprepareUnitTestEnv();
}
// -----------------------------------------------------
// Prepare Container
// -----------------
@Override
protected void xprepareTestCaseContainer() {
final String configFile = xdoPrepareTestCaseContainer();
xsaveCachedInstance(configFile);
}
protected String xdoPrepareTestCaseContainer() {
if (isUseOneTimeContainer()) {
xdestroyContainer();
}
final String configFile = prepareConfigFile();
if (xisInitializedContainer()) {
if (xcanRecycleContainer(configFile)) {
log("...Recycling lasta_di as {}: config={}", xisCurrentBootingWebContainer() ? "web-container" : "library", configFile);
xrecycleContainerInstance(configFile);
return configFile; // no need to initialize
} else { // changed
xdestroyContainer(); // to re-initialize
}
}
xinitializeContainer(configFile);
return configFile;
}
protected boolean xcanRecycleContainer(String configFile) {
if (xneedsContainlyReinitializeContainer()) {
return false; // needs to switch e.g. web-container or library
}
return xconfigCanAcceptContainerRecycle(configFile);
}
protected boolean xneedsContainlyReinitializeContainer() {
if (xisTreatedAsWebContainer()) {
if (!xisCurrentBootingWebContainer()) { // current is library
return true; // needs to re-initialize as web-container
}
} else { // treated as library container
if (xisCurrentBootingWebContainer()) { // current is web-container
return true; // needs to re-initialize as library
}
}
return false;
}
protected boolean xisTreatedAsWebContainer() { // may be overridden
return false;
}
protected boolean xisCurrentBootingWebContainer() {
// external context is actually only for web framework so simple here
return SingletonLaContainerFactory.getExternalContext() != null;
}
protected boolean xconfigCanAcceptContainerRecycle(String configFile) {
return configFile.equals(_xcachedConfigFile); // no change
}
protected void xrecycleContainerInstance(String configFile) {
// managed as singleton so caching is unneeded here
}
protected void xsaveCachedInstance(String configFile) {
_xcachedConfigFile = configFile;
}
@Override
protected boolean isUseOneTimeContainer() {
return false;
}
/**
* Prepare configuration file as root for Lasta Di.
* @return The pure file name of root xml. (NotNull)
*/
protected String prepareConfigFile() { // customize point
return "app.xml"; // as default
}
@Override
protected void xclearCachedContainer() {
_xcachedConfigFile = null;
}
// ===================================================================================
// Transaction
// ===========
@Override
protected TransactionResource beginNewTransaction() { // user method
// begin transaction via UserTransaction because it may have framework logic
final UserTransaction userTx = xfindTestCaseUserTransaction();
if (userTx == null) {
return null;
}
final TransactionManager manager = getComponent(TransactionManager.class); // for native handling
final Transaction suspendedTx;
try {
if (userTx.getStatus() != Status.STATUS_NO_TRANSACTION) {
suspendedTx = manager.suspend(); // because it doesn't support nested transaction
} else {
suspendedTx = null;
}
} catch (SystemException e) {
throw new TransactionFailureException("Failed to suspend current", e);
}
TransactionResource resource = null;
try {
userTx.begin();
resource = new TransactionResource() {
public void commit() {
try {
userTx.commit();
} catch (Exception e) {
throw new TransactionFailureException("Failed to commit the transaction.", e);
} finally {
xresumeSuspendedTxQuietly(manager, suspendedTx);
}
}
public void rollback() {
try {
userTx.rollback();
} catch (Exception e) {
throw new TransactionFailureException("Failed to roll-back the transaction.", e);
} finally {
xresumeSuspendedTxQuietly(manager, suspendedTx);
}
}
}; // for thread-fire's transaction or manual transaction
} catch (NotSupportedException e) {
throw new TransactionFailureException("Failed to begin new transaction.", e);
} catch (SystemException e) {
throw new TransactionFailureException("Failed to begin new transaction.", e);
}
return resource;
}
protected UserTransaction xfindTestCaseUserTransaction() { // null allowed
final Class userTxType = UserTransaction.class;
return hasComponent(userTxType) ? getComponent(userTxType) : null;
}
protected void xresumeSuspendedTxQuietly(TransactionManager manager, Transaction suspendedTx) {
try {
if (suspendedTx != null) {
manager.resume(suspendedTx);
}
} catch (Exception continued) {
log(continued.getMessage());
}
}
// ===================================================================================
// Component Binding
// =================
@Override
protected Map, BindingAnnotationRule> xprovideBindingAnnotationRuleMap() {
final Map, BindingAnnotationRule> ruleMap = newHashMap();
ruleMap.put(Resource.class, new BindingAnnotationRule());
return ruleMap;
}
@Override
protected String xfilterByBindingNamingRule(String propertyName, Class propertyType) {
if (propertyType.getSimpleName().contains("_")) { // e.g. (org.dbflute.maihama.) Foo_BarLogic
return null; // simple name that contains '_' is unsupported
}
// e.g. [root].logic.foo.bar.QuxLogic
final NamingConvention convention = getComponent(NamingConvention.class);
final String componentName;
try {
// e.g. foo_bar_quxLogic -> foo_bar_quxLogic ends with [property name] -> returns foo_bar_quxLogic
componentName = convention.fromClassNameToComponentName(propertyType.getName());
} catch (RuntimeException ignored) { // just in case e.g. org.dbflute.maihama.foo
return null;
}
if (xcanUseComponentNameByBindingNamingRule(componentName, propertyName)) {
return componentName;
}
// not smart deploy component or name wrong e.g. (foo_bar_) quxLogic does not equal quxService
return null;
}
protected boolean xcanUseComponentNameByBindingNamingRule(String componentName, String propertyName) {
if (componentName.contains("_")) { // means smart deploy component
if (componentName.endsWith(propertyName)) {
final String front = Srl.substringLastFront(componentName, propertyName); // e.g. foo_bar_
if (front.equals("") || front.endsWith("_")) {
// e.g.
// foo_bar_quxLogic ends with foo_bar_quxLogic
// foo_bar_quxLogic ends with quxLogic
// foo_bar_quxLogic ends with bar_quxLogic
return true;
}
// e.g. foo_bar_quxLogic ends with ar_quxLogic
}
}
return false;
}
// ===================================================================================
// Lasta Di Handling
// =================
protected void xprepareUnitTestEnv() {
SmartDeployMode.setValue(SmartDeployMode.WARM);
}
// -----------------------------------------------------
// Initialize
// ----------
protected boolean xisInitializedContainer() {
return SingletonLaContainerFactory.hasContainer();
}
protected void xinitializeContainer(String configFile) {
log("...Initializing lasta_di as library: " + configFile);
xdoInitializeContainerAsLibrary(configFile);
}
protected void xdoInitializeContainerAsLibrary(String configFile) {
SingletonLaContainerFactory.setConfigPath(configFile);
SingletonLaContainerFactory.init();
}
// -----------------------------------------------------
// Destroy
// -------
protected void xdestroyContainer() {
SingletonLaContainerFactory.destroy();
SingletonLaContainerFactory.setExternalContext(null); // destroy() does not contain this
}
// -----------------------------------------------------
// Component
// ---------
/** {@inheritDoc} */
protected COMPONENT getComponent(Class type) { // user method
return SingletonLaContainer.getComponent(type);
}
/** {@inheritDoc} */
@SuppressWarnings("unchecked")
protected COMPONENT getComponent(String name) { // user method
return (COMPONENT) SingletonLaContainer.getComponent(name);
}
/** {@inheritDoc} */
protected boolean hasComponent(Class type) { // user method
try {
SingletonLaContainer.getComponent(type);
return true;
} catch (ComponentNotFoundException ignored) {
return false;
}
}
/** {@inheritDoc} */
protected boolean hasComponent(String name) { // user method
try {
SingletonLaContainer.getComponent(name);
return true;
} catch (ComponentNotFoundException ignored) {
return false;
}
}
// ===================================================================================
// Accessor
// ========
protected static String xgetCachedConfigFile() {
return _xcachedConfigFile;
}
protected static void xsetCachedConfigFile(String xcachedConfigFile) {
_xcachedConfigFile = xcachedConfigFile;
}
}