12312390362

Committed 13 Dec 2024 08:44AM UTC coverage: 57.458% (+8.5%) from 48.92%

Build # 12312390362

Build Type

Pull #9343

github

Committed by

ellemouton

Commit Message

fn: rework the ContextGuard and add tests

In this commit, the ContextGuard struct is re-worked such that the
context that its new main WithCtx method provides is cancelled in sync
with a parent context being cancelled or with it's quit channel being
cancelled. Tests are added to assert the behaviour. In order for the
close of the quit channel to be consistent with the cancelling of the
derived context, the quit channel _must_ be contained internal to the
ContextGuard so that callers are only able to close the channel via the
exposed Quit method which will then take care to first cancel any
derived context that depend on the quit channel before returning.

Pull Request Pull Request #9343: fn: expand the ContextGuard and add tests

Run Details

101853 of 177264 relevant lines covered (57.46%)

24972.93 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

29.03

/lncfg/cluster.go

package lncfg

import (
        "context"
        "fmt"
        "os"

        "github.com/lightningnetwork/lnd/cluster"
)

const (
        // DefaultEtcdElectionPrefix is used as election prefix if none is provided
        // through the config.
        DefaultEtcdElectionPrefix = "/leader/"
)

// Cluster holds configuration for clustered LND.
type Cluster struct {
        EnableLeaderElection bool `long:"enable-leader-election" description:"Enables leader election if set."`

        LeaderElector string `long:"leader-elector" choice:"etcd" description:"Leader elector to use. Valid values: \"etcd\"."`

        EtcdElectionPrefix string `long:"etcd-election-prefix" description:"Election key prefix when using etcd leader elector."`

        ID string `long:"id" description:"Identifier for this node inside the cluster (used in leader election). Defaults to the hostname."`

        LeaderSessionTTL int `long:"leader-session-ttl" description:"The TTL in seconds to use for the leader election session."`
}

// DefaultCluster creates and returns a new default DB config.
func DefaultCluster() *Cluster {
        hostname, _ := os.Hostname()
        return &Cluster{
                LeaderElector:      cluster.EtcdLeaderElector,
                EtcdElectionPrefix: DefaultEtcdElectionPrefix,
                LeaderSessionTTL:   90,
                ID:                 hostname,
        }
}

// MakeLeaderElector is a helper method to construct the concrete leader elector
// based on the current configuration.
func (c *Cluster) MakeLeaderElector(electionCtx context.Context, db *DB) (
        cluster.LeaderElector, error) {

        if c.LeaderElector == cluster.EtcdLeaderElector {
                return cluster.MakeLeaderElector(
                        electionCtx, c.LeaderElector, c.ID,
                        c.EtcdElectionPrefix, c.LeaderSessionTTL, db.Etcd,
                )
        }

        return nil, fmt.Errorf("unsupported leader elector")
}

// Validate validates the Cluster config.
func (c *Cluster) Validate() error {
        if !c.EnableLeaderElection {
                return nil
        }

        switch c.LeaderElector {
        case cluster.EtcdLeaderElector:
                if c.EtcdElectionPrefix == "" {
                        return fmt.Errorf("etcd-election-prefix must be set")
                }
                return nil

        default:
                return fmt.Errorf("unknown leader elector, valid values are: "+
                        "\"%v\"", cluster.EtcdLeaderElector)
        }
}

// Compile-time constraint to ensure Workers implements the Validator interface.
var _ Validator = (*Cluster)(nil)

1	package lncfg
2
3	import (
4	"context"
5	"fmt"
6	"os"
7
8	"github.com/lightningnetwork/lnd/cluster"
9	)
10
11	const (
12	// DefaultEtcdElectionPrefix is used as election prefix if none is provided
13	// through the config.
14	DefaultEtcdElectionPrefix = "/leader/"
15	)
16
17	// Cluster holds configuration for clustered LND.
18	type Cluster struct {
19	EnableLeaderElection bool `long:"enable-leader-election" description:"Enables leader election if set."`
20
21	LeaderElector string `long:"leader-elector" choice:"etcd" description:"Leader elector to use. Valid values: \"etcd\"."`
22
23	EtcdElectionPrefix string `long:"etcd-election-prefix" description:"Election key prefix when using etcd leader elector."`
24
25	ID string `long:"id" description:"Identifier for this node inside the cluster (used in leader election). Defaults to the hostname."`
26
27	LeaderSessionTTL int `long:"leader-session-ttl" description:"The TTL in seconds to use for the leader election session."`
28	}
29
30	// DefaultCluster creates and returns a new default DB config.
31	func DefaultCluster() *Cluster {	1✔
32	hostname, _ := os.Hostname()	1✔
33	return &Cluster{	1✔
34	LeaderElector: cluster.EtcdLeaderElector,	1✔
35	EtcdElectionPrefix: DefaultEtcdElectionPrefix,	1✔
36	LeaderSessionTTL: 90,	1✔
37	ID: hostname,	1✔
38	}	1✔
39	}	1✔
40
41	// MakeLeaderElector is a helper method to construct the concrete leader elector
42	// based on the current configuration.
43	func (c Cluster) MakeLeaderElector(electionCtx context.Context, db DB) (
44	cluster.LeaderElector, error) {	×
45		×
46	if c.LeaderElector == cluster.EtcdLeaderElector {	×
47	return cluster.MakeLeaderElector(	×
48	electionCtx, c.LeaderElector, c.ID,	×
49	c.EtcdElectionPrefix, c.LeaderSessionTTL, db.Etcd,	×
50	)	×
51	}	×
52
53	return nil, fmt.Errorf("unsupported leader elector")	×
54	}
55
56	// Validate validates the Cluster config.
57	func (c *Cluster) Validate() error {	×
58	if !c.EnableLeaderElection {	×
59	return nil	×
60	}	×
61
62	switch c.LeaderElector {	×
63	case cluster.EtcdLeaderElector:	×
64	if c.EtcdElectionPrefix == "" {	×
65	return fmt.Errorf("etcd-election-prefix must be set")	×
66	}	×
67	return nil	×
68
69	default:	×
70	return fmt.Errorf("unknown leader elector, valid values are: "+	×
71	"\"%v\"", cluster.EtcdLeaderElector)	×
72	}
73	}
74
75	// Compile-time constraint to ensure Workers implements the Validator interface.
76	var _ Validator = (*Cluster)(nil)

lightningnetwork / lnd / 12312390362

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous