Allow test classes to provide runtime hints via declarative mechanisms
Prior to this commit, it was possible to register hints for individual test classes programmatically via the org.springframework.test.context.aot.TestRuntimeHintsRegistrar SPI; however, that requires that a custom TestRuntimeHintsRegistrar be registered via "META-INF/spring/aot.factories". In addition, implementing a TestRuntimeHintsRegistrar is more cumbersome than using the core mechanisms such as @Reflective, @ImportRuntimeHints, and @RegisterReflectionForBinding. This commit address this by introducing support for @Reflective and @ImportRuntimeHints on test classes. @RegisterReflectionForBinding support is available automatically since it is an extension of the @Reflective mechanism. Closes gh-29455
This commit is contained in:
@@ -0,0 +1,69 @@
|
||||
/*
|
||||
* 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.test.context.aot;
|
||||
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.aot.generate.InMemoryGeneratedFiles;
|
||||
import org.springframework.aot.hint.RuntimeHints;
|
||||
import org.springframework.test.context.aot.samples.hints.DeclarativeRuntimeHintsSpringJupiterTests;
|
||||
import org.springframework.test.context.aot.samples.hints.DeclarativeRuntimeHintsSpringJupiterTests.SampleClassWithGetter;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.springframework.aot.hint.predicate.RuntimeHintsPredicates.reflection;
|
||||
import static org.springframework.aot.hint.predicate.RuntimeHintsPredicates.resource;
|
||||
|
||||
/**
|
||||
* Tests for declarative support for registering run-time hints for tests, tested
|
||||
* via the {@link TestContextAotGenerator}
|
||||
*
|
||||
* @author Sam Brannen
|
||||
* @since 6.0
|
||||
*/
|
||||
class DeclarativeRuntimeHintsTests extends AbstractAotTests {
|
||||
|
||||
private final RuntimeHints runtimeHints = new RuntimeHints();
|
||||
|
||||
private final TestContextAotGenerator generator =
|
||||
new TestContextAotGenerator(new InMemoryGeneratedFiles(), this.runtimeHints);
|
||||
|
||||
|
||||
@Test
|
||||
void declarativeRuntimeHints() {
|
||||
Class<?> testClass = DeclarativeRuntimeHintsSpringJupiterTests.class;
|
||||
|
||||
this.generator.processAheadOfTime(Stream.of(testClass));
|
||||
|
||||
// @Reflective
|
||||
assertReflectionRegistered(testClass);
|
||||
|
||||
// @@RegisterReflectionForBinding
|
||||
assertReflectionRegistered(SampleClassWithGetter.class);
|
||||
assertReflectionRegistered(String.class);
|
||||
assertThat(reflection().onMethod(SampleClassWithGetter.class, "getName")).accepts(this.runtimeHints);
|
||||
|
||||
// @ImportRuntimeHints
|
||||
assertThat(resource().forResource("org/example/config/enigma.txt")).accepts(this.runtimeHints);
|
||||
}
|
||||
|
||||
private void assertReflectionRegistered(Class<?> type) {
|
||||
assertThat(reflection().onType(type)).as("Reflection hint for %s", type).accepts(this.runtimeHints);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
/*
|
||||
* 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.test.context.aot.samples.hints;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.aot.hint.RuntimeHints;
|
||||
import org.springframework.aot.hint.RuntimeHintsRegistrar;
|
||||
import org.springframework.aot.hint.annotation.Reflective;
|
||||
import org.springframework.aot.hint.annotation.RegisterReflectionForBinding;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.ImportRuntimeHints;
|
||||
import org.springframework.test.context.aot.samples.hints.DeclarativeRuntimeHintsSpringJupiterTests.DemoHints;
|
||||
import org.springframework.test.context.aot.samples.hints.DeclarativeRuntimeHintsSpringJupiterTests.SampleClassWithGetter;
|
||||
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* @author Sam Brannen
|
||||
* @since 6.0
|
||||
*/
|
||||
@SpringJUnitConfig
|
||||
@Reflective
|
||||
@RegisterReflectionForBinding(SampleClassWithGetter.class)
|
||||
@ImportRuntimeHints(DemoHints.class)
|
||||
public class DeclarativeRuntimeHintsSpringJupiterTests {
|
||||
|
||||
@Test
|
||||
void test(@Autowired String foo) {
|
||||
assertThat(foo).isEqualTo("bar");
|
||||
}
|
||||
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class Config {
|
||||
|
||||
@Bean
|
||||
String foo() {
|
||||
return "bar";
|
||||
}
|
||||
}
|
||||
|
||||
static class DemoHints implements RuntimeHintsRegistrar {
|
||||
|
||||
@Override
|
||||
public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
|
||||
hints.resources().registerPattern("org/example/config/*.txt");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public static class SampleClassWithGetter {
|
||||
|
||||
public String getName() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user