feat(netxlite): implement DNSTransport wrapping (#776)
Acknowledge that transports MAY be used in isolation (i.e., outside of a Resolver) and add support for wrapping. Ensure that every factory that creates an unwrapped type is named accordingly to hopefully ensure there are no surprises. Implement DNSTransport wrapping and use a technique similar to the one used by Dialer to customize the DNSTransport while constructing more complex data types (e.g., a specific resolver). Ensure that the stdlib resolver's own "getaddrinfo" transport (1) is wrapped and (2) could be extended during construction. This work is part of my ongoing effort to bring to this repository websteps-illustrated changes relative to netxlite. Ref issue: https://github.com/ooni/probe/issues/2096
This commit is contained in:
parent
923d81cdee
commit
8f7e3803eb
20 changed files with 369 additions and 91 deletions
156
internal/netxlite/dnstransport_test.go
Normal file
156
internal/netxlite/dnstransport_test.go
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
package netxlite
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"testing"
|
||||
|
||||
"github.com/ooni/probe-cli/v3/internal/model"
|
||||
"github.com/ooni/probe-cli/v3/internal/model/mocks"
|
||||
)
|
||||
|
||||
type dnsTransportExtensionFirst struct {
|
||||
model.DNSTransport
|
||||
}
|
||||
|
||||
type dnsTransportWrapperFirst struct{}
|
||||
|
||||
func (*dnsTransportWrapperFirst) WrapDNSTransport(txp model.DNSTransport) model.DNSTransport {
|
||||
return &dnsTransportExtensionFirst{txp}
|
||||
}
|
||||
|
||||
type dnsTransportExtensionSecond struct {
|
||||
model.DNSTransport
|
||||
}
|
||||
|
||||
type dnsTransportWrapperSecond struct{}
|
||||
|
||||
func (*dnsTransportWrapperSecond) WrapDNSTransport(txp model.DNSTransport) model.DNSTransport {
|
||||
return &dnsTransportExtensionSecond{txp}
|
||||
}
|
||||
|
||||
func TestWrapDNSTransport(t *testing.T) {
|
||||
orig := &mocks.DNSTransport{}
|
||||
extensions := []model.DNSTransportWrapper{
|
||||
&dnsTransportWrapperFirst{},
|
||||
nil, // explicitly test for documented use case
|
||||
&dnsTransportWrapperSecond{},
|
||||
}
|
||||
txp := WrapDNSTransport(orig, extensions...)
|
||||
ext2 := txp.(*dnsTransportExtensionSecond)
|
||||
ext1 := ext2.DNSTransport.(*dnsTransportExtensionFirst)
|
||||
errWrapper := ext1.DNSTransport.(*dnsTransportErrWrapper)
|
||||
underlying := errWrapper.DNSTransport
|
||||
if orig != underlying {
|
||||
t.Fatal("unexpected underlying transport")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDNSTransportErrWrapper(t *testing.T) {
|
||||
t.Run("RoundTrip", func(t *testing.T) {
|
||||
t.Run("on success", func(t *testing.T) {
|
||||
expectedResp := &mocks.DNSResponse{}
|
||||
child := &mocks.DNSTransport{
|
||||
MockRoundTrip: func(ctx context.Context, query model.DNSQuery) (model.DNSResponse, error) {
|
||||
return expectedResp, nil
|
||||
},
|
||||
}
|
||||
txp := &dnsTransportErrWrapper{
|
||||
DNSTransport: child,
|
||||
}
|
||||
query := &mocks.DNSQuery{}
|
||||
ctx := context.Background()
|
||||
resp, err := txp.RoundTrip(ctx, query)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if resp != expectedResp {
|
||||
t.Fatal("unexpected resp")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("on failure", func(t *testing.T) {
|
||||
expectedErr := io.EOF
|
||||
child := &mocks.DNSTransport{
|
||||
MockRoundTrip: func(ctx context.Context, query model.DNSQuery) (model.DNSResponse, error) {
|
||||
return nil, expectedErr
|
||||
},
|
||||
}
|
||||
txp := &dnsTransportErrWrapper{
|
||||
DNSTransport: child,
|
||||
}
|
||||
query := &mocks.DNSQuery{}
|
||||
ctx := context.Background()
|
||||
resp, err := txp.RoundTrip(ctx, query)
|
||||
if !errors.Is(err, expectedErr) {
|
||||
t.Fatal("unexpected err", err)
|
||||
}
|
||||
if resp != nil {
|
||||
t.Fatal("unexpected resp")
|
||||
}
|
||||
var errWrapper *ErrWrapper
|
||||
if !errors.As(err, &errWrapper) {
|
||||
t.Fatal("error has not been wrapped")
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("RequiresPadding", func(t *testing.T) {
|
||||
child := &mocks.DNSTransport{
|
||||
MockRequiresPadding: func() bool {
|
||||
return true
|
||||
},
|
||||
}
|
||||
txp := &dnsTransportErrWrapper{
|
||||
DNSTransport: child,
|
||||
}
|
||||
if !txp.RequiresPadding() {
|
||||
t.Fatal("expected true")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Network", func(t *testing.T) {
|
||||
child := &mocks.DNSTransport{
|
||||
MockNetwork: func() string {
|
||||
return "x"
|
||||
},
|
||||
}
|
||||
txp := &dnsTransportErrWrapper{
|
||||
DNSTransport: child,
|
||||
}
|
||||
if txp.Network() != "x" {
|
||||
t.Fatal("unexpected Network")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Address", func(t *testing.T) {
|
||||
child := &mocks.DNSTransport{
|
||||
MockAddress: func() string {
|
||||
return "x"
|
||||
},
|
||||
}
|
||||
txp := &dnsTransportErrWrapper{
|
||||
DNSTransport: child,
|
||||
}
|
||||
if txp.Address() != "x" {
|
||||
t.Fatal("unexpected Address")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("CloseIdleConnections", func(t *testing.T) {
|
||||
var called bool
|
||||
child := &mocks.DNSTransport{
|
||||
MockCloseIdleConnections: func() {
|
||||
called = true
|
||||
},
|
||||
}
|
||||
txp := &dnsTransportErrWrapper{
|
||||
DNSTransport: child,
|
||||
}
|
||||
txp.CloseIdleConnections()
|
||||
if !called {
|
||||
t.Fatal("not called")
|
||||
}
|
||||
})
|
||||
}
|
||||
Loading…
Reference in a new issue