org.flite.cach3.aop.CacheBaseTest.java Source code

Java tutorial

Introduction

Here is the source code for org.flite.cach3.aop.CacheBaseTest.java

Source

package org.flite.cach3.aop;

import org.apache.commons.lang.*;
import org.apache.commons.lang.math.RandomUtils;
import org.flite.cach3.annotations.*;
import org.flite.cach3.api.*;
import org.flite.cach3.config.*;
import org.flite.cach3.exceptions.*;
import org.flite.cach3.test.listeners.StubInvalidateAssignCacheListenerImpl;
import org.testng.annotations.*;

import java.lang.reflect.*;
import java.security.*;
import java.util.*;

import static org.testng.AssertJUnit.*;

/**
Copyright (c) 2011-2012 Flite, Inc
    
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
    
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
    
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
 */
public class CacheBaseTest {
    private CacheBase cut;

    @BeforeClass
    public void beforeClass() {
        cut = new CacheBase();

        cut.setMethodStore(new CacheKeyMethodStoreImpl());
    }

    @Test
    public void testKeyMethodArgs() throws Exception {
        try {
            cut.getKeyMethod(new KeyObject01());
            fail("Expected exception.");
        } catch (InvalidAnnotationException ex) {
            assertTrue(ex.getMessage().indexOf("0 arguments") != -1);
        }

        try {
            cut.getKeyMethod(new KeyObject02());
            fail("Expected exception.");
        } catch (InvalidAnnotationException ex) {
            assertTrue(ex.getMessage().indexOf("String") != -1);
        }

        try {
            cut.getKeyMethod(new KeyObject03());
            fail("Expected exception.");
        } catch (InvalidAnnotationException ex) {
            assertTrue(ex.getMessage().indexOf("String") != -1);
        }

        try {
            cut.getKeyMethod(new KeyObject04());
            fail("Expected exception.");
        } catch (InvalidAnnotationException ex) {
            assertTrue(ex.getMessage().indexOf("only one method") != -1);
        }

        assertEquals("doIt", cut.getKeyMethod(new KeyObject05()).getName());
        assertEquals("toString", cut.getKeyMethod(new KeyObject06(null)).getName());
    }

    @Test
    public void testBuildCacheKey() {
        final String ns = RandomStringUtils.randomAlphanumeric(235);

        try {
            cut.buildCacheKey(null, ns, null);
            fail("Expected exception.");
        } catch (InvalidParameterException ex) {
            assertTrue(ex.getMessage().indexOf("at least 1 character") != -1);
        }

        try {
            cut.buildCacheKey("", ns, null);
            fail("Expected exception.");
        } catch (InvalidParameterException ex) {
            assertTrue(ex.getMessage().indexOf("at least 1 character") != -1);
        }

        final String space = RandomStringUtils.randomAlphanumeric(8) + " "
                + RandomStringUtils.randomAlphanumeric(8);
        try {
            cut.buildCacheKey(space, ns, null);
            fail("Expected exception.");
        } catch (InvalidParameterException ex) {
            assertTrue(ex.getMessage().indexOf("whitespace") != -1);
        }

        final String endline = RandomStringUtils.randomAlphanumeric(8) + "\n"
                + RandomStringUtils.randomAlphanumeric(8);
        try {
            cut.buildCacheKey(endline, ns, null);
            fail("Expected exception.");
        } catch (InvalidParameterException ex) {
            assertTrue(ex.getMessage().indexOf("whitespace") != -1);
        }

        final String tab = RandomStringUtils.randomAlphanumeric(8) + "\t" + RandomStringUtils.randomAlphanumeric(8);
        try {
            cut.buildCacheKey(tab, ns, null);
            fail("Expected exception.");
        } catch (InvalidParameterException ex) {
            assertTrue(ex.getMessage().indexOf("whitespace") != -1);
        }

        final String objectId = RandomStringUtils.randomAlphanumeric(20);
        try {
            cut.buildCacheKey(objectId, ns, null);
            fail("Expected exception.");
        } catch (InvalidParameterException ex) {
            assertTrue(ex.getMessage().indexOf("255") != -1);
            assertTrue(ex.getMessage().indexOf(objectId) != -1);
        }

        final String namespace = RandomStringUtils.randomAlphanumeric(12);

        final String result = cut.buildCacheKey(objectId, namespace, null);

        assertTrue(result.indexOf(objectId) != -1);
        assertTrue(result.indexOf(namespace) != -1);
    }

