chanfitness: fix line wrapping

Original PR was written with 4 spaces instead of 8, do a once off fix
here rather than fixing bit-by bit in the subsequent commits and
cluttering them for review.
This commit is contained in:
carla 2020-09-08 13:47:12 +02:00
parent 751b02361e
commit 25b0c40d05
No known key found for this signature in database
GPG Key ID: 4CA7FE54A6213C91
4 changed files with 197 additions and 136 deletions

@ -51,12 +51,12 @@ type chanEventLog struct {
now func() time.Time now func() time.Time
// openedAt tracks the first time this channel was seen. This is not // openedAt tracks the first time this channel was seen. This is not
// necessarily the time that it confirmed on chain because channel events // necessarily the time that it confirmed on chain because channel
// are not persisted at present. // events are not persisted at present.
openedAt time.Time openedAt time.Time
// closedAt is the time that the channel was closed. If the channel has not // closedAt is the time that the channel was closed. If the channel has
// been closed yet, it is zero. // not been closed yet, it is zero.
closedAt time.Time closedAt time.Time
} }
@ -83,7 +83,8 @@ func (e *chanEventLog) close() {
// The open time for the eventLog will be set to the event's timestamp if it is // The open time for the eventLog will be set to the event's timestamp if it is
// not set yet. // not set yet.
func (e *chanEventLog) add(eventType eventType) { func (e *chanEventLog) add(eventType eventType) {
// If the channel is already closed, return early without adding an event. // If the channel is already closed, return early without adding an
// event.
if !e.closedAt.IsZero() { if !e.closedAt.IsZero() {
return return
} }
@ -136,14 +137,16 @@ func (e *chanEventLog) getOnlinePeriods() []*onlinePeriod {
case peerOfflineEvent: case peerOfflineEvent:
offline = true offline = true
// Do not add to uptime if there is no previous online timestamp, // Do not add to uptime if there is no previous online
// the event log has started with an offline event // timestamp, the event log has started with an offline
// event
if lastOnline.IsZero() { if lastOnline.IsZero() {
continue continue
} }
// The eventLog has recorded an offline event, having previously // The eventLog has recorded an offline event, having
// been online so we add an online period to to set of online periods. // previously been online so we add an online period to
// set of online periods.
onlinePeriods = append(onlinePeriods, &onlinePeriod{ onlinePeriods = append(onlinePeriods, &onlinePeriod{
start: lastOnline, start: lastOnline,
end: event.timestamp, end: event.timestamp,
@ -151,15 +154,15 @@ func (e *chanEventLog) getOnlinePeriods() []*onlinePeriod {
} }
} }
// If the last event was an peer offline event, we do not need to calculate // If the last event was an peer offline event, we do not need to
// a final online period and can return online periods as is. // calculate a final online period and can return online periods as is.
if offline { if offline {
return onlinePeriods return onlinePeriods
} }
// The log ended on an online event, so we need to add a final online event. // The log ended on an online event, so we need to add a final online
// If the channel is closed, this period is until channel closure. It it is // event. If the channel is closed, this period is until channel
// still open, we calculate it until the present. // closure. It it is still open, we calculate it until the present.
endTime := e.closedAt endTime := e.closedAt
if endTime.IsZero() { if endTime.IsZero() {
endTime = e.now() endTime = e.now()
@ -176,7 +179,8 @@ func (e *chanEventLog) getOnlinePeriods() []*onlinePeriod {
// inclusive range specified. An error is returned if the end of the range is // inclusive range specified. An error is returned if the end of the range is
// before the start or a zero end time is returned. // before the start or a zero end time is returned.
func (e *chanEventLog) uptime(start, end time.Time) (time.Duration, error) { func (e *chanEventLog) uptime(start, end time.Time) (time.Duration, error) {
// Error if we are provided with an invalid range to calculate uptime for. // Error if we are provided with an invalid range to calculate uptime
// for.
if end.Before(start) { if end.Before(start) {
return 0, fmt.Errorf("end time: %v before start time: %v", return 0, fmt.Errorf("end time: %v before start time: %v",
end, start) end, start)
@ -188,25 +192,27 @@ func (e *chanEventLog) uptime(start, end time.Time) (time.Duration, error) {
var uptime time.Duration var uptime time.Duration
for _, p := range e.getOnlinePeriods() { for _, p := range e.getOnlinePeriods() {
// The online period ends before the range we're looking at, so we can // The online period ends before the range we're looking at, so
// skip over it. // we can skip over it.
if p.end.Before(start) { if p.end.Before(start) {
continue continue
} }
// The online period starts after the range we're looking at, so can // The online period starts after the range we're looking at, so
// stop calculating uptime. // can stop calculating uptime.
if p.start.After(end) { if p.start.After(end) {
break break
} }
// If the online period starts before our range, shift the start time up // If the online period starts before our range, shift the start
// so that we only calculate uptime from the start of our range. // time up so that we only calculate uptime from the start of
// our range.
if p.start.Before(start) { if p.start.Before(start) {
p.start = start p.start = start
} }
// If the online period ends before our range, shift the end time // If the online period ends before our range, shift the end
// forward so that we only calculate uptime until the end of the range. // time forward so that we only calculate uptime until the end
// of the range.
if p.end.After(end) { if p.end.After(end) {
p.end = end p.end = end
} }

@ -40,9 +40,11 @@ func TestAdd(t *testing.T) {
test.eventLog.add(test.event) test.eventLog.add(test.event)
for i, e := range test.expected { for i, e := range test.expected {
if test.eventLog.events[i].eventType != e { eventType := test.eventLog.events[i].eventType
t.Fatalf("Expected event type: %v, got: %v", if eventType != e {
e, test.eventLog.events[i].eventType) t.Fatalf("Expected event type: %v, "+
"got: %v", e, eventType,
)
} }
} }
}) })
@ -154,13 +156,13 @@ func TestGetOnlinePeriod(t *testing.T) {
for i, o := range test.expectedOnline { for i, o := range test.expectedOnline {
if online[i].start != o.start { if online[i].start != o.start {
t.Errorf("Expected start: %v, got %v", o.start, t.Errorf("Expected start: %v, got "+
online[i].start) "%v", o.start, online[i].start)
} }
if online[i].end != o.end { if online[i].end != o.end {
t.Errorf("Expected end: %v, got %v", o.end, t.Errorf("Expected end: %v, got %v",
online[i].end) o.end, online[i].end)
} }
} }
}) })
@ -181,31 +183,34 @@ func TestUptime(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
// opened at is the time the channel was recorded as being open, and is // opened at is the time the channel was recorded as being open,
// never expected to be zero. // and is never expected to be zero.
openedAt time.Time openedAt time.Time
// closed at is the tim the channel was recorded as being closed, and // closed at is the time the channel was recorded as being
// can have a zero value if the. // closed, and can have a zero value if the channel is not
// closed.
closedAt time.Time closedAt time.Time
// events is the set of event log that we are calculating uptime for. // events is the set of event log that we are calculating uptime
// for.
events []*channelEvent events []*channelEvent
// startTime is the beginning of the period that we are calculating // startTime is the beginning of the period that we are
// uptime for, it cannot have a zero value. // calculating uptime for, it cannot have a zero value.
startTime time.Time startTime time.Time
// endTime is the end of the period that we are calculating uptime for, // endTime is the end of the period that we are calculating
// it cannot have a zero value. // uptime for, it cannot have a zero value.
endTime time.Time endTime time.Time
// expectedUptime is the amount of uptime we expect to be calculated // expectedUptime is the amount of uptime we expect to be
// over the period specified by startTime and endTime. // calculated over the period specified by startTime and
// endTime.
expectedUptime time.Duration expectedUptime time.Duration
// expectErr is set to true if we expect an error to be returned when // expectErr is set to true if we expect an error to be returned
// calling the uptime function // when calling the uptime function.
expectErr bool expectErr bool
}{ }{
{ {
@ -378,7 +383,9 @@ func TestUptime(t *testing.T) {
closedAt: test.closedAt, closedAt: test.closedAt,
} }
uptime, err := score.uptime(test.startTime, test.endTime) uptime, err := score.uptime(
test.startTime, test.endTime,
)
if test.expectErr && err == nil { if test.expectErr && err == nil {
t.Fatal("Expected an error, got nil") t.Fatal("Expected an error, got nil")
} }

@ -24,12 +24,12 @@ import (
) )
var ( var (
// errShuttingDown is returned when the store cannot respond to a query because // errShuttingDown is returned when the store cannot respond to a query
// it has received the shutdown signal. // because it has received the shutdown signal.
errShuttingDown = errors.New("channel event store shutting down") errShuttingDown = errors.New("channel event store shutting down")
// ErrChannelNotFound is returned when a query is made for a channel that // ErrChannelNotFound is returned when a query is made for a channel
// the event store does not have knowledge of. // that the event store does not have knowledge of.
ErrChannelNotFound = errors.New("channel not found in event store") ErrChannelNotFound = errors.New("channel not found in event store")
) )
@ -41,8 +41,8 @@ type ChannelEventStore struct {
// channels maps channel points to event logs. // channels maps channel points to event logs.
channels map[wire.OutPoint]*chanEventLog channels map[wire.OutPoint]*chanEventLog
// peers tracks the current online status of peers based on online/offline // peers tracks the current online status of peers based on online
// events. // and offline events.
peers map[route.Vertex]bool peers map[route.Vertex]bool
// lifespanRequests serves requests for the lifespan of channels. // lifespanRequests serves requests for the lifespan of channels.
@ -60,16 +60,17 @@ type ChannelEventStore struct {
// activity. All elements of the config must be non-nil for the event store to // activity. All elements of the config must be non-nil for the event store to
// operate. // operate.
type Config struct { type Config struct {
// SubscribeChannelEvents provides a subscription client which provides a // SubscribeChannelEvents provides a subscription client which provides
// stream of channel events. // a stream of channel events.
SubscribeChannelEvents func() (*subscribe.Client, error) SubscribeChannelEvents func() (*subscribe.Client, error)
// SubscribePeerEvents provides a subscription client which provides a // SubscribePeerEvents provides a subscription client which provides a
// stream of peer online/offline events. // stream of peer online/offline events.
SubscribePeerEvents func() (*subscribe.Client, error) SubscribePeerEvents func() (*subscribe.Client, error)
// GetOpenChannels provides a list of existing open channels which is used // GetOpenChannels provides a list of existing open channels which is
// to populate the ChannelEventStore with a set of channels on startup. // used to populate the ChannelEventStore with a set of channels on
// startup.
GetOpenChannels func() ([]*channeldb.OpenChannel, error) GetOpenChannels func() ([]*channeldb.OpenChannel, error)
} }
@ -140,7 +141,8 @@ func (c *ChannelEventStore) Start() error {
return err return err
} }
// cancel should be called to cancel all subscriptions if an error occurs. // cancel should be called to cancel all subscriptions if an error
// occurs.
cancel := func() { cancel := func() {
channelClient.Cancel() channelClient.Cancel()
peerClient.Cancel() peerClient.Cancel()
@ -166,8 +168,8 @@ func (c *ChannelEventStore) Start() error {
return err return err
} }
// Add existing channels to the channel store with an initial peer // Add existing channels to the channel store with an initial
// online or offline event. // peer online or offline event.
c.addChannel(ch.FundingOutpoint, peerKey) c.addChannel(ch.FundingOutpoint, peerKey)
} }
@ -200,10 +202,12 @@ func (c *ChannelEventStore) Stop() {
func (c *ChannelEventStore) addChannel(channelPoint wire.OutPoint, func (c *ChannelEventStore) addChannel(channelPoint wire.OutPoint,
peer route.Vertex) { peer route.Vertex) {
// Check for the unexpected case where the channel is already in the store. // Check for the unexpected case where the channel is already in the
// store.
_, ok := c.channels[channelPoint] _, ok := c.channels[channelPoint]
if ok { if ok {
log.Errorf("Channel %v duplicated in channel store", channelPoint) log.Errorf("Channel %v duplicated in channel store",
channelPoint)
return return
} }
@ -222,7 +226,8 @@ func (c *ChannelEventStore) addChannel(channelPoint wire.OutPoint,
// closeChannel records a closed time for a channel, and returns early is the // closeChannel records a closed time for a channel, and returns early is the
// channel is not known to the event store. // channel is not known to the event store.
func (c *ChannelEventStore) closeChannel(channelPoint wire.OutPoint) { func (c *ChannelEventStore) closeChannel(channelPoint wire.OutPoint) {
// Check for the unexpected case where the channel is unknown to the store. // Check for the unexpected case where the channel is unknown to the
// store.
eventLog, ok := c.channels[channelPoint] eventLog, ok := c.channels[channelPoint]
if !ok { if !ok {
log.Errorf("Close channel %v unknown to store", channelPoint) log.Errorf("Close channel %v unknown to store", channelPoint)
@ -265,21 +270,24 @@ func (c *ChannelEventStore) consume(subscriptions *subscriptions) {
// Process channel opened and closed events. // Process channel opened and closed events.
case e := <-subscriptions.channelUpdates: case e := <-subscriptions.channelUpdates:
switch event := e.(type) { switch event := e.(type) {
// A new channel has been opened, we must add the channel to the // A new channel has been opened, we must add the
// store and record a channel open event. // channel to the store and record a channel open event.
case channelnotifier.OpenChannelEvent: case channelnotifier.OpenChannelEvent:
compressed := event.Channel.IdentityPub.SerializeCompressed()
peerKey, err := route.NewVertexFromBytes( peerKey, err := route.NewVertexFromBytes(
event.Channel.IdentityPub.SerializeCompressed(), compressed,
) )
if err != nil { if err != nil {
log.Errorf("Could not get vertex from: %v", log.Errorf("Could not get vertex "+
event.Channel.IdentityPub.SerializeCompressed()) "from: %v", compressed)
} }
c.addChannel(event.Channel.FundingOutpoint, peerKey) c.addChannel(
event.Channel.FundingOutpoint, peerKey,
)
// A channel has been closed, we must remove the channel from the // A channel has been closed, we must remove the channel
// store and record a channel closed event. // from the store and record a channel closed event.
case channelnotifier.ClosedChannelEvent: case channelnotifier.ClosedChannelEvent:
c.closeChannel(event.CloseSummary.ChanPoint) c.closeChannel(event.CloseSummary.ChanPoint)
} }
@ -287,13 +295,15 @@ func (c *ChannelEventStore) consume(subscriptions *subscriptions) {
// Process peer online and offline events. // Process peer online and offline events.
case e := <-subscriptions.peerUpdates: case e := <-subscriptions.peerUpdates:
switch event := e.(type) { switch event := e.(type) {
// We have reestablished a connection with our peer, and should // We have reestablished a connection with our peer,
// record an online event for any channels with that peer. // and should record an online event for any channels
// with that peer.
case peernotifier.PeerOnlineEvent: case peernotifier.PeerOnlineEvent:
c.peerEvent(event.PubKey, peerOnlineEvent) c.peerEvent(event.PubKey, peerOnlineEvent)
// We have lost a connection with our peer, and should record an // We have lost a connection with our peer, and should
// offline event for any channels with that peer. // record an offline event for any channels with that
// peer.
case peernotifier.PeerOfflineEvent: case peernotifier.PeerOfflineEvent:
c.peerEvent(event.PubKey, peerOfflineEvent) c.peerEvent(event.PubKey, peerOfflineEvent)
} }
@ -320,7 +330,10 @@ func (c *ChannelEventStore) consume(subscriptions *subscriptions) {
if !ok { if !ok {
resp.err = ErrChannelNotFound resp.err = ErrChannelNotFound
} else { } else {
uptime, err := channel.uptime(req.startTime, req.endTime) uptime, err := channel.uptime(
req.startTime, req.endTime,
)
resp.uptime = uptime resp.uptime = uptime
resp.err = err resp.err = err
} }
@ -346,16 +359,16 @@ func (c *ChannelEventStore) GetLifespan(
} }
// Send a request for the channel's lifespan to the main event loop, or // Send a request for the channel's lifespan to the main event loop, or
// return early with an error if the store has already received a shutdown // return early with an error if the store has already received a
// signal. // shutdown signal.
select { select {
case c.lifespanRequests <- request: case c.lifespanRequests <- request:
case <-c.quit: case <-c.quit:
return time.Time{}, time.Time{}, errShuttingDown return time.Time{}, time.Time{}, errShuttingDown
} }
// Return the response we receive on the response channel or exit early if // Return the response we receive on the response channel or exit early
// the store is instructed to exit. // if the store is instructed to exit.
select { select {
case resp := <-request.responseChan: case resp := <-request.responseChan:
return resp.start, resp.end, resp.err return resp.start, resp.end, resp.err
@ -378,16 +391,16 @@ func (c *ChannelEventStore) GetUptime(channelPoint wire.OutPoint, startTime,
} }
// Send a request for the channel's uptime to the main event loop, or // Send a request for the channel's uptime to the main event loop, or
// return early with an error if the store has already received a shutdown // return early with an error if the store has already received a
// signal. // shutdown signal.
select { select {
case c.uptimeRequests <- request: case c.uptimeRequests <- request:
case <-c.quit: case <-c.quit:
return 0, errShuttingDown return 0, errShuttingDown
} }
// Return the response we receive on the response channel or exit early if // Return the response we receive on the response channel or exit early
// the store is instructed to exit. // if the store is instructed to exit.
select { select {
case resp := <-request.responseChan: case resp := <-request.responseChan:
return resp.uptime, resp.err return resp.uptime, resp.err

@ -19,14 +19,15 @@ import (
// functions fail. It does not test the mechanics of consuming events because // functions fail. It does not test the mechanics of consuming events because
// these are covered in a separate set of tests. // these are covered in a separate set of tests.
func TestStartStoreError(t *testing.T) { func TestStartStoreError(t *testing.T) {
// Ok and erroring subscribe functions are defined here to de-clutter tests. // Ok and erroring subscribe functions are defined here to de-clutter
// tests.
okSubscribeFunc := func() (*subscribe.Client, error) { okSubscribeFunc := func() (*subscribe.Client, error) {
return &subscribe.Client{ return &subscribe.Client{
Cancel: func() {}, Cancel: func() {},
}, nil }, nil
} }
errSubscribeFunc := func() (client *subscribe.Client, e error) { errSubscribeFunc := func() (*subscribe.Client, error) {
return nil, errors.New("intentional test err") return nil, errors.New("intentional test err")
} }
@ -49,7 +50,7 @@ func TestStartStoreError(t *testing.T) {
name: "Get open channels fails", name: "Get open channels fails",
ChannelEvents: okSubscribeFunc, ChannelEvents: okSubscribeFunc,
PeerEvents: okSubscribeFunc, PeerEvents: okSubscribeFunc,
GetChannels: func() (channels []*channeldb.OpenChannel, e error) { GetChannels: func() ([]*channeldb.OpenChannel, error) {
return nil, errors.New("intentional test err") return nil, errors.New("intentional test err")
}, },
}, },
@ -66,8 +67,8 @@ func TestStartStoreError(t *testing.T) {
}) })
err := store.Start() err := store.Start()
// Check that we receive an error, because the test only checks for // Check that we receive an error, because the test only
// error cases. // checks for error cases.
if err == nil { if err == nil {
t.Fatalf("Expected error on startup, got: nil") t.Fatalf("Expected error on startup, got: nil")
} }
@ -110,19 +111,22 @@ func TestMonitorChannelEvents(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
// generateEvents takes channels which represent the updates channels // generateEvents takes channels which represent the updates
// for subscription clients and passes events in the desired order. // channels for subscription clients and passes events in the
// This function is intended to be blocking so that the test does not // desired order. This function is intended to be blocking so
// have a data race with event consumption, so the channels should not // that the test does not have a data race with event
// be buffered. // consumption, so the channels should not be buffered.
generateEvents func(channelEvents, peerEvents chan<- interface{}) generateEvents func(channelEvents,
peerEvents chan<- interface{})
// expectedEvents is the expected set of event types in the store. // expectedEvents is the expected set of event types in the store.
expectedEvents []eventType expectedEvents []eventType
}{ }{
{ {
name: "Channel opened, peer comes online", name: "Channel opened, peer comes online",
generateEvents: func(channelEvents, peerEvents chan<- interface{}) { generateEvents: func(channelEvents,
peerEvents chan<- interface{}) {
// Add an open channel event // Add an open channel event
channelEvents <- channelnotifier.OpenChannelEvent{ channelEvents <- channelnotifier.OpenChannelEvent{
Channel: &channeldb.OpenChannel{ Channel: &channeldb.OpenChannel{
@ -132,13 +136,17 @@ func TestMonitorChannelEvents(t *testing.T) {
} }
// Add a peer online event. // Add a peer online event.
peerEvents <- peernotifier.PeerOnlineEvent{PubKey: vertex} peerEvents <- peernotifier.PeerOnlineEvent{
PubKey: vertex,
}
}, },
expectedEvents: []eventType{peerOnlineEvent}, expectedEvents: []eventType{peerOnlineEvent},
}, },
{ {
name: "Duplicate channel open events", name: "Duplicate channel open events",
generateEvents: func(channelEvents, peerEvents chan<- interface{}) { generateEvents: func(channelEvents,
peerEvents chan<- interface{}) {
// Add an open channel event // Add an open channel event
channelEvents <- channelnotifier.OpenChannelEvent{ channelEvents <- channelnotifier.OpenChannelEvent{
Channel: &channeldb.OpenChannel{ Channel: &channeldb.OpenChannel{
@ -148,7 +156,9 @@ func TestMonitorChannelEvents(t *testing.T) {
} }
// Add a peer online event. // Add a peer online event.
peerEvents <- peernotifier.PeerOnlineEvent{PubKey: vertex} peerEvents <- peernotifier.PeerOnlineEvent{
PubKey: vertex,
}
// Add a duplicate channel open event. // Add a duplicate channel open event.
channelEvents <- channelnotifier.OpenChannelEvent{ channelEvents <- channelnotifier.OpenChannelEvent{
@ -162,9 +172,13 @@ func TestMonitorChannelEvents(t *testing.T) {
}, },
{ {
name: "Channel opened, peer already online", name: "Channel opened, peer already online",
generateEvents: func(channelEvents, peerEvents chan<- interface{}) { generateEvents: func(channelEvents,
peerEvents chan<- interface{}) {
// Add a peer online event. // Add a peer online event.
peerEvents <- peernotifier.PeerOnlineEvent{PubKey: vertex} peerEvents <- peernotifier.PeerOnlineEvent{
PubKey: vertex,
}
// Add an open channel event // Add an open channel event
channelEvents <- channelnotifier.OpenChannelEvent{ channelEvents <- channelnotifier.OpenChannelEvent{
@ -179,7 +193,9 @@ func TestMonitorChannelEvents(t *testing.T) {
{ {
name: "Channel opened, peer offline, closed", name: "Channel opened, peer offline, closed",
generateEvents: func(channelEvents, peerEvents chan<- interface{}) { generateEvents: func(channelEvents,
peerEvents chan<- interface{}) {
// Add an open channel event // Add an open channel event
channelEvents <- channelnotifier.OpenChannelEvent{ channelEvents <- channelnotifier.OpenChannelEvent{
Channel: &channeldb.OpenChannel{ Channel: &channeldb.OpenChannel{
@ -189,7 +205,9 @@ func TestMonitorChannelEvents(t *testing.T) {
} }
// Add a peer online event. // Add a peer online event.
peerEvents <- peernotifier.PeerOfflineEvent{PubKey: vertex} peerEvents <- peernotifier.PeerOfflineEvent{
PubKey: vertex,
}
// Add a close channel event. // Add a close channel event.
channelEvents <- channelnotifier.ClosedChannelEvent{ channelEvents <- channelnotifier.ClosedChannelEvent{
@ -202,7 +220,9 @@ func TestMonitorChannelEvents(t *testing.T) {
}, },
{ {
name: "Event after channel close not recorded", name: "Event after channel close not recorded",
generateEvents: func(channelEvents, peerEvents chan<- interface{}) { generateEvents: func(channelEvents,
peerEvents chan<- interface{}) {
// Add an open channel event // Add an open channel event
channelEvents <- channelnotifier.OpenChannelEvent{ channelEvents <- channelnotifier.OpenChannelEvent{
Channel: &channeldb.OpenChannel{ Channel: &channeldb.OpenChannel{
@ -219,7 +239,9 @@ func TestMonitorChannelEvents(t *testing.T) {
} }
// Add a peer online event. // Add a peer online event.
peerEvents <- peernotifier.PeerOfflineEvent{PubKey: vertex} peerEvents <- peernotifier.PeerOfflineEvent{
PubKey: vertex,
}
}, },
}, },
} }
@ -228,12 +250,12 @@ func TestMonitorChannelEvents(t *testing.T) {
test := test test := test
t.Run(test.name, func(t *testing.T) { t.Run(test.name, func(t *testing.T) {
// Create a store with the channels and online peers specified // Create a store with the channels and online peers
// by the test. // specified by the test.
store := NewChannelEventStore(&Config{}) store := NewChannelEventStore(&Config{})
// Create channels which represent the subscriptions we have to peer // Create channels which represent the subscriptions
// and client events. // we have to peer and client events.
channelEvents := make(chan interface{}) channelEvents := make(chan interface{})
peerEvents := make(chan interface{}) peerEvents := make(chan interface{})
@ -244,21 +266,23 @@ func TestMonitorChannelEvents(t *testing.T) {
cancel: func() {}, cancel: func() {},
}) })
// Add events to the store then kill the goroutine using store.Stop. // Add events to the store then kill the goroutine using
// store.Stop.
test.generateEvents(channelEvents, peerEvents) test.generateEvents(channelEvents, peerEvents)
store.Stop() store.Stop()
// Retrieve the eventLog for the channel and check that its // Retrieve the eventLog for the channel and check that
// contents are as expected. // its contents are as expected.
eventLog, ok := store.channels[chanPoint] eventLog, ok := store.channels[chanPoint]
if !ok { if !ok {
t.Fatalf("Expected to find event store") t.Fatalf("Expected to find event store")
} }
for i, e := range eventLog.events { for i, e := range eventLog.events {
if test.expectedEvents[i] != e.eventType { expectedType := test.expectedEvents[i]
if expectedType != e.eventType {
t.Fatalf("Expected type: %v, got: %v", t.Fatalf("Expected type: %v, got: %v",
test.expectedEvents[i], e.eventType) expectedType, e.eventType)
} }
} }
}) })
@ -309,26 +333,30 @@ func TestGetLifetime(t *testing.T) {
// Stop the store's go routine. // Stop the store's go routine.
defer store.Stop() defer store.Stop()
// Add channel to eventStore if the test indicates that it should // Add channel to eventStore if the test indicates that
// be present. // it should be present.
if test.channelFound { if test.channelFound {
store.channels[test.channelPoint] = &chanEventLog{ store.channels[test.channelPoint] =
openedAt: test.opened, &chanEventLog{
closedAt: test.closed, openedAt: test.opened,
} closedAt: test.closed,
}
} }
open, close, err := store.GetLifespan(test.channelPoint) open, close, err := store.GetLifespan(test.channelPoint)
if test.expectedError != err { if test.expectedError != err {
t.Fatalf("Expected: %v, got: %v", test.expectedError, err) t.Fatalf("Expected: %v, got: %v",
test.expectedError, err)
} }
if open != test.opened { if open != test.opened {
t.Errorf("Expected: %v, got %v", test.opened, open) t.Errorf("Expected: %v, got %v",
test.opened, open)
} }
if close != test.closed { if close != test.closed {
t.Errorf("Expected: %v, got %v", test.closed, close) t.Errorf("Expected: %v, got %v",
test.closed, close)
} }
}) })
} }
@ -351,24 +379,28 @@ func TestGetUptime(t *testing.T) {
channelPoint wire.OutPoint channelPoint wire.OutPoint
// events is the set of events we expect to find in the channel store. // events is the set of events we expect to find in the channel
// store.
events []*channelEvent events []*channelEvent
// openedAt is the time the channel is recorded as open by the store. // openedAt is the time the channel is recorded as open by the
// store.
openedAt time.Time openedAt time.Time
// closedAt is the time the channel is recorded as closed by the store. // closedAt is the time the channel is recorded as closed by the
// If the channel is still open, this value is zero. // store. If the channel is still open, this value is zero.
closedAt time.Time closedAt time.Time
// channelFound is true if we expect to find the channel in the store. // channelFound is true if we expect to find the channel in the
// store.
channelFound bool channelFound bool
// startTime specifies the beginning of the uptime range we want to // startTime specifies the beginning of the uptime range we want
// calculate. // to calculate.
startTime time.Time startTime time.Time
// endTime specified the end of the uptime range we want to calculate. // endTime specified the end of the uptime range we want to
// calculate.
endTime time.Time endTime time.Time
expectedUptime time.Duration expectedUptime time.Duration
@ -428,8 +460,8 @@ func TestGetUptime(t *testing.T) {
test := test test := test
t.Run(test.name, func(t *testing.T) { t.Run(test.name, func(t *testing.T) {
// Set up event store with the events specified for the test and // Set up event store with the events specified for the
// mocked time. // test and mocked time.
store := NewChannelEventStore(&Config{}) store := NewChannelEventStore(&Config{})
// Start goroutine which consumes GetUptime requests. // Start goroutine which consumes GetUptime requests.
@ -443,7 +475,8 @@ func TestGetUptime(t *testing.T) {
// Stop the store's goroutine. // Stop the store's goroutine.
defer store.Stop() defer store.Stop()
// Add the channel to the store if it is intended to be found. // Add the channel to the store if it is intended to be
// found.
if test.channelFound { if test.channelFound {
store.channels[test.channelPoint] = &chanEventLog{ store.channels[test.channelPoint] = &chanEventLog{
events: test.events, events: test.events,
@ -453,16 +486,18 @@ func TestGetUptime(t *testing.T) {
} }
} }
uptime, err := store.GetUptime(test.channelPoint, test.startTime, test.endTime) uptime, err := store.GetUptime(
test.channelPoint, test.startTime, test.endTime,
)
if test.expectedError != err { if test.expectedError != err {
t.Fatalf("Expected: %v, got: %v", test.expectedError, err) t.Fatalf("Expected: %v, got: %v",
test.expectedError, err)
} }
if uptime != test.expectedUptime { if uptime != test.expectedUptime {
t.Fatalf("Expected uptime percentage: %v, got %v", t.Fatalf("Expected uptime percentage: %v, "+
test.expectedUptime, uptime) "got %v", test.expectedUptime, uptime)
} }
}) })
} }
} }