Support URI vars in formLogin and logout MockMvc requests

Author: drumonii

test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuilders.java

@@ -23,6 +23,7 @@
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.RequestBuilder;
 import org.springframework.test.web.servlet.request.RequestPostProcessor;
+import org.springframework.web.util.UriComponentsBuilder;
 
 import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.csrf;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
@@ -71,6 +72,8 @@ public static LogoutRequestBuilder logout() {
 	 * Creates a logout request (including any necessary {@link CsrfToken}) to the
 	 * specified {@code logoutUrl}
 	 *
+	 * @param logoutUrl the logout request URL
+	 *
 	 * @return the LogoutRequestBuilder for additional customizations
 	 */
 	public static LogoutRequestBuilder logout(String logoutUrl) {
@@ -106,6 +109,19 @@ public LogoutRequestBuilder logoutUrl(String logoutUrl) {
 			return this;
 		}
 
+		/**
+		 * Specifies the logout URL to POST to.
+		 *
+		 * @param logoutUrl the logout URL to POST to.
+		 * @param uriVars the URI variables
+		 * @return the {@link LogoutRequestBuilder} for additional customizations
+		 */
+		public LogoutRequestBuilder logoutUrl(String logoutUrl, Object... uriVars) {
+			this.logoutUrl = UriComponentsBuilder.fromPath(logoutUrl)
+					.buildAndExpand(uriVars).encode().toString();
+			return this;
+		}
+
 		private LogoutRequestBuilder() {
 		}
 	}
@@ -146,6 +162,19 @@ public FormLoginRequestBuilder loginProcessingUrl(String loginProcessingUrl) {
 			return this;
 		}
 
+		/**
+		 * Specifies the URL to POST to.
+		 *
+		 * @param loginProcessingUrl the URL to POST to
+		 * @param uriVars the URI variables
+		 * @return the {@link FormLoginRequestBuilder} for additional customizations
+		 */
+		public FormLoginRequestBuilder loginProcessingUrl(String loginProcessingUrl, Object... uriVars) {
+			this.loginProcessingUrl = UriComponentsBuilder.fromPath(loginProcessingUrl)
+					.buildAndExpand(uriVars).encode().toString();
+			return this;
+		}
+
 		/**
 		 * The HTTP parameter to place the username. Default is "username".
 		 * @param usernameParameter the HTTP parameter to place the username. Default is

test/src/test/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuildersFormLoginTests.java

@@ -66,6 +66,22 @@ public void custom() {
 		assertThat(request.getRequestURI()).isEqualTo("/login");
 	}
 
+	@Test
+	public void customWithUriVars() {
+		MockHttpServletRequest request = formLogin().loginProcessingUrl("/uri-login/{var1}/{var2}", "val1", "val2")
+				.user("username", "admin").password("password", "secret").buildRequest(this.servletContext);
+
+		CsrfToken token = (CsrfToken) request
+				.getAttribute(CsrfRequestPostProcessor.TestCsrfTokenRepository.TOKEN_ATTR_NAME);
+
+		assertThat(request.getParameter("username")).isEqualTo("admin");
+		assertThat(request.getParameter("password")).isEqualTo("secret");
+		assertThat(request.getMethod()).isEqualTo("POST");
+		assertThat(request.getParameter(token.getParameterName()))
+				.isEqualTo(token.getToken());
+		assertThat(request.getRequestURI()).isEqualTo("/uri-login/val1/val2");
+	}
+
 	// gh-3920
 	@Test
 	public void usesAcceptMediaForContentNegotiation() {

test/src/test/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuildersFormLogoutTests.java

@@ -58,4 +58,17 @@ public void custom() {
 		assertThat(request.getRequestURI()).isEqualTo("/admin/logout");
 	}
 
+	@Test
+	public void customWithUriVars() {
+		MockHttpServletRequest request = logout().logoutUrl("/uri-logout/{var1}/{var2}", "val1", "val2").buildRequest(
+				servletContext);
+
+		CsrfToken token = (CsrfToken) request.getAttribute(CsrfRequestPostProcessor.TestCsrfTokenRepository.TOKEN_ATTR_NAME);
+
+		assertThat(request.getMethod()).isEqualTo("POST");
+		assertThat(request.getParameter(token.getParameterName())).isEqualTo(
+				token.getToken());
+		assertThat(request.getRequestURI()).isEqualTo("/uri-logout/val1/val2");
+	}
+
 }