com.crossbusiness.resiliency.aspect.AnnotationTimeout2AspectTest.java Source code

Introduction

Here is the source code for com.crossbusiness.resiliency.aspect.AnnotationTimeout2AspectTest.java

Source

/**
 * The MIT License (MIT)
 *
 * Copyright (c)  2014 CrossBusiness, 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.
 */
package com.crossbusiness.resiliency.aspect;

import com.crossbusiness.resiliency.annotation.Async;
import com.crossbusiness.resiliency.annotation.Timeout2;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.runners.MockitoJUnitRunner;
import org.mockito.stubbing.Answer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.*;

/**
 * Unit tests for {@link AnnotationTimeout2Aspect}.
 *
 * Created by Sumanth Chinthagunta <xmlking@gmail.com> on 3/11/14.
 */
@RunWith(MockitoJUnitRunner.class)
public class AnnotationTimeout2AspectTest {
    static final Logger log = LoggerFactory.getLogger(AnnotationTimeout2AspectTest.class);

    @Mock
    Delegate delegateMock;

    @InjectMocks
    TestService testService;

    @Test
    public void method_that_takes_1000ms_and_annotated_with_timeout2_of_2000ms_will_succeed()
            throws TimeoutException {
        doAnswer(new Answer<Object>() {
            public Object answer(InvocationOnMock invocation) throws InterruptedException {
                Object[] args = invocation.getArguments();
                TimeUnit.MILLISECONDS.sleep(1000);
                return args[0] + " back";
            }
        }).when(delegateMock).mockedMethod(anyString());

        String result = testService.timeout2_2000ms("testArg");

        assertEquals("testArg back", result);
        verify(delegateMock).mockedMethod("testArg");
        verifyZeroInteractions(delegateMock);
    }

    @Test(expected = TimeoutException.class)
    public void method_that_takes_2000ms_and_annotated_with_timeout2_of_1000ms_will_fail() throws TimeoutException {
        doAnswer(new Answer<Object>() {
            public Object answer(InvocationOnMock invocation) throws InterruptedException {
                TimeUnit.MILLISECONDS.sleep(2000);
                return "testArg back";
            }
        }).when(delegateMock).mockedMethod("testArg");

        String result = testService.timeout2_1000ms("testArg");
        //Following lines will not be called as InterruptedException will be thrown.
        assertEquals(null, result);
        verify(delegateMock, timeout(2005)).mockedMethod("testArg");
        verifyZeroInteractions(delegateMock);
    }

    @Test
    public void void_method_that_takes_1000ms_and_annotated_with_timeout2_of_2000ms_and_async_will_get_routed_asynchronously()
            throws InterruptedException, TimeoutException {
        doNothing().when(delegateMock).mockedVoidMethod(anyString());
        testService.async_void_method_taking_1000ms_will_timeout2_in_2000ms("testArg");

        verify(delegateMock, timeout(1100)).mockedVoidMethod("testArg");
        verifyZeroInteractions(delegateMock);
    }

    @Test
    public void void_method_that_takes_2000ms_and_annotated_with_timeout2_of_1000ms_and_async_will_get_routed_asynchronously_but_timeout_before_calling_mockedVoidMethod()
            throws InterruptedException, TimeoutException {
        doNothing().when(delegateMock).mockedVoidMethod(anyString());
        testService.async_void_method_taking_2000ms_will_timeout2_in_1000ms("testArg");

        verify(delegateMock, never()).mockedVoidMethod("testArg");
        verifyZeroInteractions(delegateMock);
    }

    @Component
    private static class TestService {

        @Autowired
        private Delegate delegate;

        @Timeout2(2000)
        public String timeout2_2000ms(String arg) throws TimeoutException {
            return delegate.mockedMethod(arg);
        }

        @Timeout2(1000)
        public String timeout2_1000ms(String arg) throws TimeoutException {
            return delegate.mockedMethod(arg);
        }

        /**
         * Note:  Precedence Order enforced. Timeout2(outer), Async(inner){@link SystemArchitecture}.
         */
        @Timeout2(2000)
        @Async
        public void async_void_method_taking_1000ms_will_timeout2_in_2000ms(String arg)
                throws InterruptedException, TimeoutException {
            log.debug(
                    "async_void_method_taking_1000ms_will_timeout2_in_2000ms() get executed asynchronously, will run in defaultExecutor thread");
            TimeUnit.MILLISECONDS.sleep(1000);
            delegate.mockedVoidMethod(arg);
        }

        /**
         * Note:  Precedence Order enforced. Timeout2(outer), Async(inner){@link SystemArchitecture}.
         */
        @Timeout2(1000)
        @Async
        public void async_void_method_taking_2000ms_will_timeout2_in_1000ms(String arg)
                throws InterruptedException, TimeoutException {
            log.debug(
                    "async_void_method_taking_2000ms_will_timeout2_in_1000ms() get executed asynchronously, will run in defaultExecutor thread");
            TimeUnit.MILLISECONDS.sleep(2000);
            delegate.mockedVoidMethod(arg);
        }

        /**
         * It should raise an error "Only methods that are declared with throws TimeoutException
         * may have an @Timeout2 annotation". This method must remain commented-out, otherwise there
         * will be a compile-time error. Uncomment to manually verify that the compiler produces an
         * error message due to the 'declare error' statement in
         * {@link AnnotationTimeout2Aspect}.
         */
        //        @Timeout2(value = 1000, unit = TimeUnit.MILLISECONDS)
        //        public String Timeout2_compile_error(String arg) {
        //            return delegate.mockedMethod(arg);
        //        }

    }

    private static interface Delegate {
        String mockedMethod(String arg);

        void mockedVoidMethod(String arg);
    }
}