Add HoverflySpy to enable SPY mode in hoverfly-java-junit5 (#256)

Author: patown

junit5/src/main/java/io/specto/hoverfly/junit5/HoverflyExtension.java

@@ -3,12 +3,7 @@
 import io.specto.hoverfly.junit.core.Hoverfly;
 import io.specto.hoverfly.junit.core.HoverflyMode;
 import io.specto.hoverfly.junit.core.SimulationSource;
-import io.specto.hoverfly.junit5.api.HoverflyCapture;
-import io.specto.hoverfly.junit5.api.HoverflyConfig;
-import io.specto.hoverfly.junit5.api.HoverflyCore;
-import io.specto.hoverfly.junit5.api.HoverflyDiff;
-import io.specto.hoverfly.junit5.api.HoverflySimulate;
-import io.specto.hoverfly.junit5.api.HoverflyValidate;
+import io.specto.hoverfly.junit5.api.*;
 import org.junit.jupiter.api.extension.*;
 
 import java.lang.reflect.AnnotatedElement;
@@ -111,8 +106,14 @@ public void beforeAll(ExtensionContext context) {
             String path = getPath(context, hoverflyDiff.source());
             HoverflySimulate.SourceType type = hoverflyDiff.source().type();
             source = getSimulationSource(path, type);
+        } else if (isAnnotated(annotatedElement, HoverflySpy.class)) {
+            HoverflySpy hoverflySpy = annotatedElement.getAnnotation(HoverflySpy.class);
+            config = hoverflySpy.config();
+            mode = HoverflyMode.SPY;
+            String path = getPath(context, hoverflySpy.source());
+            HoverflySimulate.SourceType type = hoverflySpy.source().type();
+            source = getSimulationSource(path, type);
         }
-
         if (!isRunning()) {
             hoverfly = new Hoverfly(getHoverflyConfigs(config), mode);
             hoverfly.start();

junit5/src/main/java/io/specto/hoverfly/junit5/api/HoverflySpy.java

@@ -0,0 +1,32 @@
+package io.specto.hoverfly.junit5.api;
+
+import io.specto.hoverfly.junit5.HoverflyExtension;
+
+import io.specto.hoverfly.junit5.api.HoverflySimulate.Source;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation used along with {@link HoverflyExtension} to run Hoverfly in spy mode
+ * In this mode, Hoverfly simulates external APIs if a request match is found in simulation data
+ * (See Simulate mode), otherwise, the request will be passed through to the real API.
+ */
+@Target({ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface HoverflySpy {
+
+    /**
+     * Hoverfly configurations
+     * @see HoverflyConfig
+     */
+    HoverflyConfig config() default @HoverflyConfig;
+
+    /**
+     * Simulation source to import
+     * @see Source
+     */
+    Source source() default @Source;
+
+}

junit5/src/test/java/io/specto/hoverfly/junit5/HoverflySpyTest.java

@@ -0,0 +1,26 @@
+package io.specto.hoverfly.junit5;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.specto.hoverfly.junit.core.Hoverfly;
+import io.specto.hoverfly.junit.core.HoverflyMode;
+import io.specto.hoverfly.junit5.api.HoverflySimulate;
+import io.specto.hoverfly.junit5.api.HoverflySpy;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+@ExtendWith(HoverflyExtension.class)
+@HoverflySpy(source = @HoverflySimulate.Source(value = "test-service-https.json", type = HoverflySimulate.SourceType.CLASSPATH)
+)
+public class HoverflySpyTest {
+
+    @Test
+    void shouldInjectCustomInstanceAsParameterWithRequiredMode(Hoverfly hoverfly) {
+        assertThat(hoverfly.getMode()).isEqualTo(HoverflyMode.SPY);
+    }
+
+    @Test
+    void shouldImportSimulationFromCustomSource(Hoverfly hoverfly) {
+        assertThat(hoverfly.getSimulation().getHoverflyData().getPairs()).isNotEmpty();
+    }
+}