TestCachedSQLDirectory.java

/*
 * (C) Copyright 2006-2014 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * 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.
 *
 * Contributors:
 *     Nuxeo - initial API and implementation
 *
 * $Id$
 */

package org.nuxeo.ecm.directory.sql;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;

import javax.inject.Inject;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.nuxeo.ecm.core.api.DocumentModel;
import org.nuxeo.ecm.core.redis.RedisFeature;
import org.nuxeo.ecm.core.work.api.WorkManager;
import org.nuxeo.ecm.directory.AbstractDirectory;
import org.nuxeo.ecm.directory.DirectoryCache;
import org.nuxeo.ecm.directory.DirectoryException;
import org.nuxeo.ecm.directory.Session;
import org.nuxeo.runtime.api.Framework;
import org.nuxeo.runtime.metrics.MetricsService;
import org.nuxeo.runtime.test.runner.Deploy;
import org.nuxeo.runtime.test.runner.Features;
import org.nuxeo.runtime.test.runner.FeaturesRunner;
import org.nuxeo.runtime.test.runner.LocalDeploy;
import org.nuxeo.runtime.test.runner.RuntimeHarness;

import com.codahale.metrics.Counter;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.SharedMetricRegistries;

@RunWith(FeaturesRunner.class)
@Features(SQLDirectoryFeature.class)
@Deploy("org.nuxeo.ecm.core.cache")
@LocalDeploy("org.nuxeo.ecm.directory.sql.tests:sql-directory-cache-config.xml")
public class TestCachedSQLDirectory extends SQLDirectoryTestSuite {

    protected final static String REDIS_CACHE_CONFIG = "sql-directory-redis-cache-config.xml";

    protected final static String ENTRY_CACHE_NAME = "sql-entry-cache";

    protected final static String ENTRY_CACHE_WITHOUT_REFERENCES_NAME = "sql-entry-cache-without-references";

    @Inject
    protected RuntimeHarness harness;

    @Before
    public void setUp() throws Exception {

        if (RedisFeature.setup(harness)) {
            harness.deployTestContrib("org.nuxeo.ecm.directory.sql.tests", REDIS_CACHE_CONFIG);
            Framework.getService(WorkManager.class).init();
        }

        AbstractDirectory dir = getSQLDirectory();
        DirectoryCache cache = dir.getCache();
        cache.setEntryCacheName(ENTRY_CACHE_NAME);
        cache.setEntryCacheWithoutReferencesName(ENTRY_CACHE_WITHOUT_REFERENCES_NAME);

    }

    @Test
    public void testGetFromCache() throws DirectoryException, Exception {
        Session sqlSession = getSQLDirectory().getSession();
        MetricRegistry metrics = SharedMetricRegistries.getOrCreate(MetricsService.class.getName());
        Counter hitsCounter = metrics.counter(
                MetricRegistry.name("nuxeo", "directories", "userDirectory", "cache", "hits"));
        Counter negativeHitsCounter = metrics.counter(
                MetricRegistry.name("nuxeo", "directories", "userDirectory", "cache", "neghits"));
        Counter missesCounter = metrics.counter(
                MetricRegistry.name("nuxeo", "directories", "userDirectory", "cache", "misses"));
        long baseHitsCount = hitsCounter.getCount();
        long baseNegativeHitsCount = negativeHitsCounter.getCount();
        long baseMissesCount = missesCounter.getCount();

        // First call will update cache
        DocumentModel entry = sqlSession.getEntry("user_1");
        assertNotNull(entry);
        assertEquals(baseHitsCount, hitsCounter.getCount());
        assertEquals(baseNegativeHitsCount, negativeHitsCounter.getCount());
        assertEquals(baseMissesCount + 1, missesCounter.getCount());

        // Second call will use the cache
        entry = sqlSession.getEntry("user_1");
        assertNotNull(entry);
        assertEquals(baseHitsCount + 1, hitsCounter.getCount());
        assertEquals(baseNegativeHitsCount, negativeHitsCounter.getCount());
        assertEquals(baseMissesCount + 1, missesCounter.getCount());

        // Again
        entry = sqlSession.getEntry("user_1");
        assertNotNull(entry);
        assertEquals(baseHitsCount + 2, hitsCounter.getCount());
        assertEquals(baseNegativeHitsCount, negativeHitsCounter.getCount());
        assertEquals(baseMissesCount + 1, missesCounter.getCount());
    }

    @Test
    public void testNegativeCaching() throws Exception {
        DirectoryCache cache = getSQLDirectory().getCache();
        cache.setNegativeCaching(Boolean.TRUE);
        try {
            doTestNegativeCaching();
        } finally {
            cache.setNegativeCaching(null);
        }
    }

    protected void doTestNegativeCaching() throws Exception {
        Session sqlSession = getSQLDirectory().getSession();
        MetricRegistry metrics = SharedMetricRegistries.getOrCreate(MetricsService.class.getName());
        Counter hitsCounter = metrics.counter(
                MetricRegistry.name("nuxeo", "directories", "userDirectory", "cache", "hits"));
        Counter negativeHitsCounter = metrics.counter(
                MetricRegistry.name("nuxeo", "directories", "userDirectory", "cache", "neghits"));
        Counter missesCounter = metrics.counter(
                MetricRegistry.name("nuxeo", "directories", "userDirectory", "cache", "misses"));
        long baseHitsCount = hitsCounter.getCount();
        long baseNegativeHitsCount = negativeHitsCounter.getCount();
        long baseMissesCount = missesCounter.getCount();

        // First call will update cache
        DocumentModel entry = sqlSession.getEntry("NO_SUCH_USER");
        assertNull(entry);
        assertEquals(baseHitsCount, hitsCounter.getCount());
        assertEquals(baseNegativeHitsCount, negativeHitsCounter.getCount());
        assertEquals(baseMissesCount + 1, missesCounter.getCount());

        // Second call will use the negative cache
        entry = sqlSession.getEntry("NO_SUCH_USER");
        assertNull(entry);
        assertEquals(baseHitsCount, hitsCounter.getCount());
        assertEquals(baseNegativeHitsCount + 1, negativeHitsCounter.getCount());
        assertEquals(baseMissesCount + 1, missesCounter.getCount());

        // Again
        entry = sqlSession.getEntry("NO_SUCH_USER");
        assertNull(entry);
        assertEquals(baseHitsCount, hitsCounter.getCount());
        assertEquals(baseNegativeHitsCount + 2, negativeHitsCounter.getCount());
        assertEquals(baseMissesCount + 1, missesCounter.getCount());
    }
}