Added tests. fixes #320

Author: bnasslahsen

springdoc-openapi-ui/src/main/java/org/springdoc/ui/SwaggerWelcome.java

@@ -15,6 +15,7 @@
 import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
 import org.springframework.web.util.UriComponentsBuilder;
 
+import javax.annotation.PostConstruct;
 import javax.servlet.http.HttpServletRequest;
 import java.util.Map;
 
@@ -39,10 +40,22 @@ class SwaggerWelcome {
     @Autowired
     private SwaggerUiConfigProperties swaggerUiConfig;
 
+    private String uiRootPath;
+
+    @PostConstruct
+    public void calculateUiRootPath() {
+        StringBuilder sbUrl = new StringBuilder();
+        if (StringUtils.isNotBlank(mvcServletPath))
+            sbUrl.append(mvcServletPath);
+        if (swaggerPath.contains(DEFAULT_PATH_SEPARATOR))
+            sbUrl.append(swaggerPath.substring(0, swaggerPath.lastIndexOf(DEFAULT_PATH_SEPARATOR)));
+        this.uiRootPath=sbUrl.toString();
+    }
+
     @Operation(hidden = true)
     @GetMapping(SWAGGER_UI_PATH)
     public String redirectToUi(HttpServletRequest request) {
-        StringBuilder sbUrl = new StringBuilder(REDIRECT_URL_PREFIX).append(this.calculateUiRootPath());
+        StringBuilder sbUrl = new StringBuilder(REDIRECT_URL_PREFIX).append(this.uiRootPath);
         sbUrl.append(SWAGGER_UI_URL);
         buildConfigUrl(request);
         UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromUriString(sbUrl.toString());
@@ -72,26 +85,14 @@ private void buildConfigUrl(HttpServletRequest request) {
             String url = buildUrl(request, apiDocsUrl);
             String swaggerConfigUrl = url + DEFAULT_PATH_SEPARATOR + SWAGGGER_CONFIG_FILE;
             swaggerUiConfig.setConfigUrl(swaggerConfigUrl);
-
             if (SwaggerUiConfigProperties.getSwaggerUrls().isEmpty())
                 swaggerUiConfig.setUrl(url);
             else
                 SwaggerUiConfigProperties.addUrl(url);
-
         }
         if (!swaggerUiConfig.isValidUrl(swaggerUiConfig.getOauth2RedirectUrl())) {
-            swaggerUiConfig.setOauth2RedirectUrl(ServletUriComponentsBuilder.fromCurrentContextPath().path(this.calculateUiRootPath().append(swaggerUiConfig.getOauth2RedirectUrl()).toString()).build().toString());
+            swaggerUiConfig.setOauth2RedirectUrl(ServletUriComponentsBuilder.fromCurrentContextPath().path(this.uiRootPath).path(swaggerUiConfig.getOauth2RedirectUrl()).build().toString());
         }
     }
 
-    private StringBuilder calculateUiRootPath() {
-        String uiRootPath = "";
-        if (swaggerPath.contains("/"))
-            uiRootPath = swaggerPath.substring(0, swaggerPath.lastIndexOf('/'));
-        StringBuilder sbUrl = new StringBuilder();
-        if (StringUtils.isNotBlank(mvcServletPath))
-            sbUrl.append(mvcServletPath);
-        sbUrl.append(uiRootPath);
-        return sbUrl;
-    }
 }

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocConfigPathsTest.java

@@ -0,0 +1,26 @@
+package test.org.springdoc.ui.app1;
+
+import org.junit.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.web.servlet.MvcResult;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.junit.Assert.assertTrue;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest(properties = {
+        "springdoc.swagger-ui.path=/test/swagger.html"
+})
+public class SpringDocConfigPathsTest extends AbstractSpringDocTest {
+
+    @Test
+    public void should_display_swaggerui_page() throws Exception {
+        mockMvc.perform(get("/context-path/servlet-path/test/swagger.html").contextPath("/context-path").servletPath("/servlet-path")).andExpect(status().isFound()).andReturn();
+        MvcResult mvcResult = mockMvc.perform(get("/context-path/servlet-path/test/swagger-ui/index.html").contextPath("/context-path").servletPath("/servlet-path")).andExpect(status().isOk()).andReturn();
+        String contentAsString = mvcResult.getResponse().getContentAsString();
+        assertTrue(contentAsString.contains("Swagger UI"));
+    }
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectConfigUrlTest.java renamed to springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocRedirectConfigUrlTest.java

@@ -13,7 +13,7 @@
         "springdoc.swagger-ui.configUrl=/foo/bar",
         "springdoc.swagger-ui.url=/batz" // ignored since configUrl is configured
 })
