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

Add support for automatic context-propagation with Micrometer

Browse Source 
Closes gh-16665
This commit is contained in:
Steve Riesenberg
2025-02-26 16:09:02 -06:00
parent 10838133d4
commit 0938ca01a4
15 changed files with 579 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
core/src/test/java/org/springframework/security/core/context/ReactiveSecurityContextHolderThreadLocalAccessorTests.java Normal file
View File

@@ -0,0 +1,123 @@
/*
* Copyright 2002-2025 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.core.context;
import java.util.concurrent.CountDownLatch;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import reactor.core.publisher.Mono;
import org.springframework.core.task.SimpleAsyncTaskExecutor;
import org.springframework.security.authentication.TestingAuthenticationToken;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
/**
* Tests for {@link ReactiveSecurityContextHolderThreadLocalAccessor}.
*
* @author Steve Riesenberg
*/
public class ReactiveSecurityContextHolderThreadLocalAccessorTests {
private ReactiveSecurityContextHolderThreadLocalAccessor threadLocalAccessor;
@BeforeEach
public void setUp() {
this.threadLocalAccessor = new ReactiveSecurityContextHolderThreadLocalAccessor();
}
@AfterEach
public void tearDown() {
this.threadLocalAccessor.setValue();
}
@Test
public void keyAlwaysReturnsSecurityContextClass() {
assertThat(this.threadLocalAccessor.key()).isEqualTo(SecurityContext.class);
}
@Test
public void getValueWhenThreadLocalNotSetThenReturnsNull() {
assertThat(this.threadLocalAccessor.getValue()).isNull();
}
@Test
public void getValueWhenThreadLocalSetThenReturnsSecurityContextMono() {
SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
securityContext.setAuthentication(new TestingAuthenticationToken("user", "password"));
Mono<SecurityContext> mono = Mono.just(securityContext);
this.threadLocalAccessor.setValue(mono);
assertThat(this.threadLocalAccessor.getValue()).isSameAs(mono);
}
@Test
public void getValueWhenThreadLocalSetOnAnotherThreadThenReturnsNull() throws InterruptedException {
CountDownLatch threadLocalSet = new CountDownLatch(1);
CountDownLatch threadLocalRead = new CountDownLatch(1);
CountDownLatch threadLocalCleared = new CountDownLatch(1);
Runnable task = () -> {
SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
securityContext.setAuthentication(new TestingAuthenticationToken("user", "password"));
Mono<SecurityContext> mono = Mono.just(securityContext);
this.threadLocalAccessor.setValue(mono);
threadLocalSet.countDown();
try {
threadLocalRead.await();
}
catch (InterruptedException ignored) {
}
finally {
this.threadLocalAccessor.setValue();
threadLocalCleared.countDown();
}
};
try (SimpleAsyncTaskExecutor taskExecutor = new SimpleAsyncTaskExecutor()) {
taskExecutor.execute(task);
threadLocalSet.await();
assertThat(this.threadLocalAccessor.getValue()).isNull();
threadLocalRead.countDown();
threadLocalCleared.await();
}
}
@Test
public void setValueWhenNullThenThrowsIllegalArgumentException() {
// @formatter:off
assertThatIllegalArgumentException()
.isThrownBy(() -> this.threadLocalAccessor.setValue(null))
.withMessage("securityContext cannot be null");
// @formatter:on
}
@Test
public void setValueWhenThreadLocalSetThenClearsThreadLocal() {
SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
securityContext.setAuthentication(new TestingAuthenticationToken("user", "password"));
Mono<SecurityContext> mono = Mono.just(securityContext);
this.threadLocalAccessor.setValue(mono);
assertThat(this.threadLocalAccessor.getValue()).isSameAs(mono);
this.threadLocalAccessor.setValue();
assertThat(this.threadLocalAccessor.getValue()).isNull();
}
}

93
core/src/test/java/org/springframework/security/core/context/SecurityContextHolderThreadLocalAccessorTests.java Normal file
View File

@@ -0,0 +1,93 @@
/*
* Copyright 2002-2025 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.core.context;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.security.authentication.TestingAuthenticationToken;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
/**
* Tests for {@link SecurityContextHolderThreadLocalAccessor}.
*
* @author Steve Riesenberg
*/
public class SecurityContextHolderThreadLocalAccessorTests {
private SecurityContextHolderThreadLocalAccessor threadLocalAccessor;
@BeforeEach
public void setUp() {
this.threadLocalAccessor = new SecurityContextHolderThreadLocalAccessor();
}
@AfterEach
public void tearDown() {
this.threadLocalAccessor.setValue();
}
@Test
public void keyAlwaysReturnsSecurityContextClassName() {
assertThat(this.threadLocalAccessor.key()).isEqualTo(SecurityContext.class.getName());
}
@Test
public void getValueWhenSecurityContextHolderNotSetThenReturnsNull() {
assertThat(this.threadLocalAccessor.getValue()).isNull();
}
@Test
public void getValueWhenSecurityContextHolderSetThenReturnsSecurityContext() {
SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
securityContext.setAuthentication(new TestingAuthenticationToken("user", "password"));
SecurityContextHolder.setContext(securityContext);
assertThat(this.threadLocalAccessor.getValue()).isSameAs(securityContext);
}
@Test
public void setValueWhenSecurityContextThenSetsSecurityContextHolder() {
SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
securityContext.setAuthentication(new TestingAuthenticationToken("user", "password"));
this.threadLocalAccessor.setValue(securityContext);
assertThat(SecurityContextHolder.getContext()).isSameAs(securityContext);
}
@Test
public void setValueWhenNullThenThrowsIllegalArgumentException() {
// @formatter:off
assertThatIllegalArgumentException()
.isThrownBy(() -> this.threadLocalAccessor.setValue(null))
.withMessage("securityContext cannot be null");
// @formatter:on
}
@Test
public void setValueWhenSecurityContextSetThenClearsSecurityContextHolder() {
SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
securityContext.setAuthentication(new TestingAuthenticationToken("user", "password"));
SecurityContextHolder.setContext(securityContext);
this.threadLocalAccessor.setValue();
SecurityContext emptyContext = SecurityContextHolder.createEmptyContext();
assertThat(SecurityContextHolder.getContext()).isEqualTo(emptyContext);
}
}