Merge pull request #1651 from lightninglabs/itest-robust-AssertBalanceByID

itest: convert AssertBalanceByID to eventually-style call

Author: Roasbeef

.github/workflows/main.yaml

@@ -321,7 +321,7 @@ jobs:
           go-version: '${{ env.GO_VERSION }}'
 
       - name: run itest
-        run: make itest-parallel dbbackend=postgres
+        run: make itest-parallel dbbackend=postgres tranches=4
 
       - name: Zip log files on failure
         if: ${{ failure() }}

asset/asset.go

@@ -737,6 +737,11 @@ type Witness struct {
 // the witness should be encoded or not.
 func (w *Witness) encodeRecords(encodeType EncodeType) []tlv.Record {
 	var records []tlv.Record
+
+	if w == nil {
+		return records
+	}
+
 	if w.PrevID != nil {
 		records = append(records, NewWitnessPrevIDRecord(&w.PrevID))
 	}
@@ -771,6 +776,10 @@ func (w *Witness) DecodeRecords() []tlv.Record {
 
 // Encode encodes an asset witness into a TLV stream.
 func (w *Witness) Encode(writer io.Writer) error {
+	if w == nil {
+		return fmt.Errorf("cannot encode nil witness")
+	}
+
 	stream, err := tlv.NewStream(w.EncodeRecords()...)
 	if err != nil {
 		return err

asset/records.go

@@ -287,6 +287,10 @@ func NewWitnessPrevIDRecord(prevID **PrevID) tlv.Record {
 
 func NewWitnessTxWitnessRecord(witness *wire.TxWitness) tlv.Record {
 	recordSize := func() uint64 {
+		if witness == nil {
+			return 0
+		}
+
 		return uint64((*witness).SerializeSize())
 	}
 	return tlv.MakeDynamicRecord(

itest/addrs_test.go

@@ -1013,6 +1013,15 @@ func sendAsset(t *harnessTest, sender *tapdHarness,
 		options.sendAssetRequest.SkipProofCourierPingCheck = true
 	}
 
+	// The SubscribeSendEvents call returns immediately, but the server may
+	// still be setting up its event stream. If we emit an event too soon,
+	// it may be lost. We wait briefly to allow the server time to complete
+	// setup.
+	//
+	// TODO(ffranr): Remove this once the server supports buffering or
+	//  replaying early events for new subscribers.
+	time.Sleep(time.Second)
+
 	// Kick off the send asset request.
 	resp, err := sender.SendAsset(ctxt, &options.sendAssetRequest)
 	if options.errText != "" {

itest/assertions.go

@@ -1362,26 +1362,43 @@ func AssertAssetGenesis(t *testing.T, expected, actual *taprpc.GenesisInfo) {
 func AssertBalanceByID(t *testing.T, client taprpc.TaprootAssetsClient,
 	id []byte, amt uint64) {
 
-	ctxb := context.Background()
-	balancesResp, err := client.ListBalances(
-		ctxb, &taprpc.ListBalancesRequest{
-			GroupBy: &taprpc.ListBalancesRequest_AssetId{
-				AssetId: true,
+	require.Eventually(t, func() bool {
+		ctxb := context.Background()
+		balancesResp, err := client.ListBalances(
+			ctxb, &taprpc.ListBalancesRequest{
+				GroupBy: &taprpc.ListBalancesRequest_AssetId{
+					AssetId: true,
+				},
+				AssetFilter:   id,
+				ScriptKeyType: allScriptKeysQuery,
 			},
-			AssetFilter:   id,
-			ScriptKeyType: allScriptKeysQuery,
-		},
-	)
-	require.NoError(t, err)
+		)
+		if err != nil {
+			t.Logf("error listing balances: %v", err)
+			return false
+		}
 
-	balance, ok := balancesResp.AssetBalances[hex.EncodeToString(id)]
-	if amt == 0 {
-		require.False(t, ok)
-		return
-	}
+		// nolint: lll
+		balance, ok := balancesResp.AssetBalances[hex.EncodeToString(id)]
+		if amt == 0 {
+			require.False(t, ok)
+			return true
+		}
 
-	require.True(t, ok)
-	require.Equal(t, amt, balance.Balance)
+		if !ok {
+			t.Logf("balance for asset not found (asset_id=%x)", id)
+			return false
+		}
+
+		if balance.Balance != amt {
+			t.Logf("balance mismatch for asset (asset_id=%x, "+
+				"expected=%d, actual=%d)", id, amt,
+				balance.Balance)
+			return false
+		}
+
+		return true
+	}, defaultWaitTimeout, time.Second)
 }
 
 // AssertBalanceByGroup asserts that the balance of a single asset group

itest/test_list_on_test.go

@@ -290,7 +290,7 @@ var allTestCases = []*testCase{
 		test: testGetInfo,
 	},
 	{
-		name: "burn test",
+		name: "burn assets",
 		test: testBurnAssets,
 	},
 	{