cleanup(netx): remove subpackages and unnecessary code (#788)

This pull request consists of several small and obvious cleanups in the netx directory.

See https://github.com/ooni/probe/issues/2121
This commit is contained in:
Simone Basso 2022-06-02 11:51:21 +02:00 committed by GitHub
commit 1cb820b19d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 201 additions and 815 deletions

View file

@ -1,4 +1,4 @@
package netx_test
package netx
import (
"context"
@ -11,15 +11,13 @@ import (
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/internal/bytecounter"
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/engine/netx/resolver"
"github.com/ooni/probe-cli/v3/internal/model/mocks"
"github.com/ooni/probe-cli/v3/internal/netxlite"
"github.com/ooni/probe-cli/v3/internal/tracex"
)
func TestNewResolverVanilla(t *testing.T) {
r := netx.NewResolver(netx.Config{})
r := NewResolver(Config{})
ir, ok := r.(*netxlite.ResolverIDNA)
if !ok {
t.Fatal("not the resolver we expected")
@ -39,7 +37,7 @@ func TestNewResolverVanilla(t *testing.T) {
}
func TestNewResolverSpecificResolver(t *testing.T) {
r := netx.NewResolver(netx.Config{
r := NewResolver(Config{
BaseResolver: &netxlite.BogonResolver{
// not initialized because it doesn't matter in this context
},
@ -63,7 +61,7 @@ func TestNewResolverSpecificResolver(t *testing.T) {
}
func TestNewResolverWithBogonFilter(t *testing.T) {
r := netx.NewResolver(netx.Config{
r := NewResolver(Config{
BogonIsError: true,
})
ir, ok := r.(*netxlite.ResolverIDNA)
@ -89,7 +87,7 @@ func TestNewResolverWithBogonFilter(t *testing.T) {
}
func TestNewResolverWithLogging(t *testing.T) {
r := netx.NewResolver(netx.Config{
r := NewResolver(Config{
Logger: log.Log,
})
ir, ok := r.(*netxlite.ResolverIDNA)
@ -119,7 +117,7 @@ func TestNewResolverWithLogging(t *testing.T) {
func TestNewResolverWithSaver(t *testing.T) {
saver := new(tracex.Saver)
r := netx.NewResolver(netx.Config{
r := NewResolver(Config{
ResolveSaver: saver,
})
ir, ok := r.(*netxlite.ResolverIDNA)
@ -148,7 +146,7 @@ func TestNewResolverWithSaver(t *testing.T) {
}
func TestNewResolverWithReadWriteCache(t *testing.T) {
r := netx.NewResolver(netx.Config{
r := NewResolver(Config{
CacheResolutions: true,
})
ir, ok := r.(*netxlite.ResolverIDNA)
@ -159,7 +157,7 @@ func TestNewResolverWithReadWriteCache(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
cr, ok := ewr.Resolver.(*resolver.CacheResolver)
cr, ok := ewr.Resolver.(*CacheResolver)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -177,7 +175,7 @@ func TestNewResolverWithReadWriteCache(t *testing.T) {
}
func TestNewResolverWithPrefilledReadonlyCache(t *testing.T) {
r := netx.NewResolver(netx.Config{
r := NewResolver(Config{
DNSCache: map[string][]string{
"dns.google.com": {"8.8.8.8"},
},
@ -190,7 +188,7 @@ func TestNewResolverWithPrefilledReadonlyCache(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
cr, ok := ewr.Resolver.(*resolver.CacheResolver)
cr, ok := ewr.Resolver.(*CacheResolver)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -211,7 +209,7 @@ func TestNewResolverWithPrefilledReadonlyCache(t *testing.T) {
}
func TestNewTLSDialerVanilla(t *testing.T) {
td := netx.NewTLSDialer(netx.Config{})
td := NewTLSDialer(Config{})
rtd, ok := td.(*netxlite.TLSDialerLegacy)
if !ok {
t.Fatal("not the TLSDialer we expected")
@ -222,7 +220,7 @@ func TestNewTLSDialerVanilla(t *testing.T) {
if rtd.Config.NextProtos[0] != "h2" || rtd.Config.NextProtos[1] != "http/1.1" {
t.Fatal("invalid Config.NextProtos")
}
if rtd.Config.RootCAs != netx.DefaultCertPool() {
if rtd.Config.RootCAs != defaultCertPool {
t.Fatal("invalid Config.RootCAs")
}
if rtd.Dialer == nil {
@ -241,7 +239,7 @@ func TestNewTLSDialerVanilla(t *testing.T) {
}
func TestNewTLSDialerWithConfig(t *testing.T) {
td := netx.NewTLSDialer(netx.Config{
td := NewTLSDialer(Config{
TLSConfig: new(tls.Config),
})
rtd, ok := td.(*netxlite.TLSDialerLegacy)
@ -251,7 +249,7 @@ func TestNewTLSDialerWithConfig(t *testing.T) {
if len(rtd.Config.NextProtos) != 0 {
t.Fatal("invalid len(config.NextProtos)")
}
if rtd.Config.RootCAs != netx.DefaultCertPool() {
if rtd.Config.RootCAs != defaultCertPool {
t.Fatal("invalid Config.RootCAs")
}
if rtd.Dialer == nil {
@ -270,7 +268,7 @@ func TestNewTLSDialerWithConfig(t *testing.T) {
}
func TestNewTLSDialerWithLogging(t *testing.T) {
td := netx.NewTLSDialer(netx.Config{
td := NewTLSDialer(Config{
Logger: log.Log,
})
rtd, ok := td.(*netxlite.TLSDialerLegacy)
@ -283,7 +281,7 @@ func TestNewTLSDialerWithLogging(t *testing.T) {
if rtd.Config.NextProtos[0] != "h2" || rtd.Config.NextProtos[1] != "http/1.1" {
t.Fatal("invalid Config.NextProtos")
}
if rtd.Config.RootCAs != netx.DefaultCertPool() {
if rtd.Config.RootCAs != defaultCertPool {
t.Fatal("invalid Config.RootCAs")
}
if rtd.Dialer == nil {
@ -310,7 +308,7 @@ func TestNewTLSDialerWithLogging(t *testing.T) {
func TestNewTLSDialerWithSaver(t *testing.T) {
saver := new(tracex.Saver)
td := netx.NewTLSDialer(netx.Config{
td := NewTLSDialer(Config{
TLSSaver: saver,
})
rtd, ok := td.(*netxlite.TLSDialerLegacy)
@ -323,7 +321,7 @@ func TestNewTLSDialerWithSaver(t *testing.T) {
if rtd.Config.NextProtos[0] != "h2" || rtd.Config.NextProtos[1] != "http/1.1" {
t.Fatal("invalid Config.NextProtos")
}
if rtd.Config.RootCAs != netx.DefaultCertPool() {
if rtd.Config.RootCAs != defaultCertPool {
t.Fatal("invalid Config.RootCAs")
}
if rtd.Dialer == nil {
@ -349,7 +347,7 @@ func TestNewTLSDialerWithSaver(t *testing.T) {
}
func TestNewTLSDialerWithNoTLSVerifyAndConfig(t *testing.T) {
td := netx.NewTLSDialer(netx.Config{
td := NewTLSDialer(Config{
TLSConfig: new(tls.Config),
NoTLSVerify: true,
})
@ -363,7 +361,7 @@ func TestNewTLSDialerWithNoTLSVerifyAndConfig(t *testing.T) {
if rtd.Config.InsecureSkipVerify != true {
t.Fatal("expected true InsecureSkipVerify")
}
if rtd.Config.RootCAs != netx.DefaultCertPool() {
if rtd.Config.RootCAs != defaultCertPool {
t.Fatal("invalid Config.RootCAs")
}
if rtd.Dialer == nil {
@ -382,7 +380,7 @@ func TestNewTLSDialerWithNoTLSVerifyAndConfig(t *testing.T) {
}
func TestNewTLSDialerWithNoTLSVerifyAndNoConfig(t *testing.T) {
td := netx.NewTLSDialer(netx.Config{
td := NewTLSDialer(Config{
NoTLSVerify: true,
})
rtd, ok := td.(*netxlite.TLSDialerLegacy)
@ -398,7 +396,7 @@ func TestNewTLSDialerWithNoTLSVerifyAndNoConfig(t *testing.T) {
if rtd.Config.InsecureSkipVerify != true {
t.Fatal("expected true InsecureSkipVerify")
}
if rtd.Config.RootCAs != netx.DefaultCertPool() {
if rtd.Config.RootCAs != defaultCertPool {
t.Fatal("invalid Config.RootCAs")
}
if rtd.Dialer == nil {
@ -417,7 +415,7 @@ func TestNewTLSDialerWithNoTLSVerifyAndNoConfig(t *testing.T) {
}
func TestNewVanilla(t *testing.T) {
txp := netx.NewHTTPTransport(netx.Config{})
txp := NewHTTPTransport(Config{})
if _, ok := txp.(*netxlite.HTTPTransportWrapper); !ok {
t.Fatal("not the transport we expected")
}
@ -425,8 +423,12 @@ func TestNewVanilla(t *testing.T) {
func TestNewWithDialer(t *testing.T) {
expected := errors.New("mocked error")
dialer := netx.FakeDialer{Err: expected}
txp := netx.NewHTTPTransport(netx.Config{
dialer := &mocks.Dialer{
MockDialContext: func(ctx context.Context, network, address string) (net.Conn, error) {
return nil, expected
},
}
txp := NewHTTPTransport(Config{
Dialer: dialer,
})
client := &http.Client{Transport: txp}
@ -453,7 +455,7 @@ func TestNewWithTLSDialer(t *testing.T) {
},
TLSHandshaker: &netxlite.TLSHandshakerConfigurable{},
}
txp := netx.NewHTTPTransport(netx.Config{
txp := NewHTTPTransport(Config{
TLSDialer: tlsDialer,
})
client := &http.Client{Transport: txp}
@ -468,7 +470,7 @@ func TestNewWithTLSDialer(t *testing.T) {
func TestNewWithByteCounter(t *testing.T) {
counter := bytecounter.New()
txp := netx.NewHTTPTransport(netx.Config{
txp := NewHTTPTransport(Config{
ByteCounter: counter,
})
bctxp, ok := txp.(*bytecounter.HTTPTransport)
@ -484,7 +486,7 @@ func TestNewWithByteCounter(t *testing.T) {
}
func TestNewWithLogger(t *testing.T) {
txp := netx.NewHTTPTransport(netx.Config{
txp := NewHTTPTransport(Config{
Logger: log.Log,
})
ltxp, ok := txp.(*netxlite.HTTPTransportLogger)
@ -501,7 +503,7 @@ func TestNewWithLogger(t *testing.T) {
func TestNewWithSaver(t *testing.T) {
saver := new(tracex.Saver)
txp := netx.NewHTTPTransport(netx.Config{
txp := NewHTTPTransport(Config{
HTTPSaver: saver,
})
stxptxp, ok := txp.(*tracex.HTTPTransportSaver)
@ -520,7 +522,7 @@ func TestNewWithSaver(t *testing.T) {
}
func TestNewDNSClientInvalidURL(t *testing.T) {
dnsclient, err := netx.NewDNSClient(netx.Config{}, "\t\t\t")
dnsclient, err := NewDNSClient(Config{}, "\t\t\t")
if err == nil || !strings.HasSuffix(err.Error(), "invalid control character in URL") {
t.Fatal("not the error we expected")
}
@ -530,7 +532,7 @@ func TestNewDNSClientInvalidURL(t *testing.T) {
}
func TestNewDNSClientUnsupportedScheme(t *testing.T) {
dnsclient, err := netx.NewDNSClient(netx.Config{}, "antani:///")
dnsclient, err := NewDNSClient(Config{}, "antani:///")
if err == nil || err.Error() != "unsupported resolver scheme" {
t.Fatal("not the error we expected")
}
@ -540,8 +542,8 @@ func TestNewDNSClientUnsupportedScheme(t *testing.T) {
}
func TestNewDNSClientSystemResolver(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "system:///")
dnsclient, err := NewDNSClient(
Config{}, "system:///")
if err != nil {
t.Fatal(err)
}
@ -552,8 +554,8 @@ func TestNewDNSClientSystemResolver(t *testing.T) {
}
func TestNewDNSClientEmpty(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "")
dnsclient, err := NewDNSClient(
Config{}, "")
if err != nil {
t.Fatal(err)
}
@ -564,8 +566,8 @@ func TestNewDNSClientEmpty(t *testing.T) {
}
func TestNewDNSClientPowerdnsDoH(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "doh://powerdns")
dnsclient, err := NewDNSClient(
Config{}, "doh://powerdns")
if err != nil {
t.Fatal(err)
}
@ -580,8 +582,8 @@ func TestNewDNSClientPowerdnsDoH(t *testing.T) {
}
func TestNewDNSClientGoogleDoH(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "doh://google")
dnsclient, err := NewDNSClient(
Config{}, "doh://google")
if err != nil {
t.Fatal(err)
}
@ -596,8 +598,8 @@ func TestNewDNSClientGoogleDoH(t *testing.T) {
}
func TestNewDNSClientCloudflareDoH(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "doh://cloudflare")
dnsclient, err := NewDNSClient(
Config{}, "doh://cloudflare")
if err != nil {
t.Fatal(err)
}
@ -613,8 +615,8 @@ func TestNewDNSClientCloudflareDoH(t *testing.T) {
func TestNewDNSClientCloudflareDoHSaver(t *testing.T) {
saver := new(tracex.Saver)
dnsclient, err := netx.NewDNSClient(
netx.Config{ResolveSaver: saver}, "doh://cloudflare")
dnsclient, err := NewDNSClient(
Config{ResolveSaver: saver}, "doh://cloudflare")
if err != nil {
t.Fatal(err)
}
@ -633,8 +635,8 @@ func TestNewDNSClientCloudflareDoHSaver(t *testing.T) {
}
func TestNewDNSClientUDP(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "udp://8.8.8.8:53")
dnsclient, err := NewDNSClient(
Config{}, "udp://8.8.8.8:53")
if err != nil {
t.Fatal(err)
}
@ -650,8 +652,8 @@ func TestNewDNSClientUDP(t *testing.T) {
func TestNewDNSClientUDPDNSSaver(t *testing.T) {
saver := new(tracex.Saver)
dnsclient, err := netx.NewDNSClient(
netx.Config{ResolveSaver: saver}, "udp://8.8.8.8:53")
dnsclient, err := NewDNSClient(
Config{ResolveSaver: saver}, "udp://8.8.8.8:53")
if err != nil {
t.Fatal(err)
}
@ -670,8 +672,8 @@ func TestNewDNSClientUDPDNSSaver(t *testing.T) {
}
func TestNewDNSClientTCP(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "tcp://8.8.8.8:53")
dnsclient, err := NewDNSClient(
Config{}, "tcp://8.8.8.8:53")
if err != nil {
t.Fatal(err)
}
@ -691,8 +693,8 @@ func TestNewDNSClientTCP(t *testing.T) {
func TestNewDNSClientTCPDNSSaver(t *testing.T) {
saver := new(tracex.Saver)
dnsclient, err := netx.NewDNSClient(
netx.Config{ResolveSaver: saver}, "tcp://8.8.8.8:53")
dnsclient, err := NewDNSClient(
Config{ResolveSaver: saver}, "tcp://8.8.8.8:53")
if err != nil {
t.Fatal(err)
}
@ -715,8 +717,8 @@ func TestNewDNSClientTCPDNSSaver(t *testing.T) {
}
func TestNewDNSClientDoT(t *testing.T) {
dnsclient, err := netx.NewDNSClient(
netx.Config{}, "dot://8.8.8.8:53")
dnsclient, err := NewDNSClient(
Config{}, "dot://8.8.8.8:53")
if err != nil {
t.Fatal(err)
}
@ -736,8 +738,8 @@ func TestNewDNSClientDoT(t *testing.T) {
func TestNewDNSClientDoTDNSSaver(t *testing.T) {
saver := new(tracex.Saver)
dnsclient, err := netx.NewDNSClient(
netx.Config{ResolveSaver: saver}, "dot://8.8.8.8:53")
dnsclient, err := NewDNSClient(
Config{ResolveSaver: saver}, "dot://8.8.8.8:53")
if err != nil {
t.Fatal(err)
}
@ -760,8 +762,8 @@ func TestNewDNSClientDoTDNSSaver(t *testing.T) {
}
func TestNewDNSCLientDoTWithoutPort(t *testing.T) {
c, err := netx.NewDNSClientWithOverrides(
netx.Config{}, "dot://8.8.8.8", "", "8.8.8.8", "")
c, err := NewDNSClientWithOverrides(
Config{}, "dot://8.8.8.8", "", "8.8.8.8", "")
if err != nil {
t.Fatal(err)
}
@ -771,8 +773,8 @@ func TestNewDNSCLientDoTWithoutPort(t *testing.T) {
}
func TestNewDNSCLientTCPWithoutPort(t *testing.T) {
c, err := netx.NewDNSClientWithOverrides(
netx.Config{}, "tcp://8.8.8.8", "", "8.8.8.8", "")
c, err := NewDNSClientWithOverrides(
Config{}, "tcp://8.8.8.8", "", "8.8.8.8", "")
if err != nil {
t.Fatal(err)
}
@ -782,8 +784,8 @@ func TestNewDNSCLientTCPWithoutPort(t *testing.T) {
}
func TestNewDNSCLientUDPWithoutPort(t *testing.T) {
c, err := netx.NewDNSClientWithOverrides(
netx.Config{}, "udp://8.8.8.8", "", "8.8.8.8", "")
c, err := NewDNSClientWithOverrides(
Config{}, "udp://8.8.8.8", "", "8.8.8.8", "")
if err != nil {
t.Fatal(err)
}
@ -793,33 +795,108 @@ func TestNewDNSCLientUDPWithoutPort(t *testing.T) {
}
func TestNewDNSClientBadDoTEndpoint(t *testing.T) {
_, err := netx.NewDNSClient(
netx.Config{}, "dot://bad:endpoint:53")
_, err := NewDNSClient(
Config{}, "dot://bad:endpoint:53")
if err == nil || !strings.Contains(err.Error(), "too many colons in address") {
t.Fatal("expected error with bad endpoint")
}
}
func TestNewDNSClientBadTCPEndpoint(t *testing.T) {
_, err := netx.NewDNSClient(
netx.Config{}, "tcp://bad:endpoint:853")
_, err := NewDNSClient(
Config{}, "tcp://bad:endpoint:853")
if err == nil || !strings.Contains(err.Error(), "too many colons in address") {
t.Fatal("expected error with bad endpoint")
}
}
func TestNewDNSClientBadUDPEndpoint(t *testing.T) {
_, err := netx.NewDNSClient(
netx.Config{}, "udp://bad:endpoint:853")
_, err := NewDNSClient(
Config{}, "udp://bad:endpoint:853")
if err == nil || !strings.Contains(err.Error(), "too many colons in address") {
t.Fatal("expected error with bad endpoint")
}
}
func TestNewDNSCLientWithInvalidTLSVersion(t *testing.T) {
_, err := netx.NewDNSClientWithOverrides(
netx.Config{}, "dot://8.8.8.8", "", "", "TLSv999")
_, err := NewDNSClientWithOverrides(
Config{}, "dot://8.8.8.8", "", "", "TLSv999")
if !errors.Is(err, netxlite.ErrInvalidTLSVersion) {
t.Fatalf("not the error we expected: %+v", err)
}
}
func TestSuccess(t *testing.T) {
if testing.Short() {
t.Skip("skip test in short mode")
}
log.SetLevel(log.DebugLevel)
counter := bytecounter.New()
config := Config{
BogonIsError: true,
ByteCounter: counter,
CacheResolutions: true,
ContextByteCounting: true,
DialSaver: &tracex.Saver{},
HTTPSaver: &tracex.Saver{},
Logger: log.Log,
ReadWriteSaver: &tracex.Saver{},
ResolveSaver: &tracex.Saver{},
TLSSaver: &tracex.Saver{},
}
txp := NewHTTPTransport(config)
client := &http.Client{Transport: txp}
resp, err := client.Get("https://www.google.com")
if err != nil {
t.Fatal(err)
}
if _, err = netxlite.ReadAllContext(context.Background(), resp.Body); err != nil {
t.Fatal(err)
}
if err = resp.Body.Close(); err != nil {
t.Fatal(err)
}
if counter.Sent.Load() <= 0 {
t.Fatal("no bytes sent?!")
}
if counter.Received.Load() <= 0 {
t.Fatal("no bytes received?!")
}
if ev := config.DialSaver.Read(); len(ev) <= 0 {
t.Fatal("no dial events?!")
}
if ev := config.HTTPSaver.Read(); len(ev) <= 0 {
t.Fatal("no HTTP events?!")
}
if ev := config.ReadWriteSaver.Read(); len(ev) <= 0 {
t.Fatal("no R/W events?!")
}
if ev := config.ResolveSaver.Read(); len(ev) <= 0 {
t.Fatal("no resolver events?!")
}
if ev := config.TLSSaver.Read(); len(ev) <= 0 {
t.Fatal("no TLS events?!")
}
}
func TestBogonResolutionNotBroken(t *testing.T) {
saver := new(tracex.Saver)
r := NewResolver(Config{
BogonIsError: true,
DNSCache: map[string][]string{
"www.google.com": {"127.0.0.1"},
},
ResolveSaver: saver,
Logger: log.Log,
})
addrs, err := r.LookupHost(context.Background(), "www.google.com")
if !errors.Is(err, netxlite.ErrDNSBogon) {
t.Fatal("not the error we expected")
}
if err.Error() != netxlite.FailureDNSBogonError {
t.Fatal("error not correctly wrapped")
}
if len(addrs) > 0 {
t.Fatal("expected no addresses here")
}
}