Move deployment tests to system tests pipeline

Closes gh-27499

spring-boot-system-tests/spring-boot-deployment-tests/src/main/java/sample/app/DeploymentTestApplication.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2012-2020 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 sample.app;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
+
+@SpringBootApplication
+public class DeploymentTestApplication extends SpringBootServletInitializer {
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/main/java/sample/app/SampleController.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2012-2020 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 sample.app;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class SampleController {
+
+	@GetMapping("/")
+	public String hello() {
+		return "Hello World";
+	}
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/main/java/sample/autoconfig/ExampleAutoConfiguration.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-2020 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 sample.autoconfig;
+
+import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWarDeployment;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@ConditionalOnWarDeployment
+@Configuration
+public class ExampleAutoConfiguration {
+
+	@Bean
+	public TestEndpoint testEndpoint() {
+		return new TestEndpoint();
+	}
+
+	@Endpoint(id = "war")
+	static class TestEndpoint {
+
+		@ReadOperation
+		String hello() {
+			return "{\"hello\":\"world\"}";
+		}
+
+	}
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+sample.autoconfig.ExampleAutoConfiguration

spring-boot-system-tests/spring-boot-deployment-tests/src/main/resources/application.yml

@@ -0,0 +1 @@
+management.endpoints.web.exposure.include: '*'

spring-boot-system-tests/spring-boot-deployment-tests/src/systemTest/java/org/springframework/boot/deployment/AbstractDeploymentTests.java

@@ -0,0 +1,136 @@
+/*
+ * Copyright 2012-2021 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.deployment;
+
+import java.io.File;
+import java.time.Duration;
+import java.util.function.Consumer;
+
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.impl.client.StandardHttpRequestRetryHandler;
+import org.awaitility.Awaitility;
+import org.awaitility.core.ConditionTimeoutException;
+import org.junit.jupiter.api.Test;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.images.builder.ImageFromDockerfile;
+
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.web.client.RestTemplateBuilder;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Abstract class for deployment tests.
+ */
+abstract class AbstractDeploymentTests {
+
+	protected static final int DEFAULT_PORT = 8080;
+
+	@Test
+	void home() {
+		getDeployedApplication().test((rest) -> {
+			ResponseEntity<String> response = rest.getForEntity("/", String.class);
+			assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
+			assertThat(response.getBody()).isEqualTo("Hello World");
+		});
+	}
+
+	@Test
+	void health() {
+		getDeployedApplication().test((rest) -> {
+			ResponseEntity<String> response = rest.getForEntity("/actuator/health", String.class);
+			assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
+			assertThat(response.getBody()).isEqualTo("{\"status\":\"UP\"}");
+		});
+	}
+
+	@Test
+	void conditionalOnWarShouldBeTrue() {
+		getDeployedApplication().test((rest) -> {
+			ResponseEntity<String> response = rest.getForEntity("/actuator/war", String.class);
+			assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
+			assertThat(response.getBody()).isEqualTo("{\"hello\":\"world\"}");
+		});
+	}
+
+	private DeployedApplication getDeployedApplication() {
+		return new DeployedApplication(getContainer(), getPort());
+	}
+
+	protected int getPort() {
+		return DEFAULT_PORT;
+	}
+
+	abstract WarDeploymentContainer getContainer();
+
+	static final class DeployedApplication {
+
+		private final WarDeploymentContainer container;
+
+		private final int port;
+
+		DeployedApplication(WarDeploymentContainer container, int port) {
+			this.container = container;
+			this.port = port;
+		}
+
+		private void test(Consumer<TestRestTemplate> consumer) {
+			TestRestTemplate rest = new TestRestTemplate(new RestTemplateBuilder()
+					.rootUri("http://" + this.container.getHost() + ":" + this.container.getMappedPort(this.port)
+							+ "/spring-boot")
+					.requestFactory(() -> new HttpComponentsClientHttpRequestFactory(HttpClients.custom()
+							.setRetryHandler(new StandardHttpRequestRetryHandler(10, false)).build())));
+			try {
+				Awaitility.await().atMost(Duration.ofMinutes(10)).until(() -> {
+					try {
+						consumer.accept(rest);
+						return true;
+					}
+					catch (Throwable ex) {
+						return false;
+					}
+				});
+			}
+			catch (ConditionTimeoutException ex) {
+				System.out.println(this.container.getLogs());
+				throw ex;
+			}
+		}
+
+	}
+
+	static final class WarDeploymentContainer extends GenericContainer<WarDeploymentContainer> {
+
+		WarDeploymentContainer(String baseImage, String deploymentLocation, int port) {
+			super(new ImageFromDockerfile().withFileFromFile("spring-boot.war", findWarToDeploy())
+					.withDockerfileFromBuilder((builder) -> builder.from(baseImage)
+							.add("spring-boot.war", deploymentLocation + "/spring-boot.war").build()));
+			withExposedPorts(port).withStartupTimeout(Duration.ofMinutes(5)).withStartupAttempts(3);
+		}
+
+		private static File findWarToDeploy() {
+			File[] candidates = new File("build/libs").listFiles();
+			assertThat(candidates).hasSize(1);
+			return candidates[0];
+		}
+
+	}
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/systemTest/java/org/springframework/boot/deployment/OpenLibertyDeploymentIntegrationTests.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2012-2021 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.deployment;
+
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+/**
+ * Deployment tests for Open Liberty.
+ *
+ * @author Christoph Dreis
+ * @author Scott Frederick
+ */
+@Testcontainers(disabledWithoutDocker = true)
+class OpenLibertyDeploymentTests extends AbstractDeploymentTests {
+
+	private static final int PORT = 9080;
+
+	@Container
+	static WarDeploymentContainer container = new WarDeploymentContainer(
+			"openliberty/open-liberty:full-java8-openj9-ubi", "/config/dropins", PORT);
+
+	@Override
+	WarDeploymentContainer getContainer() {
+		return container;
+	}
+
+	@Override
+	protected int getPort() {
+		return PORT;
+	}
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/systemTest/java/org/springframework/boot/deployment/TomEEDeploymentIntegrationTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2021 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.deployment;
+
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+/**
+ * Deployment tests for TomEE.
+ *
+ * @author Christoph Dreis
+ * @author Scott Frederick
+ */
+@Testcontainers(disabledWithoutDocker = true)
+class TomEEDeploymentTests extends AbstractDeploymentTests {
+
+	@Container
+	static WarDeploymentContainer container = new WarDeploymentContainer("tomee:8", "/usr/local/tomee/webapps",
+			DEFAULT_PORT);
+
+	@Override
+	WarDeploymentContainer getContainer() {
+		return container;
+	}
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/systemTest/java/org/springframework/boot/deployment/TomcatDeploymentIntegrationTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2021 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.deployment;
+
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+/**
+ * Deployment tests for Tomcat.
+ *
+ * @author Christoph Dreis
+ * @author Scott Frederick
+ */
+@Testcontainers(disabledWithoutDocker = true)
+class TomcatDeploymentTests extends AbstractDeploymentTests {
+
+	@Container
+	static WarDeploymentContainer container = new WarDeploymentContainer("tomcat:9-jdk8-openjdk",
+			"/usr/local/tomcat/webapps", DEFAULT_PORT);
+
+	@Override
+	WarDeploymentContainer getContainer() {
+		return container;
+	}
+
+}

spring-boot-system-tests/spring-boot-deployment-tests/src/systemTest/java/org/springframework/boot/deployment/WildflyDeploymentIntegrationTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2021 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.deployment;
+
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+/**
+ * Deployment tests for Wildfly.
+ *
+ * @author Christoph Dreis
+ * @author Scott Frederick
+ */
+@Testcontainers(disabledWithoutDocker = true)
+class WildflyDeploymentTests extends AbstractDeploymentTests {
+
+	@Container
+	static WarDeploymentContainer container = new WarDeploymentContainer("jboss/wildfly:latest",
+			"/opt/jboss/wildfly/standalone/deployments", DEFAULT_PORT);
+
+	@Override
+	WarDeploymentContainer getContainer() {
+		return container;
+	}
+
+}