    @Test
    public void testGenerateCacheKey() throws Exception {
        final Method method = KeyObject.class.getMethod("toString", null);

        try {
            cut.generateObjectId(method, new KeyObject(null));
            fail("Expected Exception.");
        } catch (RuntimeException ex) {
            assertTrue(ex.getMessage().indexOf("empty key value") != -1);
        }

        try {
            cut.generateObjectId(method, new KeyObject(""));
            fail("Expected Exception.");
        } catch (RuntimeException ex) {
            assertTrue(ex.getMessage().indexOf("empty key value") != -1);
        }

        final String result = "momma";
        assertEquals(result, cut.generateObjectId(method, new KeyObject(result)));
    }

    @Test
    public void testReturnTypeChecking() throws Exception {
        Method method = null;

        method = ReturnTypeCheck.class.getMethod("checkA", null);
        cut.verifyReturnTypeIsList(method, CacheKeyMethod.class);

        method = ReturnTypeCheck.class.getMethod("checkB", null);
        cut.verifyReturnTypeIsList(method, CacheKeyMethod.class);

        method = ReturnTypeCheck.class.getMethod("checkC", null);
        cut.verifyReturnTypeIsList(method, CacheKeyMethod.class);

        method = ReturnTypeCheck.class.getMethod("checkD", null);
        cut.verifyReturnTypeIsList(method, CacheKeyMethod.class);

        try {
            method = ReturnTypeCheck.class.getMethod("checkE", null);
            cut.verifyReturnTypeIsList(method, CacheKeyMethod.class);
            fail("Expected Exception.");
        } catch (InvalidAnnotationException ex) {
            assertTrue(ex.getMessage().indexOf("requirement") != -1);
        }
    }

    @Test
    public void testGetPertinentListeners() throws Exception {
        final Cach3State state = new Cach3State();
        cut.setState(state);

        final StubInvalidateAssignCacheListenerImpl bubba = new StubInvalidateAssignCacheListenerImpl();
        bubba.setInterests(new HashSet<String>());
        bubba.getInterests().add("buford");
        bubba.getInterests().add("blue");
        bubba.getInterests().add("shrimp");
        state.addListener(bubba);

        final StubInvalidateAssignCacheListenerImpl forest = new StubInvalidateAssignCacheListenerImpl();
        forest.setInterests(new HashSet<String>());
        forest.getInterests().add("gump");
        forest.getInterests().add("shrimp");
        state.addListener(forest);

        final StubInvalidateAssignCacheListenerImpl nosey1 = new StubInvalidateAssignCacheListenerImpl();
        nosey1.setInterests(new HashSet<String>());
        state.addListener(nosey1);

        final StubInvalidateAssignCacheListenerImpl nosey2 = new StubInvalidateAssignCacheListenerImpl();
        state.addListener(nosey2);

        // Check for valid parameters
        try {
            cut.getPertinentListeners(null, "bubba");
            fail("Expected Exception.");
        } catch (InvalidParameterException ex) {
        }

        try {
            cut.getPertinentListeners(CacheListener.class, null);
            fail("Expected Exception.");
        } catch (InvalidParameterException ex) {
        }

        try {
            cut.getPertinentListeners(CacheListener.class, "");
            fail("Expected Exception.");
        } catch (InvalidParameterException ex) {
        }

        // Now check actual execution.
        final List<InvalidateAssignCacheListener> r1 = cut
                .getPertinentListeners(InvalidateAssignCacheListener.class, "yankee");
        assertFalse(r1.contains(bubba));
        assertFalse(r1.contains(forest));
        assertTrue(r1.contains(nosey1));
        assertTrue(r1.contains(nosey2));

        final List<InvalidateAssignCacheListener> r2 = cut
                .getPertinentListeners(InvalidateAssignCacheListener.class, "buford");
        assertTrue(r2.contains(bubba));
        assertFalse(r2.contains(forest));
        assertTrue(r2.contains(nosey1));
        assertTrue(r2.contains(nosey2));

        final List<InvalidateAssignCacheListener> r3 = cut
                .getPertinentListeners(InvalidateAssignCacheListener.class, "shrimp");
        assertTrue(r3.contains(bubba));
        assertTrue(r3.contains(forest));
        assertTrue(r3.contains(nosey1));
        assertTrue(r3.contains(nosey2));

        final List<UpdateMultiCacheListener> r4 = cut.getPertinentListeners(UpdateMultiCacheListener.class,
                "shrimp");
        assertTrue(r4.isEmpty());
    }

