/*
 * Copyright 2012-2023 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.actuate.autoconfigure.endpoint.web.documentation;

import java.util.Collections;

import org.junit.jupiter.api.Test;

import org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint;
import org.springframework.boot.actuate.endpoint.Show;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;

import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
import static org.springframework.restdocs.payload.PayloadDocumentation.subsectionWithPath;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

/**
 * Tests for generating documentation describing
 * {@link ConfigurationPropertiesReportEndpoint}.
 *
 * @author Andy Wilkinson
 * @author Chris Bono
 */
class ConfigurationPropertiesReportEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {

	@Test
	void configProps() throws Exception {
		this.mockMvc.perform(get("/actuator/configprops"))
			.andExpect(status().isOk())
			.andDo(MockMvcRestDocumentation.document("configprops/all",
					preprocessResponse(limit("contexts", getApplicationContext().getId(), "beans")),
					responseFields(fieldWithPath("contexts").description("Application contexts keyed by id."),
							fieldWithPath("contexts.*.beans.*")
								.description("`@ConfigurationProperties` beans keyed by bean name."),
							fieldWithPath("contexts.*.beans.*.prefix")
								.description("Prefix applied to the names of the bean's properties."),
							subsectionWithPath("contexts.*.beans.*.properties")
								.description("Properties of the bean as name-value pairs."),
							subsectionWithPath("contexts.*.beans.*.inputs").description(
									"Origin and value of the configuration property used when binding to this bean."),
							parentIdField())));
	}

	@Test
	void configPropsFilterByPrefix() throws Exception {
		this.mockMvc.perform(get("/actuator/configprops/spring.jackson"))
			.andExpect(status().isOk())
			.andDo(MockMvcRestDocumentation.document("configprops/prefixed",
					preprocessResponse(limit("contexts", getApplicationContext().getId(), "beans")),
					responseFields(fieldWithPath("contexts").description("Application contexts keyed by id."),
							fieldWithPath("contexts.*.beans.*")
								.description("`@ConfigurationProperties` beans keyed by bean name."),
							fieldWithPath("contexts.*.beans.*.prefix")
								.description("Prefix applied to the names of the bean's properties."),
							subsectionWithPath("contexts.*.beans.*.properties")
								.description("Properties of the bean as name-value pairs."),
							subsectionWithPath("contexts.*.beans.*.inputs").description(
									"Origin and value of the configuration property used when binding to this bean."),
							parentIdField())));
	}

	@Configuration(proxyBeanMethods = false)
	@Import(BaseDocumentationConfiguration.class)
	static class TestConfiguration {

		@Bean
		ConfigurationPropertiesReportEndpoint endpoint() {
			return new ConfigurationPropertiesReportEndpoint(Collections.emptyList(), Show.ALWAYS);
		}

	}

}
