WithSecurityContextTestExecutionListener Supports Nested Classes

WithSecurityContextTestExecutionListener now supports nested classes. If
the class is nested WithSecurityContext is not found, then the enclosing
class is looked at until there is no enclosing class.

Closes gh-9179
This commit is contained in:
Rob Winch 2020-11-03 14:06:46 -06:00
parent d0d655e18d
commit 87d8741730
2 changed files with 60 additions and 9 deletions

View File

@ -31,7 +31,6 @@ import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequ
import org.springframework.test.context.TestContext;
import org.springframework.test.context.TestExecutionListener;
import org.springframework.test.context.support.AbstractTestExecutionListener;
import org.springframework.test.util.MetaAnnotationUtils;
import org.springframework.test.web.servlet.MockMvc;
/**
@ -61,10 +60,7 @@ public class WithSecurityContextTestExecutionListener extends AbstractTestExecut
*/
@Override
public void beforeTestMethod(TestContext testContext) {
TestSecurityContext testSecurityContext = createTestSecurityContext(testContext.getTestMethod(), testContext);
if (testSecurityContext == null) {
testSecurityContext = createTestSecurityContext(testContext.getTestClass(), testContext);
}
TestSecurityContext testSecurityContext = findTestSecurityContext(testContext);
if (testSecurityContext == null) {
return;
}
@ -77,6 +73,21 @@ public class WithSecurityContextTestExecutionListener extends AbstractTestExecut
}
}
private TestSecurityContext findTestSecurityContext(TestContext testContext) {
TestSecurityContext testSecurityContext = createTestSecurityContext(testContext.getTestMethod(), testContext);
if (testSecurityContext != null) {
return testSecurityContext;
}
for (Class<?> classToSearch = testContext.getTestClass(); classToSearch != null; classToSearch = classToSearch
.getEnclosingClass()) {
testSecurityContext = createTestSecurityContext(classToSearch, testContext);
if (testSecurityContext != null) {
return testSecurityContext;
}
}
return null;
}
/**
* If configured before test execution sets the SecurityContext
* @since 5.1
@ -97,10 +108,7 @@ public class WithSecurityContextTestExecutionListener extends AbstractTestExecut
}
private TestSecurityContext createTestSecurityContext(Class<?> annotated, TestContext context) {
MetaAnnotationUtils.AnnotationDescriptor<WithSecurityContext> withSecurityContextDescriptor = MetaAnnotationUtils
.findAnnotationDescriptor(annotated, WithSecurityContext.class);
WithSecurityContext withSecurityContext = (withSecurityContextDescriptor != null)
? withSecurityContextDescriptor.getAnnotation() : null;
WithSecurityContext withSecurityContext = AnnotationUtils.findAnnotation(annotated, WithSecurityContext.class);
return createTestSecurityContext(annotated, withSecurityContext, context);
}

View File

@ -92,6 +92,30 @@ public class WithSecurityContextTestExcecutionListenerTests {
assertThat(TestSecurityContextHolder.getContext().getAuthentication().getName()).isEqualTo("user");
}
@Test
@SuppressWarnings({ "rawtypes", "unchecked" })
public void beforeTestMethodInnerClass() throws Exception {
Class testClass = OuterClass.InnerClass.class;
Method testNoAnnotation = ReflectionUtils.findMethod(testClass, "testNoAnnotation");
given(this.testContext.getTestClass()).willReturn(testClass);
given(this.testContext.getTestMethod()).willReturn(testNoAnnotation);
given(this.testContext.getApplicationContext()).willThrow(new IllegalStateException(""));
this.listener.beforeTestMethod(this.testContext);
assertThat(TestSecurityContextHolder.getContext().getAuthentication().getName()).isEqualTo("user");
}
@Test
@SuppressWarnings({ "rawtypes", "unchecked" })
public void beforeTestMethodInnerInnerClass() throws Exception {
Class testClass = OuterClass.InnerClass.InnerInnerClass.class;
Method testNoAnnotation = ReflectionUtils.findMethod(testClass, "testNoAnnotation");
given(this.testContext.getTestClass()).willReturn(testClass);
given(this.testContext.getTestMethod()).willReturn(testNoAnnotation);
given(this.testContext.getApplicationContext()).willThrow(new IllegalStateException(""));
this.listener.beforeTestMethod(this.testContext);
assertThat(TestSecurityContextHolder.getContext().getAuthentication().getName()).isEqualTo("user");
}
// gh-3962
@Test
public void withSecurityContextAfterSqlScripts() {
@ -166,4 +190,23 @@ public class WithSecurityContextTestExcecutionListenerTests {
}
@WithMockUser
static class OuterClass {
static class InnerClass {
void testNoAnnotation() {
}
static class InnerInnerClass {
void testNoAnnotation() {
}
}
}
}
}