Fix extensions calling invocation.proceed multiple times (#1862) (#2239)

Author: Vampire

docs/release_notes.adoc

@@ -78,6 +78,7 @@ will now require that the spec is annotated with <<parallel_execution.adoc#isola
 * Fix: Prevent NPE in SpecRunHistory.sortFeatures when duration is missing spockIssue:2234[]
 * `Retry` extension does not mesh with `TestAbortedException` and `PendingFeature` spockIssue:1863[]
 * Fix display of caught exceptions within `verifyEach` blocks spockPull:2163[]
+* Fix extensions that call `invocation.proceed()` multiple times like `@Retry` does spockIssue:1862[]
 
 Thanks to all the contributors to this release: Andreas Turban, Björn Kautler, Christoph Loy, Leonard Brünings, Thanos Tsiamis
 

spock-core/src/main/java/org/spockframework/runtime/extension/MethodInvocation.java

@@ -41,6 +41,7 @@ public class MethodInvocation implements IMethodInvocation {
   private final MethodInfo method;
   private Object[] arguments;
   private final Iterator<IMethodInterceptor> interceptors;
+  private IMethodInterceptor nextInterceptor;
 
   private final StoreProvider storeProvider;
 
@@ -59,6 +60,19 @@ public MethodInvocation(FeatureInfo feature, IterationInfo iteration, StoreProvi
       : CollectionUtil.concat(scopedInterceptors, method.getInterceptors()).iterator();
   }
 
+  private MethodInvocation(FeatureInfo feature, IterationInfo iteration, StoreProvider storeProvider, Object sharedInstance,
+                          Object instance, Object target, MethodInfo method, Iterator<IMethodInterceptor> interceptors, Object[] arguments) {
+    this.feature = feature;
+    this.iteration = iteration;
+    this.storeProvider = storeProvider;
+    this.sharedInstance = sharedInstance;
+    this.instance = instance;
+    this.target = target;
+    this.method = method;
+    this.interceptors = interceptors;
+    this.arguments = arguments;
+  }
+
   @Override
   public SpecInfo getSpec() {
     return method.getParent();
@@ -118,8 +132,12 @@ public void resolveArgument(int index, Object value) {
 
   @Override
   public void proceed() throws Throwable {
-    if (interceptors.hasNext())
-      interceptors.next().intercept(this);
+    if ((nextInterceptor == null) && interceptors.hasNext()) {
+      nextInterceptor = interceptors.next();
+    }
+    if (nextInterceptor != null)
+      nextInterceptor.intercept(new MethodInvocation(feature, iteration, storeProvider,
+        sharedInstance, instance, target, method, interceptors, arguments.clone()));
     else method.invoke(target, arguments);
   }
 }

spock-specs/src/test/groovy/org/spockframework/smoke/extension/RetryFeatureExtensionSpec.groovy

@@ -27,13 +27,15 @@ class RetryFeatureExtensionSpec extends EmbeddedSpecification {
   static AtomicInteger setupCounter = new AtomicInteger()
   static AtomicInteger cleanupCounter = new AtomicInteger()
   static AtomicInteger featureCounter = new AtomicInteger()
+  static AtomicInteger extensionCounter = new AtomicInteger()
   static StringBuffer iterationBuffer
 
   def setup() {
     runner.throwFailure = false
     setupCounter.set(0)
     cleanupCounter.set(0)
     featureCounter.set(0)
+    extensionCounter.set(0)
     iterationBuffer = new StringBuffer()
   }
 
@@ -772,6 +774,33 @@ class Foo extends Specification {
     )
   }
 
+  def "@Retry interceptor chains to enclosed interceptors each time"() {
+    when:
+    def result = runner.runWithImports("""
+import spock.lang.Retry
+import org.spockframework.smoke.extension.CountExecution
+
+class Foo extends Specification {
+  @Retry
+  @CountExecution
+  def bar(baz) {
+    expect: false
+  }
+}
+    """)
+
+    then:
+    result.testsStartedCount == 1
+    result.testsSucceededCount == 0
+    result.testsFailedCount == 1
+    with(result.failures.exception[0], MultipleFailuresError) {
+      failures.size() == 4
+      failures.every { it instanceof ConditionNotSatisfiedError }
+    }
+    result.testsSkippedCount == 0
+    extensionCounter.get() == 4
+  }
+
   private def withParallelExecution(boolean enableParallelExecution) {
     runner.configurationScript {
       runner {
@@ -795,9 +824,25 @@ class Foo extends Specification {
       }
     }
   }
+
+  static class CountExecutionExtension implements IAnnotationDrivenExtension<CountExecution> {
+    @Override
+    void visitFeatureAnnotation(CountExecution annotation, FeatureInfo feature) {
+      feature.featureMethod.addInterceptor { invocation ->
+        org.spockframework.smoke.extension.RetryFeatureExtensionSpec.extensionCounter.incrementAndGet()
+        invocation.resolveArgument(0, "BAZ")
+        invocation.proceed()
+      }
+    }
+  }
 }
 
 @Retention(RetentionPolicy.RUNTIME)
 @ExtensionAnnotation(RetryFeatureExtensionSpec.ChangeThreadExtension)
 @interface ChangeThread {
 }
+
+@Retention(RetentionPolicy.RUNTIME)
+@ExtensionAnnotation(RetryFeatureExtensionSpec.CountExecutionExtension)
+@interface CountExecution {
+}