/*
 * 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.request;

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

import org.junit.Rule;
import org.junit.Test;

import org.springframework.restdocs.snippet.SnippetException;
import org.springframework.restdocs.templates.TemplateFormats;
import org.springframework.restdocs.testfixtures.OperationBuilder;

import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.springframework.restdocs.request.RequestDocumentation.partWithName;

/**
 * Tests for failures when rendering {@link RequestPartsSnippet} due to missing or
 * undocumented request parts.
 *
 * @author Andy Wilkinson
 */
public class RequestPartsSnippetFailureTests {

	@Rule
	public OperationBuilder operationBuilder = new OperationBuilder(TemplateFormats.asciidoctor());

	@Test
	public void undocumentedPart() {
		assertThatExceptionOfType(SnippetException.class)
			.isThrownBy(() -> new RequestPartsSnippet(Collections.<RequestPartDescriptor>emptyList())
				.document(this.operationBuilder.request("http://localhost").part("a", "alpha".getBytes()).build()))
			.withMessage("Request parts with the following names were not documented: [a]");
	}

	@Test
	public void missingPart() {
		assertThatExceptionOfType(SnippetException.class)
			.isThrownBy(() -> new RequestPartsSnippet(Arrays.asList(partWithName("a").description("one")))
				.document(this.operationBuilder.request("http://localhost").build()))
			.withMessage("Request parts with the following names were not found in the request: [a]");
	}

	@Test
	public void undocumentedAndMissingParts() {
		assertThatExceptionOfType(SnippetException.class)
			.isThrownBy(() -> new RequestPartsSnippet(Arrays.asList(partWithName("a").description("one")))
				.document(this.operationBuilder.request("http://localhost").part("b", "bravo".getBytes()).build()))
			.withMessage("Request parts with the following names were not documented: [b]. Request parts with the"
					+ " following names were not found in the request: [a]");
	}

}
