InvalidateSingleCacheAdviceTest.java

/* Copyright (c) 2012-2017 Jakub Białek
 * 
 * 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.
 */

package com.google.code.ssm.aop;

import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.never;
import static org.mockito.Matchers.anyString;

import java.util.Arrays;
import java.util.Collection;

import org.hamcrest.CoreMatchers;
import org.junit.Assume;
import org.junit.Before;
import org.junit.Test;
import org.junit.runners.Parameterized.Parameters;

import com.google.code.ssm.api.InvalidateSingleCache;
import com.google.code.ssm.api.ParameterValueKeyProvider;
import com.google.code.ssm.api.ReturnValueKeyProvider;
import com.google.code.ssm.test.Point;

/**
 * 
 * @author Jakub Białek
 * 
 */
public class InvalidateSingleCacheAdviceTest extends AbstractCacheTest<InvalidateSingleCacheAdvice> {

    @Parameters
    public static Collection<Object[]> data() {
        return Arrays.asList(new Object[][] { //
                        { true, "method1", new Class[] { int.class }, new Object[] { 1 }, 1, null }, //
                        { true, "method2", new Class[] { int.class }, new Object[] { 2 }, "2", null }, //
                        { true, "method3", new Class[] { int.class, int.class }, new Object[] { 3, 44 }, 3, null }, //
                        { true, "method4", new Class[] { int.class }, new Object[] { 4 }, 5, NS + ":5" }, //
                        { true, "method5", new Class[] { int.class, Point.class }, new Object[] { 5, new Point(1, 2) }, "5",
                                NS + ":(1,2)/5" }, //
                        { true, "method6", new Class[] { int.class }, new Object[] { 6 }, new Point(6, 7), NS + ":(6,7)" }, //
                        { true, "method7", new Class[] { int.class }, new Object[] { 7 }, 8, NS + ":8" }, //

                        { false, "method51", new Class[] { int.class }, new Object[] { 51 }, 51, null }, //
                        { false, "method52", new Class[] { int.class }, new Object[] { 52 }, null, null }, //
                });
    }

    private static final String NS = "SOME_NS";

    private Object expectedValue;

    public InvalidateSingleCacheAdviceTest(boolean isValid, String methodName, Class<?>[] paramTypes, Object[] params,
            Object expectedValue, String cacheKey) {
        super(isValid, methodName, paramTypes, params, cacheKey);
        this.expectedValue = expectedValue;
    }

    @Before
    public void setUp() {
        super.setUp(new TestService());
    }

    @Test
    public void valid() throws Throwable {
        Assume.assumeTrue(isValid);

        when(pjp.proceed()).thenReturn(expectedValue);

        assertEquals(expectedValue, advice.cacheInvalidateSingle(pjp));

        verify(cache).delete(cacheKey);
        verify(pjp).proceed();
    }

    @Test
    public void invalid() throws Throwable {
        Assume.assumeThat(isValid, CoreMatchers.is(false));

        when(pjp.proceed()).thenReturn(expectedValue);

        assertEquals(expectedValue, advice.cacheInvalidateSingle(pjp));

        verify(pjp).proceed();
        verify(cache, never()).delete(anyString());
    }

    @Override
    protected InvalidateSingleCacheAdvice createAdvice() {
        return new InvalidateSingleCacheAdvice();
    }

    @Override
    protected String getNamespace() {
        return NS;
    }

    private static class TestService {

        @InvalidateSingleCache(namespace = NS)
        public int method1(@ParameterValueKeyProvider int id1) {
            return 1;
        }

        @InvalidateSingleCache(namespace = NS)
        public String method2(@ParameterValueKeyProvider int id1) {
            return "2";
        }

        @InvalidateSingleCache(namespace = NS)
        public int method3(@ParameterValueKeyProvider(order = 1) int id1, @ParameterValueKeyProvider(order = 2) int id2) {
            return 3;
        }

        @ReturnValueKeyProvider
        @InvalidateSingleCache(namespace = NS)
        public int method4(int id1) {
            return 4;
        }

        @InvalidateSingleCache(namespace = NS)
        public String method5(@ParameterValueKeyProvider(order = 2) int id1, @ParameterValueKeyProvider(order = 1) Point p) {
            return "5";
        }

        @ReturnValueKeyProvider
        @InvalidateSingleCache(namespace = NS)
        public Point method6(int id1) {
            return new Point(1, 1);
        }

        // both @ParameterValueKeyProvider and @ReturnValueKeyProvider currently is valid
        @ReturnValueKeyProvider
        @InvalidateSingleCache(namespace = NS)
        public int method7(@ParameterValueKeyProvider int id1) {
            return 7;
        }

        // no @ParameterValueKeyProvider or @ReturnValueKeyProvider
        @InvalidateSingleCache(namespace = NS)
        public int method51(int id1) {
            return 51;
        }

        // @ReturnValueKeyProvider but void return type
        @ReturnValueKeyProvider
        @InvalidateSingleCache(namespace = NS)
        public void method52(int id1) {

        }

    }

}