Support A Well-Known URL for Changing Passwords

Closes gh-8657

web/src/test/java/org/springframework/security/web/RequestMatcherRedirectFilterTests.java

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2002-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.security.web;
+
+import javax.servlet.FilterChain;
+
+import org.junit.Test;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.mock.web.MockHttpServletResponse;
+import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoInteractions;
+
+/**
+ * Tests for {@link RequestMatcherRedirectFilter}.
+ *
+ * @author Evgeniy Cheban
+ */
+public class RequestMatcherRedirectFilterTests {
+
+	@Test
+	public void doFilterWhenRequestMatchThenRedirectToSpecifiedUrl() throws Exception {
+		RequestMatcherRedirectFilter filter = new RequestMatcherRedirectFilter(new AntPathRequestMatcher("/context"),
+				"/test");
+
+		MockHttpServletRequest request = new MockHttpServletRequest();
+		request.setServletPath("/context");
+
+		MockHttpServletResponse response = new MockHttpServletResponse();
+		FilterChain filterChain = mock(FilterChain.class);
+
+		filter.doFilter(request, response, filterChain);
+
+		assertThat(response.getStatus()).isEqualTo(HttpStatus.FOUND.value());
+		assertThat(response.getRedirectedUrl()).isEqualTo("/test");
+
+		verifyNoInteractions(filterChain);
+	}
+
+	@Test
+	public void doFilterWhenRequestNotMatchThenNextFilter() throws Exception {
+		RequestMatcherRedirectFilter filter = new RequestMatcherRedirectFilter(new AntPathRequestMatcher("/context"),
+				"/test");
+
+		MockHttpServletRequest request = new MockHttpServletRequest();
+		request.setServletPath("/test");
+
+		MockHttpServletResponse response = new MockHttpServletResponse();
+		FilterChain filterChain = mock(FilterChain.class);
+
+		filter.doFilter(request, response, filterChain);
+
+		assertThat(response.getStatus()).isEqualTo(HttpStatus.OK.value());
+
+		verify(filterChain).doFilter(request, response);
+	}
+
+	@Test
+	public void constructWhenRequestMatcherNull() {
+		assertThatIllegalArgumentException().isThrownBy(() -> new RequestMatcherRedirectFilter(null, "/test"))
+				.withMessage("requestMatcher cannot be null");
+	}
+
+	@Test
+	public void constructWhenRedirectUrlNull() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> new RequestMatcherRedirectFilter(new AntPathRequestMatcher("/**"), null))
+				.withMessage("redirectUrl cannot be empty");
+	}
+
+	@Test
+	public void constructWhenRedirectUrlEmpty() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> new RequestMatcherRedirectFilter(new AntPathRequestMatcher("/**"), ""))
+				.withMessage("redirectUrl cannot be empty");
+	}
+
+	@Test
+	public void constructWhenRedirectUrlBlank() {
+		assertThatIllegalArgumentException()
+				.isThrownBy(() -> new RequestMatcherRedirectFilter(new AntPathRequestMatcher("/**"), " "))
+				.withMessage("redirectUrl cannot be empty");
+	}
+
+}

web/src/test/java/org/springframework/security/web/server/ExchangeMatcherRedirectWebFilterTests.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2002-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.security.web.server;
+
+import java.util.Collections;
+
+import org.junit.Test;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.security.web.server.util.matcher.PathPatternParserServerWebExchangeMatcher;
+import org.springframework.test.web.reactive.server.WebTestClient;
+import org.springframework.web.server.handler.FilteringWebHandler;
+
+import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
+
+/**
+ * Tests for {@link ExchangeMatcherRedirectWebFilter}.
+ *
+ * @author Evgeniy Cheban
+ */
+public class ExchangeMatcherRedirectWebFilterTests {
+
+	@Test
+	public void filterWhenRequestMatchThenRedirectToSpecifiedUrl() {
+		ExchangeMatcherRedirectWebFilter filter = new ExchangeMatcherRedirectWebFilter(
+				new PathPatternParserServerWebExchangeMatcher("/context"), "/test");
+		FilteringWebHandler handler = new FilteringWebHandler((e) -> e.getResponse().setComplete(),
+				Collections.singletonList(filter));
+
+		WebTestClient client = WebTestClient.bindToWebHandler(handler).build();
+		client.get().uri("/context").exchange().expectStatus().isFound().expectHeader()
+				.valueEquals(HttpHeaders.LOCATION, "/test");
+	}
+
+	@Test
+	public void filterWhenRequestNotMatchThenNextFilter() {
+		ExchangeMatcherRedirectWebFilter filter = new ExchangeMatcherRedirectWebFilter(
+				new PathPatternParserServerWebExchangeMatcher("/context"), "/test");
+		FilteringWebHandler handler = new FilteringWebHandler((e) -> e.getResponse().setComplete(),
+				Collections.singletonList(filter));
+
+		WebTestClient client = WebTestClient.bindToWebHandler(handler).build();
+		client.get().uri("/test").exchange().expectStatus().isOk();
+	}
+
+	@Test
+	public void constructWhenExchangeMatcherNull() {
+		assertThatIllegalArgumentException().isThrownBy(() -> new ExchangeMatcherRedirectWebFilter(null, "/test"))
+				.withMessage("exchangeMatcher cannot be null");
+	}
+
+	@Test
+	public void constructWhenRedirectUrlNull() {
+		assertThatIllegalArgumentException().isThrownBy(
+				() -> new ExchangeMatcherRedirectWebFilter(new PathPatternParserServerWebExchangeMatcher("/**"), null))
+				.withMessage("redirectUrl cannot be empty");
+	}
+
+	@Test
+	public void constructWhenRedirectUrlEmpty() {
+		assertThatIllegalArgumentException().isThrownBy(
+				() -> new ExchangeMatcherRedirectWebFilter(new PathPatternParserServerWebExchangeMatcher("/**"), ""))
+				.withMessage("redirectUrl cannot be empty");
+	}
+
+	@Test
+	public void constructWhenRedirectUrlBlank() {
+		assertThatIllegalArgumentException().isThrownBy(
+				() -> new ExchangeMatcherRedirectWebFilter(new PathPatternParserServerWebExchangeMatcher("/**"), " "))
+				.withMessage("redirectUrl cannot be empty");
+	}
+
+}