Spring/spring-security
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish MockHttpServletRequest Usage

Browse Source 
This commit makes so that the requestURI is set to a value that makes
sense with the other properties being mocked.

Issue gh-16632
This commit is contained in:
Josh Cummings
2025-03-26 11:12:37 -06:00
parent ad1ee28f01
commit 50ad378a29
10 changed files with 52 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
saml2/saml2-service-provider/src/opensaml4Test/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml4AuthenticationRequestResolverTests.java
View File

@@ -102,7 +102,7 @@ public class OpenSaml4AuthenticationRequestResolverTests {
}
private MockHttpServletRequest givenRequest(String path) {
MockHttpServletRequest request = new MockHttpServletRequest();
MockHttpServletRequest request = new MockHttpServletRequest("GET", path);
request.setServletPath(path);
return request;
}

2
saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5AuthenticationRequestResolverTests.java
View File

@@ -102,7 +102,7 @@ public class OpenSaml5AuthenticationRequestResolverTests {
}
private MockHttpServletRequest givenRequest(String path) {
MockHttpServletRequest request = new MockHttpServletRequest();
MockHttpServletRequest request = new MockHttpServletRequest("GET", path);
request.setServletPath(path);
return request;
}

3
saml2/saml2-service-provider/src/test/java/org/springframework/security/saml2/provider/service/web/DefaultRelyingPartyRegistrationResolverTests.java
View File

