/*
 * Copyright 2012-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.boot.integration.autoconfigure;

import java.io.FileNotFoundException;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.properties.bind.BindResult;
import org.springframework.boot.context.properties.bind.Bindable;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.origin.Origin;
import org.springframework.boot.origin.OriginLookup;
import org.springframework.boot.origin.TextResourceOrigin;
import org.springframework.boot.origin.TextResourceOrigin.Location;
import org.springframework.boot.testsupport.classpath.resources.WithResource;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.integration.context.IntegrationProperties;
import org.springframework.mock.env.MockEnvironment;
import org.springframework.test.util.ReflectionTestUtils;
import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;

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

/**
 * Tests for {@link IntegrationPropertiesEnvironmentPostProcessor}.
 *
 * @author Stephane Nicoll
 */
class IntegrationPropertiesEnvironmentPostProcessorTests {

	@Test
	@WithResource(name = "META-INF/spring.integration.properties",
			content = "spring.integration.endpoints.noAutoStartup=testService*")
	void postProcessEnvironmentAddPropertySource() {
		ConfigurableEnvironment environment = new StandardEnvironment();
		new IntegrationPropertiesEnvironmentPostProcessor().postProcessEnvironment(environment,
				mock(SpringApplication.class));
		assertThat(environment.getPropertySources().contains("META-INF/spring.integration.properties")).isTrue();
		assertThat(environment.getProperty("spring.integration.endpoint.no-auto-startup")).isEqualTo("testService*");
	}

	@Test
	@WithResource(name = "META-INF/spring.integration.properties",
			content = "spring.integration.endpoints.noAutoStartup=testService*")
	void postProcessEnvironmentAddPropertySourceLast() {
		ConfigurableEnvironment environment = new StandardEnvironment();
		environment.getPropertySources()
			.addLast(new MapPropertySource("test",
					Collections.singletonMap("spring.integration.endpoint.no-auto-startup", "another*")));
		new IntegrationPropertiesEnvironmentPostProcessor().postProcessEnvironment(environment,
				mock(SpringApplication.class));
		assertThat(environment.getPropertySources().contains("META-INF/spring.integration.properties")).isTrue();
		assertThat(environment.getProperty("spring.integration.endpoint.no-auto-startup")).isEqualTo("another*");
	}

	@Test
	void registerIntegrationPropertiesPropertySourceWithUnknownResourceThrowsException() {
		ConfigurableEnvironment environment = new StandardEnvironment();
		ClassPathResource unknown = new ClassPathResource("does-not-exist.properties", getClass());
		assertThatIllegalStateException()
			.isThrownBy(() -> new IntegrationPropertiesEnvironmentPostProcessor()
				.registerIntegrationPropertiesPropertySource(environment, unknown))
			.withCauseInstanceOf(FileNotFoundException.class)
			.withMessageContaining(unknown.toString());
	}

	@Test
	void registerIntegrationPropertiesPropertySourceWithResourceAddPropertySource() {
		ConfigurableEnvironment environment = new StandardEnvironment();
		new IntegrationPropertiesEnvironmentPostProcessor().registerIntegrationPropertiesPropertySource(environment,
				new ClassPathResource("spring.integration.properties", getClass()));
		assertThat(environment.getProperty("spring.integration.channel.auto-create", Boolean.class)).isFalse();
		assertThat(environment.getProperty("spring.integration.channel.max-unicast-subscribers", Integer.class))
			.isEqualTo(4);
		assertThat(environment.getProperty("spring.integration.channel.max-broadcast-subscribers", Integer.class))
			.isEqualTo(6);
		assertThat(environment.getProperty("spring.integration.error.require-subscribers", Boolean.class)).isFalse();
		assertThat(environment.getProperty("spring.integration.error.ignore-failures", Boolean.class)).isFalse();
		assertThat(environment.getProperty("spring.integration.endpoint.throw-exception-on-late-reply", Boolean.class))
			.isTrue();
		assertThat(environment.getProperty("spring.integration.endpoint.read-only-headers", String.class))
			.isEqualTo("header1,header2");
		assertThat(environment.getProperty("spring.integration.endpoint.no-auto-startup", String.class))
			.isEqualTo("testService,anotherService");
	}

