/*
 * Copyright 2012-2024 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.autoconfigure.orm.jpa;

import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Supplier;

import org.hibernate.boot.model.naming.CamelCaseToUnderscoresNamingStrategy;
import org.hibernate.cfg.MappingSettings;
import org.hibernate.cfg.PersistenceSettings;
import org.hibernate.cfg.SchemaToolingSettings;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.orm.jpa.hibernate.SpringImplicitNamingStrategy;
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.boot.test.context.runner.ContextConsumer;
import org.springframework.context.annotation.Configuration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.entry;
import static org.mockito.BDDMockito.then;
import static org.mockito.Mockito.never;

/**
 * Tests for {@link HibernateProperties}.
 *
 * @author Stephane Nicoll
 * @author Artsiom Yudovin
 * @author Chris Bono
 */
@ExtendWith(MockitoExtension.class)
class HibernatePropertiesTests {

	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
		.withUserConfiguration(TestConfiguration.class);

	@Mock
	private Supplier<String> ddlAutoSupplier;

	@Test
	void noCustomNamingStrategy() {
		this.contextRunner.run(assertHibernateProperties((hibernateProperties) -> {
			assertThat(hibernateProperties).doesNotContainKeys("hibernate.ejb.naming_strategy");
			assertThat(hibernateProperties).containsEntry(MappingSettings.PHYSICAL_NAMING_STRATEGY,
					CamelCaseToUnderscoresNamingStrategy.class.getName());
			assertThat(hibernateProperties).containsEntry(MappingSettings.IMPLICIT_NAMING_STRATEGY,
					SpringImplicitNamingStrategy.class.getName());
		}));
	}

	@Test
	void hibernate5CustomNamingStrategies() {
		this.contextRunner
			.withPropertyValues("spring.jpa.hibernate.naming.implicit-strategy:com.example.Implicit",
					"spring.jpa.hibernate.naming.physical-strategy:com.example.Physical")
			.run(assertHibernateProperties((hibernateProperties) -> {
				assertThat(hibernateProperties).contains(
						entry(MappingSettings.IMPLICIT_NAMING_STRATEGY, "com.example.Implicit"),
						entry(MappingSettings.PHYSICAL_NAMING_STRATEGY, "com.example.Physical"));
				assertThat(hibernateProperties).doesNotContainKeys("hibernate.ejb.naming_strategy");
			}));
	}

	@Test
	void hibernate5CustomNamingStrategiesViaJpaProperties() {
		this.contextRunner
			.withPropertyValues("spring.jpa.properties.hibernate.implicit_naming_strategy:com.example.Implicit",
					"spring.jpa.properties.hibernate.physical_naming_strategy:com.example.Physical")
			.run(assertHibernateProperties((hibernateProperties) -> {
				// You can override them as we don't provide any default
				assertThat(hibernateProperties).contains(
						entry(MappingSettings.IMPLICIT_NAMING_STRATEGY, "com.example.Implicit"),
						entry(MappingSettings.PHYSICAL_NAMING_STRATEGY, "com.example.Physical"));
				assertThat(hibernateProperties).doesNotContainKeys("hibernate.ejb.naming_strategy");
			}));
	}

	@Test
	void scannerUsesDisabledScannerByDefault() {
		this.contextRunner.run(assertHibernateProperties((hibernateProperties) -> assertThat(hibernateProperties)
			.containsEntry(PersistenceSettings.SCANNER, "org.hibernate.boot.archive.scan.internal.DisabledScanner")));
	}

	@Test
	void scannerCanBeCustomized() {
		this.contextRunner.withPropertyValues(
				"spring.jpa.properties.hibernate.archive.scanner:org.hibernate.boot.archive.scan.internal.StandardScanner")
			.run(assertHibernateProperties((hibernateProperties) -> assertThat(hibernateProperties).containsEntry(
					PersistenceSettings.SCANNER, "org.hibernate.boot.archive.scan.internal.StandardScanner")));
	}

	@Test
	void defaultDdlAutoIsNotInvokedIfPropertyIsSet() {
		this.contextRunner.withPropertyValues("spring.jpa.hibernate.ddl-auto=validate")
			.run(assertDefaultDdlAutoNotInvoked("validate"));
	}

	@Test
	void defaultDdlAutoIsNotInvokedIfHibernateSpecificPropertyIsSet() {
		this.contextRunner.withPropertyValues("spring.jpa.properties.hibernate.hbm2ddl.auto=create")
			.run(assertDefaultDdlAutoNotInvoked("create"));
	}

	@Test
	void defaultDdlAutoIsNotInvokedAndDdlAutoIsNotSetIfJpaDbActionPropertyIsSet() {
		this.contextRunner
			.withPropertyValues(
					"spring.jpa.properties.jakarta.persistence.schema-generation.database.action=drop-and-create")
			.run(assertHibernateProperties((hibernateProperties) -> {
				assertThat(hibernateProperties).doesNotContainKey(SchemaToolingSettings.HBM2DDL_AUTO);
				assertThat(hibernateProperties).containsEntry(SchemaToolingSettings.JAKARTA_HBM2DDL_DATABASE_ACTION,
						"drop-and-create");
				then(this.ddlAutoSupplier).should(never()).get();
			}));
	}

	private ContextConsumer<AssertableApplicationContext> assertDefaultDdlAutoNotInvoked(String expectedDdlAuto) {
		return assertHibernateProperties((hibernateProperties) -> {
			assertThat(hibernateProperties).containsEntry(SchemaToolingSettings.HBM2DDL_AUTO, expectedDdlAuto);
			then(this.ddlAutoSupplier).should(never()).get();
		});
	}

	private ContextConsumer<AssertableApplicationContext> assertHibernateProperties(
			Consumer<Map<String, Object>> consumer) {
		return (context) -> {
			assertThat(context).hasSingleBean(JpaProperties.class);
			assertThat(context).hasSingleBean(HibernateProperties.class);
			Map<String, Object> hibernateProperties = context.getBean(HibernateProperties.class)
				.determineHibernateProperties(context.getBean(JpaProperties.class).getProperties(),
						new HibernateSettings().ddlAuto(this.ddlAutoSupplier));
			consumer.accept(hibernateProperties);
		};
	}

	@Configuration(proxyBeanMethods = false)
	@EnableConfigurationProperties({ JpaProperties.class, HibernateProperties.class })
	static class TestConfiguration {

	}

}
