/*
* 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
*
* 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.apache.tomcat.jdbc.test;
import java.lang.reflect.Proxy;
import java.sql.Connection;
import java.sql.PreparedStatement;
import org.junit.After;
import org.junit.Assert;
import org.junit.Test;
import org.apache.tomcat.jdbc.pool.JdbcInterceptor;
import org.apache.tomcat.jdbc.pool.interceptor.StatementCache;
import org.apache.tomcat.jdbc.pool.interceptor.StatementCounterInterceptor;
public class TestStatementCache extends DefaultTestCase {
private static volatile TestStatementCacheInterceptor interceptor = null;
@Override
@After
public void tearDown() throws Exception {
interceptor = null;
super.tearDown();
}
private void config(boolean cachePrepared, boolean cacheCallable, int max) {
datasource.getPoolProperties().setJdbcInterceptors(TestStatementCacheInterceptor.class.getName()+
"(prepared="+cachePrepared+",callable="+cacheCallable+",max="+max+")");
}
@Test
public void testIsCacheEnabled() throws Exception {
config(true,true,50);
datasource.getConnection().close();
Assert.assertNotNull("Interceptor was not created.", interceptor);
}
@Test
public void testCacheProperties() throws Exception {
config(true,true,50);
datasource.getConnection().close();
Assert.assertTrue(interceptor.isCacheCallable());
Assert.assertTrue(interceptor.isCachePrepared());
Assert.assertEquals(50,interceptor.getMaxCacheSize());
}
@Test
public void testCacheProperties2() throws Exception {
config(false,false,100);
datasource.getConnection().close();
Assert.assertFalse(interceptor.isCacheCallable());
Assert.assertFalse(interceptor.isCachePrepared());
Assert.assertEquals(100,interceptor.getMaxCacheSize());
}
@Test
public void testPreparedStatementCache() throws Exception {
config(true,false,100);
Connection con = datasource.getConnection();
PreparedStatement ps1 = con.prepareStatement("select 1");
PreparedStatement ps2 = con.prepareStatement("select 1");
Assert.assertEquals(0,interceptor.getCacheSize().get());
ps1.close();
Assert.assertTrue(ps1.isClosed());
Assert.assertEquals(1,interceptor.getCacheSize().get());
PreparedStatement ps3 = con.prepareStatement("select 1");
Assert.assertEquals(0,interceptor.getCacheSize().get());
ps2.close();
Assert.assertTrue(ps2.isClosed());
ps3.close();
Assert.assertTrue(ps3.isClosed());
Assert.assertEquals(1,interceptor.getCacheSize().get());
}
@Test
public void testPreparedStatementCache2() throws Exception {
init();
config(false,false,100);
Connection con = datasource.getConnection();
PreparedStatement ps1 = con.prepareStatement("select 1");
PreparedStatement ps2 = con.prepareStatement("select 1");
Assert.assertEquals(0,interceptor.getCacheSize().get());
ps1.close();
Assert.assertTrue(ps1.isClosed());
Assert.assertEquals(0,interceptor.getCacheSize().get());
PreparedStatement ps3 = con.prepareStatement("select 1");
Assert.assertEquals(0,interceptor.getCacheSize().get());
ps2.close();
Assert.assertTrue(ps2.isClosed());
ps3.close();
Assert.assertTrue(ps3.isClosed());
Assert.assertEquals(0,interceptor.getCacheSize().get());
}
@Test
public void testStatementClose1() throws Exception {
init();
datasource.setJdbcInterceptors(
TestStatementCacheInterceptor.class.getName()
+ "(prepared=true,callable=false,max=1);"
+ StatementCounterInterceptor.class.getName());
Connection con = datasource.getConnection();
StatementCounterInterceptor counter = findInterceptor(con, StatementCounterInterceptor.class);
PreparedStatement ps1, ps2;
ps1 = con.prepareStatement("select 1");
Assert.assertEquals(1, counter.getActiveCount());
ps1.close();
Assert.assertEquals("Statement goes into cache, not closed", 1, counter.getActiveCount());
ps1 = con.prepareStatement("select 1");
Assert.assertEquals("Reusing statement from cache", 1, counter.getActiveCount());
ps2 = con.prepareStatement("select 1");
Assert.assertEquals("Reusing statement from cache", 2, counter.getActiveCount());
ps2.close();
Assert.assertEquals("Statement goes into cache, not closed", 2, counter.getActiveCount());
ps1.close();
// Cache has "max=1". The following tests BZ 54732.
Assert.assertEquals("Statement does not go into cache, closed", 1, counter.getActiveCount());
con.close();
Assert.assertEquals("Connection returned to the pool. Statement is in cache", 1, counter.getActiveCount());
datasource.close();
Assert.assertEquals("Pool cleared. All statements in cache are closed", 0, counter.getActiveCount());
}
@Test
public void testStatementClose2() throws Exception {
init();
datasource.setJdbcInterceptors(
TestStatementCacheInterceptor.class.getName()
+ "(prepared=false,callable=false,max=10);"
+ StatementCounterInterceptor.class.getName());
Connection con = datasource.getConnection();
StatementCounterInterceptor counter = findInterceptor(con, StatementCounterInterceptor.class);
PreparedStatement ps1 = con.prepareStatement("select 1");
Assert.assertEquals(1, counter.getActiveCount());
ps1.close();
Assert.assertEquals("Statement is not pooled, closes immediately", 0, counter.getActiveCount());
}
@Test
public void testMaxCacheSize() throws Exception {
init();
config(true,false,100);
Connection con1 = datasource.getConnection();
Connection con2 = datasource.getConnection();
for (int i=0; i<120; i++) {
Connection con = (i%2==0)?con1:con2;
PreparedStatement ps = con.prepareStatement("select "+i);
ps.close();
}
Assert.assertEquals(100,interceptor.getCacheSize().get());
}
public static class TestStatementCacheInterceptor extends StatementCache {
public TestStatementCacheInterceptor() {
TestStatementCache.interceptor = this;
}
}
/**
* Helper method that finds interceptor instance in interceptor chain of a
* proxied class.
*
* @param proxy
* Proxy class
* @param clazz
* Interceptor class that we are looking for
* @return Instance of <code>clazz</code>
*/
private static <T extends JdbcInterceptor> T findInterceptor(Object proxy,
Class<T> clazz) {
JdbcInterceptor interceptor = (JdbcInterceptor) Proxy
.getInvocationHandler(proxy);
while (interceptor != null) {
if (clazz.isInstance(interceptor)) {
return clazz.cast(interceptor);
}
interceptor = interceptor.getNext();
}
return null;
}
}