Extend the top interaction scope to cleanup methods

Author: Vampire

docs/interaction_based_testing.adoc

@@ -444,7 +444,7 @@ This makes sure that `subscriber` receives `"message1"` during execution of the
 and `"message2"` during execution of the second `when:` block.
 
 Interactions declared outside a `then:` block are active from their declaration until the end of the
-containing feature method.
+containing feature method plus an eventually existing `cleanup` method.
 
 Interactions are always scoped to a particular feature method. Hence they cannot be declared in a static method,
 `setupSpec` method, or `cleanupSpec` method. Likewise, mock objects should not be stored in static or `@Shared`

docs/release_notes.adoc

@@ -19,6 +19,12 @@ include::include.adoc[]
 === Breaking Changes
 
 * Mock/Stub checks on `Comparable<T>` with `T` being something other than `Object` now compare using the java identity hash code instead of always being equal spockIssue:2352[]
+* Interactions outside a `then:` block are now still active in an eventually existing `cleanup` method.
+  If the interaction contains a lower cardinality, this is still checked at the end of the feature method.
+  Upper cardinality is still relevant in the `cleanup` method, so could cause test failures where previously simply the default response of the mock object was used without cardinality check and could now cause previously working tests to fail.
+  This enables `cleanup` methods to get stubbed responses from mock objects which previously was only possible by using a custom default response.
+  If an interaction with stubbed response is present, the default response is also no longer used in the `cleanup` method because the interaction's stubbed response is used now, which could also cause existing tests to fail.
+  spockIssue:616[]
 
 == 2.4 (2025-12-11)
 

spock-core/src/main/java/org/spockframework/compiler/AstNodeCache.java