-public class SpringDocApp1RedirectConfigUrlTest extends AbstractSpringDocTest {
+public class SpringDocRedirectConfigUrlTest extends AbstractSpringDocTest {
 
     @Test
     public void shouldRedirectWithConfigUrlIgnoringQueryParams() throws Exception {

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectDefaultTest.java renamed to springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocRedirectDefaultTest.java

@@ -8,7 +8,7 @@
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
-public class SpringDocApp1RedirectDefaultTest extends AbstractSpringDocTest {
+public class SpringDocRedirectDefaultTest extends AbstractSpringDocTest {
 
     @Test
     public void shouldRedirectWithDefaultQueryParams() throws Exception {

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocApp1RedirectWithConfigTest.java renamed to springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app1/SpringDocRedirectWithConfigTest.java

@@ -15,7 +15,7 @@
         "springdoc.swagger-ui.validatorUrl=/foo/validate",
         "springdoc.api-docs.path=/baf/batz"
 })
-public class SpringDocApp1RedirectWithConfigTest extends AbstractSpringDocTest {
+public class SpringDocRedirectWithConfigTest extends AbstractSpringDocTest {
 
     @Test
     public void shouldRedirectWithConfiguredParams() throws Exception {

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocOauthContextPathTest.java

@@ -0,0 +1,21 @@
+package test.org.springdoc.ui.app5;
+
+import org.junit.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest(properties ="server.servlet.context-path=/context-path")
+public class SpringDocOauthContextPathTest extends AbstractSpringDocTest {
+
+    @Test
+    public void oauth2_redirect_url_calculated_with_context_path() throws Exception {
+        mockMvc.perform(get("/context-path/v3/api-docs/swagger-config").contextPath("/context-path"))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("oauth2RedirectUrl", equalTo("http://localhost/context-path/swagger-ui/oauth2-redirect.html")));
+    }
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocOauthPathsTest.java

@@ -0,0 +1,20 @@
+package test.org.springdoc.ui.app5;
+
+import org.junit.Test;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+public class SpringDocOauthPathsTest extends AbstractSpringDocTest {
+
+    @Test
+    public void oauth2_redirect_url_calculated() throws Exception {
+        mockMvc.perform(get("/v3/api-docs/swagger-config"))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("oauth2RedirectUrl", equalTo("http://localhost/swagger-ui/oauth2-redirect.html")));
+    }
+
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocOauthPathsWithPropertyTest.java

@@ -0,0 +1,22 @@
+package test.org.springdoc.ui.app5;
+
+import org.junit.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest(properties = "springdoc.swagger-ui.oauth2RedirectUrl=http://localhost:8080/toto/test/swagger-ui/oauth2-redirect.html")
+public class SpringDocOauthPathsWithPropertyTest extends AbstractSpringDocTest {
+
+    @Test
+    public void oauth2_redirect_url_calculated() throws Exception {
+        mockMvc.perform(get("/v3/api-docs/swagger-config"))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("oauth2RedirectUrl", equalTo("http://localhost:8080/toto/test/swagger-ui/oauth2-redirect.html")));
+    }
+
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocOauthServletPathsTest.java

@@ -0,0 +1,29 @@
+package test.org.springdoc.ui.app5;
+
+import org.junit.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest(properties = {
+        "springdoc.swagger-ui.path=/test/swagger.html",
+        "spring.mvc.servlet.path=/servlet-path"
+})
+public class SpringDocOauthServletPathsTest extends AbstractSpringDocTest {
+
+    @Test
+    public void should_display_oauth2_redirect_page() throws Exception {
+        mockMvc.perform(get("/context-path/servlet-path/test/swagger-ui/oauth2-redirect.html").contextPath("/context-path").servletPath("/servlet-path")).andExpect(status().isOk()).andReturn();
+    }
+
+    @Test
+    public void oauth2_redirect_url_calculated_with_context_path_and_servlet_path() throws Exception {
+        mockMvc.perform(get("/context-path/servlet-path/v3/api-docs/swagger-config").contextPath("/context-path").servletPath("/servlet-path"))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("oauth2RedirectUrl", equalTo("http://localhost/context-path/servlet-path/test/swagger-ui/oauth2-redirect.html")));
+    }
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocTestApp.java

@@ -0,0 +1,12 @@
+package test.org.springdoc.ui.app5;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class SpringDocTestApp {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SpringDocTestApp.class, args);
+    }
+}