RootUriRequestExpectationManagerTests.java

/*
 * Copyright 2012-2017 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
 *
 *      http://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.test.web.client;

import java.net.URI;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.http.client.ClientHttpRequest;
import org.springframework.http.client.support.HttpRequestWrapper;
import org.springframework.test.web.client.ExpectedCount;
import org.springframework.test.web.client.MockRestServiceServer;
import org.springframework.test.web.client.RequestExpectationManager;
import org.springframework.test.web.client.RequestMatcher;
import org.springframework.web.client.RestTemplate;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

/**
 * Tests for {@link RootUriRequestExpectationManager}.
 *
 * @author Phillip Webb
 */
public class RootUriRequestExpectationManagerTests {

	@Rule
	public ExpectedException thrown = ExpectedException.none();

	private String uri = "http://example.com";

	@Mock
	private RequestExpectationManager delegate;

	private RootUriRequestExpectationManager manager;

	@Captor
	private ArgumentCaptor<ClientHttpRequest> requestCaptor;

	@Before
	public void setup() {
		MockitoAnnotations.initMocks(this);
		this.manager = new RootUriRequestExpectationManager(this.uri, this.delegate);
	}

	@Test
	public void createWhenRootUriIsNullShouldThrowException() throws Exception {
		this.thrown.expect(IllegalArgumentException.class);
		this.thrown.expectMessage("RootUri must not be null");
		new RootUriRequestExpectationManager(null, this.delegate);
	}

	@Test
	public void createWhenExpectationManagerIsNullShouldThrowException()
			throws Exception {
		this.thrown.expect(IllegalArgumentException.class);
		this.thrown.expectMessage("ExpectationManager must not be null");
		new RootUriRequestExpectationManager(this.uri, null);
	}

	@Test
	public void expectRequestShouldDelegateToExpectationManager() throws Exception {
		ExpectedCount count = mock(ExpectedCount.class);
		RequestMatcher requestMatcher = mock(RequestMatcher.class);
		this.manager.expectRequest(count, requestMatcher);
		verify(this.delegate).expectRequest(count, requestMatcher);
	}

	@Test
	public void validateRequestWhenUriDoesNotStartWithRootUriShouldDelegateToExpectationManager()
			throws Exception {
		ClientHttpRequest request = mock(ClientHttpRequest.class);
		given(request.getURI()).willReturn(new URI("http://spring.io/test"));
		this.manager.validateRequest(request);
		verify(this.delegate).validateRequest(request);
	}

	@Test
	public void validateRequestWhenUriStartsWithRootUriShouldReplaceUri()
			throws Exception {
		ClientHttpRequest request = mock(ClientHttpRequest.class);
		given(request.getURI()).willReturn(new URI(this.uri + "/hello"));
		this.manager.validateRequest(request);
		verify(this.delegate).validateRequest(this.requestCaptor.capture());
		HttpRequestWrapper actual = (HttpRequestWrapper) this.requestCaptor.getValue();
		assertThat(actual.getRequest()).isSameAs(request);
		assertThat(actual.getURI()).isEqualTo(new URI("/hello"));
	}

	@Test
	public void validateRequestWhenRequestUriAssertionIsThrownShouldReplaceUriInMessage()
			throws Exception {
		ClientHttpRequest request = mock(ClientHttpRequest.class);
		given(request.getURI()).willReturn(new URI(this.uri + "/hello"));
		given(this.delegate.validateRequest((ClientHttpRequest) any()))
				.willThrow(new AssertionError(
						"Request URI expected:</hello> was:<http://example.com/bad>"));
		this.thrown.expect(AssertionError.class);
		this.thrown.expectMessage("Request URI expected:<http://example.com/hello>");
		this.manager.validateRequest(request);
	}

	@Test
	public void resetRequestShouldDelegateToExpectationManager() throws Exception {
		this.manager.reset();
		verify(this.delegate).reset();
	}

	@Test
	public void bindToShouldReturnMockRestServiceServer() throws Exception {
		RestTemplate restTemplate = new RestTemplateBuilder().build();
		MockRestServiceServer bound = RootUriRequestExpectationManager
				.bindTo(restTemplate);
		assertThat(bound).isNotNull();
	}

	@Test
	public void bindToWithExpectationManagerShouldReturnMockRestServiceServer()
			throws Exception {
		RestTemplate restTemplate = new RestTemplateBuilder().build();
		MockRestServiceServer bound = RootUriRequestExpectationManager
				.bindTo(restTemplate, this.delegate);
		assertThat(bound).isNotNull();
	}

	@Test
	public void forRestTemplateWhenUsingRootUriTemplateHandlerShouldReturnRootUriRequestExpectationManager()
			throws Exception {
		RestTemplate restTemplate = new RestTemplateBuilder().rootUri(this.uri).build();
		RequestExpectationManager actual = RootUriRequestExpectationManager
				.forRestTemplate(restTemplate, this.delegate);
		assertThat(actual).isInstanceOf(RootUriRequestExpectationManager.class);
		assertThat(actual).extracting("rootUri").containsExactly(this.uri);
	}

	@Test
	public void forRestTemplateWhenNotUsingRootUriTemplateHandlerShouldReturnOriginalRequestExpectationManager()
			throws Exception {
		RestTemplate restTemplate = new RestTemplateBuilder().build();
		RequestExpectationManager actual = RootUriRequestExpectationManager
				.forRestTemplate(restTemplate, this.delegate);
		assertThat(actual).isSameAs(this.delegate);
	}

	@Test
	public void boundRestTemplateShouldPrefixRootUri() {
		RestTemplate restTemplate = new RestTemplateBuilder()
				.rootUri("http://example.com").build();
		MockRestServiceServer server = RootUriRequestExpectationManager
				.bindTo(restTemplate);
		server.expect(requestTo("/hello")).andRespond(withSuccess());
		restTemplate.getForEntity("/hello", String.class);
	}

	@Test
	public void boundRestTemplateWhenUrlIncludesDomainShouldNotPrefixRootUri() {
		RestTemplate restTemplate = new RestTemplateBuilder()
				.rootUri("http://example.com").build();
		MockRestServiceServer server = RootUriRequestExpectationManager
				.bindTo(restTemplate);
		server.expect(requestTo("/hello")).andRespond(withSuccess());
		this.thrown.expect(AssertionError.class);
		this.thrown.expectMessage(
				"expected:<http://example.com/hello> but was:<http://spring.io/hello>");
		restTemplate.getForEntity("http://spring.io/hello", String.class);
	}

}