Add @ConditionalOnCloudPlatform

Add a @ConditionalOnCloudPlatform annotation that matches based on the
active ClouldPlatform.

Fixes gh-7155

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnCloudPlatform.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2012-2016 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.boot.autoconfigure.condition;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.boot.cloud.CloudPlatform;
+import org.springframework.context.annotation.Conditional;
+
+/**
+ * {@link Conditional} that matches when the specified cloud platform is active.
+ *
+ * @author Madhura Bhave
+ * @since 1.5.0
+ */
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Conditional(OnCloudPlatformCondition.class)
+public @interface ConditionalOnCloudPlatform {
+
+	/**
+	 * The {@link CloudPlatform cloud platform} that must be active.
+	 * @return the expected cloud platform
+	 */
+	CloudPlatform value();
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/OnCloudPlatformCondition.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2012-2016 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.boot.autoconfigure.condition;
+
+import java.util.Map;
+
+import org.springframework.boot.cloud.CloudPlatform;
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.env.Environment;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+/**
+ * {@link Condition} that checks for a required {@link CloudPlatform}.
+ *
+ * @author Madhura Bhave
+ * @see ConditionalOnCloudPlatform
+ */
+class OnCloudPlatformCondition extends SpringBootCondition {
+
+	@Override
+	public ConditionOutcome getMatchOutcome(ConditionContext context,
+			AnnotatedTypeMetadata metadata) {
+		Map<String, Object> attributes = metadata
+				.getAnnotationAttributes(ConditionalOnCloudPlatform.class.getName());
+		CloudPlatform cloudPlatform = (CloudPlatform) attributes.get("value");
+		return getMatchOutcome(context.getEnvironment(), cloudPlatform);
+	}
+
+	private ConditionOutcome getMatchOutcome(Environment environment,
+			CloudPlatform cloudPlatform) {
+		String name = cloudPlatform.name();
+		ConditionMessage.Builder message = ConditionMessage
+				.forCondition(ConditionalOnCloudPlatform.class);
+		if (cloudPlatform.isActive(environment)) {
+			return ConditionOutcome.match(message.foundExactly(name));
+		}
+		return ConditionOutcome.noMatch(message.didNotFind(name).atAll());
+	}
+
+}

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnCloudPlatformTests.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2012-2016 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.boot.autoconfigure.condition;
+
+import org.junit.Test;
+
+import org.springframework.boot.cloud.CloudPlatform;
+import org.springframework.boot.test.util.EnvironmentTestUtils;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ConditionalOnCloudPlatform}.
+ */
+public class ConditionalOnCloudPlatformTests {
+
+	private final AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
+
+	@Test
+	public void outcomeWhenCloudfoundryPlatformNotPresentShouldNotMatch()
+			throws Exception {
+		load(CloudFoundryPlatformConfig.class, "");
+		assertThat(this.context.containsBean("foo")).isFalse();
+	}
+
+	@Test
+	public void outcomeWhenCloudfoundryPlatformPresentShouldMatch() throws Exception {
+		load(CloudFoundryPlatformConfig.class, "VCAP_APPLICATION:---");
+		assertThat(this.context.containsBean("foo")).isTrue();
+	}
+
+	@Test
+	public void outcomeWhenCloudfoundryPlatformPresentAndMethodTargetShouldMatch()
+			throws Exception {
+		load(CloudFoundryPlatformOnMethodConfig.class, "VCAP_APPLICATION:---");
+		assertThat(this.context.containsBean("foo")).isTrue();
+	}
+
+	private void load(Class<?> config, String... environment) {
+		EnvironmentTestUtils.addEnvironment(this.context, environment);
+		this.context.register(config);
+		this.context.refresh();
+	}
+
+	@Configuration
+	@ConditionalOnCloudPlatform(CloudPlatform.CLOUD_FOUNDRY)
+	static class CloudFoundryPlatformConfig {
+
+		@Bean
+		public String foo() {
+			return "foo";
+		}
+
+	}
+
+	@Configuration
+	static class CloudFoundryPlatformOnMethodConfig {
+
+		@Bean
+		@ConditionalOnCloudPlatform(CloudPlatform.CLOUD_FOUNDRY)
+		public String foo() {
+			return "foo";
+		}
+
+	}
+
+}