    @Test
    public void testIsList() {
        assertFalse(CacheBase.verifyTypeIsList(Object.class));
        assertFalse(CacheBase.verifyTypeIsList(String.class));

        assertTrue(CacheBase.verifyTypeIsList(ArrayList.class));

        final List<Long> full = new ArrayList<Long>();
        for (int ix = 0; ix < 10; ix++) {
            full.add(RandomUtils.nextLong());
        }
        final List<Long> sub = full.subList(2, 7);
        assertTrue(CacheBase.verifyTypeIsList(sub.getClass()));
    }

    private static class ReturnTypeCheck {
        @ReadThroughMultiCache(keyIndex = 0, namespace = "bubba", expiration = 10)
        public List checkA() {
            return null;
        }

        @ReadThroughMultiCache(keyIndex = 0, namespace = "bubba", expiration = 10)
        public List<String> checkB() {
            return null;
        }

        @ReadThroughMultiCache(keyIndex = 0, namespace = "bubba", expiration = 10)
        public ArrayList checkC() {
            return null;
        }

        @ReadThroughMultiCache(keyIndex = 0, namespace = "bubba", expiration = 10)
        public ArrayList<String> checkD() {
            return null;
        }

        @ReadThroughMultiCache(keyIndex = 0, namespace = "bubba", expiration = 10)
        public String checkE() {
            return null;
        }
    }

    private static class KeyObject {
        private String result;

        private KeyObject(String result) {
            this.result = result;
        }

        public String toString() {
            return result;
        }
    }

    private static class KeyObject01 {
        @CacheKeyMethod
        public void doIt(final String nonsense) {
        }
    }

    private static class KeyObject02 {
        @CacheKeyMethod
        public void doIt() {
        }
    }

    private static class KeyObject03 {
        @CacheKeyMethod
        public Long doIt() {
            return null;
        }
    }

    private static class KeyObject04 {
        @CacheKeyMethod
        public String doIt() {
            return null;
        }

        @CacheKeyMethod
        public String doItAgain() {
            return null;
        }
    }

    private static class KeyObject05 {
        public static final String result = "shrimp";

        @CacheKeyMethod
        public String doIt() {
            return result;
        }
    }

    private static class KeyObject06 {
        private String result;

        private KeyObject06(String result) {
            this.result = result;
        }

        public String toString() {
            return result;
        }
    }

    @Test
    public void testJitterCalculation() {
        final int base_exp = 100 + RandomUtils.nextInt(100);

        // Jitter percent is not between 1 and 99
        assertEquals(base_exp, CacheBase.calculateJitteredExpiration(base_exp, -2));
        assertEquals(base_exp, CacheBase.calculateJitteredExpiration(base_exp, -1));
        assertEquals(base_exp, CacheBase.calculateJitteredExpiration(base_exp, 0));
        assertEquals(base_exp, CacheBase.calculateJitteredExpiration(base_exp, 100));
        assertEquals(base_exp, CacheBase.calculateJitteredExpiration(base_exp, 101));

        // Expiration is over the boundary, so it is representing an actual date/time
        assertEquals(CacheBase.JITTER_BOUND, CacheBase.calculateJitteredExpiration(CacheBase.JITTER_BOUND, 20));
        assertEquals(CacheBase.JITTER_BOUND + base_exp,
                CacheBase.calculateJitteredExpiration((CacheBase.JITTER_BOUND + base_exp), 20));

        // Now, we are working with actual jitter.
        int exp = 10000;
        int lower = 8000;
        int previous = 0;
        for (int ix = 0; ix < 25; ix++) {
            final int attempt = CacheBase.calculateJitteredExpiration(exp, 20);
            // System.out.println(attempt);
            assertTrue(previous != attempt);
            assertTrue(attempt <= exp);
            assertTrue(attempt > lower);

            previous = attempt;
        }
    }
}