ConfigDataPostProcessor migrated

spring-cloud-commons/src/main/java/org/springframework/cloud/commons/ConfigDataMissingEnvironmentPostProcessor.java

@@ -42,8 +42,11 @@
 
 /**
  * @author Ryan Baxter
+ * @deprecated Deprecated in favor of
+ * {@link org.springframework.cloud.commons.config.ConfigDataMissingEnvironmentPostProcessor}
  */
 // TODO: 4.0.0 move to org.springframework.cloud.commons.config
+@Deprecated(forRemoval = true, since = "5.0.0")
 public abstract class ConfigDataMissingEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered {
 
 	/**

spring-cloud-commons/src/main/java/org/springframework/cloud/commons/config/ConfigDataMissingEnvironmentPostProcessor.java

@@ -0,0 +1,152 @@
+/*
+ * Copyright 2015-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.commons.config;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.jspecify.annotations.NullMarked;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import org.springframework.boot.EnvironmentPostProcessor;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.context.config.ConfigDataEnvironmentPostProcessor;
+import org.springframework.boot.context.properties.bind.BindContext;
+import org.springframework.boot.context.properties.bind.BindHandler;
+import org.springframework.boot.context.properties.bind.Bindable;
+import org.springframework.boot.context.properties.bind.Binder;
+import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
+import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
+import org.springframework.core.Ordered;
+import org.springframework.core.env.CompositePropertySource;
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.MutablePropertySources;
+import org.springframework.core.env.PropertySource;
+
+/**
+ * @author Ryan Baxter
+ * @author Mikhail Polivakha
+ */
+@NullMarked
+public abstract class ConfigDataMissingEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered {
+
+	/**
+	 * Spring config import property name.
+	 */
+	public static final String CONFIG_IMPORT_PROPERTY = "spring.config.import";
+
+	private static final Bindable<String[]> CONFIG_DATA_LOCATION_ARRAY = Bindable.of(String[].class);
+
+	private static final String[] EMPTY_ARRAY = new String[0];
+
+	/**
+	 * Order of post processor, set to run after
+	 * {@link ConfigDataEnvironmentPostProcessor}.
+	 */
+	public static final int ORDER = ConfigDataEnvironmentPostProcessor.ORDER + 1000;
+
+	private final Logger LOG = LoggerFactory.getLogger(ConfigDataMissingEnvironmentPostProcessor.class);
+
+	@Override
+	public int getOrder() {
+		return ORDER;
+	}
+
+	protected abstract boolean shouldProcessEnvironment(Environment environment);
+
+	protected abstract String getPrefix();
+
+	@Override
+	public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
+		if (!shouldProcessEnvironment(environment)) {
+			return;
+		}
+
+		List<String> property = getConfigImports(environment);
+
+		if (property.stream().noneMatch(impt -> impt.contains(getPrefix()))) {
+			throw new ImportException("spring.config.import missing " + getPrefix(), true);
+		}
+	}
+
+	private List<String> getConfigImports(ConfigurableEnvironment environment) {
+		MutablePropertySources propertySources = environment.getPropertySources();
+		return propertySources.stream().filter(it -> propertySourceWithConfigImport(it, 0)).flatMap(propertySource -> {
+			List<String> configImports = new ArrayList<>();
+			Object configProperty = propertySource.getProperty(CONFIG_IMPORT_PROPERTY);
+			if (configProperty instanceof String stringProperty) {
+				configImports.add(stringProperty);
+			}
+			else {
+				configImports.addAll(Arrays.asList(getConfigImportArray(propertySource)));
+			}
+			return configImports.stream();
+		}).collect(Collectors.toList());
+	}
+
+	private boolean propertySourceWithConfigImport(PropertySource propertySource, int epoch) {
+		if (epoch > 1000) {
+			throw new IllegalStateException(
+					"The nesting of property sources is too deep. Preventing further recursion for security purposes");
+		}
+
+		if (propertySource instanceof CompositePropertySource) {
+			return ((CompositePropertySource) propertySource).getPropertySources()
+				.stream()
+				.anyMatch(it -> propertySourceWithConfigImport(it, epoch + 1));
+		}
+
+		return propertySource.containsProperty(CONFIG_IMPORT_PROPERTY)
+				|| getConfigImportArray(propertySource).length > 0;
+	}
+
+	private String[] getConfigImportArray(PropertySource propertySource) {
+		ConfigurationPropertySource configurationPropertySource = ConfigurationPropertySource.from(propertySource);
+		if (configurationPropertySource == null) {
+			return EMPTY_ARRAY;
+		}
+		Binder binder = new Binder(configurationPropertySource);
+		return binder.bind(CONFIG_IMPORT_PROPERTY, CONFIG_DATA_LOCATION_ARRAY, new BindHandler() {
+			@Override
+			public Object onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context,
+					Exception error) throws Exception {
+				ConfigDataMissingEnvironmentPostProcessor.this.LOG.info("Error binding " + CONFIG_IMPORT_PROPERTY,
+						error);
+				return EMPTY_ARRAY;
+			}
+		}).orElse(EMPTY_ARRAY);
+	}
+
+	public static class ImportException extends RuntimeException {
+
+		/**
+		 * Indicates if prefix is missing.
+		 */
+		public final boolean missingPrefix;
+
+		ImportException(String message, boolean missingPrefix) {
+			super(message);
+			this.missingPrefix = missingPrefix;
+		}
+
+	}
+
+}