From f815c88ee4a6dd59c9979aef910f6713cbad27a4 Mon Sep 17 00:00:00 2001 From: Elle Mouton Date: Tue, 4 Oct 2022 14:59:11 +0200 Subject: [PATCH] watchtower: fix formatting In order to make upcoming commits in the PR easier to parse, this commit makes some basic formatting changes to some of the watchtower files. --- watchtower/wtclient/interface.go | 7 ++--- watchtower/wtdb/client_db.go | 15 ++++++++--- watchtower/wtdb/client_db_test.go | 44 +++++++++++++++++++++---------- 3 files changed, 45 insertions(+), 21 deletions(-) diff --git a/watchtower/wtclient/interface.go b/watchtower/wtclient/interface.go index 69f367293..dbf2faf71 100644 --- a/watchtower/wtclient/interface.go +++ b/watchtower/wtclient/interface.go @@ -62,7 +62,8 @@ type DB interface { // still be able to accept state updates. An optional tower ID can be // used to filter out any client sessions in the response that do not // correspond to this tower. - ListClientSessions(*wtdb.TowerID) (map[wtdb.SessionID]*wtdb.ClientSession, error) + ListClientSessions(*wtdb.TowerID) ( + map[wtdb.SessionID]*wtdb.ClientSession, error) // FetchChanSummaries loads a mapping from all registered channels to // their channel summaries. @@ -96,8 +97,8 @@ type DB interface { AckUpdate(id *wtdb.SessionID, seqNum, lastApplied uint16) error } -// AuthDialer connects to a remote node using an authenticated transport, such as -// brontide. The dialer argument is used to specify a resolver, which allows +// AuthDialer connects to a remote node using an authenticated transport, such +// as brontide. The dialer argument is used to specify a resolver, which allows // this method to be used over Tor or clear net connections. type AuthDialer func(localKey keychain.SingleKeyECDH, netAddr *lnwire.NetAddress, diff --git a/watchtower/wtdb/client_db.go b/watchtower/wtdb/client_db.go index 91df574d2..c868b949f 100644 --- a/watchtower/wtdb/client_db.go +++ b/watchtower/wtdb/client_db.go @@ -113,7 +113,8 @@ var ( // NewBoltBackendCreator returns a function that creates a new bbolt backend for // the watchtower database. func NewBoltBackendCreator(active bool, dbPath, - dbFileName string) func(boltCfg *kvdb.BoltConfig) (kvdb.Backend, error) { + dbFileName string) func(boltCfg *kvdb.BoltConfig) (kvdb.Backend, + error) { // If the watchtower client isn't active, we return a function that // always returns a nil DB to make sure we don't create empty database @@ -575,7 +576,9 @@ func (c *ClientDB) CreateClientSession(session *ClientSession) error { // Check that client session with this session id doesn't // already exist. - existingSessionBytes := sessions.NestedReadWriteBucket(session.ID[:]) + existingSessionBytes := sessions.NestedReadWriteBucket( + session.ID[:], + ) if existingSessionBytes != nil { return ErrClientSessionAlreadyExists } @@ -662,7 +665,9 @@ func getSessionKeyIndex(keyIndexes kvdb.RwBucket, towerID TowerID, // ListClientSessions returns the set of all client sessions known to the db. An // optional tower ID can be used to filter out any client sessions in the // response that do not correspond to this tower. -func (c *ClientDB) ListClientSessions(id *TowerID) (map[SessionID]*ClientSession, error) { +func (c *ClientDB) ListClientSessions(id *TowerID) ( + map[SessionID]*ClientSession, error) { + var clientSessions map[SessionID]*ClientSession err := kvdb.View(c.db, func(tx kvdb.RTx) error { sessions := tx.ReadBucket(cSessionBkt) @@ -951,7 +956,9 @@ func (c *ClientDB) AckUpdate(id *SessionID, seqNum uint16, // If the commits sub-bucket doesn't exist, there can't possibly // be a corresponding committed update to remove. - sessionCommits := sessionBkt.NestedReadWriteBucket(cSessionCommits) + sessionCommits := sessionBkt.NestedReadWriteBucket( + cSessionCommits, + ) if sessionCommits == nil { return ErrCommittedUpdateNotFound } diff --git a/watchtower/wtdb/client_db_test.go b/watchtower/wtdb/client_db_test.go index f694b746f..42189df41 100644 --- a/watchtower/wtdb/client_db_test.go +++ b/watchtower/wtdb/client_db_test.go @@ -37,7 +37,9 @@ func newClientDBHarness(t *testing.T, init clientDBInit) *clientDBHarness { return h } -func (h *clientDBHarness) insertSession(session *wtdb.ClientSession, expErr error) { +func (h *clientDBHarness) insertSession(session *wtdb.ClientSession, + expErr error) { + h.t.Helper() err := h.db.CreateClientSession(session) @@ -47,7 +49,9 @@ func (h *clientDBHarness) insertSession(session *wtdb.ClientSession, expErr erro } } -func (h *clientDBHarness) listSessions(id *wtdb.TowerID) map[wtdb.SessionID]*wtdb.ClientSession { +func (h *clientDBHarness) listSessions( + id *wtdb.TowerID) map[wtdb.SessionID]*wtdb.ClientSession { + h.t.Helper() sessions, err := h.db.ListClientSessions(id) @@ -82,7 +86,8 @@ func (h *clientDBHarness) createTower(lnAddr *lnwire.NetAddress, tower, err := h.db.CreateTower(lnAddr) if err != expErr { - h.t.Fatalf("expected create tower error: %v, got: %v", expErr, err) + h.t.Fatalf("expected create tower error: %v, got: %v", expErr, + err) } if tower.ID == 0 { @@ -106,35 +111,38 @@ 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) + h.t.Fatalf("expected remove tower error: %v, got %v", expErr, + err) } if expErr != nil { return } + pubKeyStr := pubKey.SerializeCompressed() + if addr != nil { tower, err := h.db.LoadTower(pubKey) if err != nil { h.t.Fatalf("expected tower %x to still exist", - pubKey.SerializeCompressed()) + pubKeyStr) } removedAddr := addr.String() for _, towerAddr := range tower.Addresses { if towerAddr.String() == removedAddr { - h.t.Fatalf("address %v not removed for tower %x", - removedAddr, pubKey.SerializeCompressed()) + h.t.Fatalf("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", pubKey.SerializeCompressed()) + "exist", pubKeyStr) } if !hasSessions && err == nil { h.t.Fatalf("expected tower %x with no sessions to not "+ - "exist", pubKey.SerializeCompressed()) + "exist", pubKeyStr) } if !hasSessions { return @@ -149,23 +157,29 @@ func (h *clientDBHarness) removeTower(pubKey *btcec.PublicKey, addr net.Addr, } } -func (h *clientDBHarness) loadTower(pubKey *btcec.PublicKey, expErr error) *wtdb.Tower { +func (h *clientDBHarness) loadTower(pubKey *btcec.PublicKey, + expErr error) *wtdb.Tower { + h.t.Helper() tower, err := h.db.LoadTower(pubKey) if err != expErr { - h.t.Fatalf("expected load tower error: %v, got: %v", expErr, err) + h.t.Fatalf("expected load tower error: %v, got: %v", expErr, + err) } return tower } -func (h *clientDBHarness) loadTowerByID(id wtdb.TowerID, expErr error) *wtdb.Tower { +func (h *clientDBHarness) loadTowerByID(id wtdb.TowerID, + expErr error) *wtdb.Tower { + h.t.Helper() tower, err := h.db.LoadTowerByID(id) if err != expErr { - h.t.Fatalf("expected load tower error: %v, got: %v", expErr, err) + h.t.Fatalf("expected load tower error: %v, got: %v", expErr, + err) } return tower @@ -320,7 +334,9 @@ func testFilterClientSessions(h *clientDBHarness) { }, ID: sessionID, }, nil) - towerSessions[towerID] = append(towerSessions[towerID], sessionID) + towerSessions[towerID] = append( + towerSessions[towerID], sessionID, + ) } // We should see the expected sessions for each tower when filtering