Skip to content

Avoid final-field mutation in security tests #19521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gregjotau wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −2
Open

Avoid final-field mutation in security tests #19521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion test/src/main/java/org/springframework/security/test/web/support/WebTestUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public static void setSecurityContextRepository(HttpServletRequest request,
}
SecurityContextHolderFilter holderFilter = findFilter(request, SecurityContextHolderFilter.class);
if (holderFilter != null) {
ReflectionTestUtils.setField(holderFilter, "securityContextRepository", securityContextRepository);
holderFilter.setSecurityContextRepository(securityContextRepository);
}
}

Expand Down
12 changes: 11 additions & 1 deletion web/src/main/java/org/springframework/security/web/context/SecurityContextHolderFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public class SecurityContextHolderFilter extends GenericFilterBean {

private static final String FILTER_APPLIED = SecurityContextHolderFilter.class.getName() + ".APPLIED";

private final SecurityContextRepository securityContextRepository;
private SecurityContextRepository securityContextRepository;

private SecurityContextHolderStrategy securityContextHolderStrategy = SecurityContextHolder
.getContextHolderStrategy();
Expand All @@ -63,6 +63,16 @@ public SecurityContextHolderFilter(SecurityContextRepository securityContextRepo
this.securityContextRepository = securityContextRepository;
}

/**
* Sets the {@link SecurityContextRepository} to use.
* @param securityContextRepository the repository to use. Cannot be null.
* @since 7.1
*/
public void setSecurityContextRepository(SecurityContextRepository securityContextRepository) {
Assert.notNull(securityContextRepository, "securityContextRepository cannot be null");
this.securityContextRepository = securityContextRepository;
}

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
Expand Down
6 changes: 6 additions & 0 deletions .../test/java/org/springframework/security/web/context/SecurityContextHolderFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import org.springframework.security.core.context.SecurityContextImpl;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.lenient;
Expand Down Expand Up @@ -77,6 +78,11 @@ void setup() {
this.filter = new SecurityContextHolderFilter(this.repository);
}

@Test
void setSecurityContextRepositoryWhenNullThenThrowsIllegalArgumentException() {
assertThatIllegalArgumentException().isThrownBy(() -> this.filter.setSecurityContextRepository(null));
}

@AfterEach
void cleanup() {
SecurityContextHolder.clearContext();
Expand Down