Add check for Configuration or TestConfiguration presence, add test

Author: a-simeshin

grpc-client-spring-boot-autoconfigure/build.gradle

@@ -15,6 +15,7 @@ dependencies {
 
     api project(':grpc-common-spring-boot')
     api 'org.springframework.boot:spring-boot-starter'
+    api 'org.springframework.boot:spring-boot-starter-test'
     optionalSupportImplementation 'org.springframework.boot:spring-boot-starter-actuator'
     optionalSupportImplementation 'org.springframework.cloud:spring-cloud-starter-sleuth'
     optionalSupportImplementation 'org.springframework.cloud:spring-cloud-starter-consul-discovery'

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/inject/GrpcClientBeanPostProcessor.java

@@ -33,8 +33,10 @@
 import org.springframework.beans.factory.BeanDefinitionStoreException;
 import org.springframework.beans.factory.config.BeanPostProcessor;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Configuration;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.ReflectionUtils;
 
@@ -105,16 +107,20 @@ public Object postProcessBeforeInitialization(final Object bean, final String be
                 }
             }
 
-            for (final GrpcClientBean beanClientIterator : clazz.getAnnotationsByType(GrpcClientBean.class)) {
-                final String beanNameToCreate = getBeanName(beanClientIterator);
-                try {
-                    final ConfigurableListableBeanFactory beanFactory = getConfigurableBeanFactory();
-                    final Object beanValue =
-                            processInjectionPoint(null, beanClientIterator.clazz(), beanClientIterator.client());
-                    beanFactory.registerSingleton(beanNameToCreate, beanValue);
-                } catch (final Exception e) {
-                    throw new BeanCreationException(
-                            "Could not create and register grpc client bean: {}", beanNameToCreate, e);
+            if (isAnnotatedWithConfiguration(clazz)) {
+                for (final GrpcClientBean beanClientIterator : clazz.getAnnotationsByType(GrpcClientBean.class)) {
+
+                    final String beanNameToCreate = getBeanName(beanClientIterator);
+                    try {
+                        final ConfigurableListableBeanFactory beanFactory = getConfigurableBeanFactory();
+                        final Object beanValue =
+                                processInjectionPoint(null, beanClientIterator.clazz(), beanClientIterator.client());
+                        beanFactory.registerSingleton(beanNameToCreate, beanValue);
+                    } catch (final Exception e) {
+                        throw new BeanCreationException(
+                                "Could not create and register grpc client bean: {} from class {}", beanNameToCreate,
+                                clazz.getSimpleName(), e);
+                    }
                 }
             }
 
@@ -318,4 +324,16 @@ private String getBeanName(final GrpcClientBean grpcClientBean) {
         }
     }
 
+    /**
+     * The method is used to check for the presence of an annotation {@link Configuration} or {@link TestConfiguration}
+     *
+     * @param clazz instance of the class
+     * @return does the class have an annotation or not
+     */
+    private boolean isAnnotatedWithConfiguration(final Class<?> clazz) {
+        final Configuration[] configurationAnnotation = clazz.getAnnotationsByType(Configuration.class);
+        final TestConfiguration[] testConfigurationAnnotation = clazz.getAnnotationsByType(TestConfiguration.class);
+        return configurationAnnotation.length != 0 || testConfigurationAnnotation.length != 0;
+    }
+
 }

tests/src/test/java/net/devh/boot/grpc/test/inject/GrpcClientBeanInjectionTest.java

@@ -25,6 +25,7 @@
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 
@@ -48,6 +49,7 @@
 @SpringJUnitConfig(
         classes = {
                 GrpcClientBeanInjectionTest.TestConfig.class,
+                GrpcClientBeanInjectionTest.CustomConfig.class,
                 InProcessConfiguration.class,
                 ServiceConfiguration.class,
                 BaseAutoConfiguration.class
@@ -73,36 +75,67 @@ public class GrpcClientBeanInjectionTest {
     @Autowired
     String aboutMethodInjectedBlockingStubBean;
 
+    @Autowired
+    TestServiceGrpc.TestServiceBlockingStub stubFromSpringConfiguration;
+
+    /**
+     * Test should cover bean simple single bean creation with {@link GrpcClientBean} annotation with
+     * {@link TestConfiguration}
+     */
     @Test
-    void singleContextInjectionTest() {
+    void singleContextInjectionFromTestConfigurationTest() {
         assertNotNull(blockingStub, "blockingStub");
     }
 
+    /**
+     * Test should cover bean simple single bean creation with {@link GrpcClientBean} annotation with
+     * {@link Configuration}
+     */
+    @Test
+    void singleContextInjectionFromConfigurationTest() {
+        assertNotNull(stubFromSpringConfiguration, "stubFromSpringConfiguration");
+    }
+
+    /**
+     * Test should cover creation of another bean with different stub class and same grpc client definition
+     */
     @Test
     void anotherSubTypeAndSameClientDefinitionTest() {
         assertNotNull(futureStubForClientTest, "futureStubForClientTest");
     }
 
+    /**
+     * Test should cover creation of another bean same different stub class, but different grpc client definition
+     */
     @Test
     void twoDifferentClientDefinitionsTest() {
         assertNotNull(anotherBlockingStub, "blockingStub");
     }
 
+    /**
+     * Test should cover creation of another bean with different service and stub class with same grpc client definition
+     */
+    @Test
+    void anotherGrpcServiceAndSameGrpcClientDefinitionTest() {
+        assertNotNull(anotherServiceClientBean, "anotherServiceClientBean");
+    }
+
+    /**
+     * Test should cover creation of bean without defined bean name
+     */
     @Test
     void unnamedBeanContextInjectionTest() {
         assertNotNull(unnamedTestServiceBlockingStub, "unnamedTestServiceBlockingStub");
     }
 
+    /**
+     * Test should cover bean method injection via {@link Autowired} and {@link Qualifier} from context
+     */
     @Test
     void autoWiringQualifierMethodInjectionFromContextTest() {
         assertNotNull(aboutMethodInjectedBlockingStubBean, "aboutBlockingStubBean");
     }
 
-    @Test
-    void anotherGrpcServiceAndSameGrpcClientDefinitionTest() {
-        assertNotNull(anotherServiceClientBean, "anotherServiceClientBean");
-    }
-
     @TestConfiguration
     @GrpcClientBeans(value = {
             @GrpcClientBean(
@@ -151,4 +184,12 @@ protected String getFactoryMethodName() {
             };
         }
     }
+
+    @Configuration
+    @GrpcClientBean(
+            clazz = TestServiceGrpc.TestServiceBlockingStub.class,
+            beanName = "stubFromSpringConfiguration",
+            client = @GrpcClient("test2"))
+    public static class CustomConfig {
+    }
 }