Merge pull request #811 from lightninglabs/flake-fix

Fix unit and integration test flakes

Author: guggero

Makefile

@@ -212,11 +212,15 @@ endif
 
 flakehunter: build-itest
 	@$(call print, "Flake hunting ${backend} integration tests.")
-	while [ $$? -eq 0 ]; do make itest-only; done
+	while [ $$? -eq 0 ]; do make itest-only-trace; done
 
 flake-unit:
 	@$(call print, "Flake hunting unit tests.")
-	while [ $$? -eq 0 ]; do '$(GOLIST) | $(XARGS) env $(GOTEST) -test.timeout=20m -count=1'; done
+	while [ $$? -eq 0 ]; do make unit nocache=1; done
+
+flake-unit-trace:
+	@$(call print, "Flake hunting unit tests in debug mode.")
+	while [ $$? -eq 0 ]; do make unit-trace nocache=1; done
 
 flake-unit-race:
 	@$(call print, "Flake hunting races in unit tests.")

itest/assertions.go

@@ -1198,6 +1198,34 @@ func AssertUniverseRootEquality(t *testing.T,
 	))
 }
 
+// AssertUniverseRootEqualityEventually checks that the universe roots returned
+// by two daemons are either equal eventually.
+func AssertUniverseRootEqualityEventually(t *testing.T,
+	clientA, clientB unirpc.UniverseClient) {
+
+	ctxb := context.Background()
+	ctxt, cancel := context.WithTimeout(ctxb, defaultWaitTimeout)
+	defer cancel()
+
+	err := wait.NoError(func() error {
+		rootRequest := &unirpc.AssetRootRequest{}
+		universeRootsAlice, err := clientA.AssetRoots(ctxt, rootRequest)
+		require.NoError(t, err)
+		universeRootsBob, err := clientB.AssetRoots(ctxt, rootRequest)
+		require.NoError(t, err)
+
+		if !AssertUniverseRootsEqual(
+			universeRootsAlice, universeRootsBob,
+		) {
+
+			return fmt.Errorf("roots not equal")
+		}
+
+		return nil
+	}, defaultWaitTimeout)
+	require.NoError(t, err)
+}
+
 // AssertUniverseRoot makes sure the given universe root exists with the given
 // sum, either identified by the asset ID or group key.
 func AssertUniverseRoot(t *testing.T, client unirpc.UniverseClient,

itest/multi_asset_group_test.go

@@ -317,6 +317,10 @@ func testMultiAssetGroupSend(t *harnessTest) {
 		collectibleGroupMembers + 1,
 	})
 
+	AssertUniverseRootEqualityEventually(
+		t.t, t.tapd, t.universeServer.service,
+	)
+
 	// We'll make a second node now that'll be the receiver of all the
 	// assets made above.
 	secondTapd := setupTapdHarness(
@@ -326,6 +330,10 @@ func testMultiAssetGroupSend(t *harnessTest) {
 		require.NoError(t.t, secondTapd.stop(!*noDelete))
 	}()
 
+	AssertUniverseRootEqualityEventually(
+		t.t, secondTapd, t.universeServer.service,
+	)
+
 	// Send 5 of the assets to Bob, and verify that they are received.
 	numUnits := issuableAsset.Asset.Amount
 	assetType := issuableAsset.Asset.AssetType

proof/mock.go

@@ -268,7 +268,29 @@ func (m *MockProofCourier) ReceiveProof(_ context.Context,
 		return nil, ErrProofNotFound
 	}
 
-	return proof, nil
+	return &AnnotatedProof{
+		Locator: Locator{
+			AssetID:   proof.Locator.AssetID,
+			GroupKey:  proof.Locator.GroupKey,
+			ScriptKey: proof.Locator.ScriptKey,
+			OutPoint:  proof.Locator.OutPoint,
+		},
+		Blob: proof.Blob,
+		AssetSnapshot: &AssetSnapshot{
+			Asset:             proof.AssetSnapshot.Asset,
+			OutPoint:          proof.AssetSnapshot.OutPoint,
+			AnchorBlockHash:   proof.AssetSnapshot.AnchorBlockHash,
+			AnchorBlockHeight: proof.AssetSnapshot.AnchorBlockHeight,
+			AnchorTxIndex:     proof.AssetSnapshot.AnchorTxIndex,
+			AnchorTx:          proof.AssetSnapshot.AnchorTx,
+			OutputIndex:       proof.AssetSnapshot.OutputIndex,
+			InternalKey:       proof.AssetSnapshot.InternalKey,
+			ScriptRoot:        proof.AssetSnapshot.ScriptRoot,
+			TapscriptSibling:  proof.AssetSnapshot.TapscriptSibling,
+			SplitAsset:        proof.AssetSnapshot.SplitAsset,
+			MetaReveal:        proof.AssetSnapshot.MetaReveal,
+		},
+	}, nil
 }
 
 // SetSubscribers sets the set of subscribers that will be notified

rpcserver.go

@@ -3873,7 +3873,7 @@ func (r *rpcServer) QueryProof(ctx context.Context,
 	}
 
 	rpcsLog.Tracef("[QueryProof]: fetching proof at (universeID=%v, "+
-		"leafKey=%x)", universeID, leafKey.UniverseKey())
+		"leafKey=%x)", universeID.StringForLog(), leafKey.UniverseKey())
 
 	// Retrieve proof export config for the given universe.
 	syncConfigs, err := r.cfg.UniverseFederation.QuerySyncConfigs(ctx)
