Add consistent tests for WebFlux and WebMvc to verify correct WebJar mappings

Author: jamesmissen

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app34/SpringDocApp34Test.java

@@ -33,11 +33,14 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-@TestPropertySource(properties = "springdoc.swagger-ui.disable-swagger-default-url=true")
+@TestPropertySource(properties = {
+		"springdoc.swagger-ui.disable-swagger-default-url=true",
+		"springdoc.swagger-ui.path=/documentation/swagger-ui.html"
+})
 public class SpringDocApp34Test extends AbstractSpringDocTest {
 
 	@Test
-	void transformed_index_with_oauth() throws Exception {
+	void testWebJarResourceTransformed() {
 		EntityExchangeResult<byte[]> getResult = webTestClient.get().uri("/webjars/swagger-ui/swagger-initializer.js")
 				.exchange()
 				.expectStatus().isOk()

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app35/HelloController.java

@@ -0,0 +1,41 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-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 test.org.springdoc.ui.app35;
+
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+}

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app35/SpringDocApp35Test.java

@@ -0,0 +1,63 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-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 test.org.springdoc.ui.app35;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.http.CacheControl;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.web.reactive.server.EntityExchangeResult;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@TestPropertySource(properties = {
+		"spring.webflux.webjars-path-pattern=/webjars-pref/**",
+		"springdoc.swagger-ui.disable-swagger-default-url=true",
+		"springdoc.swagger-ui.path=/documentation/swagger-ui.html"
+})
+public class SpringDocApp35Test extends AbstractSpringDocTest {
+
+	@Test
+	void testWebJarPrefix() {
+		webTestClient.get().uri("/webjars/swagger-ui/swagger-initializer.js")
+				.exchange()
+				.expectStatus().isNotFound();
+
+		EntityExchangeResult<byte[]> getResult = webTestClient.get().uri("/webjars-pref/swagger-ui/swagger-initializer.js")
+				.exchange()
+				.expectStatus().isOk()
+				.expectHeader().cacheControl(CacheControl.noStore())
+				.expectBody().returnResult();
+
+		var responseContent = new String(getResult.getResponseBody());
+		assertFalse(responseContent.contains("https://petstore.swagger.io/v2/swagger.json"));
+		assertTrue(responseContent.contains("/v3/api-docs"));
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app36/HelloController.java

@@ -0,0 +1,41 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-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 test.org.springdoc.ui.app36;
+
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+}

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/app36/SpringDocApp36Test.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-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 test.org.springdoc.ui.app36;
+
+import org.junit.jupiter.api.Test;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+@TestPropertySource(properties = {
+		"spring.webflux.webjars-path-pattern=/webjars-pref/**",
+		"spring.web.resources.add-mappings=false",
+		"springdoc.swagger-ui.path=/documentation/swagger-ui.html"
+})
+public class SpringDocApp36Test extends AbstractSpringDocTest {
+
+	@Test
+	void testWebJarMappingDisabled() {
+		webTestClient.get().uri("/webjars/swagger-ui/swagger-initializer.js")
+				.exchange()
+				.expectStatus().isNotFound();
+
+		webTestClient.get().uri("/webjars-pref/swagger-ui/swagger-initializer.js")
+				.exchange()
+				.expectStatus().isNotFound();
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app36/HelloController.java

@@ -0,0 +1,36 @@
+/*
+ *
+ *  * Copyright 2019-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 test.org.springdoc.ui.app36;
+
+
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+}

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app36/SpringDocApp36Test.java

@@ -0,0 +1,49 @@
+/*
+ *
+ *  * Copyright 2019-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 test.org.springdoc.ui.app36;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.not;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@TestPropertySource(properties = {
+		"springdoc.swagger-ui.disable-swagger-default-url=true",
+		"springdoc.swagger-ui.path=/documentation/swagger-ui.html"
+})
+public class SpringDocApp36Test extends AbstractSpringDocTest {
+
+	@Test
+	void testWebJarResourceTransformed() throws Exception {
+		mockMvc.perform(get("/webjars/swagger-ui/swagger-initializer.js"))
+				.andExpect(status().isOk())
+				.andExpect(content().string(not(containsString("https://petstore.swagger.io/v2/swagger.json"))))
+				.andExpect(content().string(containsString("/v3/api-docs")));
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app37/HelloController.java

@@ -0,0 +1,36 @@
+/*
+ *
+ *  * Copyright 2019-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 test.org.springdoc.ui.app37;
+
+
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+}

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app37/SpringDocApp37Test.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  * Copyright 2019-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 test.org.springdoc.ui.app37;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.not;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@TestPropertySource(properties = {
+		"spring.mvc.webjars-path-pattern=/webjars-pref/**",
+		"springdoc.swagger-ui.disable-swagger-default-url=true",
+		"springdoc.swagger-ui.path=/documentation/swagger-ui.html"
+})
+public class SpringDocApp37Test extends AbstractSpringDocTest {
+
+	@Test
+	void testWebJarPrefix() throws Exception {
+		mockMvc.perform(get("/webjars/swagger-ui/swagger-initializer.js"))
+				.andExpect(status().isNotFound());
+
+		mockMvc.perform(get("/webjars-pref/swagger-ui/swagger-initializer.js"))
+				.andExpect(status().isOk())
+				.andExpect(content().string(not(containsString("https://petstore.swagger.io/v2/swagger.json"))))
+				.andExpect(content().string(containsString("/v3/api-docs")));
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}