Merge pull request #1482 from lightninglabs/fix-planter-unittest-flakes

Fix CI Unit Test Flakes

Author: guggero

tapgarden/custodian_test.go

@@ -584,12 +584,28 @@ func TestBookAssetSyncer(t *testing.T) {
 	// If we add the asset to the asset syncer, address creation should
 	// succeed.
 	h.syncer.AddAsset(*newAsset)
-	addrVersion = test.RandFlip(address.V0, address.V1)
-	newAddr, err := h.addrBook.NewAddress(
-		ctx, addrVersion, newAsset.ID(), 1, nil, proofCourierAddr,
-	)
+
+	// Fetch the asset from the syncer. This should trigger the
+	// background goroutine to add the asset to the address book.
+	_, err = h.syncer.FetchAsset(newAsset.ID())
 	require.NoError(t, err)
-	require.NotNil(t, newAddr)
+
+	// Eventually, the asset should be registered and we should be able to
+	// create a new address for it.
+	var newAddr *address.AddrWithKeyInfo
+	addrVersion = test.RandFlip(address.V0, address.V1)
+
+	require.Eventually(t, func() bool {
+		newAddr, err = h.addrBook.NewAddress(
+			ctx, addrVersion, newAsset.ID(), 1, nil,
+			proofCourierAddr,
+		)
+		if err != nil {
+			return false
+		}
+
+		return newAddr != nil
+	}, defaultTimeout, wait.PollInterval)
 
 	h.keyRing.AssertNumberOfCalls(t, "DeriveNextTaprootAssetKey", 2)
 

tapgarden/planter_test.go

@@ -46,7 +46,7 @@ import (
 // Default to a large interval so the planter never actually ticks and only
 // rely on our manual ticks.
 var (
-	defaultTimeout    = time.Second * 5
+	defaultTimeout    = time.Second * 10
 	noCaretakerStates = fn.NewSet(
 		tapgarden.BatchStatePending,
 		tapgarden.BatchStateSeedlingCancelled,
@@ -309,7 +309,18 @@ func (t *mintingTestHarness) queueSeedlingsInBatch(isFunded bool,
 		// The received update should be a state of MintingStateSeed.
 		require.Equal(t, tapgarden.MintingStateSeed, update.NewState)
 
-		t.keyRing.AssertNumberOfCalls(t, "DeriveNextKey", keyCount)
+		require.Eventually(t, func() bool {
+			// Assert that the key ring method DeriveNextKey was
+			// called the expected number of times.
+			count := 0
+			for _, call := range t.keyRing.Calls {
+				if call.Method == "DeriveNextKey" {
+					count++
+				}
+			}
+
+			return count == keyCount
+		}, defaultTimeout, wait.PollInterval)
 	}
 }
 
@@ -318,10 +329,15 @@ func (t *mintingTestHarness) queueSeedlingsInBatch(isFunded bool,
 func (t *mintingTestHarness) assertPendingBatchExists(numSeedlings int) {
 	t.Helper()
 
-	batch, err := t.planter.PendingBatch()
-	require.NoError(t, err)
-	require.NotNil(t, batch)
-	require.Len(t, batch.Seedlings, numSeedlings)
+	// The planter is a state machine, so we need to wait until it has
+	// reached the expected state.
+	require.Eventually(t, func() bool {
+		batch, err := t.planter.PendingBatch()
+		require.NoError(t, err)
+
+		require.NotNil(t, batch)
+		return len(batch.Seedlings) == numSeedlings
+	}, defaultTimeout, wait.PollInterval)
 }
 
 // assertNoActiveBatch asserts that no pending batch exists.