@@ -107,6 +107,9 @@ public class AstNodeCache {
   public final MethodNode MockController_LeaveScope =
       MockController.getDeclaredMethods(org.spockframework.mock.runtime.MockController.LEAVE_SCOPE).get(0);
 
+  public final MethodNode MockController_VerifyLastScope =
+      MockController.getDeclaredMethods(org.spockframework.mock.runtime.MockController.VERIFY_LAST_SCOPE).get(0);
+
   public final MethodNode SpecificationContext_GetMockController =
       SpecificationContext.getDeclaredMethods(org.spockframework.runtime.SpecificationContext.GET_MOCK_CONTROLLER).get(0);
 

spock-core/src/main/java/org/spockframework/compiler/SpecRewriter.java

@@ -410,7 +410,7 @@ public void visitMethodAgain(Method method) {
 
     // for global required interactions
     if (method instanceof FeatureMethod) {
-      method.getStatements().add(createMockControllerCall(nodeCache.MockController_LeaveScope));
+      method.getStatements().add(createMockControllerCall(nodeCache.MockController_VerifyLastScope));
     }
 
     if (method instanceof VerifyAllMethod) {

spock-core/src/main/java/org/spockframework/mock/TooFewInvocationsError.java

@@ -37,7 +37,7 @@ public TooFewInvocationsError(List<IMockInteraction> interactions, List<IMockInv
     Assert.notNull(interactions);
     Assert.that(interactions.size() > 0);
     this.interactions = interactions;
-    this.unmatchedInvocations = unmatchedInvocations;
+    this.unmatchedInvocations = new ArrayList<>(unmatchedInvocations);
   }
 
   @Override

spock-core/src/main/java/org/spockframework/mock/runtime/MockController.java

@@ -17,7 +17,7 @@
 package org.spockframework.mock.runtime;
 
 import org.spockframework.mock.*;
-import org.spockframework.util.Checks;
+import org.spockframework.util.Assert;
 import org.spockframework.util.ExceptionUtil;
 
 import java.util.*;
@@ -110,6 +110,14 @@ public synchronized void leaveScope() {
     scope.verifyInteractions();
   }
 
+  public static final String VERIFY_LAST_SCOPE = "verifyLastScope";
+
+  public synchronized void verifyLastScope() {
+    throwAnyPreviousError();
+    Assert.that(scopes.size() == 1,  () -> "There should be exactly one scope left, but there were " + scopes.size());
+    scopes.getFirst().verifyInteractions();
+  }
+
   private void throwAnyPreviousError() {
     if (!errors.isEmpty()) throw errors.get(0);
   }

spock-specs/src/test/groovy/org/spockframework/smoke/mock/GlobalInteractionsInCleanup.groovy

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2026 the original author or authors.
+ *
+ * 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
+ *
+ *     https://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 org.spockframework.smoke.mock
+
+import org.spockframework.runtime.ConditionNotSatisfiedError
+import spock.lang.FailsWith
+import spock.lang.Issue
+import spock.lang.Specification
+
+import java.util.function.Function
+
+@Issue("https://github.com/spockframework/spock/issues/616")
+class GlobalInteractionsInCleanup extends Specification {
+  def mock = Mock(Function)
+  def mock2 = Mock(Function) {
+    apply("a") >> { "c" }
+  }
+  def mock3 = Mock(Function)
+
+  def setup() {
+    mock.apply("a") >> { "b" }
+  }
+
+  def cleanup() {
+    verifyAll {
+      mock.apply("a") == "b"
+      mock2.apply("a") == "c"
+      mock3.apply("a") == "d"
+    }
+  }
+
+  def "run a successful test"() {
+    given:
+    mock3.apply("a") >> { "d" }
+
+    expect:
+    true
+  }
+
+  @FailsWith(ConditionNotSatisfiedError)
+  def "run a failing test"() {
+    given:
+    mock3.apply("a") >> { "d" }
+
+    expect:
+    false
+  }
+}

spock-specs/src/test/resources/snapshots/org/spockframework/smoke/ast/AstSpec/Primitive_types_are_used_in_AST_transformation.txt

@@ -181,7 +181,7 @@ public class apackage/TestSpec extends spock/lang/Specification implements groov
     LDC Lorg/spockframework/mock/runtime/MockController;.class
     INVOKESTATIC org/codehaus/groovy/runtime/ScriptBytecodeAdapter.castToType (Ljava/lang/Object;Ljava/lang/Class;)Ljava/lang/Object;
     CHECKCAST org/spockframework/mock/runtime/MockController
-    INVOKEVIRTUAL org/spockframework/mock/runtime/MockController.leaveScope ()V
+    INVOKEVIRTUAL org/spockframework/mock/runtime/MockController.verifyLastScope ()V
     ACONST_NULL
     POP
    L18

spock-specs/src/test/resources/snapshots/org/spockframework/smoke/ast/AstSpec/astToSourceFeatureBody_can_render_everything.groovy

@@ -10,7 +10,7 @@ public class apackage.ASpec extends spock.lang.Specification {
         org.spockframework.runtime.SpockRuntime.callBlockEntered(this, 0)
         java.lang.Object nothing = null
         org.spockframework.runtime.SpockRuntime.callBlockExited(this, 0)
-        this.getSpecificationContext().getMockController().leaveScope()
+        this.getSpecificationContext().getMockController().verifyLastScope()
     }
 
 }

spock-specs/src/test/resources/snapshots/org/spockframework/smoke/ast/AstSpec/astToSourceFeatureBody_renders_only_methods_and_its_annotation_by_default.groovy

@@ -9,7 +9,7 @@ public void $spock_feature_0_0() {
     org.spockframework.runtime.SpockRuntime.callBlockEntered(this, 0)
     java.lang.Object nothing = null
     org.spockframework.runtime.SpockRuntime.callBlockExited(this, 0)
-    this.getSpecificationContext().getMockController().leaveScope()
+    this.getSpecificationContext().getMockController().verifyLastScope()
 }
 /*--------- end::snapshot[] ---------*/
   }