RefreshScopeIntegrationTests.java

/*
 * Copyright 2013-present 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 org.springframework.cloud.context.integration;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import org.springframework.aop.framework.Advised;
import org.springframework.aop.scope.ScopedProxyUtils;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.cloud.context.integration.RefreshScopeIntegrationTests.TestConfiguration;
import org.springframework.cloud.context.scope.refresh.RefreshScopeRefreshedEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jmx.export.annotation.ManagedAttribute;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.test.annotation.DirtiesContext;

import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.BDDAssertions.then;

@SpringBootTest(classes = TestConfiguration.class)
@SuppressWarnings("Duplicates")
public class RefreshScopeIntegrationTests {

	@Autowired
	private Service service;

	@Autowired
	private TestProperties properties;

	@Autowired
	private org.springframework.cloud.context.scope.refresh.RefreshScope scope;

	@BeforeEach
	public void init() {
		then(ExampleService.getInitCount()).isEqualTo(1);
		ExampleService.reset();
	}

	@AfterEach
	public void close() {
		ExampleService.reset();
	}

	@Test
	@DirtiesContext
	public void testSimpleProperties() {
		then(service.getMessage()).isEqualTo("Hello scope!");
		then(service instanceof Advised).isTrue();
		// Change the dynamic property source...
		properties.setMessage("Foo");
		// ...but don't refresh, so the bean stays the same:
		then(service.getMessage()).isEqualTo("Hello scope!");
		then(ExampleService.getInitCount()).isEqualTo(0);
		then(ExampleService.getDestroyCount()).isEqualTo(0);
	}

	@Test
	@DirtiesContext
	public void testRefresh() {
		then(service.getMessage()).isEqualTo("Hello scope!");
		String id1 = service.toString();
		// Change the dynamic property source...
		properties.setMessage("Foo");
		// ...and then refresh, so the bean is re-initialized:
		scope.refreshAll();
		String id2 = service.toString();
		then(service.getMessage()).isEqualTo("Foo");
		then(ExampleService.getInitCount()).isEqualTo(1);
		then(ExampleService.getDestroyCount()).isEqualTo(1);
		then(id2).isNotSameAs(id1);
		then(ExampleService.event).isNotNull();
		then(ExampleService.event.getName()).isEqualTo(RefreshScopeRefreshedEvent.DEFAULT_NAME);
	}

	@Test
	@DirtiesContext
	public void testRefreshBean() {
		then(service.getMessage()).isEqualTo("Hello scope!");
		String id1 = service.toString();
		// Change the dynamic property source...
		properties.setMessage("Foo");
		// ...and then refresh, so the bean is re-initialized:
		scope.refresh("service");
		String id2 = service.toString();
		then(service.getMessage()).isEqualTo("Foo");
		then(service.getMessage()).isEqualTo("Foo");
		then(ExampleService.getInitCount()).isEqualTo(1);
		then(ExampleService.getDestroyCount()).isEqualTo(1);
		then(id2).isNotSameAs(id1);
		then(ExampleService.event).isNotNull();
		then(ExampleService.event.getName()).isEqualTo(ScopedProxyUtils.getTargetBeanName("service"));
	}

	// see gh-349
	@Test
	@DirtiesContext
	public void testCheckedException() {
		assertThatExceptionOfType(ServiceException.class).isThrownBy(() -> service.throwsException());
	}

	public interface Service {

		String getMessage();

		String throwsException() throws ServiceException;

	}

	public static class ExampleService
			implements Service, InitializingBean, DisposableBean, ApplicationListener<RefreshScopeRefreshedEvent> {

		private static Log logger = LogFactory.getLog(ExampleService.class);

		private volatile static int initCount = 0;

		private volatile static int destroyCount = 0;

		private volatile static RefreshScopeRefreshedEvent event;

		private String message = null;

		private volatile long delay = 0;

		public static void reset() {
			initCount = 0;
			destroyCount = 0;
			event = null;
		}

		public static int getInitCount() {
			return initCount;
		}

		public static int getDestroyCount() {
			return destroyCount;
		}

		public void setDelay(long delay) {
			this.delay = delay;
		}

		@Override
		public void afterPropertiesSet() {
			logger.debug("Initializing message: " + message);
			initCount++;
		}

		@Override
		public void destroy() {
			logger.debug("Destroying message: " + message);
			destroyCount++;
			message = null;
		}

		@Override
		public String getMessage() {
			logger.debug("Getting message: " + message);
			try {
				Thread.sleep(delay);
			}
			catch (InterruptedException e) {
				Thread.currentThread().interrupt();
			}
			logger.info("Returning message: " + message);
			return message;
		}

		public void setMessage(String message) {
			logger.debug("Setting message: " + message);
			this.message = message;
		}

		@Override
		public String throwsException() throws ServiceException {
			throw new ServiceException();
		}

		@Override
		public void onApplicationEvent(RefreshScopeRefreshedEvent e) {
			event = e;
		}

	}

	@SuppressWarnings("serial")
	public static class ServiceException extends Exception {

	}

	@Configuration(proxyBeanMethods = false)
	@EnableConfigurationProperties(TestProperties.class)
	@EnableAutoConfiguration
	protected static class TestConfiguration {

		@Autowired
		private TestProperties properties;

		@Bean
		@RefreshScope
		public ExampleService service() {
			ExampleService service = new ExampleService();
			service.setMessage(properties.getMessage());
			service.setDelay(properties.getDelay());
			return service;
		}

	}

	@ConfigurationProperties
	@ManagedResource
	protected static class TestProperties {

		private String message;

		private int delay;

		@ManagedAttribute
		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		@ManagedAttribute
		public int getDelay() {
			return delay;
		}

		public void setDelay(int delay) {
			this.delay = delay;
		}

	}

}