Support HtmlUnit and Selenium localhost resolution

Provide variants of `WebClient` and `WebConnectionHtmlUnitDriver` that
automatically resolve relative URLs to "localhost:${local.server.port}".

Fixes gh-5472

spring-boot-dependencies/pom.xml

@@ -84,6 +84,7 @@
 		<hikaricp-java6.version>2.3.13</hikaricp-java6.version>
 		<hornetq.version>2.4.7.Final</hornetq.version>
 		<hsqldb.version>2.3.3</hsqldb.version>
+		<htmlunit.version>2.19</htmlunit.version>
 		<httpasyncclient.version>4.1.1</httpasyncclient.version>
 		<httpclient.version>4.5.1</httpclient.version>
 		<httpcore.version>4.4.4</httpcore.version>
@@ -124,6 +125,7 @@
 		<postgresql.version>9.4.1208.jre7</postgresql.version>
 		<reactor.version>2.0.7.RELEASE</reactor.version>
 		<reactor-spring.version>2.0.7.RELEASE</reactor-spring.version>
+		<selenium.version>2.52.0</selenium.version>
 		<sendgrid.version>2.2.2</sendgrid.version>
 		<servlet-api.version>3.1.0</servlet-api.version>
 		<simple-json.version>1.1.1</simple-json.version>