@@ -3937,7 +3937,8 @@ func (r *rpcServer) QueryProof(ctx context.Context,
 
 			rpcsLog.Debugf("[QueryProof]: error querying for "+
 				"proof at (universeID=%v, leafKey=%x)",
-				universeID, leafKey.UniverseKey())
+				universeID.StringForLog(),
+				leafKey.UniverseKey())
 			return nil, err
 		}
 
@@ -3953,12 +3954,13 @@ func (r *rpcServer) QueryProof(ctx context.Context,
 
 	// TODO(roasbeef): query may return multiple proofs, if allow key to
 	// not be fully specified
-	proof := proofs[0]
+	firstProof := proofs[0]
 
 	rpcsLog.Tracef("[QueryProof]: found proof at (universeID=%v, "+
-		"leafKey=%x)", universeID, leafKey.UniverseKey())
+		"leafKey=%x)", universeID.StringForLog(),
+		leafKey.UniverseKey())
 
-	return r.marshalUniverseProofLeaf(ctx, req, proof)
+	return r.marshalUniverseProofLeaf(ctx, req, firstProof)
 }
 
 // unmarshalAssetLeaf unmarshals an asset leaf from the RPC form.

tapdb/asset_minting.go

@@ -1096,10 +1096,11 @@ func (a *AssetMintingStore) CommitSignedGenesisTx(ctx context.Context,
 			AnchorUtxoID: sqlInt64(utxoID),
 		})
 		if err != nil {
-			return fmt.Errorf("unable to anchor pending assets: %w", err)
+			return fmt.Errorf("unable to anchor pending assets: %w",
+				err)
 		}
 
-		// Next, we'll anchor the genesis point to point to the chain
+		// Next, we'll anchor the genesis point-to-point to the chain
 		// transaction we inserted above.
 		if err := q.AnchorGenesisPoint(ctx, GenesisPointAnchor{
 			PrevOut:    genesisOutpoint,

tapdb/asset_minting_test.go

@@ -244,7 +244,7 @@ func TestCommitMintingBatchSeedlings(t *testing.T) {
 	mintingBatch := tapgarden.RandSeedlingMintingBatch(t, numSeedlings)
 	addRandGroupToBatch(t, assetStore, ctx, mintingBatch.Seedlings)
 	err := assetStore.CommitMintingBatch(ctx, mintingBatch)
-	require.NoError(t, err, "unable to write batch: %v", err)
+	require.NoError(t, err)
 
 	batchKey := mintingBatch.BatchKey.PubKey
 
@@ -267,11 +267,9 @@ func TestCommitMintingBatchSeedlings(t *testing.T) {
 	// Pick a random seedling and give it a specific group.
 	addRandGroupToBatch(t, assetStore, ctx, seedlings)
 	mintingBatch.Seedlings = mergeMap(mintingBatch.Seedlings, seedlings)
-	require.NoError(t,
-		assetStore.AddSeedlingsToBatch(
-			ctx, batchKey, maps.Values(seedlings)...,
-		), "unable to write seedlings: %v", err,
-	)
+	require.NoError(t, assetStore.AddSeedlingsToBatch(
+		ctx, batchKey, maps.Values(seedlings)...,
+	))
 
 	// If we read the batch from disk again, then we should have 10 total
 	// seedlings, and the batch still matches what we wrote to disk.
@@ -1088,7 +1086,7 @@ func TestGroupAnchors(t *testing.T) {
 	)
 	addMultiAssetGroupToBatch(t, mintingBatch.Seedlings)
 	err := assetStore.CommitMintingBatch(ctx, mintingBatch)
-	require.NoError(t, err, "unable to write batch: %v", err)
+	require.NoError(t, err)
 
 	batchKey := mintingBatch.BatchKey.PubKey
 

tapdb/multiverse.go

@@ -538,7 +538,7 @@ func namespaceForProof(proofType universe.ProofType) (string, error) {
 		return transferMultiverseNS, nil
 
 	default:
-		return "", fmt.Errorf("unknown proof type: %v", int(proofType))
+		return "", fmt.Errorf("unknown proof type: %d", int(proofType))
 	}
 }
 

tapdb/sqlutils.go

@@ -167,7 +167,7 @@ func parseCoalesceNumericType[T constraints.Integer](value any) (T, error) {
 		parsedValue, err := strconv.ParseInt(typedValue, 10, 64)
 		if err != nil {
 			return 0, fmt.Errorf("unable to parse value '%v' as "+
-				"number: %v", value, err)
+				"number: %w", value, err)
 		}
 
 		return T(parsedValue), nil

tapgarden/custodian.go

@@ -284,6 +284,14 @@ func (c *Custodian) watchInboundAssets() {
 			continue
 		}
 
+		// If this event is not yet confirmed, we don't yet expect a
+		// proof to be delivered. We'll wait for the confirmation to
+		// come in, and then we'll launch a goroutine to use the
+		// ProofCourier to import the proof into our local DB.
+		if event.ConfirmationHeight == 0 {
+			continue
+		}
+
 		// If we didn't find a proof, we'll launch a goroutine to use
 		// the ProofCourier to import the proof into our local DB.
 		c.Wg.Add(1)
@@ -530,7 +538,8 @@ func (c *Custodian) receiveProof(addr *address.Tap, op wire.OutPoint) error {
 		ctx, headerVerifier, c.cfg.GroupVerifier, false, addrProof,
 	)
 	if err != nil {
-		return fmt.Errorf("unable to import proofs: %w", err)
+		return fmt.Errorf("unable to import proofs script_key=%x, "+
+			"asset_id=%x: %w", scriptKeyBytes, assetID[:], err)
 	}
 
 	// The proof is now verified and in our local archive. We will now