SnsConfigurationTest.java

/*
 * Copyright 2013-2014 the original author or authors.
 *
 * 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.
 */

package org.springframework.cloud.aws.messaging.config.annotation;

import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.regions.Region;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.sns.AmazonSNS;
import org.junit.Before;
import org.junit.Test;
import org.springframework.cloud.aws.context.config.annotation.EnableContextRegion;
import org.springframework.cloud.aws.messaging.endpoint.NotificationStatusHandlerMethodArgumentResolver;
import org.springframework.context.annotation.Bean;
import org.springframework.mock.web.MockServletContext;
import org.springframework.test.util.ReflectionTestUtils;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodArgumentResolverComposite;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;

import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;

/**
 * @author Alain Sahli
 */
public class SnsConfigurationTest {

    private AnnotationConfigWebApplicationContext webApplicationContext;

    @Before
    public void setUp() throws Exception {
        this.webApplicationContext = new AnnotationConfigWebApplicationContext();
        this.webApplicationContext.setServletContext(new MockServletContext());
    }

    @Test
    public void enableSns_withMinimalConfig_shouldConfigureACompositeArgumentResolver() throws Exception {
        // Arrange & Act
        this.webApplicationContext.register(MinimalSnsConfiguration.class);
        this.webApplicationContext.refresh();
        RequestMappingHandlerAdapter requestMappingHandlerAdapter = this.webApplicationContext.getBean(RequestMappingHandlerAdapter.class);

        // Assert
        assertEquals(1, requestMappingHandlerAdapter.getCustomArgumentResolvers().size());
        HandlerMethodArgumentResolver argumentResolver = requestMappingHandlerAdapter.getCustomArgumentResolvers().get(0);
        assertTrue(HandlerMethodArgumentResolverComposite.class.isInstance(argumentResolver));

        HandlerMethodArgumentResolverComposite compositeArgumentResolver = (HandlerMethodArgumentResolverComposite) argumentResolver;
        assertEquals(3, compositeArgumentResolver.getResolvers().size());
        assertNotNull(ReflectionTestUtils.getField(getNotificationStatusHandlerMethodArgumentResolver(compositeArgumentResolver.getResolvers()), "amazonSns"));
    }

    @Test
    public void enableSns_withProvidedCredentials_shouldBeUsedToCreateClient() throws Exception {
        // Arrange & Act
        this.webApplicationContext.register(SnsConfigurationWithCredentials.class);
        this.webApplicationContext.refresh();
        AmazonSNS amazonSns = this.webApplicationContext.getBean(AmazonSNS.class);

        // Assert
        assertEquals(SnsConfigurationWithCredentials.AWS_CREDENTIALS_PROVIDER, ReflectionTestUtils.getField(amazonSns, "awsCredentialsProvider"));
    }

    @Test
    public void enableSns_withCustomAmazonSnsClient_shouldBeUsedByTheArgumentResolver() throws Exception {
        // Arrange & Act
        this.webApplicationContext.register(SnsConfigurationWithCustomAmazonClient.class);
        this.webApplicationContext.refresh();
        RequestMappingHandlerAdapter requestMappingHandlerAdapter = this.webApplicationContext.getBean(RequestMappingHandlerAdapter.class);

        // Assert
        HandlerMethodArgumentResolverComposite handlerMethodArgumentResolver = (HandlerMethodArgumentResolverComposite) requestMappingHandlerAdapter.getCustomArgumentResolvers().get(0);
        NotificationStatusHandlerMethodArgumentResolver notificationStatusHandlerMethodArgumentResolver = getNotificationStatusHandlerMethodArgumentResolver(handlerMethodArgumentResolver.getResolvers());
        assertEquals(SnsConfigurationWithCustomAmazonClient.AMAZON_SNS, ReflectionTestUtils.getField(notificationStatusHandlerMethodArgumentResolver, "amazonSns"));
    }

    @Test
    public void enableSns_withRegionProvided_shouldBeUsedToCreateClient() throws Exception {
        // Arrange & Act
        this.webApplicationContext.register(SnsConfigurationWithRegionProvider.class);
        this.webApplicationContext.refresh();
        AmazonSNS amazonSns = this.webApplicationContext.getBean(AmazonSNS.class);

        // Assert
        assertEquals("https://" + Region.getRegion(Regions.EU_WEST_1).getServiceEndpoint("sns"), ReflectionTestUtils.getField(amazonSns, "endpoint").toString());
    }

    private NotificationStatusHandlerMethodArgumentResolver getNotificationStatusHandlerMethodArgumentResolver(List<HandlerMethodArgumentResolver> resolvers) {
        for (HandlerMethodArgumentResolver resolver : resolvers) {
            if (resolver instanceof NotificationStatusHandlerMethodArgumentResolver) {
                return (NotificationStatusHandlerMethodArgumentResolver) resolver;

            }
        }

        return null;
    }

    @EnableWebMvc
    @EnableSns
    protected static class MinimalSnsConfiguration {

    }

    @EnableWebMvc
    @EnableSns
    protected static class SnsConfigurationWithCredentials {

        public static final AWSCredentialsProvider AWS_CREDENTIALS_PROVIDER = mock(AWSCredentialsProvider.class);

        @Bean
        public AWSCredentialsProvider awsCredentialsProvider() {
            return AWS_CREDENTIALS_PROVIDER;
        }

    }

    @EnableWebMvc
    @EnableSns
    protected static class SnsConfigurationWithCustomAmazonClient {

        public static final AmazonSNS AMAZON_SNS = mock(AmazonSNS.class);

        @Bean
        public AmazonSNS amazonSNS() {
            return AMAZON_SNS;
        }

    }

    @EnableWebMvc
    @EnableContextRegion(region = "eu-west-1")
    @EnableSns
    protected static class SnsConfigurationWithRegionProvider {

    }

}