@@ -932,6 +934,11 @@
 				<artifactId>ehcache</artifactId>
 				<version>${ehcache.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>net.sourceforge.htmlunit</groupId>
+				<artifactId>htmlunit</artifactId>
+				<version>${htmlunit.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>net.sourceforge.jtds</groupId>
 				<artifactId>jtds</artifactId>
@@ -1758,6 +1765,11 @@
 				<artifactId>lombok</artifactId>
 				<version>${lombok.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>org.seleniumhq.selenium</groupId>
+				<artifactId>selenium-htmlunit-driver</artifactId>
+				<version>${selenium.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>org.skyscreamer</groupId>
 				<artifactId>jsonassert</artifactId>

spring-boot-test/pom.xml

@@ -75,6 +75,11 @@
 			<artifactId>jsonassert</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.seleniumhq.selenium</groupId>
+			<artifactId>selenium-htmlunit-driver</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework</groupId>
 			<artifactId>spring-test</artifactId>
@@ -86,8 +91,8 @@
 			<optional>true</optional>
 		</dependency>
 		<dependency>
-			<groupId>junit</groupId>
-			<artifactId>junit</artifactId>
+			<groupId>net.sourceforge.htmlunit</groupId>
+			<artifactId>htmlunit</artifactId>
 			<optional>true</optional>
 		</dependency>
 		<!-- Test -->

spring-boot-test/src/main/java/org/springframework/boot/test/web/htmlunit/LocalHostWebClient.java

+/*
+ * Copyright 2012-2016 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.htmlunit;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+
+import com.gargoylesoftware.htmlunit.FailingHttpStatusCodeException;
+import com.gargoylesoftware.htmlunit.Page;
+import com.gargoylesoftware.htmlunit.WebClient;
+
+import org.springframework.core.env.Environment;
+import org.springframework.util.Assert;
+
+/**
+ * {@link WebClient} will automatically prefix relative URLs with
+ * <code>localhost:$&#123;local.server.port&#125;</code>.
+ *
+ * @author Phillip Webb
+ * @since 1.4.0
+ */
+public class LocalHostWebClient extends WebClient {
+
+	private final Environment environment;
+
+	public LocalHostWebClient(Environment environment) {
+		Assert.notNull(environment, "Environment must not be null");
+		this.environment = environment;
+	}
+
+	@Override
+	public <P extends Page> P getPage(String url)
+			throws IOException, FailingHttpStatusCodeException, MalformedURLException {
+		if (url.startsWith("/")) {
+			String port = this.environment.getProperty("local.server.port", "8080");
+			url = "http://localhost:" + port + url;
+		}
+		return super.getPage(url);
+	}
+
+}

spring-boot-test/src/main/java/org/springframework/boot/test/web/htmlunit/package-info.java

+/*
+ * Copyright 2012-2016 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.
+ */
+
+/**
+ * HtmlUnit support classes.
+ */
+package org.springframework.boot.test.web.htmlunit;

spring-boot-test/src/main/java/org/springframework/boot/test/web/htmlunit/webdriver/LocalHostWebConnectionHtmlUnitDriver.java

+/*
+ * Copyright 2012-2016 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.htmlunit.webdriver;
+
+import com.gargoylesoftware.htmlunit.BrowserVersion;
+import org.openqa.selenium.Capabilities;
+
+import org.springframework.core.env.Environment;
+import org.springframework.test.web.servlet.htmlunit.webdriver.WebConnectionHtmlUnitDriver;
+import org.springframework.util.Assert;
+
+/**
+ * {@link LocalHostWebConnectionHtmlUnitDriver} will automatically prefix relative URLs
+ * with <code>localhost:$&#123;local.server.port&#125;</code>.
+ *
+ * @author Phillip Webb
+ * @since 1.4.0
+ */
+public class LocalHostWebConnectionHtmlUnitDriver extends WebConnectionHtmlUnitDriver {
+
+	private final Environment environment;
+
+	public LocalHostWebConnectionHtmlUnitDriver(Environment environment) {
+		Assert.notNull(environment, "Environment must not be null");
+		this.environment = environment;
+	}
+
+	public LocalHostWebConnectionHtmlUnitDriver(Environment environment,
+			boolean enableJavascript) {
+		super(enableJavascript);
+		Assert.notNull(environment, "Environment must not be null");
+		this.environment = environment;
+	}
+
+	public LocalHostWebConnectionHtmlUnitDriver(Environment environment,
+			BrowserVersion browserVersion) {
+		super(browserVersion);
+		Assert.notNull(environment, "Environment must not be null");
+		this.environment = environment;
+	}
+
+	public LocalHostWebConnectionHtmlUnitDriver(Environment environment,
+			Capabilities capabilities) {
+		super(capabilities);
+		Assert.notNull(environment, "Environment must not be null");
+		this.environment = environment;
+	}
+
+	@Override
+	public void get(String url) {
+		if (url.startsWith("/")) {
+			String port = this.environment.getProperty("local.server.port", "8080");
+			url = "http://localhost:" + port + url;
+		}
+		super.get(url);
+	}
+
+}

spring-boot-test/src/main/java/org/springframework/boot/test/web/htmlunit/webdriver/package-info.java

+/*
+ * Copyright 2012-2016 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.
+ */
+
+/**
+ * Selenium support classes.
+ */
+package org.springframework.boot.test.web.htmlunit.webdriver;

spring-boot-test/src/test/java/org/springframework/boot/test/web/htmlunit/LocalHostWebClientTests.java

+/*
+ * Copyright 2012-2016 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.htmlunit;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+
+import com.gargoylesoftware.htmlunit.StringWebResponse;
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.gargoylesoftware.htmlunit.WebConnection;
+import com.gargoylesoftware.htmlunit.WebRequest;
+import com.gargoylesoftware.htmlunit.WebResponse;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.MockitoAnnotations;
+
+import org.springframework.mock.env.MockEnvironment;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+
+/**
+ * Tests for {@link LocalHostWebClient}.
+ *
+ * @author Phillip Webb
+ */
+@SuppressWarnings("resource")
+public class LocalHostWebClientTests {
+
+	@Rule
+	public ExpectedException thrown = ExpectedException.none();
+
+	@Captor
+	private ArgumentCaptor<WebRequest> requestCaptor;
+
+	public LocalHostWebClientTests() {
+		MockitoAnnotations.initMocks(this);
+	}
+
+	@Test
+	public void createWhenEnvironmentIsNullWillThrowException() throws Exception {
+		this.thrown.expect(IllegalArgumentException.class);
+		this.thrown.expectMessage("Environment must not be null");
+		new LocalHostWebClient(null);
+	}
+
+	@Test
+	public void getPageWhenUrlIsRelativeAndNoPortWillUseLocalhost8080() throws Exception {
+		MockEnvironment environment = new MockEnvironment();
+		WebClient client = new LocalHostWebClient(environment);
+		WebConnection connection = mockConnection();
+		client.setWebConnection(connection);
+		client.getPage("/test");
+		verify(connection).getResponse(this.requestCaptor.capture());
+		assertThat(this.requestCaptor.getValue().getUrl())
+				.isEqualTo(new URL("http://localhost:8080/test"));
+	}
+
+	@Test
+	public void getPageWhenUrlIsRelativeAndHasPortWillUseLocalhostPort()
+			throws Exception {
+		MockEnvironment environment = new MockEnvironment();
+		environment.setProperty("local.server.port", "8181");
+		WebClient client = new LocalHostWebClient(environment);
+		WebConnection connection = mockConnection();
+		client.setWebConnection(connection);
+		client.getPage("/test");
+		verify(connection).getResponse(this.requestCaptor.capture());
+		assertThat(this.requestCaptor.getValue().getUrl())
+				.isEqualTo(new URL("http://localhost:8181/test"));
+	}
+
+	private WebConnection mockConnection() throws MalformedURLException, IOException {
+		WebConnection connection = mock(WebConnection.class);
+		WebResponse response = new StringWebResponse("test", new URL("http://localhost"));
+		given(connection.getResponse((WebRequest) any())).willReturn(response);
+		return connection;
+	}
+
+}

spring-boot-test/src/test/java/org/springframework/boot/test/web/htmlunit/webdriver/LocalHostWebConnectionHtmlUnitDriverTests.java

+/*
+ * Copyright 2012-2016 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.htmlunit.webdriver;
+
+import java.net.URL;
+
+import com.gargoylesoftware.htmlunit.BrowserVersion;
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.gargoylesoftware.htmlunit.WebClientOptions;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.openqa.selenium.Capabilities;
+
+import org.springframework.core.env.Environment;
+import org.springframework.mock.env.MockEnvironment;
+
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+
+/**
+ * Tests for {@link LocalHostWebConnectionHtmlUnitDriver}.
+ *
+ * @author Phillip Webb
+ */
+public class LocalHostWebConnectionHtmlUnitDriverTests {
+
+	@Rule
+	public ExpectedException thrown = ExpectedException.none();
+
+	@Mock
+	private WebClient webClient;
+
+	public LocalHostWebConnectionHtmlUnitDriverTests() {
+		MockitoAnnotations.initMocks(this);
+		given(this.webClient.getOptions()).willReturn(new WebClientOptions());
+	}
+
+	@Test
+	public void createWhenEnvironmentIsNullWillThrowException() throws Exception {
+		this.thrown.expect(IllegalArgumentException.class);
+		this.thrown.expectMessage("Environment must not be null");
+		new LocalHostWebConnectionHtmlUnitDriver(null);
+	}
+
+	@Test
+	public void createWithJavascriptFlagWhenEnvironmentIsNullWillThrowException()
+			throws Exception {
+		this.thrown.expect(IllegalArgumentException.class);
+		this.thrown.expectMessage("Environment must not be null");
+		new LocalHostWebConnectionHtmlUnitDriver(null, true);
+	}
+
+	@Test
+	public void createWithBrowserVersionWhenEnvironmentIsNullWillThrowException()
+			throws Exception {
+		this.thrown.expect(IllegalArgumentException.class);
+		this.thrown.expectMessage("Environment must not be null");
+		new LocalHostWebConnectionHtmlUnitDriver(null, BrowserVersion.CHROME);
+	}
+
+	@Test
+	public void createWithCapabilitiesWhenEnvironmentIsNullWillThrowException()
+			throws Exception {
+		this.thrown.expect(IllegalArgumentException.class);
+		this.thrown.expectMessage("Environment must not be null");
+		new LocalHostWebConnectionHtmlUnitDriver(null, mock(Capabilities.class));
+	}
+
+	@Test
+	public void getPageWhenUrlIsRelativeAndNoPortWillUseLocalhost8080() throws Exception {
+		MockEnvironment environment = new MockEnvironment();
+		LocalHostWebConnectionHtmlUnitDriver driver = new TestLocalHostWebConnectionHtmlUnitDriver(
+				environment);
+		driver.get("/test");
+		verify(this.webClient).getPage(new URL("http://localhost:8080/test"));
+	}
+
+	@Test
+	public void getWhenUrlIsRelativeAndHasPortWillUseLocalhostPort() throws Exception {
+		MockEnvironment environment = new MockEnvironment();
+		environment.setProperty("local.server.port", "8181");
+		LocalHostWebConnectionHtmlUnitDriver driver = new TestLocalHostWebConnectionHtmlUnitDriver(
+				environment);
+		driver.get("/test");
+		verify(this.webClient).getPage(new URL("http://localhost:8181/test"));
+	}
+
+	public class TestLocalHostWebConnectionHtmlUnitDriver
+			extends LocalHostWebConnectionHtmlUnitDriver {
+
+		public TestLocalHostWebConnectionHtmlUnitDriver(Environment environment) {
+			super(environment);
+		}
+
+		@Override
+		public WebClient getWebClient() {
+			return LocalHostWebConnectionHtmlUnitDriverTests.this.webClient;
+		}
+
+	}
+
+}