From 177e11fbd723a0f87e44b8942f42fc40d7b45f60 Mon Sep 17 00:00:00 2001 From: Marcus Da Coregio Date: Wed, 16 Nov 2022 11:16:20 -0300 Subject: [PATCH] Add WebTestUtils test runtime hints Closes gh-12216 --- .../hint/WebTestUtilsTestRuntimeHints.java | 56 ++++++++++++++ .../resources/META-INF/spring/aot.factories | 3 +- .../WebTestUtilsTestRuntimeHintsTests.java | 75 +++++++++++++++++++ 3 files changed, 133 insertions(+), 1 deletion(-) create mode 100644 test/src/main/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHints.java create mode 100644 test/src/test/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHintsTests.java diff --git a/test/src/main/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHints.java b/test/src/main/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHints.java new file mode 100644 index 0000000000..a71633b8c2 --- /dev/null +++ b/test/src/main/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHints.java @@ -0,0 +1,56 @@ +/* + * Copyright 2002-2022 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.test.aot.hint; + +import org.springframework.aot.hint.MemberCategory; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.security.web.FilterChainProxy; +import org.springframework.security.web.context.SecurityContextHolderFilter; +import org.springframework.security.web.context.SecurityContextPersistenceFilter; +import org.springframework.security.web.csrf.CsrfFilter; +import org.springframework.test.context.aot.TestRuntimeHintsRegistrar; + +/** + * {@link TestRuntimeHintsRegistrar} implementation that register runtime hints for + * {@link org.springframework.security.test.web.support.WebTestUtils}. + * + * @author Marcus da Coregio + * @since 6.0 + */ +class WebTestUtilsTestRuntimeHints implements TestRuntimeHintsRegistrar { + + @Override + public void registerHints(RuntimeHints hints, Class testClass, ClassLoader classLoader) { + registerFilterChainProxyHints(hints); + registerSecurityContextRepositoryHints(hints); + registerCsrfTokenRepositoryHints(hints); + } + + private void registerFilterChainProxyHints(RuntimeHints hints) { + hints.reflection().registerType(FilterChainProxy.class, MemberCategory.INVOKE_DECLARED_METHODS); + } + + private void registerCsrfTokenRepositoryHints(RuntimeHints hints) { + hints.reflection().registerType(CsrfFilter.class, MemberCategory.DECLARED_FIELDS); + } + + private void registerSecurityContextRepositoryHints(RuntimeHints hints) { + hints.reflection().registerType(SecurityContextPersistenceFilter.class, MemberCategory.DECLARED_FIELDS); + hints.reflection().registerType(SecurityContextHolderFilter.class, MemberCategory.DECLARED_FIELDS); + } + +} diff --git a/test/src/main/resources/META-INF/spring/aot.factories b/test/src/main/resources/META-INF/spring/aot.factories index 8fb5958d70..6bae612979 100644 --- a/test/src/main/resources/META-INF/spring/aot.factories +++ b/test/src/main/resources/META-INF/spring/aot.factories @@ -1,2 +1,3 @@ org.springframework.test.context.aot.TestRuntimeHintsRegistrar=\ -org.springframework.security.test.aot.hint.WithSecurityContextTestRuntimeHints +org.springframework.security.test.aot.hint.WithSecurityContextTestRuntimeHints,\ +org.springframework.security.test.aot.hint.WebTestUtilsTestRuntimeHints diff --git a/test/src/test/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHintsTests.java b/test/src/test/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHintsTests.java new file mode 100644 index 0000000000..78bee4f968 --- /dev/null +++ b/test/src/test/java/org/springframework/security/test/aot/hint/WebTestUtilsTestRuntimeHintsTests.java @@ -0,0 +1,75 @@ +/* + * Copyright 2002-2022 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.test.aot.hint; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import org.springframework.aot.hint.MemberCategory; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.predicate.RuntimeHintsPredicates; +import org.springframework.core.io.support.SpringFactoriesLoader; +import org.springframework.security.web.FilterChainProxy; +import org.springframework.security.web.context.SecurityContextHolderFilter; +import org.springframework.security.web.context.SecurityContextPersistenceFilter; +import org.springframework.security.web.csrf.CsrfFilter; +import org.springframework.test.context.aot.TestRuntimeHintsRegistrar; +import org.springframework.util.ClassUtils; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link WebTestUtilsTestRuntimeHints}. + * + * @author Marcus da Coregio + */ +class WebTestUtilsTestRuntimeHintsTests { + + private final RuntimeHints hints = new RuntimeHints(); + + @BeforeEach + void setup() { + SpringFactoriesLoader.forResourceLocation("META-INF/spring/aot.factories").load(TestRuntimeHintsRegistrar.class) + .forEach((registrar) -> registrar.registerHints(this.hints, WebTestUtilsTestRuntimeHintsTests.class, + ClassUtils.getDefaultClassLoader())); + } + + @Test + void filterChainProxyHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(FilterChainProxy.class) + .withMemberCategories(MemberCategory.INVOKE_DECLARED_METHODS)).accepts(this.hints); + } + + @Test + void csrfFilterHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(CsrfFilter.class) + .withMemberCategories(MemberCategory.DECLARED_FIELDS)).accepts(this.hints); + } + + @Test + void securityContextPersistenceFilterHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(SecurityContextPersistenceFilter.class) + .withMemberCategories(MemberCategory.DECLARED_FIELDS)).accepts(this.hints); + } + + @Test + void securityContextHolderFilterHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(SecurityContextHolderFilter.class) + .withMemberCategories(MemberCategory.DECLARED_FIELDS)).accepts(this.hints); + } + +}