Skip to content

Commit

Permalink
Disable HttpGraphQlTesterContextCustomizer after AOT processing
Browse files Browse the repository at this point in the history
After AOT processing, a HttpGraphQlTester bean will be defined directly
so the context customizer that initiates its registration is not
needed.

Closes spring-projectsgh-32872
  • Loading branch information
mhalbritter committed Oct 25, 2022
1 parent 99edda7 commit 9ee3fd0
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.boot.test.graphql.tester;

import org.springframework.aot.AotDetector;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
Expand Down Expand Up @@ -53,6 +54,9 @@ class HttpGraphQlTesterContextCustomizer implements ContextCustomizer {

@Override
public void customizeContext(ConfigurableApplicationContext context, MergedContextConfiguration mergedConfig) {
if (AotDetector.useGeneratedArtifacts()) {
return;
}
SpringBootTest springBootTest = TestContextAnnotationUtils.findMergedAnnotation(mergedConfig.getTestClass(),
SpringBootTest.class);
if (springBootTest.webEnvironment().isEmbedded()) {
Expand Down Expand Up @@ -83,8 +87,7 @@ public int hashCode() {
return getClass().hashCode();
}

private static class HttpGraphQlTesterRegistrar
implements BeanDefinitionRegistryPostProcessor, Ordered, BeanFactoryAware {
static class HttpGraphQlTesterRegistrar implements BeanDefinitionRegistryPostProcessor, Ordered, BeanFactoryAware {

private BeanFactory beanFactory;

Expand All @@ -95,6 +98,9 @@ public void setBeanFactory(BeanFactory beanFactory) throws BeansException {

@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
if (AotDetector.useGeneratedArtifacts()) {
return;
}
if (BeanFactoryUtils.beanNamesForTypeIncludingAncestors((ListableBeanFactory) this.beanFactory,
HttpGraphQlTester.class, false, false).length == 0) {
registry.registerBeanDefinition(HttpGraphQlTester.class.getName(),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
/*
* Copyright 2012-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.boot.test.graphql.tester;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.boot.test.graphql.tester.HttpGraphQlTesterContextCustomizer.HttpGraphQlTesterRegistrar;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.AbstractApplicationContext;
import org.springframework.graphql.test.tester.HttpGraphQlTester;
import org.springframework.test.context.MergedContextConfiguration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;

/**
* Tests for HttpGraphQlTesterContextCustomizer.
*
* @author Moritz Halbritter
*/
class HttpGraphQlTesterContextCustomizerTests {

@Test
void whenContextIsNotABeanDefinitionRegistryHttpGraphQlTesterIsRegistered() {
new ApplicationContextRunner(HttpGraphQlTesterContextCustomizerTests.TestApplicationContext::new)
.withInitializer(this::applyHttpGraphQlTesterContextCustomizer)
.run((context) -> assertThat(context).hasSingleBean(HttpGraphQlTester.class));
}

@Test
void whenUsingAotGeneratedArtifactsHttpGraphQlTesterIsNotRegistered() {
new ApplicationContextRunner().withSystemProperties("spring.aot.enabled:true")
.withInitializer(this::applyHttpGraphQlTesterContextCustomizer).run((context) -> {
assertThat(context).doesNotHaveBean(HttpGraphQlTesterRegistrar.class);
assertThat(context).doesNotHaveBean(HttpGraphQlTester.class);
});
}

@SuppressWarnings({ "unchecked", "rawtypes" })
void applyHttpGraphQlTesterContextCustomizer(ConfigurableApplicationContext context) {
MergedContextConfiguration configuration = mock(MergedContextConfiguration.class);
given(configuration.getTestClass()).willReturn((Class) HttpGraphQlTesterContextCustomizerTests.TestClass.class);
new HttpGraphQlTesterContextCustomizer().customizeContext(context, configuration);
}

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
static class TestClass {

}

static class TestApplicationContext extends AbstractApplicationContext {

private final ConfigurableListableBeanFactory beanFactory = new DefaultListableBeanFactory();

@Override
protected void refreshBeanFactory() {
}

@Override
protected void closeBeanFactory() {

}

@Override
public ConfigurableListableBeanFactory getBeanFactory() {
return this.beanFactory;
}

}

}

0 comments on commit 9ee3fd0

Please sign in to comment.