SnsAutoConfigurationTest.java

/*
 * Copyright 2013-2022 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
 *
 *      https://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 io.awspring.cloud.autoconfigure.sns;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

import io.awspring.cloud.autoconfigure.ConfiguredAwsClient;
import io.awspring.cloud.autoconfigure.core.AwsAutoConfiguration;
import io.awspring.cloud.autoconfigure.core.CredentialsProviderAutoConfiguration;
import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration;
import io.awspring.cloud.sns.core.SnsOperations;
import io.awspring.cloud.sns.core.SnsTemplate;
import io.awspring.cloud.sns.core.TopicArnResolver;
import io.awspring.cloud.sns.core.batch.SnsBatchTemplate;
import io.awspring.cloud.sns.core.batch.converter.SnsMessageConverter;
import io.awspring.cloud.sns.core.batch.executor.BatchExecutionStrategy;
import io.awspring.cloud.sns.sms.SnsSmsOperations;
import io.awspring.cloud.sns.sms.SnsSmsTemplate;

import java.net.URI;

import org.junit.jupiter.api.Test;
import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.FilteredClassLoader;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.support.ChannelInterceptor;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import software.amazon.awssdk.arns.Arn;
import software.amazon.awssdk.services.sns.SnsClient;

/**
 * Tests for class {@link io.awspring.cloud.autoconfigure.sns.SnsAutoConfiguration}.
 *
 * @author Matej Nedic
 * @author Mariusz Sondecki
 */
class SnsAutoConfigurationTest {

	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
		.withPropertyValues("spring.cloud.aws.region.static:eu-west-1")
		.withConfiguration(AutoConfigurations.of(RegionProviderAutoConfiguration.class,
			CredentialsProviderAutoConfiguration.class, SnsAutoConfiguration.class,
			AwsAutoConfiguration.class));

	@Test
	void snsAutoConfigurationIsDisabled() {
		this.contextRunner.withPropertyValues("spring.cloud.aws.sns.enabled:false")
			.run(context -> assertThat(context).doesNotHaveBean(SnsClient.class));
	}

	@Test
	void snsAutoConfigurationIsEnabled() {
		this.contextRunner.withPropertyValues("spring.cloud.aws.sns.enabled:true").run(context -> {
			assertThat(context).hasSingleBean(SnsClient.class);
			assertThat(context).hasSingleBean(SnsTemplate.class);
			assertThat(context).hasSingleBean(SnsSmsTemplate.class);
			assertThat(context).hasBean("snsWebMvcConfigurer");

			ConfiguredAwsClient client = new ConfiguredAwsClient(context.getBean(SnsClient.class));
			assertThat(client.getEndpoint()).isEqualTo(URI.create("https://sns.eu-west-1.amazonaws.com"));

		});
	}

	@Test
	void withCustomEndpoint() {
		this.contextRunner.withPropertyValues("spring.cloud.aws.sns.endpoint:http://localhost:8090").run(context -> {
			assertThat(context).hasSingleBean(SnsTemplate.class);
			assertThat(context).hasBean("snsWebMvcConfigurer");

			ConfiguredAwsClient client = new ConfiguredAwsClient(context.getBean(SnsClient.class));
			assertThat(client.getEndpoint()).isEqualTo(URI.create("http://localhost:8090"));
			assertThat(client.isEndpointOverridden()).isTrue();
		});
	}

	@Test
	void customTopicArnResolverCanBeConfigured() {
		this.contextRunner.withUserConfiguration(CustomTopicArnResolverConfiguration.class)
			.run(context -> assertThat(context).hasSingleBean(CustomTopicArnResolver.class));
	}

	@Test
	void doesNotConfigureArgumentResolversWhenSpringWebNotOnTheClasspath() {
		this.contextRunner.withClassLoader(new FilteredClassLoader(WebMvcConfigurer.class)).run(context -> {
			assertThat(context).hasSingleBean(SnsClient.class);
			assertThat(context).hasSingleBean(SnsTemplate.class);
			assertThat(context).hasSingleBean(SnsBatchTemplate.class);
			assertThat(context).hasSingleBean(SnsMessageConverter.class);
			assertThat(context).hasSingleBean(BatchExecutionStrategy.class);
			assertThat(context).hasSingleBean(SnsSmsTemplate.class);
			assertThat(context).doesNotHaveBean("snsWebMvcConfigurer");
		});
	}

	@Test
	void smsSnsOperationsBeanCanBeOverwritten() {
		this.contextRunner.withUserConfiguration(CustomSmsOperations.class).run(context -> {
			assertThat(context.getBean("customSmsOperations", SnsSmsOperations.class)).isNotNull();
			assertThat(context).doesNotHaveBean(SnsSmsTemplate.class);
		});
	}

	@Test
	void bothTemplatesAndOperationsAreInjectable() {
		this.contextRunner.withUserConfiguration(InjectingTemplatesConfiguration.class).run(context -> {
			assertThat(context.isRunning()).isTrue();
		});
	}

	@Test
	void customChannelInterceptorCanBeConfigured() {
		this.contextRunner.withUserConfiguration(CustomChannelInterceptorConfiguration.class)
			.run(context -> assertThat(context).hasSingleBean(CustomChannelInterceptor.class));
	}


	@Configuration(proxyBeanMethods = false)
	static class CustomTopicArnResolverConfiguration {

		@Bean
		TopicArnResolver customS3OutputStreamProvider() {
			return new CustomTopicArnResolver();
		}

	}

	static class CustomTopicArnResolver implements TopicArnResolver {

		@Override
		public Arn resolveTopicArn(String topicName) {
			return Arn.builder().build();
		}
	}

	@Configuration(proxyBeanMethods = false)
	static class CustomSmsOperations {

		@Bean
		SnsSmsOperations customSmsOperations() {
			return mock(SnsSmsOperations.class);
		}

	}

	@Configuration(proxyBeanMethods = false)
	static class InjectingTemplatesConfiguration {
		@Bean
		ApplicationRunner runner1(SnsTemplate snsTemplate) {
			return args -> {
			};
		}

		@Bean
		ApplicationRunner runner2(SnsOperations snsOperations) {
			return args -> {
			};
		}

		@Bean
		ApplicationRunner runner3(SnsSmsTemplate snsSmsTemplate) {
			return args -> {
			};
		}

		@Bean
		ApplicationRunner runner4(SnsSmsOperations snsSmsOperations) {
			return args -> {
			};
		}
	}

	@Configuration(proxyBeanMethods = false)
	static class CustomChannelInterceptorConfiguration {

		@Bean
		ChannelInterceptor customChannelInterceptor() {
			return new CustomChannelInterceptor();
		}
	}

	static class CustomChannelInterceptor implements ChannelInterceptor {
	}
}