RefreshEndpointTests.java

/*
 * Copyright 2015 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.endpoint;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.junit.After;
import org.junit.Test;
import org.springframework.boot.Banner.Mode;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.test.util.EnvironmentTestUtils;
import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
import org.springframework.cloud.context.refresh.ContextRefresher;
import org.springframework.cloud.context.scope.refresh.RefreshScope;
import org.springframework.cloud.context.scope.refresh.RefreshScopeRefreshedEvent;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.EventListener;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

/**
 * @author Dave Syer
 * @author Venil Noronha
 */
public class RefreshEndpointTests {

	private ConfigurableApplicationContext context;

	@After
	public void close() {
		if (this.context != null) {
			this.context.close();
		}
	}

	@Test
	public void keysComputedWhenAdded() throws Exception {
		this.context = new SpringApplicationBuilder(Empty.class).web(false)
				.bannerMode(Mode.OFF).properties("spring.cloud.bootstrap.name:none")
				.run();
		RefreshScope scope = new RefreshScope();
		scope.setApplicationContext(this.context);
		EnvironmentTestUtils.addEnvironment(this.context, "spring.profiles.active=local");
		ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
		RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
		Collection<String> keys = endpoint.invoke();
		assertTrue("Wrong keys: " + keys, keys.contains("added"));
	}

	@Test
	public void keysComputedWhenOveridden() throws Exception {
		this.context = new SpringApplicationBuilder(Empty.class).web(false)
				.bannerMode(Mode.OFF).properties("spring.cloud.bootstrap.name:none")
				.run();
		RefreshScope scope = new RefreshScope();
		scope.setApplicationContext(this.context);
		EnvironmentTestUtils.addEnvironment(this.context,
				"spring.profiles.active=override");
		ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
		RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
		Collection<String> keys = endpoint.invoke();
		assertTrue("Wrong keys: " + keys, keys.contains("message"));
	}

	@Test
	public void keysComputedWhenChangesInExternalProperties() throws Exception {
		this.context = new SpringApplicationBuilder(Empty.class).web(false)
				.bannerMode(Mode.OFF).properties("spring.cloud.bootstrap.name:none")
				.run();
		RefreshScope scope = new RefreshScope();
		scope.setApplicationContext(this.context);
		EnvironmentTestUtils.addEnvironment(this.context,
				"spring.cloud.bootstrap.sources="
						+ ExternalPropertySourceLocator.class.getName());
		ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
		RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
		Collection<String> keys = endpoint.invoke();
		assertTrue("Wrong keys: " + keys, keys.contains("external.message"));
	}

	@Test
	public void springMainSourcesEmptyInRefreshCycle() throws Exception {
		this.context = new SpringApplicationBuilder(Empty.class).web(false)
				.bannerMode(Mode.OFF).properties("spring.cloud.bootstrap.name:none")
				.run();
		RefreshScope scope = new RefreshScope();
		scope.setApplicationContext(this.context);
		// spring.main.sources should be empty when the refresh cycle starts (we don't
		// want any config files from the application context getting into the one used to
		// construct the environment for refresh)
		EnvironmentTestUtils.addEnvironment(this.context,
				"spring.main.sources=" + ExternalPropertySourceLocator.class.getName());
		ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
		RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
		Collection<String> keys = endpoint.invoke();
		assertFalse("Wrong keys: " + keys, keys.contains("external.message"));
	}

	@Test
	public void eventsPublishedInOrder() throws Exception {
		this.context = new SpringApplicationBuilder(Empty.class).web(false)
				.bannerMode(Mode.OFF).run();
		RefreshScope scope = new RefreshScope();
		scope.setApplicationContext(this.context);
		ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
		RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
		Empty empty = this.context.getBean(Empty.class);
		endpoint.invoke();
		int after = empty.events.size();
		assertEquals("Shutdown hooks not cleaned on refresh", 2, after);
		assertTrue(empty.events.get(0) instanceof EnvironmentChangeEvent);
	}

	@Test
	public void shutdownHooksCleaned() {
		ConfigurableApplicationContext context = new SpringApplicationBuilder(Empty.class)
				.web(false).bannerMode(Mode.OFF).run();
		RefreshScope scope = new RefreshScope();
		scope.setApplicationContext(context);
		ContextRefresher contextRefresher = new ContextRefresher(context, scope);
		RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
		int count = countShutdownHooks();
		endpoint.invoke();
		int after = countShutdownHooks();
		assertEquals("Shutdown hooks not cleaned on refresh", count, after);
	}

	private int countShutdownHooks() {
		Class<?> type = ClassUtils.resolveClassName("java.lang.ApplicationShutdownHooks",
				null);
		Field field = ReflectionUtils.findField(type, "hooks");
		ReflectionUtils.makeAccessible(field);
		@SuppressWarnings("rawtypes")
		Map map = (Map) ReflectionUtils.getField(field, null);
		return map.size();
	}

	@Configuration
	protected static class Empty {
		private List<ApplicationEvent> events = new ArrayList<ApplicationEvent>();

		@EventListener(EnvironmentChangeEvent.class)
		public void changed(EnvironmentChangeEvent event) {
			this.events.add(event);
		}

		@EventListener(RefreshScopeRefreshedEvent.class)
		public void refreshed(RefreshScopeRefreshedEvent event) {
			this.events.add(event);
		}
	}

	@Component
	protected static class ExternalPropertySourceLocator
			implements PropertySourceLocator {

		@Override
		public PropertySource<?> locate(Environment environment) {
			return new MapPropertySource("external", Collections
					.<String, Object> singletonMap("external.message", "I'm External"));
		}

	}
}