	@Test
	@SuppressWarnings("unchecked")
	void registerIntegrationPropertiesPropertySourceWithResourceCanRetrieveOrigin() {
		ConfigurableEnvironment environment = new StandardEnvironment();
		ClassPathResource resource = new ClassPathResource("spring.integration.properties", getClass());
		new IntegrationPropertiesEnvironmentPostProcessor().registerIntegrationPropertiesPropertySource(environment,
				resource);
		PropertySource<?> ps = environment.getPropertySources().get("META-INF/spring.integration.properties");
		assertThat(ps).isInstanceOf(OriginLookup.class);
		OriginLookup<String> originLookup = (OriginLookup<String>) ps;
		assertThat(originLookup.getOrigin("spring.integration.channel.auto-create"))
			.satisfies(textOrigin(resource, 0, 39));
		assertThat(originLookup.getOrigin("spring.integration.channel.max-unicast-subscribers"))
			.satisfies(textOrigin(resource, 1, 50));
		assertThat(originLookup.getOrigin("spring.integration.channel.max-broadcast-subscribers"))
			.satisfies(textOrigin(resource, 2, 52));
	}

	@Test
	@SuppressWarnings("unchecked")
	void hasMappingsForAllMappableProperties() throws Exception {
		Class<?> propertySource = ClassUtils.forName("%s.IntegrationPropertiesPropertySource"
			.formatted(IntegrationPropertiesEnvironmentPostProcessor.class.getName()), getClass().getClassLoader());
		Map<String, String> mappings = (Map<String, String>) ReflectionTestUtils.getField(propertySource,
				"KEYS_MAPPING");
		assertThat(mappings).isNotNull();
		assertThat(mappings.values()).containsExactlyInAnyOrderElementsOf(integrationPropertyNames());
	}

	private static List<String> integrationPropertyNames() {
		List<String> propertiesToMap = new ArrayList<>();
		ReflectionUtils.doWithFields(IntegrationProperties.class, (field) -> {
			String value = (String) ReflectionUtils.getField(field, null);
			assertThat(value).isNotNull();
			if (value.startsWith(IntegrationProperties.INTEGRATION_PROPERTIES_PREFIX)
					&& value.length() > IntegrationProperties.INTEGRATION_PROPERTIES_PREFIX.length()) {
				propertiesToMap.add(value);
			}
		}, (field) -> Modifier.isStatic(field.getModifiers()) && field.getType().equals(String.class));
		propertiesToMap.remove(IntegrationProperties.TASK_SCHEDULER_POOL_SIZE);
		return propertiesToMap;
	}

	@MethodSource("mappedConfigurationProperties")
	@ParameterizedTest
	void mappedPropertiesExistOnBootsIntegrationProperties(String mapping) {
		Bindable<org.springframework.boot.integration.autoconfigure.IntegrationProperties> bindable = Bindable
			.of(org.springframework.boot.integration.autoconfigure.IntegrationProperties.class);
		MockEnvironment environment = new MockEnvironment().withProperty(mapping,
				(mapping.contains("max") || mapping.contains("timeout")) ? "1" : "true");
		BindResult<org.springframework.boot.integration.autoconfigure.IntegrationProperties> result = Binder
			.get(environment)
			.bind("spring.integration", bindable);
		assertThat(result.isBound()).isTrue();
	}

	@SuppressWarnings("unchecked")
	private static Collection<String> mappedConfigurationProperties() {
		try {
			Class<?> propertySource = ClassUtils.forName("%s.IntegrationPropertiesPropertySource"
				.formatted(IntegrationPropertiesEnvironmentPostProcessor.class.getName()), null);
			Map<String, String> mappings = (Map<String, String>) ReflectionTestUtils.getField(propertySource,
					"KEYS_MAPPING");
			assertThat(mappings).isNotNull();
			return mappings.keySet();
		}
		catch (Exception ex) {
			throw new RuntimeException(ex);
		}
	}

	private Consumer<Origin> textOrigin(Resource resource, int line, int column) {
		return (origin) -> {
			assertThat(origin).isInstanceOf(TextResourceOrigin.class);
			TextResourceOrigin textOrigin = (TextResourceOrigin) origin;
			assertThat(textOrigin.getResource()).isEqualTo(resource);
			Location location = textOrigin.getLocation();
			assertThat(location).isNotNull();
			assertThat(location.getLine()).isEqualTo(line);
			assertThat(location.getColumn()).isEqualTo(column);
		};
	}

}