@@ -43,7 +43,8 @@ public class DefaultRelyingPartyRegistrationResolverTests {
@Test
public void resolveWhenRequestContainsRegistrationIdThenResolves() {
MockHttpServletRequest request = new MockHttpServletRequest();
MockHttpServletRequest request = new MockHttpServletRequest("GET",
"/some/path/" + this.registration.getRegistrationId());
request.setPathInfo("/some/path/" + this.registration.getRegistrationId());
RelyingPartyRegistration registration = this.resolver.convert(request);
assertThat(registration).isNotNull();

52
saml2/saml2-service-provider/src/test/java/org/springframework/security/saml2/provider/service/web/Saml2MetadataFilterTests.java
View File

@@ -74,39 +74,39 @@ public class Saml2MetadataFilterTests {
@Test
public void doFilterWhenMatcherSucceedsThenResolverInvoked() throws Exception {
this.request.setPathInfo("/saml2/service-provider-metadata/registration-id");
this.filter.doFilter(this.request, this.response, this.chain);
MockHttpServletRequest request = uri("/saml2/service-provider-metadata/registration-id");
this.filter.doFilter(request, this.response, this.chain);
verifyNoInteractions(this.chain);
verify(this.repository).findByRegistrationId("registration-id");
}
@Test
public void doFilterWhenMatcherFailsThenProcessesFilterChain() throws Exception {
this.request.setPathInfo("/saml2/authenticate/registration-id");
this.filter.doFilter(this.request, this.response, this.chain);
verify(this.chain).doFilter(this.request, this.response);
MockHttpServletRequest request = uri("/saml2/authenticate/registration-id");
this.filter.doFilter(request, this.response, this.chain);
verify(this.chain).doFilter(request, this.response);
}
@Test
public void doFilterWhenNoRelyingPartyRegistrationThenUnauthorized() throws Exception {
this.request.setPathInfo("/saml2/service-provider-metadata/invalidRegistration");
MockHttpServletRequest request = uri("/saml2/service-provider-metadata/invalidRegistration");
given(this.repository.findByRegistrationId("invalidRegistration")).willReturn(null);
this.filter.doFilter(this.request, this.response, this.chain);
this.filter.doFilter(request, this.response, this.chain);
verifyNoInteractions(this.chain);
assertThat(this.response.getStatus()).isEqualTo(401);
}
@Test
public void doFilterWhenRelyingPartyRegistrationFoundThenInvokesMetadataResolver() throws Exception {
this.request.setPathInfo("/saml2/service-provider-metadata/validRegistration");
MockHttpServletRequest request = uri("/saml2/service-provider-metadata/validRegistration");
RelyingPartyRegistration validRegistration = TestRelyingPartyRegistrations.noCredentials()
.assertingPartyDetails((party) -> party
.verificationX509Credentials((c) -> c.add(TestSaml2X509Credentials.relyingPartyVerifyingCredential())))
.build();
String generatedMetadata = "<xml>test</xml>";
given(this.resolver.resolve(validRegistration)).willReturn(generatedMetadata);
this.filter = new Saml2MetadataFilter((request, registrationId) -> validRegistration, this.resolver);
this.filter.doFilter(this.request, this.response, this.chain);
this.filter = new Saml2MetadataFilter((r, registrationId) -> validRegistration, this.resolver);
this.filter.doFilter(request, this.response, this.chain);
verifyNoInteractions(this.chain);
assertThat(this.response.getStatus()).isEqualTo(200);
assertThat(this.response.getContentAsString()).isEqualTo(generatedMetadata);
@@ -128,9 +128,9 @@ public class Saml2MetadataFilterTests {
@Test
public void doFilterWhenCustomRequestMatcherThenUses() throws Exception {
this.request.setPathInfo("/path");
MockHttpServletRequest request = uri("/path");
this.filter.setRequestMatcher(new AntPathRequestMatcher("/path"));
this.filter.doFilter(this.request, this.response, this.chain);
this.filter.doFilter(request, this.response, this.chain);
verifyNoInteractions(this.chain);
verify(this.repository).findByRegistrationId("path");
}
@@ -142,11 +142,11 @@ public class Saml2MetadataFilterTests {
String fileName = testMetadataFilename.replace("{registrationId}", validRegistration.getRegistrationId());
String encodedFileName = URLEncoder.encode(fileName, StandardCharsets.UTF_8.name());
String generatedMetadata = "<xml>test</xml>";
this.request.setPathInfo("/saml2/service-provider-metadata/registration-id");
MockHttpServletRequest request = uri("/saml2/service-provider-metadata/registration-id");
given(this.resolver.resolve(validRegistration)).willReturn(generatedMetadata);
this.filter = new Saml2MetadataFilter((request, registrationId) -> validRegistration, this.resolver);
this.filter = new Saml2MetadataFilter((r, registrationId) -> validRegistration, this.resolver);
this.filter.setMetadataFilename(testMetadataFilename);
this.filter.doFilter(this.request, this.response, this.chain);
this.filter.doFilter(request, this.response, this.chain);
assertThat(this.response.getHeaderValue(HttpHeaders.CONTENT_DISPOSITION)).asString()
.isEqualTo("attachment; filename=\"%s\"; filename*=UTF-8''%s", fileName, encodedFileName);
}
@@ -160,8 +160,8 @@ public class Saml2MetadataFilterTests {
(id) -> this.repository.findByRegistrationId("registration-id"));
this.filter = new Saml2MetadataFilter(resolver, this.resolver);
this.filter.setRequestMatcher(new AntPathRequestMatcher("/metadata"));
this.request.setPathInfo("/metadata");
this.filter.doFilter(this.request, this.response, new MockFilterChain());
MockHttpServletRequest request = uri("/metadata");
this.filter.doFilter(request, this.response, new MockFilterChain());
verify(this.repository).findByRegistrationId("registration-id");
}
@@ -174,8 +174,8 @@ public class Saml2MetadataFilterTests {
this.filter = new Saml2MetadataFilter((id) -> this.repository.findByRegistrationId("registration-id"),
this.resolver);
this.filter.setRequestMatcher(new AntPathRequestMatcher("/metadata"));
this.request.setPathInfo("/metadata");
this.filter.doFilter(this.request, this.response, new MockFilterChain());
MockHttpServletRequest request = uri("/metadata");
this.filter.doFilter(request, this.response, new MockFilterChain());
verify(this.repository).findByRegistrationId("registration-id");
}
@@ -185,11 +185,11 @@ public class Saml2MetadataFilterTests {
RelyingPartyRegistration validRegistration = TestRelyingPartyRegistrations.full().build();
String testMetadataFilename = "test-{registrationId}-metadata.xml";
String generatedMetadata = "<xml>testäöü</xml>";
this.request.setPathInfo("/saml2/service-provider-metadata/registration-id");
MockHttpServletRequest request = uri("/saml2/service-provider-metadata/registration-id");
given(this.resolver.resolve(validRegistration)).willReturn(generatedMetadata);
this.filter = new Saml2MetadataFilter((req, id) -> validRegistration, this.resolver);
this.filter.setMetadataFilename(testMetadataFilename);
this.filter.doFilter(this.request, this.response, this.chain);
this.filter.doFilter(request, this.response, this.chain);
assertThat(this.response.getCharacterEncoding()).isEqualTo(StandardCharsets.UTF_8.name());
assertThat(this.response.getContentAsString(StandardCharsets.UTF_8)).isEqualTo(generatedMetadata);
assertThat(this.response.getContentLength())
@@ -218,9 +218,15 @@ public class Saml2MetadataFilterTests {
public void constructorWhenRelyingPartyRegistrationRepositoryThenUses() throws Exception {
RelyingPartyRegistrationRepository repository = mock(RelyingPartyRegistrationRepository.class);
this.filter = new Saml2MetadataFilter(repository, this.resolver);
this.request.setPathInfo("/saml2/service-provider-metadata/one");
this.filter.doFilter(this.request, this.response, this.chain);
MockHttpServletRequest request = uri("/saml2/service-provider-metadata/one");
this.filter.doFilter(request, this.response, this.chain);
verify(repository).findByRegistrationId("one");
}
private MockHttpServletRequest uri(String uri) {
MockHttpServletRequest request = new MockHttpServletRequest("GET", uri);
request.setPathInfo(uri);
return request;
}
}

5
saml2/saml2-service-provider/src/test/java/org/springframework/security/saml2/provider/service/web/authentication/Saml2WebSsoAuthenticationFilterTests.java
View File

@@ -68,6 +68,7 @@ public class Saml2WebSsoAuthenticationFilterTests {
@BeforeEach
public void setup() {
this.filter = new Saml2WebSsoAuthenticationFilter(this.repository);
this.request.setRequestURI("/login/saml2/sso/idp-registration-id");
this.request.setPathInfo("/login/saml2/sso/idp-registration-id");
this.request.setParameter(Saml2ParameterNames.SAML_RESPONSE, "xml-data-goes-here");
}
@@ -99,6 +100,7 @@ public class Saml2WebSsoAuthenticationFilterTests {
@Test
public void requiresAuthenticationWhenCustomProcessingUrlThenReturnsTrue() {
this.filter = new Saml2WebSsoAuthenticationFilter(this.repository, "/some/other/path/{registrationId}");
this.request.setRequestURI("/some/other/path/idp-registration-id");
this.request.setPathInfo("/some/other/path/idp-registration-id");
this.request.setParameter(Saml2ParameterNames.SAML_RESPONSE, "xml-data-goes-here");
assertThat(this.filter.requiresAuthentication(this.request, this.response)).isTrue();
@@ -108,6 +110,7 @@ public class Saml2WebSsoAuthenticationFilterTests {
public void attemptAuthenticationWhenRegistrationIdDoesNotExistThenThrowsException() {
given(this.repository.findByRegistrationId("non-existent-id")).willReturn(null);
this.filter = new Saml2WebSsoAuthenticationFilter(this.repository, "/some/other/path/{registrationId}");
this.request.setRequestURI("/some/other/path/non-existent-id");
this.request.setPathInfo("/some/other/path/non-existent-id");
this.request.setParameter(Saml2ParameterNames.SAML_RESPONSE, "response");
assertThatExceptionOfType(Saml2AuthenticationException.class)
@@ -123,6 +126,7 @@ public class Saml2WebSsoAuthenticationFilterTests {
given(authenticationConverter.convert(this.request)).willReturn(TestSaml2AuthenticationTokens.token());
this.filter = new Saml2WebSsoAuthenticationFilter(authenticationConverter, "/some/other/path/{registrationId}");
this.filter.setAuthenticationManager((authentication) -> null);
this.request.setRequestURI("/some/other/path/idp-registration-id");
this.request.setPathInfo("/some/other/path/idp-registration-id");
this.filter.setAuthenticationRequestRepository(authenticationRequestRepository);
this.filter.attemptAuthentication(this.request, this.response);
@@ -201,6 +205,7 @@ public class Saml2WebSsoAuthenticationFilterTests {
Saml2AuthenticationTokenConverter authenticationConverter = new Saml2AuthenticationTokenConverter(resolver);
this.filter = new Saml2WebSsoAuthenticationFilter(authenticationConverter, loginProcessingUrl);
this.filter.setAuthenticationManager(this.authenticationManager);
this.request.setRequestURI("/registration-id/login/saml2/sso");
this.request.setPathInfo("/registration-id/login/saml2/sso");
this.request.setParameter(Saml2ParameterNames.SAML_RESPONSE, "response");
this.filter.doFilter(this.request, this.response, new MockFilterChain());