4.x: Ability to Inject MockBeans in Helidon #7694 (#8674)

* 4.x: Ability to Inject MockBeans in Helidon #7694

Signed-off-by: Jorge Bescos Gascon <jorge.bescos.gascon@oracle.com>

all/pom.xml

@@ -773,6 +773,10 @@
             <groupId>io.helidon.messaging.mock</groupId>
             <artifactId>helidon-messaging-mock</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.microprofile.testing</groupId>
+            <artifactId>helidon-microprofile-testing-mocking</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.helidon.logging</groupId>
             <artifactId>helidon-logging-common</artifactId>

bom/pom.xml

@@ -1028,6 +1028,11 @@
                 <artifactId>helidon-messaging-mock</artifactId>
                 <version>${helidon.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.helidon.microprofile.testing</groupId>
+                <artifactId>helidon-microprofile-testing-mocking</artifactId>
+                <version>${helidon.version}</version>
+            </dependency>
             <!-- Logging -->
             <dependency>
                 <groupId>io.helidon.logging</groupId>

dependencies/pom.xml

@@ -40,6 +40,7 @@
         <version.lib.animal-sniffer>1.18</version.lib.animal-sniffer>
         <version.lib.annotation-api>1.3.5</version.lib.annotation-api>
         <version.lib.brave-opentracing>1.0.0</version.lib.brave-opentracing>
+        <version.lib.bytebuddy>1.14.14</version.lib.bytebuddy>
         <version.lib.commons-codec>1.16.0</version.lib.commons-codec>
         <version.lib.commons-logging>1.2</version.lib.commons-logging>
         <version.lib.cron-utils>9.1.6</version.lib.cron-utils>
@@ -501,6 +502,11 @@
                     </exclusion>
                 </exclusions>
             </dependency>
+            <dependency>
+                <groupId>net.bytebuddy</groupId>
+                <artifactId>byte-buddy</artifactId>
+                <version>${version.lib.bytebuddy}</version>
+            </dependency>
             <dependency>
                 <groupId>jakarta.websocket</groupId>
                 <artifactId>jakarta.websocket-api</artifactId>

microprofile/testing/junit5/pom.xml

@@ -67,7 +67,6 @@
             <artifactId>hamcrest-core</artifactId>
             <scope>test</scope>
         </dependency>
-
     </dependencies>
 
 </project>

microprofile/testing/junit5/src/main/java/module-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2020, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

microprofile/testing/mocking/pom.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Copyright (c) 2024 Oracle and/or its affiliates.
+
+    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
+
+        http://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.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.helidon.microprofile.testing</groupId>
+        <artifactId>helidon-microprofile-testing-project</artifactId>
+        <version>4.0.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>helidon-microprofile-testing-mocking</artifactId>
+    <name>Helidon Microprofile Testing Mocking</name>
+
+    <description>
+        Integration with Mocking to support tests with CDI injection
+    </description>
+
+    <dependencies>
+        <dependency>
+            <groupId>jakarta.enterprise</groupId>
+            <artifactId>jakarta.enterprise.cdi-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+</project>

microprofile/testing/mocking/src/main/java/io/helidon/microprofile/testing/mocking/MockBean.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * 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
+ *
+ *     http://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 io.helidon.microprofile.testing.mocking;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.mockito.Answers;
+
+/**
+ * A field annotated with @MockBean will be mocked by Mockito
+ * and injected in every place it is referenced.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.PARAMETER})
+public @interface MockBean {
+
+    /**
+     * The {@link Answers} type to use on the mock.
+     * Defaults to {@link Answers#RETURNS_DEFAULTS}
+     * @return the answer type
+     */
+    Answers answer() default Answers.RETURNS_DEFAULTS;
+}

microprofile/testing/mocking/src/main/java/io/helidon/microprofile/testing/mocking/MockBeansCdiExtension.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * 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
+ *
+ *     http://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 io.helidon.microprofile.testing.mocking;
+
+import java.lang.reflect.Field;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.enterprise.event.Observes;
+import jakarta.enterprise.inject.literal.InjectLiteral;
+import jakarta.enterprise.inject.spi.AfterBeanDiscovery;
+import jakarta.enterprise.inject.spi.AnnotatedParameter;
+import jakarta.enterprise.inject.spi.Bean;
+import jakarta.enterprise.inject.spi.BeanManager;
+import jakarta.enterprise.inject.spi.Extension;
+import jakarta.enterprise.inject.spi.ProcessAnnotatedType;
+import jakarta.enterprise.inject.spi.WithAnnotations;
+import org.mockito.MockSettings;
+import org.mockito.Mockito;
+
+/**
+ * CDI extension for Mocking implementation.
+ */
+public class MockBeansCdiExtension implements Extension {
+
+    private final Map<Class<?>, MockBean> mocks = new HashMap<>();
+
+    void processMockBean(@Observes @WithAnnotations(MockBean.class) ProcessAnnotatedType<?> obj) throws Exception {
+        var configurator = obj.configureAnnotatedType();
+        configurator.fields().forEach(field -> {
+            MockBean mockBean = field.getAnnotated().getAnnotation(MockBean.class);
+            if (mockBean != null) {
+                Field f = field.getAnnotated().getJavaMember();
+                // Adds @Inject to be more user friendly
+                field.add(InjectLiteral.INSTANCE);
+                Class<?> fieldType = f.getType();
+                mocks.put(fieldType, mockBean);
+            }
+        });
+        configurator.constructors().forEach(constructor -> {
+            processMockBeanParameters(constructor.getAnnotated().getParameters());
+        });
+    }
+
+    private void processMockBeanParameters(List<? extends AnnotatedParameter<?>> parameters) {
+        parameters.stream().forEach(parameter -> {
+            MockBean mockBean = parameter.getAnnotation(MockBean.class);
+            if (mockBean != null) {
+                Class<?> parameterType = parameter.getJavaParameter().getType();
+                mocks.put(parameterType, mockBean);
+            }
+        });
+    }
+
+    void registerOtherBeans(@Observes AfterBeanDiscovery event, BeanManager beanManager) {
+        // Register all mocks
+        mocks.entrySet().forEach(entry -> {
+            event.addBean()
+                .addType(entry.getKey())
+                .scope(ApplicationScoped.class)
+                .alternative(true)
+                .createWith(inst -> {
+                    Set<Bean<?>> beans = beanManager.getBeans(MockSettings.class);
+                    if (!beans.isEmpty()) {
+                        Bean<?> bean = beans.iterator().next();
+                        MockSettings mockSettings = (MockSettings) beanManager.getReference(bean, MockSettings.class,
+                                beanManager.createCreationalContext(null));
+                        return Mockito.mock(entry.getKey(), mockSettings);
+                    } else {
+                        return Mockito.mock(entry.getKey(), Mockito.withSettings().defaultAnswer(entry.getValue().answer()));
+                    }
+                })
+                .priority(0);
+        });
+    }
+}

microprofile/testing/mocking/src/main/java/io/helidon/microprofile/testing/mocking/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * 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
+ *
+ *     http://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.
+ */
+
+/**
+ * Helidon implementation of mocking.
+ */
+package io.helidon.microprofile.testing.mocking;

microprofile/testing/mocking/src/main/java/module-info.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * 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
+ *
+ *     http://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.
+ */
+
+/**
+ * Mock Beans extension module to run CDI tests.
+ */
+module io.helidon.microprofile.testing.mocking {
+
+    requires jakarta.inject;
+    requires org.mockito;
+
+    requires transitive jakarta.cdi;
+
+    exports io.helidon.microprofile.testing.mocking;
+
+    provides jakarta.enterprise.inject.spi.Extension
+        with io.helidon.microprofile.testing.mocking.MockBeansCdiExtension;
+}

microprofile/testing/pom.xml

@@ -35,5 +35,6 @@
     <modules>
         <module>junit5</module>
         <module>testng</module>
+        <module>mocking</module>
     </modules>
 </project>

microprofile/testing/testng/pom.xml

@@ -57,7 +57,6 @@
             <groupId>io.helidon.config</groupId>
             <artifactId>helidon-config-yaml-mp</artifactId>
         </dependency>
-
         <dependency>
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>

microprofile/testing/testng/src/main/java/module-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

microprofile/tests/testing/junit5/pom.xml

@@ -55,5 +55,15 @@
             <artifactId>hamcrest-core</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.microprofile.testing</groupId>
+            <artifactId>helidon-microprofile-testing-mocking</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>