ooni-probe-cli/internal/netxlite/http_test.go
Simone Basso 5ebdeb56ca
feat: tlsping and tcpping using step-by-step (#815)
## Checklist

- [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md)
- [x] reference issue for this pull request: https://github.com/ooni/probe/issues/2158
- [x] if you changed anything related how experiments work and you need to reflect these changes in the ooni/spec repository, please link to the related ooni/spec pull request: https://github.com/ooni/spec/pull/250

## Description

This diff refactors the codebase to reimplement tlsping and tcpping
to use the step-by-step measurements style.

See docs/design/dd-003-step-by-step.md for more information on the
step-by-step measurement style.
2022-07-01 12:22:22 +02:00

630 lines
16 KiB
Go

package netxlite
import (
"context"
"errors"
"io"
"net"
"net/http"
"net/url"
"strings"
"testing"
"time"
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/internal/atomicx"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/model/mocks"
)
func TestNewHTTPTransportWithLoggerResolverAndOptionalProxyURL(t *testing.T) {
t.Run("without proxy URL", func(t *testing.T) {
logger := &mocks.Logger{}
resolver := &mocks.Resolver{}
txp := NewHTTPTransportWithLoggerResolverAndOptionalProxyURL(logger, resolver, nil)
txpLogger := txp.(*httpTransportLogger)
if txpLogger.Logger != logger {
t.Fatal("unexpected logger")
}
txpErrWrapper := txpLogger.HTTPTransport.(*httpTransportErrWrapper)
txpCc := txpErrWrapper.HTTPTransport.(*httpTransportConnectionsCloser)
dialer := txpCc.Dialer
dialerWithReadTimeout := dialer.(*httpDialerWithReadTimeout)
dialerLog := dialerWithReadTimeout.Dialer.(*dialerLogger)
dialerReso := dialerLog.Dialer.(*dialerResolverWithTracing)
if dialerReso.Resolver != resolver {
t.Fatal("invalid resolver")
}
})
t.Run("with proxy URL", func(t *testing.T) {
URL := &url.URL{}
logger := &mocks.Logger{}
resolver := &mocks.Resolver{}
txp := NewHTTPTransportWithLoggerResolverAndOptionalProxyURL(logger, resolver, URL)
txpLogger := txp.(*httpTransportLogger)
if txpLogger.Logger != logger {
t.Fatal("unexpected logger")
}
txpErrWrapper := txpLogger.HTTPTransport.(*httpTransportErrWrapper)
txpCc := txpErrWrapper.HTTPTransport.(*httpTransportConnectionsCloser)
dialer := txpCc.Dialer
dialerWithReadTimeout := dialer.(*httpDialerWithReadTimeout)
dialerProxy := dialerWithReadTimeout.Dialer.(*proxyDialer)
dialerLog := dialerProxy.Dialer.(*dialerLogger)
dialerReso := dialerLog.Dialer.(*dialerResolverWithTracing)
if dialerReso.Resolver != resolver {
t.Fatal("invalid resolver")
}
})
}
func TestNewHTTPTransportWithResolver(t *testing.T) {
expected := errors.New("mocked error")
reso := &mocks.Resolver{
MockLookupHost: func(ctx context.Context, domain string) ([]string, error) {
return nil, expected
},
}
txp := NewHTTPTransportWithResolver(model.DiscardLogger, reso)
req, err := http.NewRequest("GET", "http://x.org", nil)
if err != nil {
t.Fatal(err)
}
resp, err := txp.RoundTrip(req)
if !errors.Is(err, expected) {
t.Fatal("unexpected err")
}
if resp != nil {
t.Fatal("expected nil resp")
}
}
func TestHTTPTransportErrWrapper(t *testing.T) {
t.Run("RoundTrip", func(t *testing.T) {
t.Run("with failure", func(t *testing.T) {
txp := &httpTransportErrWrapper{
HTTPTransport: &mocks.HTTPTransport{
MockRoundTrip: func(req *http.Request) (*http.Response, error) {
return nil, io.EOF
},
},
}
resp, err := txp.RoundTrip(&http.Request{})
var errWrapper *ErrWrapper
if !errors.As(err, &errWrapper) {
t.Fatal("the returned error is not an ErrWrapper")
}
if errWrapper.Failure != FailureEOFError {
t.Fatal("unexpected failure", errWrapper.Failure)
}
if resp != nil {
t.Fatal("expected nil response")
}
})
t.Run("with success", func(t *testing.T) {
expect := &http.Response{}
txp := &httpTransportErrWrapper{
HTTPTransport: &mocks.HTTPTransport{
MockRoundTrip: func(req *http.Request) (*http.Response, error) {
return expect, nil
},
},
}
resp, err := txp.RoundTrip(&http.Request{})
if err != nil {
t.Fatal(err)
}
if resp != expect {
t.Fatal("not the expected response")
}
})
})
}
func TestHTTPTransportLogger(t *testing.T) {
t.Run("RoundTrip", func(t *testing.T) {
t.Run("with failure", func(t *testing.T) {
var count int
lo := &mocks.Logger{
MockDebug: func(message string) {
count++
},
MockDebugf: func(format string, v ...interface{}) {
count++
},
}
txp := &httpTransportLogger{
Logger: lo,
HTTPTransport: &mocks.HTTPTransport{
MockRoundTrip: func(req *http.Request) (*http.Response, error) {
return nil, io.EOF
},
},
}
client := &http.Client{Transport: txp}
resp, err := client.Get("https://www.google.com")
if !errors.Is(err, io.EOF) {
t.Fatal("not the error we expected")
}
if resp != nil {
t.Fatal("expected nil response here")
}
if count < 1 {
t.Fatal("no logs?!")
}
})
t.Run("with success", func(t *testing.T) {
var count int
lo := &mocks.Logger{
MockDebug: func(message string) {
count++
},
MockDebugf: func(format string, v ...interface{}) {
count++
},
}
txp := &httpTransportLogger{
Logger: lo,
HTTPTransport: &mocks.HTTPTransport{
MockRoundTrip: func(req *http.Request) (*http.Response, error) {
return &http.Response{
Body: io.NopCloser(strings.NewReader("")),
Header: http.Header{
"Server": []string{"antani/0.1.0"},
},
StatusCode: 200,
}, nil
},
},
}
client := &http.Client{Transport: txp}
req, err := http.NewRequest("GET", "https://www.google.com", nil)
if err != nil {
t.Fatal(err)
}
req.Header.Set("User-Agent", "miniooni/0.1.0-dev")
resp, err := client.Do(req)
if err != nil {
t.Fatal(err)
}
ReadAllContext(context.Background(), resp.Body)
resp.Body.Close()
if count < 1 {
t.Fatal("no logs?!")
}
})
})
t.Run("CloseIdleConnections", func(t *testing.T) {
calls := &atomicx.Int64{}
txp := &httpTransportLogger{
HTTPTransport: &mocks.HTTPTransport{
MockCloseIdleConnections: func() {
calls.Add(1)
},
},
Logger: log.Log,
}
txp.CloseIdleConnections()
if calls.Load() != 1 {
t.Fatal("not called")
}
})
}
func TestHTTPTransportConnectionsCloser(t *testing.T) {
t.Run("CloseIdleConnections", func(t *testing.T) {
var (
calledTxp bool
calledDialer bool
calledTLS bool
)
txp := &httpTransportConnectionsCloser{
HTTPTransport: &mocks.HTTPTransport{
MockCloseIdleConnections: func() {
calledTxp = true
},
},
Dialer: &mocks.Dialer{
MockCloseIdleConnections: func() {
calledDialer = true
},
},
TLSDialer: &mocks.TLSDialer{
MockCloseIdleConnections: func() {
calledTLS = true
},
},
}
txp.CloseIdleConnections()
if !calledDialer || !calledTLS || !calledTxp {
t.Fatal("not called")
}
})
t.Run("RoundTrip", func(t *testing.T) {
expected := errors.New("mocked error")
txp := &httpTransportConnectionsCloser{
HTTPTransport: &mocks.HTTPTransport{
MockRoundTrip: func(req *http.Request) (*http.Response, error) {
return nil, expected
},
},
}
client := &http.Client{Transport: txp}
resp, err := client.Get("https://www.google.com")
if !errors.Is(err, expected) {
t.Fatal("unexpected err", err)
}
if resp != nil {
t.Fatal("unexpected resp")
}
})
}
func TestNewHTTPTransport(t *testing.T) {
t.Run("works as intended with failing dialer", func(t *testing.T) {
called := &atomicx.Int64{}
expected := errors.New("mocked error")
d := &dialerResolverWithTracing{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context,
network, address string) (net.Conn, error) {
return nil, expected
},
MockCloseIdleConnections: func() {
called.Add(1)
},
},
Resolver: NewStdlibResolver(log.Log),
}
td := NewTLSDialer(d, NewTLSHandshakerStdlib(log.Log))
txp := NewHTTPTransport(log.Log, d, td)
client := &http.Client{Transport: txp}
resp, err := client.Get("https://8.8.4.4/robots.txt")
if !errors.Is(err, expected) {
t.Fatal("not the error we expected", err)
}
if resp != nil {
t.Fatal("expected non-nil response here")
}
client.CloseIdleConnections()
if called.Load() < 1 {
t.Fatal("did not propagate CloseIdleConnections")
}
})
t.Run("creates the correct type chain", func(t *testing.T) {
d := &mocks.Dialer{}
td := &mocks.TLSDialer{}
txp := NewHTTPTransport(log.Log, d, td)
logger := txp.(*httpTransportLogger)
if logger.Logger != log.Log {
t.Fatal("invalid logger")
}
errWrapper := logger.HTTPTransport.(*httpTransportErrWrapper)
connectionsCloser := errWrapper.HTTPTransport.(*httpTransportConnectionsCloser)
withReadTimeout := connectionsCloser.Dialer.(*httpDialerWithReadTimeout)
if withReadTimeout.Dialer != d {
t.Fatal("invalid dialer")
}
tlsWithReadTimeout := connectionsCloser.TLSDialer.(*httpTLSDialerWithReadTimeout)
if tlsWithReadTimeout.TLSDialer != td {
t.Fatal("invalid tls dialer")
}
stdlib := connectionsCloser.HTTPTransport.(*httpTransportStdlib)
if !stdlib.StdlibTransport.ForceAttemptHTTP2 {
t.Fatal("invalid ForceAttemptHTTP2")
}
if !stdlib.StdlibTransport.DisableCompression {
t.Fatal("invalid DisableCompression")
}
if stdlib.StdlibTransport.MaxConnsPerHost != 1 {
t.Fatal("invalid MaxConnPerHost")
}
if stdlib.StdlibTransport.DialTLSContext == nil {
t.Fatal("invalid DialTLSContext")
}
if stdlib.StdlibTransport.DialContext == nil {
t.Fatal("invalid DialContext")
}
})
}
func TestHTTPDialerWithReadTimeout(t *testing.T) {
t.Run("DialContext", func(t *testing.T) {
t.Run("on success", func(t *testing.T) {
var (
calledWithZeroTime bool
calledWithNonZeroTime bool
)
origConn := &mocks.Conn{
MockSetReadDeadline: func(t time.Time) error {
switch t.IsZero() {
case true:
calledWithZeroTime = true
case false:
calledWithNonZeroTime = true
}
return nil
},
MockRead: func(b []byte) (int, error) {
return 0, io.EOF
},
}
d := &httpDialerWithReadTimeout{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network, address string) (net.Conn, error) {
return origConn, nil
},
},
}
ctx := context.Background()
conn, err := d.DialContext(ctx, "", "")
if err != nil {
t.Fatal(err)
}
if _, okay := conn.(*httpConnWithReadTimeout); !okay {
t.Fatal("invalid conn type")
}
if conn.(*httpConnWithReadTimeout).Conn != origConn {
t.Fatal("invalid origin conn")
}
b := make([]byte, 1024)
count, err := conn.Read(b)
if !errors.Is(err, io.EOF) {
t.Fatal("invalid error")
}
if count != 0 {
t.Fatal("invalid count")
}
if !calledWithZeroTime || !calledWithNonZeroTime {
t.Fatal("not called")
}
})
t.Run("on failure", func(t *testing.T) {
expected := errors.New("mocked error")
d := &httpDialerWithReadTimeout{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network, address string) (net.Conn, error) {
return nil, expected
},
},
}
conn, err := d.DialContext(context.Background(), "", "")
if !errors.Is(err, expected) {
t.Fatal("not the error we expected")
}
if conn != nil {
t.Fatal("expected nil conn here")
}
})
})
}
func TestHTTPTLSDialerWithReadTimeout(t *testing.T) {
t.Run("DialContext", func(t *testing.T) {
t.Run("on success", func(t *testing.T) {
var (
calledWithZeroTime bool
calledWithNonZeroTime bool
)
origConn := &mocks.TLSConn{
Conn: mocks.Conn{
MockSetReadDeadline: func(t time.Time) error {
switch t.IsZero() {
case true:
calledWithZeroTime = true
case false:
calledWithNonZeroTime = true
}
return nil
},
MockRead: func(b []byte) (int, error) {
return 0, io.EOF
},
},
}
d := &httpTLSDialerWithReadTimeout{
TLSDialer: &mocks.TLSDialer{
MockDialTLSContext: func(ctx context.Context, network, address string) (net.Conn, error) {
return origConn, nil
},
},
}
ctx := context.Background()
conn, err := d.DialTLSContext(ctx, "", "")
if err != nil {
t.Fatal(err)
}
if _, okay := conn.(*httpTLSConnWithReadTimeout); !okay {
t.Fatal("invalid conn type")
}
if conn.(*httpTLSConnWithReadTimeout).TLSConn != origConn {
t.Fatal("invalid origin conn")
}
b := make([]byte, 1024)
count, err := conn.Read(b)
if !errors.Is(err, io.EOF) {
t.Fatal("invalid error")
}
if count != 0 {
t.Fatal("invalid count")
}
if !calledWithZeroTime || !calledWithNonZeroTime {
t.Fatal("not called")
}
})
t.Run("on failure", func(t *testing.T) {
expected := errors.New("mocked error")
d := &httpTLSDialerWithReadTimeout{
TLSDialer: &mocks.TLSDialer{
MockDialTLSContext: func(ctx context.Context, network, address string) (net.Conn, error) {
return nil, expected
},
},
}
conn, err := d.DialTLSContext(context.Background(), "", "")
if !errors.Is(err, expected) {
t.Fatal("not the error we expected")
}
if conn != nil {
t.Fatal("expected nil conn here")
}
})
t.Run("with invalid conn type", func(t *testing.T) {
var called bool
d := &httpTLSDialerWithReadTimeout{
TLSDialer: &mocks.TLSDialer{
MockDialTLSContext: func(ctx context.Context, network, address string) (net.Conn, error) {
return &mocks.Conn{
MockClose: func() error {
called = true
return nil
},
}, nil
},
},
}
conn, err := d.DialTLSContext(context.Background(), "", "")
if !errors.Is(err, ErrNotTLSConn) {
t.Fatal("not the error we expected")
}
if conn != nil {
t.Fatal("expected nil conn here")
}
if !called {
t.Fatal("not called")
}
})
})
}
func TestNewHTTPTransportStdlib(t *testing.T) {
txp := NewHTTPTransportStdlib(log.Log)
ctx, cancel := context.WithCancel(context.Background())
cancel() // immediately!
req, err := http.NewRequestWithContext(ctx, "GET", "http://x.org", nil)
if err != nil {
t.Fatal(err)
}
resp, err := txp.RoundTrip(req)
if !errors.Is(err, context.Canceled) {
t.Fatal("unexpected err", err)
}
if resp != nil {
t.Fatal("unexpected resp")
}
if txp.Network() != "tcp" {
t.Fatal("unexpected .Network return value")
}
txp.CloseIdleConnections()
}
func TestHTTPClientErrWrapper(t *testing.T) {
t.Run("Do", func(t *testing.T) {
t.Run("with failure", func(t *testing.T) {
clnt := &httpClientErrWrapper{
HTTPClient: &mocks.HTTPClient{
MockDo: func(req *http.Request) (*http.Response, error) {
return nil, io.EOF
},
},
}
resp, err := clnt.Do(&http.Request{})
var errWrapper *ErrWrapper
if !errors.As(err, &errWrapper) {
t.Fatal("the returned error is not an ErrWrapper")
}
if errWrapper.Failure != FailureEOFError {
t.Fatal("unexpected failure", errWrapper.Failure)
}
if resp != nil {
t.Fatal("expected nil response")
}
})
t.Run("with success", func(t *testing.T) {
expect := &http.Response{}
clnt := &httpClientErrWrapper{
HTTPClient: &mocks.HTTPClient{
MockDo: func(req *http.Request) (*http.Response, error) {
return expect, nil
},
},
}
resp, err := clnt.Do(&http.Request{})
if err != nil {
t.Fatal(err)
}
if resp != expect {
t.Fatal("not the expected response")
}
})
})
t.Run("CloseIdleConnections", func(t *testing.T) {
var called bool
child := &mocks.HTTPClient{
MockCloseIdleConnections: func() {
called = true
},
}
clnt := &httpClientErrWrapper{child}
clnt.CloseIdleConnections()
if !called {
t.Fatal("not called")
}
})
}
func TestNewHTTPClientStdlib(t *testing.T) {
clnt := NewHTTPClientStdlib(model.DiscardLogger)
ewc, ok := clnt.(*httpClientErrWrapper)
if !ok {
t.Fatal("expected *httpClientErrWrapper")
}
_, ok = ewc.HTTPClient.(*http.Client)
if !ok {
t.Fatal("expected *http.Client")
}
}
func TestNewHTTPClientWithResolver(t *testing.T) {
reso := &mocks.Resolver{}
clnt := NewHTTPClientWithResolver(model.DiscardLogger, reso)
ewc, ok := clnt.(*httpClientErrWrapper)
if !ok {
t.Fatal("expected *httpClientErrWrapper")
}
httpClnt, ok := ewc.HTTPClient.(*http.Client)
if !ok {
t.Fatal("expected *http.Client")
}
txp := httpClnt.Transport.(*httpTransportLogger)
txpEwrap := txp.HTTPTransport.(*httpTransportErrWrapper)
txpCc := txpEwrap.HTTPTransport.(*httpTransportConnectionsCloser)
dialer := txpCc.Dialer.(*httpDialerWithReadTimeout)
dialerLogger := dialer.Dialer.(*dialerLogger)
dialerReso := dialerLogger.Dialer.(*dialerResolverWithTracing)
if dialerReso.Resolver != reso {
t.Fatal("invalid resolver")
}
}
func TestWrapHTTPClient(t *testing.T) {
origClient := &http.Client{}
wrapped := WrapHTTPClient(origClient)
errWrapper := wrapped.(*httpClientErrWrapper)
innerClient := errWrapper.HTTPClient.(*http.Client)
if innerClient != origClient {
t.Fatal("not the inner client we expected")
}
}