/*
 * Copyright 2014-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.restdocs.payload;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.junit.Test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.subsectionWithPath;

/**
 * Tests for {@link XmlContentHandler}.
 *
 * @author Andy Wilkinson
 */
public class XmlContentHandlerTests {

	@Test
	public void topLevelElementCanBeDocumented() {
		List<FieldDescriptor> descriptors = Arrays.asList(fieldWithPath("a").type("a").description("description"));
		String undocumentedContent = createHandler("<a>5</a>", descriptors).getUndocumentedContent();
		assertThat(undocumentedContent).isNull();
	}

	@Test
	public void nestedElementCanBeDocumentedLeavingAncestors() {
		List<FieldDescriptor> descriptors = Arrays.asList(fieldWithPath("a/b").type("b").description("description"));
		String undocumentedContent = createHandler("<a><b>5</b></a>", descriptors).getUndocumentedContent();
		assertThat(undocumentedContent).isEqualTo(String.format("<a/>%n"));
	}

	@Test
	public void fieldDescriptorDoesNotDocumentEntireSubsection() {
		List<FieldDescriptor> descriptors = Arrays.asList(fieldWithPath("a").type("a").description("description"));
		String undocumentedContent = createHandler("<a><b>5</b></a>", descriptors).getUndocumentedContent();
		assertThat(undocumentedContent).isEqualTo(String.format("<a>%n    <b>5</b>%n</a>%n"));
	}

	@Test
	public void subsectionDescriptorDocumentsEntireSubsection() {
		List<FieldDescriptor> descriptors = Arrays.asList(subsectionWithPath("a").type("a").description("description"));
		String undocumentedContent = createHandler("<a><b>5</b></a>", descriptors).getUndocumentedContent();
		assertThat(undocumentedContent).isNull();
	}

	@Test
	public void multipleElementsCanBeInDescendingOrderDocumented() {
		List<FieldDescriptor> descriptors = Arrays.asList(fieldWithPath("a").type("a").description("description"),
				fieldWithPath("a/b").type("b").description("description"));
		String undocumentedContent = createHandler("<a><b>5</b></a>", descriptors).getUndocumentedContent();
		assertThat(undocumentedContent).isNull();
	}

	@Test
	public void multipleElementsCanBeInAscendingOrderDocumented() {
		List<FieldDescriptor> descriptors = Arrays.asList(fieldWithPath("a/b").type("b").description("description"),
				fieldWithPath("a").type("a").description("description"));
		String undocumentedContent = createHandler("<a><b>5</b></a>", descriptors).getUndocumentedContent();
		assertThat(undocumentedContent).isNull();
	}

	@Test
	public void failsFastWithNonXmlContent() {
		assertThatExceptionOfType(PayloadHandlingException.class)
			.isThrownBy(() -> createHandler("non-XML content", Collections.emptyList()));
	}

	private XmlContentHandler createHandler(String xml, List<FieldDescriptor> descriptors) {
		return new XmlContentHandler(xml.getBytes(), descriptors);
	}

}
