test: indexes, fix on error infinite loop

furszy · furszy · commit 89ba8905f5c6 · 2023-07-10T15:27:13.000-03:00
As index sync failures trigger a shutdown request without notifying
BaseIndex::BlockUntilSyncedToCurrentChain in any way, we also need
to check whether a shutdown was requested or not inside 'IndexWaitSynced'.

Otherwise, any error inside the index sync process will hang the test
forever.
diff --git a/src/test/util/index.cpp b/src/test/util/index.cpp
@@ -5,11 +5,18 @@
 #include <test/util/index.h>
 
 #include <index/base.h>
+#include <shutdown.h>
+#include <util/check.h>
 #include <util/time.h>
 
 void IndexWaitSynced(const BaseIndex& index)
 {
     while (!index.BlockUntilSyncedToCurrentChain()) {
+        // Assert shutdown was not requested to abort the test, instead of looping forever, in case
+        // there was an unexpected error in the index that caused it to stop syncing and request a shutdown.
+        Assert(!ShutdownRequested());
+
         UninterruptibleSleep(100ms);
     }
+    assert(index.GetSummary().synced);
 }

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,18 @@`
`5`	`5`	`#include <test/util/index.h>`
`6`	`6`
`7`	`7`	`#include <index/base.h>`
	`8`	`+#include <shutdown.h>`
	`9`	`+#include <util/check.h>`
`8`	`10`	`#include <util/time.h>`
`9`	`11`
`10`	`12`	`void IndexWaitSynced(const BaseIndex& index)`
`11`	`13`	`{`
`12`	`14`	`while (!index.BlockUntilSyncedToCurrentChain()) {`
	`15`	`+ // Assert shutdown was not requested to abort the test, instead of looping forever, in case`
	`16`	`+ // there was an unexpected error in the index that caused it to stop syncing and request a shutdown.`
	`17`	`+ Assert(!ShutdownRequested());`
	`18`	`+`
`13`	`19`	`UninterruptibleSleep(100ms);`
`14`	`20`	`}`
	`21`	`+ assert(index.GetSummary().synced);`
`15`	`22`	`}`