LocaleBeanificationTest.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* https://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.apache.commons.beanutils2.locale;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.lang.ref.ReferenceQueue;
import java.lang.ref.WeakReference;
import java.util.Locale;
import java.util.Map;
import java.util.WeakHashMap;
import org.apache.commons.beanutils2.BeanUtilsBean;
import org.apache.commons.beanutils2.ContextClassLoaderLocal;
import org.apache.commons.beanutils2.ConvertUtils;
import org.apache.commons.beanutils2.PrimitiveBean;
import org.apache.commons.beanutils2.locale.converters.LongLocaleConverter;
import org.apache.commons.logging.LogFactory;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
* <p>
* Test Case for changes made during LocaleBeanutils Beanification. This is basically a cut-and-correct version of the BeanUtils beanifications tests.
* </p>
*/
class LocaleBeanificationTest {
final class Signal {
private Exception e;
private int signal;
private LocaleBeanUtilsBean bean;
private LocaleConvertUtilsBean convertUtils;
private Object marker;
public LocaleBeanUtilsBean getBean() {
return bean;
}
public LocaleConvertUtilsBean getConvertUtils() {
return convertUtils;
}
public Exception getException() {
return e;
}
public Object getMarkerObject() {
return marker;
}
public int getSignal() {
return signal;
}
public void setBean(final LocaleBeanUtilsBean bean) {
this.bean = bean;
}
public void setConvertUtils(final LocaleConvertUtilsBean convertUtils) {
this.convertUtils = convertUtils;
}
public void setException(final Exception e) {
this.e = e;
}
public void setMarkerObject(final Object marker) {
this.marker = marker;
}
public void setSignal(final int signal) {
this.signal = signal;
}
}
final class TestClassLoader extends ClassLoader {
@Override
public String toString() {
return "TestClassLoader";
}
}
/** Maximum number of iterations before our test fails */
public static final int MAX_GC_ITERATIONS = 50;
/**
* Sets up instance variables required by this test case.
*/
@BeforeEach
public void setUp() {
LocaleConvertUtils.deregister();
}
/** Tests whether different threads can set BeanUtils instances correctly */
@Test
void testBeanUtilsBeanSetInstance() throws Exception {
final class SetInstanceTesterThread extends Thread {
private final Signal signal;
private final LocaleBeanUtilsBean bean;
SetInstanceTesterThread(final Signal signal, final LocaleBeanUtilsBean bean) {
this.signal = signal;
this.bean = bean;
}
@Override
public void run() {
LocaleBeanUtilsBean.setInstance(bean);
signal.setSignal(21);
signal.setBean(LocaleBeanUtilsBean.getLocaleBeanUtilsInstance());
}
@Override
public String toString() {
return "SetInstanceTesterThread";
}
}
final Signal signal = new Signal();
signal.setSignal(1);
final LocaleBeanUtilsBean beanOne = new LocaleBeanUtilsBean();
final LocaleBeanUtilsBean beanTwo = new LocaleBeanUtilsBean();
final SetInstanceTesterThread thread = new SetInstanceTesterThread(signal, beanTwo);
thread.setContextClassLoader(new TestClassLoader());
LocaleBeanUtilsBean.setInstance(beanOne);
assertEquals(beanOne, LocaleBeanUtilsBean.getLocaleBeanUtilsInstance(), "Start thread gets right instance");
thread.start();
thread.join();
assertEquals(21, signal.getSignal(), "Signal not set by test thread");
assertEquals(beanOne, LocaleBeanUtilsBean.getLocaleBeanUtilsInstance(), "Second thread preserves value");
assertEquals(beanTwo, signal.getBean(), "Second thread gets value it set");
}
/** Tests whether calls are independent for different class loaders */
@Test
void testContextClassloaderIndependence() throws Exception {
final class TestIndependenceThread extends Thread {
private final Signal signal;
private final PrimitiveBean bean;
TestIndependenceThread(final Signal signal, final PrimitiveBean bean) {
this.signal = signal;
this.bean = bean;
}
@Override
public void run() {
try {
signal.setSignal(3);
LocaleConvertUtils.register(new LocaleConverter<Integer>() {
@Override
public <R> R convert(final Class<R> type, final Object value) {
return ConvertUtils.primitiveToWrapper(type).cast(9);
}
@Override
public <R> R convert(final Class<R> type, final Object value, final String pattern) {
return ConvertUtils.primitiveToWrapper(type).cast(9);
}
}, Integer.TYPE, Locale.getDefault());
LocaleBeanUtils.setProperty(bean, "int", "1");
} catch (final Exception e) {
e.printStackTrace();
signal.setException(e);
}
}
@Override
public String toString() {
return "TestIndependenceThread";
}
}
final PrimitiveBean bean = new PrimitiveBean();
LocaleBeanUtils.setProperty(bean, "int", new Integer(1));
assertEquals(1, bean.getInt(), "Wrong property value (1)");
LocaleConvertUtils.register(new LocaleConverter<Integer>() {
@Override
public <R> R convert(final Class<R> type, final Object value) {
return ConvertUtils.primitiveToWrapper(type).cast(5);
}
@Override
public <R> R convert(final Class<R> type, final Object value, final String pattern) {
return ConvertUtils.primitiveToWrapper(type).cast(5);
}
}, Integer.TYPE, Locale.getDefault());
LocaleBeanUtils.setProperty(bean, "int", "1");
assertEquals(5, bean.getInt(), "Wrong property value(2)");
final Signal signal = new Signal();
signal.setSignal(1);
final TestIndependenceThread thread = new TestIndependenceThread(signal, bean);
thread.setContextClassLoader(new TestClassLoader());
thread.start();
thread.join();
assertNull(signal.getException(), "Exception thrown by test thread:" + signal.getException());
assertEquals(3, signal.getSignal(), "Signal not set by test thread");
assertEquals(9, bean.getInt(), "Wrong property value(3)");
}
/**
* Tests whether difference instances are loaded by different context class loaders.
*/
@Test
void testContextClassLoaderLocal() throws Exception {
final class CCLLTesterThread extends Thread {
private final Signal signal;
private final ContextClassLoaderLocal<Integer> ccll;
CCLLTesterThread(final Signal signal, final ContextClassLoaderLocal<Integer> ccll) {
this.signal = signal;
this.ccll = ccll;
}
@Override
public void run() {
ccll.set(new Integer(1789));
signal.setSignal(2);
signal.setMarkerObject(ccll.get());
}
@Override
public String toString() {
return "CCLLTesterThread";
}
}
final ContextClassLoaderLocal<Integer> ccll = new ContextClassLoaderLocal<>();
ccll.set(1776);
assertEquals(new Integer(1776), ccll.get(), "Start thread sets value");
final Signal signal = new Signal();
signal.setSignal(1);
final CCLLTesterThread thread = new CCLLTesterThread(signal, ccll);
thread.setContextClassLoader(new TestClassLoader());
thread.start();
thread.join();
assertEquals(2, signal.getSignal(), "Signal not set by test thread");
assertEquals(new Integer(1776), ccll.get(), "Second thread preserves value");
assertEquals(new Integer(1789), signal.getMarkerObject(), "Second thread gets value it set");
}
/** Tests whether the unset method works */
@Test
void testContextClassLoaderUnset() {
final LocaleBeanUtilsBean beanOne = new LocaleBeanUtilsBean();
final ContextClassLoaderLocal<LocaleBeanUtilsBean> ccll = new ContextClassLoaderLocal<>();
ccll.set(beanOne);
assertEquals(beanOne, ccll.get(), "Start thread gets right instance");
ccll.unset();
assertTrue(!beanOne.equals(ccll.get()), "Unset works");
}
/**
* Tests whether difference instances are loaded by different context class loaders.
*/
@Test
void testGetByContextClassLoader() throws Exception {
final class GetBeanUtilsBeanThread extends Thread {
private final Signal signal;
GetBeanUtilsBeanThread(final Signal signal) {
this.signal = signal;
}
@Override
public void run() {
signal.setSignal(2);
signal.setBean(LocaleBeanUtilsBean.getLocaleBeanUtilsInstance());
signal.setConvertUtils(LocaleConvertUtilsBean.getInstance());
}
@Override
public String toString() {
return "GetBeanUtilsBeanThread";
}
}
final Signal signal = new Signal();
signal.setSignal(1);
final GetBeanUtilsBeanThread thread = new GetBeanUtilsBeanThread(signal);
thread.setContextClassLoader(new TestClassLoader());
thread.start();
thread.join();
assertEquals(2, signal.getSignal(), "Signal not set by test thread");
assertTrue(BeanUtilsBean.getInstance() != signal.getBean(), "Different LocaleBeanUtilsBean instances per context classloader");
assertTrue(LocaleConvertUtilsBean.getInstance() != signal.getConvertUtils(), "Different LocaleConvertUtilsBean instances per context classloader");
}
/**
* Test registering a locale-aware converter with the standard ConvertUtils.
*/
@Test
void testLocaleAwareConverterInConvertUtils() {
try {
// first use the default non-locale-aware converter
Long data = (Long) ConvertUtils.convert("777", Long.class);
assertEquals(777, data.longValue(), "Standard format long converted ok");
// now try default converter with special delimiters
// This conversion will cause an error. But the default
// Long converter is set up to return a default value of
// zero on error.
data = (Long) ConvertUtils.convert("1.000.000", Long.class);
assertEquals(0, data.longValue(), "Standard format behaved as expected");
// Now try using a locale-aware converter together with
// locale-specific input string. Note that in the german locale,
// large numbers can be split up into groups of three digits
// using a dot character (and comma is the decimal-point indicator).
final Locale germanLocale = Locale.GERMAN;
final LongLocaleConverter longLocaleConverter = LongLocaleConverter.builder().setLocale(germanLocale).get();
ConvertUtils.register(longLocaleConverter, Long.class);
data = (Long) ConvertUtils.convert("1.000.000", Long.class);
assertEquals(1000000, data.longValue(), "German-format long converted ok");
} finally {
ConvertUtils.deregister();
}
}
/** Tests whether class loaders and beans are released from memory */
@Test
void testMemoryLeak() throws Exception {
// many thanks to Juozas Baliuka for suggesting this methodology
TestClassLoader loader = new TestClassLoader();
final WeakReference<TestClassLoader> loaderReference = new WeakReference<>(loader);
LocaleBeanUtilsBean.getLocaleBeanUtilsInstance();
final class GetBeanUtilsBeanThread extends Thread {
LocaleBeanUtilsBean beanUtils;
LocaleConvertUtilsBean convertUtils;
GetBeanUtilsBeanThread() {
}
@Override
public void run() {
beanUtils = LocaleBeanUtilsBean.getLocaleBeanUtilsInstance();
convertUtils = LocaleConvertUtilsBean.getInstance();
// XXX Log keeps a reference around!
LogFactory.releaseAll();
}
@Override
public String toString() {
return "GetBeanUtilsBeanThread";
}
}
GetBeanUtilsBeanThread thread = new GetBeanUtilsBeanThread();
final WeakReference<GetBeanUtilsBeanThread> threadWeakReference = new WeakReference<>(thread);
thread.setContextClassLoader(loader);
thread.start();
thread.join();
final WeakReference<LocaleBeanUtilsBean> beanUtilsReference = new WeakReference<>(thread.beanUtils);
final WeakReference<LocaleConvertUtilsBean> convertUtilsReference = new WeakReference<>(thread.convertUtils);
assertNotNull(loaderReference.get(), "Weak reference released early (1)");
assertNotNull(beanUtilsReference.get(), "Weak reference released early (2)");
assertNotNull(convertUtilsReference.get(), "Weak reference released early (4)");
// dereference strong references
loader = null;
thread.setContextClassLoader(null);
thread = null;
int iterations = 0;
int bytz = 2;
while (true) {
LocaleBeanUtilsBean.getLocaleBeanUtilsInstance();
System.gc();
assertFalse(iterations++ > MAX_GC_ITERATIONS, "Max iterations reached before resource released.");
if (loaderReference.get() == null && beanUtilsReference.get() == null && convertUtilsReference.get() == null) {
break;
}
// create garbage:
final byte[] b = new byte[bytz];
bytz *= 2;
}
}
/** Tests whether class loaders and beans are released from memory by the map used by BeanUtils */
@Test
void testMemoryLeak2() {
// many thanks to Juozas Baliuka for suggesting this methodology
TestClassLoader loader = new TestClassLoader();
final ReferenceQueue<Object> queue = new ReferenceQueue<>();
final WeakReference<ClassLoader> loaderReference = new WeakReference<>(loader, queue);
Integer test = new Integer(1);
final WeakReference<Integer> testReference = new WeakReference<>(test, queue);
// Map map = new ReferenceMap(ReferenceMap.WEAK, ReferenceMap.HARD, true);
final Map<TestClassLoader, Integer> map = new WeakHashMap<>();
map.put(loader, test);
assertEquals(test, map.get(loader), "In map");
assertNotNull(loaderReference.get(), "Weak reference released early (1)");
assertNotNull(testReference.get(), "Weak reference released early (2)");
// dereference strong references
loader = null;
test = null;
int iterations = 0;
int bytz = 2;
while (true) {
System.gc();
assertFalse(iterations++ > MAX_GC_ITERATIONS, "Max iterations reached before resource released.");
map.isEmpty();
if (loaderReference.get() == null && testReference.get() == null) {
break;
}
// create garbage:
final byte[] b = new byte[bytz];
bytz *= 2;
}
}
/** Test of the methodology we'll use for some of the later tests */
@Test
void testMemoryTestMethodology() throws Exception {
// test methodology
// many thanks to Juozas Baliuka for suggesting this method
ClassLoader loader = new ClassLoader(this.getClass().getClassLoader()) {
};
final WeakReference<ClassLoader> reference = new WeakReference<>(loader);
Class<?> myClass = loader.loadClass("org.apache.commons.beanutils2.BetaBean");
assertNotNull(reference.get(), "Weak reference released early");
// dereference class loader and class:
loader = null;
myClass = null;
int iterations = 0;
int bytz = 2;
while (true) {
System.gc();
assertFalse(iterations++ > MAX_GC_ITERATIONS, "Max iterations reached before resource released.");
if (reference.get() == null) {
break;
}
// create garbage:
final byte[] b = new byte[bytz];
bytz *= 2;
}
}
}