watchtower/wtdb: update tests to use require package

In this commit, all the tests in the wtdb package are updated in order
to make use of the `require` package where appropriate.

watchtower/wtdb/client_db_test.go

@@ -1,11 +1,9 @@
 package wtdb_test
 
 import (
-	"bytes"
 	crand "crypto/rand"
 	"io"
 	"net"
-	"reflect"
 	"testing"
 
 	"github.com/btcsuite/btcd/btcec/v2"
@@ -16,6 +14,7 @@ import (
 	"github.com/lightningnetwork/lnd/watchtower/wtdb"
 	"github.com/lightningnetwork/lnd/watchtower/wtmock"
 	"github.com/lightningnetwork/lnd/watchtower/wtpolicy"
+	"github.com/stretchr/testify/require"
 )
 
 // clientDBInit is a closure used to initialize a wtclient.DB instance.
@@ -43,10 +42,7 @@ func (h *clientDBHarness) insertSession(session *wtdb.ClientSession,
 	h.t.Helper()
 
 	err := h.db.CreateClientSession(session)
-	if err != expErr {
-		h.t.Fatalf("expected create client session error: %v, got: %v",
-			expErr, err)
-	}
+	require.ErrorIs(h.t, err, expErr)
 }
 
 func (h *clientDBHarness) listSessions(
@@ -55,9 +51,7 @@ func (h *clientDBHarness) listSessions(
 	h.t.Helper()
 
 	sessions, err := h.db.ListClientSessions(id)
-	if err != nil {
-		h.t.Fatalf("unable to list client sessions: %v", err)
-	}
+	require.NoError(h.t, err, "unable to list client sessions")
 
 	return sessions
 }
@@ -68,13 +62,8 @@ func (h *clientDBHarness) nextKeyIndex(id wtdb.TowerID,
 	h.t.Helper()
 
 	index, err := h.db.NextSessionKeyIndex(id, blobType)
-	if err != nil {
-		h.t.Fatalf("unable to create next session key index: %v", err)
-	}
-
-	if index == 0 {
-		h.t.Fatalf("next key index should never be 0")
-	}
+	require.NoError(h.t, err, "unable to create next session key index")
+	require.NotZero(h.t, index, "next key index should never be 0")
 
 	return index
 }
@@ -85,21 +74,11 @@ func (h *clientDBHarness) createTower(lnAddr *lnwire.NetAddress,
 	h.t.Helper()
 
 	tower, err := h.db.CreateTower(lnAddr)
-	if err != expErr {
-		h.t.Fatalf("expected create tower error: %v, got: %v", expErr,
-			err)
-	}
-
-	if tower.ID == 0 {
-		h.t.Fatalf("tower id should never be 0")
-	}
+	require.ErrorIs(h.t, err, expErr)
+	require.NotZero(h.t, tower.ID, "tower id should never be 0")
 
 	for _, session := range h.listSessions(&tower.ID) {
-		if session.Status != wtdb.CSessionActive {
-			h.t.Fatalf("expected status for session %v to be %v, "+
-				"got %v", session.ID, wtdb.CSessionActive,
-				session.Status)
-		}
+		require.Equal(h.t, wtdb.CSessionActive, session.Status)
 	}
 
 	return tower
@@ -110,10 +89,9 @@ func (h *clientDBHarness) removeTower(pubKey *btcec.PublicKey, addr net.Addr,
 
 	h.t.Helper()
 
-	if err := h.db.RemoveTower(pubKey, addr); err != expErr {
-		h.t.Fatalf("expected remove tower error: %v, got %v", expErr,
-			err)
-	}
+	err := h.db.RemoveTower(pubKey, addr)
+	require.ErrorIs(h.t, err, expErr)
+
 	if expErr != nil {
 		return
 	}
@@ -122,37 +100,31 @@ func (h *clientDBHarness) removeTower(pubKey *btcec.PublicKey, addr net.Addr,
 
 	if addr != nil {
 		tower, err := h.db.LoadTower(pubKey)
-		if err != nil {
-			h.t.Fatalf("expected tower %x to still exist",
-				pubKeyStr)
-		}
+		require.NoErrorf(h.t, err, "expected tower %x to still exist",
+			pubKeyStr)
 
 		removedAddr := addr.String()
 		for _, towerAddr := range tower.Addresses {
-			if towerAddr.String() == removedAddr {
-				h.t.Fatalf("address %v not removed for tower "+
-					"%x", removedAddr, pubKeyStr)
-			}
+			require.NotEqualf(h.t, removedAddr, towerAddr,
+				"address %v not removed for tower %x",
+				removedAddr, pubKeyStr)
 		}
 	} else {
 		tower, err := h.db.LoadTower(pubKey)
-		if hasSessions && err != nil {
-			h.t.Fatalf("expected tower %x with sessions to still "+
-				"exist", pubKeyStr)
-		}
-		if !hasSessions && err == nil {
-			h.t.Fatalf("expected tower %x with no sessions to not "+
-				"exist", pubKeyStr)
-		}
-		if !hasSessions {
+		if hasSessions {
+			require.NoError(h.t, err, "expected tower %x with "+
+				"sessions to still exist", pubKeyStr)
+		} else {
+			require.Errorf(h.t, err, "expected tower %x with no "+
+				"sessions to not exist", pubKeyStr)
 			return
 		}
+
 		for _, session := range h.listSessions(&tower.ID) {
-			if session.Status != wtdb.CSessionInactive {
-				h.t.Fatalf("expected status for session %v to "+
-					"be %v, got %v", session.ID,
-					wtdb.CSessionInactive, session.Status)
-			}
+			require.Equal(h.t, wtdb.CSessionInactive,
+				session.Status, "expected status for session "+
+					"%v to be %v, got %v", session.ID,
+				wtdb.CSessionInactive, session.Status)
 		}
 	}
 }
@@ -163,10 +135,7 @@ func (h *clientDBHarness) loadTower(pubKey *btcec.PublicKey,
 	h.t.Helper()
 
 	tower, err := h.db.LoadTower(pubKey)
-	if err != expErr {
-		h.t.Fatalf("expected load tower error: %v, got: %v", expErr,
-			err)
-	}
+	require.ErrorIs(h.t, err, expErr)
 
 	return tower
 }
@@ -177,10 +146,7 @@ func (h *clientDBHarness) loadTowerByID(id wtdb.TowerID,
 	h.t.Helper()
 
 	tower, err := h.db.LoadTowerByID(id)
-	if err != expErr {
-		h.t.Fatalf("expected load tower error: %v, got: %v", expErr,
-			err)
-	}
+	require.ErrorIs(h.t, err, expErr)
 
 	return tower
 }
@@ -189,9 +155,7 @@ func (h *clientDBHarness) fetchChanSummaries() map[lnwire.ChannelID]wtdb.ClientC
 	h.t.Helper()
 
 	summaries, err := h.db.FetchChanSummaries()
-	if err != nil {
-		h.t.Fatalf("unable to fetch chan summaries: %v", err)
-	}
+	require.NoError(h.t, err)
 
 	return summaries
 }
@@ -202,10 +166,7 @@ func (h *clientDBHarness) registerChan(chanID lnwire.ChannelID,
 	h.t.Helper()
 
 	err := h.db.RegisterChannel(chanID, sweepPkScript)
-	if err != expErr {
-		h.t.Fatalf("expected register channel error: %v, got: %v",
-			expErr, err)
-	}
+	require.ErrorIs(h.t, err, expErr)
 }
 
 func (h *clientDBHarness) commitUpdate(id *wtdb.SessionID,
@@ -214,10 +175,7 @@ func (h *clientDBHarness) commitUpdate(id *wtdb.SessionID,
 	h.t.Helper()
 
 	lastApplied, err := h.db.CommitUpdate(id, update)
-	if err != expErr {
-		h.t.Fatalf("expected commit update error: %v, got: %v",
-			expErr, err)
-	}
+	require.ErrorIs(h.t, err, expErr)
 
 	return lastApplied
 }
@@ -228,10 +186,7 @@ func (h *clientDBHarness) ackUpdate(id *wtdb.SessionID, seqNum uint16,
 	h.t.Helper()
 
 	err := h.db.AckUpdate(id, seqNum, lastApplied)
-	if err != expErr {
-		h.t.Fatalf("expected commit update error: %v, got: %v",
-			expErr, err)
-	}
+	require.ErrorIs(h.t, err, expErr)
 }
 
 // testCreateClientSession asserts various conditions regarding the creation of
@@ -259,9 +214,9 @@ func testCreateClientSession(h *clientDBHarness) {
 
 	// First, assert that this session is not already present in the
 	// database.
-	if _, ok := h.listSessions(nil)[session.ID]; ok {
-		h.t.Fatalf("session for id %x should not exist yet", session.ID)
-	}
+	_, ok := h.listSessions(nil)[session.ID]
+	require.Falsef(h.t, ok, "session for id %x should not exist yet",
+		session.ID)
 
 	// Attempting to insert the client session without reserving a session
 	// key index should fail.
@@ -278,10 +233,8 @@ func testCreateClientSession(h *clientDBHarness) {
 	// successfully created, it should return the same index to maintain
 	// idempotency across restarts.
 	keyIndex2 := h.nextKeyIndex(session.TowerID, blobType)
-	if keyIndex != keyIndex2 {
-		h.t.Fatalf("next key index should be idempotent: want: %v, "+
-			"got %v", keyIndex, keyIndex2)
-	}
+	require.Equalf(h.t, keyIndex, keyIndex2, "next key index should "+
+		"be idempotent: want: %v, got %v", keyIndex, keyIndex2)
 
 	// Now, set the client session's key index so that it is proper and
 	// insert it. This should succeed.
@@ -289,9 +242,8 @@ func testCreateClientSession(h *clientDBHarness) {
 	h.insertSession(session, nil)
 
 	// Verify that the session now exists in the database.
-	if _, ok := h.listSessions(nil)[session.ID]; !ok {
-		h.t.Fatalf("session for id %x should exist now", session.ID)
-	}
+	_, ok = h.listSessions(nil)[session.ID]
+	require.Truef(h.t, ok, "session for id %x should exist now", session.ID)
 
 	// Attempt to insert the session again, which should fail due to the
 	// session already existing.
@@ -300,9 +252,8 @@ func testCreateClientSession(h *clientDBHarness) {
 	// Finally, assert that reserving another key index succeeds with a
 	// different key index, now that the first one has been finalized.
 	keyIndex3 := h.nextKeyIndex(session.TowerID, blobType)
-	if keyIndex == keyIndex3 {
-		h.t.Fatalf("key index still reserved after creating session")
-	}
+	require.NotEqualf(h.t, keyIndex, keyIndex3, "key index still "+
+		"reserved after creating session")
 }
 
 // testFilterClientSessions asserts that we can correctly filter client sessions
@@ -343,15 +294,12 @@ func testFilterClientSessions(h *clientDBHarness) {
 	// them.
 	for towerID, expectedSessions := range towerSessions {
 		sessions := h.listSessions(&towerID)
-		if len(sessions) != len(expectedSessions) {
-			h.t.Fatalf("expected %v sessions for tower %v, got %v",
-				len(expectedSessions), towerID, len(sessions))
-		}
+		require.Len(h.t, sessions, len(expectedSessions))
+
 		for _, expectedSession := range expectedSessions {
-			if _, ok := sessions[expectedSession]; !ok {
-				h.t.Fatalf("expected session %v for tower %v",
-					expectedSession, towerID)
-			}
+			_, ok := sessions[expectedSession]
+			require.Truef(h.t, ok, "expected session %v for "+
+				"tower %v", expectedSession, towerID)
 		}
 	}
 }
@@ -380,26 +328,18 @@ func testCreateTower(h *clientDBHarness) {
 	// Load the tower from the database and assert that it matches the tower
 	// we created.
 	tower2 := h.loadTowerByID(tower.ID, nil)
-	if !reflect.DeepEqual(tower, tower2) {
-		h.t.Fatalf("loaded tower mismatch, want: %v, got: %v",
-			tower, tower2)
-	}
-	tower2 = h.loadTower(pk, err)
-	if !reflect.DeepEqual(tower, tower2) {
-		h.t.Fatalf("loaded tower mismatch, want: %v, got: %v",
-			tower, tower2)
-	}
+	require.Equal(h.t, tower, tower2)
+
+	tower2 = h.loadTower(tower.IdentityKey, nil)
+	require.Equal(h.t, tower, tower2)
 
 	// Insert the address again into the database. Since the address is the
 	// same, this should result in an unmodified tower record.
 	towerDupAddr := h.createTower(lnAddr, nil)
-	if len(towerDupAddr.Addresses) != 1 {
-		h.t.Fatalf("duplicate address should be deduped")
-	}
-	if !reflect.DeepEqual(tower, towerDupAddr) {
-		h.t.Fatalf("mismatch towers, want: %v, got: %v",
-			tower, towerDupAddr)
-	}
+	require.Lenf(h.t, towerDupAddr.Addresses, 1, "duplicate address "+
+		"should be deduped")
+
+	require.Equal(h.t, tower, towerDupAddr)
 
 	// Generate a new address for this tower.
 	addr2 := &net.TCPAddr{IP: []byte{0x02, 0x00, 0x00, 0x00}, Port: 9911}
@@ -416,26 +356,18 @@ func testCreateTower(h *clientDBHarness) {
 	// Load the tower from the database, and assert that it matches the
 	// tower returned from creation.
 	towerNewAddr2 := h.loadTowerByID(tower.ID, nil)
-	if !reflect.DeepEqual(towerNewAddr, towerNewAddr2) {
-		h.t.Fatalf("loaded tower mismatch, want: %v, got: %v",
-			towerNewAddr, towerNewAddr2)
-	}
-	towerNewAddr2 = h.loadTower(pk, nil)
-	if !reflect.DeepEqual(towerNewAddr, towerNewAddr2) {
-		h.t.Fatalf("loaded tower mismatch, want: %v, got: %v",
-			towerNewAddr, towerNewAddr2)
-	}
+	require.Equal(h.t, towerNewAddr, towerNewAddr2)
+
+	towerNewAddr2 = h.loadTower(tower.IdentityKey, nil)
+	require.Equal(h.t, towerNewAddr, towerNewAddr2)
 
 	// Assert that there are now two addresses on the tower object.
-	if len(towerNewAddr.Addresses) != 2 {
-		h.t.Fatalf("new address should be added")
-	}
+	require.Lenf(h.t, towerNewAddr.Addresses, 2, "new address should be "+
+		"added")
 
 	// Finally, assert that the new address was prepended since it is deemed
 	// fresher.
-	if !reflect.DeepEqual(tower.Addresses, towerNewAddr.Addresses[1:]) {
-		h.t.Fatalf("new address should be prepended")
-	}
+	require.Equal(h.t, tower.Addresses, towerNewAddr.Addresses[1:])
 }
 
 // testRemoveTower asserts the behavior of removing Tower objects as a whole and
@@ -443,9 +375,7 @@ func testCreateTower(h *clientDBHarness) {
 func testRemoveTower(h *clientDBHarness) {
 	// Generate a random public key we'll use for our tower.
 	pk, err := randPubKey()
-	if err != nil {
-		h.t.Fatalf("unable to generate pubkey: %v", err)
-	}
+	require.NoError(h.t, err)
 
 	// Removing a tower that does not exist within the database should
 	// result in a NOP.
@@ -523,28 +453,23 @@ func testRemoveTower(h *clientDBHarness) {
 func testChanSummaries(h *clientDBHarness) {
 	// First, assert that this channel is not already registered.
 	var chanID lnwire.ChannelID
-	if _, ok := h.fetchChanSummaries()[chanID]; ok {
-		h.t.Fatalf("pkscript for channel %x should not exist yet",
-			chanID)
-	}
+	_, ok := h.fetchChanSummaries()[chanID]
+	require.Falsef(h.t, ok, "pkscript for channel %x should not exist yet",
+		chanID)
 
 	// Generate a random sweep pkscript and register it for this channel.
 	expPkScript := make([]byte, 22)
-	if _, err := io.ReadFull(crand.Reader, expPkScript); err != nil {
-		h.t.Fatalf("unable to generate pkscript: %v", err)
-	}
+	_, err := io.ReadFull(crand.Reader, expPkScript)
+	require.NoError(h.t, err)
+
 	h.registerChan(chanID, expPkScript, nil)
 
 	// Assert that the channel exists and that its sweep pkscript matches
 	// the one we registered.
 	summary, ok := h.fetchChanSummaries()[chanID]
-	if !ok {
-		h.t.Fatalf("pkscript for channel %x should not exist yet",
-			chanID)
-	} else if bytes.Compare(expPkScript, summary.SweepPkScript) != 0 {
-		h.t.Fatalf("pkscript mismatch, want: %x, got: %x",
-			expPkScript, summary.SweepPkScript)
-	}
+	require.Truef(h.t, ok, "pkscript for channel %x should not exist yet",
+		chanID)
+	require.Equal(h.t, expPkScript, summary.SweepPkScript)
 
 	// Finally, assert that re-registering the same channel produces a
 	// failure.
@@ -581,10 +506,7 @@ func testCommitUpdate(h *clientDBHarness) {
 	// succeed. The lastApplied value should be 0 since we have not received
 	// an ack from the tower.
 	lastApplied := h.commitUpdate(&session.ID, update1, nil)
-	if lastApplied != 0 {
-		h.t.Fatalf("last applied mismatch, want: 0, got: %v",
-			lastApplied)
-	}
+	require.Zero(h.t, lastApplied)
 
 	// Assert that the committed update appears in the client session's
 	// CommittedUpdates map when loaded from disk and that there are no
@@ -600,10 +522,7 @@ func testCommitUpdate(h *clientDBHarness) {
 	// the on-disk update's hint). The lastApplied value should remain
 	// unchanged.
 	lastApplied2 := h.commitUpdate(&session.ID, update1, nil)
-	if lastApplied2 != lastApplied {
-		h.t.Fatalf("last applied should not have changed, got %v",
-			lastApplied2)
-	}
+	require.Equal(h.t, lastApplied, lastApplied2)
 
 	// Assert that the loaded ClientSession is the same as before.
 	dbSession = h.listSessions(nil)[session.ID]
@@ -621,10 +540,7 @@ func testCommitUpdate(h *clientDBHarness) {
 	// which should succeed.
 	update2.SeqNum = 2
 	lastApplied3 := h.commitUpdate(&session.ID, update2, nil)
-	if lastApplied3 != lastApplied {
-		h.t.Fatalf("last applied should not have changed, got %v",
-			lastApplied3)
-	}
+	require.Equal(h.t, lastApplied, lastApplied3)
 
 	// Check that both updates now appear as committed on the ClientSession
 	// loaded from disk.
@@ -684,10 +600,7 @@ func testAckUpdate(h *clientDBHarness) {
 	// Commit to a random update at seqnum 1.
 	update1 := randCommittedUpdate(h.t, 1)
 	lastApplied := h.commitUpdate(&session.ID, update1, nil)
-	if lastApplied != 0 {
-		h.t.Fatalf("last applied mismatch, want: 0, got: %v",
-			lastApplied)
-	}
+	require.Zero(h.t, lastApplied)
 
 	// Acking seqnum 1 should succeed.
 	h.ackUpdate(&session.ID, 1, 1, nil)
@@ -715,10 +628,7 @@ func testAckUpdate(h *clientDBHarness) {
 	// ack.
 	update2 := randCommittedUpdate(h.t, 2)
 	lastApplied = h.commitUpdate(&session.ID, update2, nil)
-	if lastApplied != 1 {
-		h.t.Fatalf("last applied mismatch, want: 1, got: %v",
-			lastApplied)
-	}
+	require.EqualValues(h.t, 1, lastApplied)
 
 	// Ack seqnum 2.
 	h.ackUpdate(&session.ID, 2, 2, nil)
@@ -756,10 +666,7 @@ func checkCommittedUpdates(t *testing.T, session *wtdb.ClientSession,
 		expUpdates = make([]wtdb.CommittedUpdate, 0)
 	}
 
-	if !reflect.DeepEqual(session.CommittedUpdates, expUpdates) {
-		t.Fatalf("committed updates mismatch, want: %v, got: %v",
-			expUpdates, session.CommittedUpdates)
-	}
+	require.Equal(t, expUpdates, session.CommittedUpdates)
 }
 
 // checkAckedUpdates asserts that the AckedUpdates on a session match the
@@ -774,10 +681,7 @@ func checkAckedUpdates(t *testing.T, session *wtdb.ClientSession,
 		expUpdates = make(map[uint16]wtdb.BackupID)
 	}
 
-	if !reflect.DeepEqual(session.AckedUpdates, expUpdates) {
-		t.Fatalf("acked updates mismatch, want: %v, got: %v",
-			expUpdates, session.AckedUpdates)
-	}
+	require.Equal(t, expUpdates, session.AckedUpdates)
 }
 
 // TestClientDB asserts the behavior of a fresh client db, a reopened client db,
@@ -795,14 +699,10 @@ func TestClientDB(t *testing.T) {
 				bdb, err := wtdb.NewBoltBackendCreator(
 					true, t.TempDir(), "wtclient.db",
 				)(dbCfg)
-				if err != nil {
-					t.Fatalf("unable to open db: %v", err)
-				}
+				require.NoError(t, err)
 
 				db, err := wtdb.OpenClientDB(bdb)
-				if err != nil {
-					t.Fatalf("unable to open db: %v", err)
-				}
+				require.NoError(t, err)
 
 				t.Cleanup(func() {
 					db.Close()
@@ -819,27 +719,19 @@ func TestClientDB(t *testing.T) {
 				bdb, err := wtdb.NewBoltBackendCreator(
 					true, path, "wtclient.db",
 				)(dbCfg)
-				if err != nil {
-					t.Fatalf("unable to open db: %v", err)
-				}
+				require.NoError(t, err)
 
 				db, err := wtdb.OpenClientDB(bdb)
-				if err != nil {
-					t.Fatalf("unable to open db: %v", err)
-				}
+				require.NoError(t, err)
 				db.Close()
 
 				bdb, err = wtdb.NewBoltBackendCreator(
 					true, path, "wtclient.db",
 				)(dbCfg)
-				if err != nil {
-					t.Fatalf("unable to open db: %v", err)
-				}
+				require.NoError(t, err)
 
 				db, err = wtdb.OpenClientDB(bdb)
-				if err != nil {
-					t.Fatalf("unable to reopen db: %v", err)
-				}
+				require.NoError(t, err)
 
 				t.Cleanup(func() {
 					db.Close()
@@ -909,19 +801,16 @@ func TestClientDB(t *testing.T) {
 // randCommittedUpdate generates a random committed update.
 func randCommittedUpdate(t *testing.T, seqNum uint16) *wtdb.CommittedUpdate {
 	var chanID lnwire.ChannelID
-	if _, err := io.ReadFull(crand.Reader, chanID[:]); err != nil {
-		t.Fatalf("unable to generate chan id: %v", err)
-	}
+	_, err := io.ReadFull(crand.Reader, chanID[:])
+	require.NoError(t, err)
 
 	var hint blob.BreachHint
-	if _, err := io.ReadFull(crand.Reader, hint[:]); err != nil {
-		t.Fatalf("unable to generate breach hint: %v", err)
-	}
+	_, err = io.ReadFull(crand.Reader, hint[:])
+	require.NoError(t, err)
 
 	encBlob := make([]byte, blob.Size(blob.FlagCommitOutputs.Type()))
-	if _, err := io.ReadFull(crand.Reader, encBlob); err != nil {
-		t.Fatalf("unable to generate encrypted blob: %v", err)
-	}
+	_, err = io.ReadFull(crand.Reader, encBlob)
+	require.NoError(t, err)
 
 	return &wtdb.CommittedUpdate{
 		SeqNum: seqNum,