HSEARCH-4316 Prioritize displaying unexpected calls when expectations…

… are not met in BackendMock Unexpected calls are often the right place to start to debug problems, so we might as well display them first.
hibernate · Nov 30, 2021 · 67e6bc4 · 67e6bc4
1 parent 752e1ee
commit 67e6bc4
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/...n/src/main/java/org/hibernate/search/util/impl/integrationtest/common/rule/CallQueue.java b/...n/src/main/java/org/hibernate/search/util/impl/integrationtest/common/rule/CallQueue.java
@@ -217,14 +217,16 @@ private AssertionError createFailure(String message) {
 		throw new IllegalStateException( "This should not happen" );
 	}
 
-	public synchronized void verifyExpectationsMet() {
+	public synchronized void verifyNoUnexpectedCall() {
 		if ( lastVerifyFailure != null ) {
 			Fail.fail(
 					"A verify error occurred during the test: " + lastVerifyFailure.getMessage(),
 					lastVerifyFailure
 			);
 		}
+	}
 
+	public synchronized void verifyExpectationsMet() {
 		List<C> remaining = new ArrayList<>();
 		remaining.addAll( callsExpectedInOrder );
 		remaining.addAll( callsExpectedOutOfOrder );

diff --git a/.../hibernate/search/util/impl/integrationtest/common/rule/VerifyingStubBackendBehavior.java b/.../hibernate/search/util/impl/integrationtest/common/rule/VerifyingStubBackendBehavior.java
@@ -205,6 +205,20 @@ void verifyExpectationsMet() {
 		// we also report the additional ones as suppressed exceptions.
 		try ( Closer<RuntimeException> closer = new Closer<>() ) {
 			// We don't check anything for the various behaviors (createBackendBehaviors, ...): they are ignored if they are not executed.
+
+			// First, we check that there weren't any unexpected calls:
+			// those are the most useful to debug problems.
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall, schemaDefinitionCalls.values() );
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall, indexScaleWorkCalls.values() );
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall, schemaManagementWorkCall.values() );
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall, documentWorkCreateCalls.values() );
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall, documentWorkDiscardCalls.values() );
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall, documentWorkExecuteCalls.values() );
+			closer.pushAll( CallQueue::verifyNoUnexpectedCall,
+					searchCalls, countCalls,
+					scrollCalls, closeScrollCalls, nextScrollCalls );
+
+			// Then, we check that whatever we *were* expecting actually happened.
 			closer.pushAll( CallQueue::verifyExpectationsMet, schemaDefinitionCalls.values() );
 			closer.pushAll( CallQueue::verifyExpectationsMet, indexScaleWorkCalls.values() );
 			closer.pushAll( CallQueue::verifyExpectationsMet, schemaManagementWorkCall.values() );
@@ -221,7 +235,7 @@ void verifyExpectationsMet() {
 			);
 			closer.pushAll( CallQueue::verifyExpectationsMet,
 					searchCalls, countCalls,
-					scrollCalls, closeScrollCalls, nextScrollCalls, closeScrollCalls );
+					scrollCalls, closeScrollCalls, nextScrollCalls );
 		}
 
 		if ( indexingWorkExpectations.allowDuplicateIndexing() ) {