feat: collect system resolver results using context (#856)
* feat: Introduce context-based tracing to the system resolver * testing: added tests for context-based tracing in netxlite resolvers * Apply suggestions from code review Reference issue: https://github.com/ooni/probe/issues/2207 Co-authored-by: decfox <decfox@github.com> Co-authored-by: Simone Basso <bassosimone@gmail.com>
This commit is contained in:
DecFox
GitHub
parent
a818373e2c
commit
576b52b1e3
3 changed files with 347 additions and 2 deletions
|
|
@ -6,10 +6,13 @@ import (
|
|||
"errors"
|
||||
"net"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/miekg/dns"
|
||||
"github.com/ooni/probe-cli/v3/internal/model"
|
||||
"github.com/ooni/probe-cli/v3/internal/model/mocks"
|
||||
"github.com/ooni/probe-cli/v3/internal/testingx"
|
||||
)
|
||||
|
||||
func TestParallelResolver(t *testing.T) {
|
||||
|
|
@ -272,4 +275,214 @@ func TestParallelResolver(t *testing.T) {
|
|||
}
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("uses a context-injected custom trace (success case)", func(t *testing.T) {
|
||||
var (
|
||||
onLookupACalled bool
|
||||
onLookupAAAACalled bool
|
||||
goodQueryTypeA bool
|
||||
goodQueryTypeAAAA bool
|
||||
goodLookupAddrsA bool
|
||||
goodLookupAddrsAAAA bool
|
||||
goodLookupErrorA bool
|
||||
goodLookupErrorAAAA bool
|
||||
goodLookupResolverA bool
|
||||
goodLookupResolverAAAA bool
|
||||
)
|
||||
expectedA := []string{"1.1.1.1"}
|
||||
expectedAAAA := []string{"::1"}
|
||||
txp := &mocks.DNSTransport{
|
||||
MockRoundTrip: func(ctx context.Context, query model.DNSQuery) (model.DNSResponse, error) {
|
||||
if query.Type() == dns.TypeA {
|
||||
return &mocks.DNSResponse{
|
||||
MockDecodeLookupHost: func() ([]string, error) {
|
||||
return expectedA, nil
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
if query.Type() == dns.TypeAAAA {
|
||||
return &mocks.DNSResponse{
|
||||
MockDecodeLookupHost: func() ([]string, error) {
|
||||
return expectedAAAA, nil
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
return nil, errors.New("unexpected query type")
|
||||
},
|
||||
MockNetwork: func() string {
|
||||
return "mocked"
|
||||
},
|
||||
MockRequiresPadding: func() bool {
|
||||
return false
|
||||
},
|
||||
}
|
||||
r := NewUnwrappedParallelResolver(txp)
|
||||
zeroTime := time.Now()
|
||||
deteterministicTime := testingx.NewTimeDeterministic(zeroTime)
|
||||
tx := &mocks.Trace{
|
||||
MockTimeNow: deteterministicTime.Now,
|
||||
MockOnDNSRoundTripForLookupHost: func(started time.Time, reso model.Resolver, query model.DNSQuery,
|
||||
response model.DNSResponse, addrs []string, err error, finished time.Time) {
|
||||
if query.Type() == dns.TypeA {
|
||||
onLookupACalled = true
|
||||
goodQueryTypeA = (query.Type() == dns.TypeA)
|
||||
goodLookupAddrsA = (cmp.Diff(expectedA, addrs) == "")
|
||||
goodLookupErrorA = (err == nil)
|
||||
goodLookupResolverA = (reso.Network() == "mocked")
|
||||
}
|
||||
if query.Type() == dns.TypeAAAA {
|
||||
onLookupAAAACalled = true
|
||||
goodQueryTypeAAAA = (query.Type() == dns.TypeAAAA)
|
||||
goodLookupAddrsAAAA = (cmp.Diff(expectedAAAA, addrs) == "")
|
||||
goodLookupErrorAAAA = (err == nil)
|
||||
goodLookupResolverAAAA = (reso.Network() == "mocked")
|
||||
}
|
||||
},
|
||||
}
|
||||
want := []string{"1.1.1.1", "::1"}
|
||||
ctx := ContextWithTrace(context.Background(), tx)
|
||||
addrs, err := r.LookupHost(ctx, "example.com")
|
||||
if err != nil {
|
||||
t.Fatal("unexpected error", err)
|
||||
}
|
||||
// Note: the implementation always puts IPv4 addrs before IPv6 addrs
|
||||
if diff := cmp.Diff(want, addrs); diff != "" {
|
||||
t.Fatal("unexpected addresses")
|
||||
}
|
||||
|
||||
t.Run("with A reply", func(t *testing.T) {
|
||||
if !onLookupACalled {
|
||||
t.Fatal("onLookupACalled not called")
|
||||
}
|
||||
if !goodQueryTypeA {
|
||||
t.Fatal("unexpected query type in parallel resolver")
|
||||
}
|
||||
if !goodLookupAddrsA {
|
||||
t.Fatal("unexpected addresses in LookupHost")
|
||||
}
|
||||
if !goodLookupErrorA {
|
||||
t.Fatal("unexpected error in trace")
|
||||
}
|
||||
if !goodLookupResolverA {
|
||||
t.Fatal("unexpected resolver network encountered")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("with AAAA reply", func(t *testing.T) {
|
||||
if !onLookupAAAACalled {
|
||||
t.Fatal("onLookupAAAACalled not called")
|
||||
}
|
||||
if !goodQueryTypeAAAA {
|
||||
t.Fatal("unexpected query type in parallel resolver")
|
||||
}
|
||||
if !goodLookupAddrsAAAA {
|
||||
t.Fatal("unexpected addresses in LookupHost")
|
||||
}
|
||||
if !goodLookupErrorAAAA {
|
||||
t.Fatal("unexpected error in trace")
|
||||
}
|
||||
if !goodLookupResolverAAAA {
|
||||
t.Fatal("unexpected resolver network encountered")
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("uses a context-injected custom trace (failure case)", func(t *testing.T) {
|
||||
var (
|
||||
onLookupACalled bool
|
||||
onLookupAAAACalled bool
|
||||
goodQueryTypeA bool
|
||||
goodQueryTypeAAAA bool
|
||||
goodLookupAddrsA bool
|
||||
goodLookupAddrsAAAA bool
|
||||
goodLookupErrorA bool
|
||||
goodLookupErrorAAAA bool
|
||||
goodLookupResolverA bool
|
||||
goodLookupResolverAAAA bool
|
||||
)
|
||||
expected := errors.New("mocked")
|
||||
txp := &mocks.DNSTransport{
|
||||
MockRoundTrip: func(ctx context.Context, query model.DNSQuery) (model.DNSResponse, error) {
|
||||
if query.Type() == dns.TypeAAAA || query.Type() == dns.TypeA {
|
||||
return nil, expected
|
||||
}
|
||||
return nil, errors.New("unexpected query type")
|
||||
},
|
||||
MockNetwork: func() string {
|
||||
return "mocked"
|
||||
},
|
||||
MockRequiresPadding: func() bool {
|
||||
return false
|
||||
},
|
||||
}
|
||||
r := NewUnwrappedParallelResolver(txp)
|
||||
zeroTime := time.Now()
|
||||
deteterministicTime := testingx.NewTimeDeterministic(zeroTime)
|
||||
tx := &mocks.Trace{
|
||||
MockTimeNow: deteterministicTime.Now,
|
||||
MockOnDNSRoundTripForLookupHost: func(started time.Time, reso model.Resolver, query model.DNSQuery,
|
||||
response model.DNSResponse, addrs []string, err error, finished time.Time) {
|
||||
if query.Type() == dns.TypeA {
|
||||
onLookupACalled = true
|
||||
goodQueryTypeA = (query.Type() == dns.TypeA)
|
||||
goodLookupAddrsA = (len(addrs) == 0)
|
||||
goodLookupErrorA = errors.Is(expected, err)
|
||||
goodLookupResolverA = (reso.Network() == "mocked")
|
||||
return
|
||||
}
|
||||
if query.Type() == dns.TypeAAAA {
|
||||
onLookupAAAACalled = true
|
||||
goodQueryTypeAAAA = (query.Type() == dns.TypeAAAA)
|
||||
goodLookupAddrsAAAA = (len(addrs) == 0)
|
||||
goodLookupErrorAAAA = errors.Is(expected, err)
|
||||
goodLookupResolverAAAA = (reso.Network() == "mocked")
|
||||
return
|
||||
}
|
||||
},
|
||||
}
|
||||
ctx := ContextWithTrace(context.Background(), tx)
|
||||
addrs, err := r.LookupHost(ctx, "example.com")
|
||||
if !errors.Is(expected, err) {
|
||||
t.Fatal("unexpected error", err)
|
||||
}
|
||||
if len(addrs) != 0 {
|
||||
t.Fatal("unexpected addresses")
|
||||
}
|
||||
|
||||
t.Run("with A reply", func(t *testing.T) {
|
||||
if !onLookupACalled {
|
||||
t.Fatal("onLookupACalled not called")
|
||||
}
|
||||
if !goodQueryTypeA {
|
||||
t.Fatal("unexpected query type in parallel resolver")
|
||||
}
|
||||
if !goodLookupAddrsA {
|
||||
t.Fatal("unexpected addresses in LookupHost")
|
||||
}
|
||||
if !goodLookupErrorA {
|
||||
t.Fatal("unexpected error in trace")
|
||||
}
|
||||
if !goodLookupResolverA {
|
||||
t.Fatal("unexpected resolver network encountered")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("with AAAA reply", func(t *testing.T) {
|
||||
if !onLookupAAAACalled {
|
||||
t.Fatal("onLookupAAAACalled not called")
|
||||
}
|
||||
if !goodQueryTypeAAAA {
|
||||
t.Fatal("unexpected query type in parallel resolver")
|
||||
}
|
||||
if !goodLookupAddrsAAAA {
|
||||
t.Fatal("unexpected addresses in LookupHost")
|
||||
}
|
||||
if !goodLookupErrorAAAA {
|
||||
t.Fatal("unexpected error in trace")
|
||||
}
|
||||
if !goodLookupResolverAAAA {
|
||||
t.Fatal("unexpected resolver network encountered")
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue