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

41.67

/macaroons/auth.go

package macaroons

import (
        "context"
        "encoding/hex"

        macaroon "gopkg.in/macaroon.v2"
)

// MacaroonCredential wraps a macaroon to implement the
// credentials.PerRPCCredentials interface.
type MacaroonCredential struct {
        *macaroon.Macaroon
}

// RequireTransportSecurity implements the PerRPCCredentials interface.
func (m MacaroonCredential) RequireTransportSecurity() bool {
        return true
}

// GetRequestMetadata implements the PerRPCCredentials interface. This method
// is required in order to pass the wrapped macaroon into the gRPC context.
// With this, the macaroon will be available within the request handling scope
// of the ultimate gRPC server implementation.
func (m MacaroonCredential) GetRequestMetadata(ctx context.Context,
        uri ...string) (map[string]string, error) {

        macBytes, err := m.MarshalBinary()
        if err != nil {
                return nil, err
        }

        md := make(map[string]string)
        md["macaroon"] = hex.EncodeToString(macBytes)
        return md, nil
}

// NewMacaroonCredential returns a copy of the passed macaroon wrapped in a
// MacaroonCredential struct which implements PerRPCCredentials.
func NewMacaroonCredential(m *macaroon.Macaroon) (MacaroonCredential, error) {
        ms := MacaroonCredential{}

        // The macaroon library's Clone() method has a subtle bug that doesn't
        // correctly clone all caveats. We need to use our own, safe clone
        // function instead.
        var err error
        ms.Macaroon, err = SafeCopyMacaroon(m)
        if err != nil {
                return ms, err
        }

        return ms, nil
}

1	package macaroons
2
3	import (
4	"context"
5	"encoding/hex"
6
7	macaroon "gopkg.in/macaroon.v2"
8	)
9
10	// MacaroonCredential wraps a macaroon to implement the
11	// credentials.PerRPCCredentials interface.
12	type MacaroonCredential struct {
13	*macaroon.Macaroon
14	}
15
16	// RequireTransportSecurity implements the PerRPCCredentials interface.
17	func (m MacaroonCredential) RequireTransportSecurity() bool {	×
18	return true	×
19	}	×
20
21	// GetRequestMetadata implements the PerRPCCredentials interface. This method
22	// is required in order to pass the wrapped macaroon into the gRPC context.
23	// With this, the macaroon will be available within the request handling scope
24	// of the ultimate gRPC server implementation.
25	func (m MacaroonCredential) GetRequestMetadata(ctx context.Context,
26	uri ...string) (map[string]string, error) {	×
27		×
28	macBytes, err := m.MarshalBinary()	×
29	if err != nil {	×
30	return nil, err	×
31	}	×
32
33	md := make(map[string]string)	×
34	md["macaroon"] = hex.EncodeToString(macBytes)	×
35	return md, nil	×
36	}
37
38	// NewMacaroonCredential returns a copy of the passed macaroon wrapped in a
39	// MacaroonCredential struct which implements PerRPCCredentials.
40	func NewMacaroonCredential(m *macaroon.Macaroon) (MacaroonCredential, error) {	1✔
41	ms := MacaroonCredential{}	1✔
42		1✔
43	// The macaroon library's Clone() method has a subtle bug that doesn't	1✔
44	// correctly clone all caveats. We need to use our own, safe clone	1✔
45	// function instead.	1✔
46	var err error	1✔
47	ms.Macaroon, err = SafeCopyMacaroon(m)	1✔
48	if err != nil {	1✔
49	return ms, err	×
50	}	×
51
52	return ms, nil	1✔
53	}

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