feat: ConnectWireMock annotation introduced (#65)

quarkiverse · Nov 17, 2023 · 18ea4e9 · 18ea4e9
1 parent 99f8ef9
commit 18ea4e9
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 30 deletions.
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -48,17 +48,16 @@ In addition, you might want to configure `WireMock` programmatically. To do so,
 </dependency>
 ----
 
-After that, you are able to inject a `WireMock` reference along with your test execution lifecycle has shown below:
+After that, a `WireMock` reference can be injected along with your test execution lifecycle has shown below:
 [source,java]
 ----
 @QuarkusTest
-@QuarkusTestResource(WireMockServerTestResource.class)
+@ConnectWireMock
 class WireMockDevServiceResourceTest {
 
     private static final String MOCK_MSG = "Hello from WireMock!";
 
-    @InjectWireMock
-    WireMock wiremock;
+    WireMock wiremock; // will be injected automatically when the class has been annotated with @ConnectWireMock
 
     @Test
     void testHelloEndpoint() {

diff --git a/...ervices/WireMockDevServiceResourceIT.java → ...service/WireMockDevServiceResourceIT.java b/...ervices/WireMockDevServiceResourceIT.java → ...service/WireMockDevServiceResourceIT.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.wiremock.devservices;
+package io.quarkiverse.wiremock.devservice;
 
 import io.quarkus.test.junit.QuarkusIntegrationTest;
 

diff --git a/...vices/WireMockDevServiceResourceTest.java → ...rvice/WireMockDevServiceResourceTest.java b/...vices/WireMockDevServiceResourceTest.java → ...rvice/WireMockDevServiceResourceTest.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.wiremock.devservices;
+package io.quarkiverse.wiremock.devservice;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
@@ -11,19 +11,14 @@
 
 import com.github.tomakehurst.wiremock.client.WireMock;
 
-import io.quarkiverse.wiremock.devservice.InjectWireMock;
-import io.quarkiverse.wiremock.devservice.WireMockServerTestResource;
-import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
 
 @QuarkusTest
-@QuarkusTestResource(WireMockServerTestResource.class)
+@ConnectWireMock
 class WireMockDevServiceResourceTest {
 
     private static final String MOCK_MSG = "Hello from WireMock!";
-
-    @InjectWireMock
-    WireMock wiremock;
+    WireMock wiremock; // will be injected automatically when the class has been annotated with @ConnectWireMock
 
     @Test
     void testHelloEndpoint() {

diff --git a/test/src/main/java/io/quarkiverse/wiremock/devservice/ConnectWireMock.java b/test/src/main/java/io/quarkiverse/wiremock/devservice/ConnectWireMock.java
@@ -0,0 +1,16 @@
+package io.quarkiverse.wiremock.devservice;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import io.quarkus.test.common.QuarkusTestResource;
+
+@QuarkusTestResource(value = WireMockServerConnector.class, restrictToAnnotatedClass = true)
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Documented
+public @interface ConnectWireMock {
+}
diff --git a/test/src/main/java/io/quarkiverse/wiremock/devservice/InjectWireMock.java b/test/src/main/java/io/quarkiverse/wiremock/devservice/InjectWireMock.java
diff --git a/...evservice/WireMockServerTestResource.java → ...k/devservice/WireMockServerConnector.java b/...evservice/WireMockServerTestResource.java → ...k/devservice/WireMockServerConnector.java
@@ -11,12 +11,12 @@
 import com.github.tomakehurst.wiremock.client.WireMock;
 
 import io.quarkus.test.common.DevServicesContext;
-import io.quarkus.test.common.QuarkusTestResourceLifecycleManager;
+import io.quarkus.test.common.QuarkusTestResourceConfigurableLifecycleManager;
 
-public class WireMockServerTestResource
-        implements QuarkusTestResourceLifecycleManager, DevServicesContext.ContextAware {
+public class WireMockServerConnector
+        implements QuarkusTestResourceConfigurableLifecycleManager<ConnectWireMock>, DevServicesContext.ContextAware {
 
-    private static final Logger LOGGER = Logger.getLogger(WireMockServerTestResource.class);
+    private static final Logger LOGGER = Logger.getLogger(WireMockServerConnector.class);
     private static final String CONFIG_TEMPLATE = "%%dev,test.%s.%s";
     WireMock wiremock;
 
@@ -33,8 +33,7 @@ public void stop() {
 
     @Override
     public void inject(TestInjector testInjector) {
-        testInjector.injectIntoFields(wiremock,
-                new TestInjector.AnnotatedAndMatchesType(InjectWireMock.class, WireMock.class));
+        testInjector.injectIntoFields(wiremock, new TestInjector.MatchesType(WireMock.class));
     }
 
     @Override