f4f3ed7c42
The code that is now into the tracex package was written a long time ago, so let's start to make it more in line with the coding style of packages that were written more recently. I didn't apply all the changes I'd like to apply in a single diff and for now I am committing just this diff. Broadly, what we need to do is: 1. improve documentation 2. ~always use pointer receivers (object receives have the issue that they are not mutable by accident meaning that you can mutate them but their state do not change after the call returns, which is potentially a source of bugs in case you later refactor to use a pointer receiver, so always use pointer receivers) 3. ~always avoid embedding (let's say we want to avoid embedding for types we define and it's instead fine to embed types that are defined in the stdlib: if later we add a new method, we will not see a broken build and we'll probably forget to add the new method to all wrappers -- conversely, if we're wrapping rather than embedding, we'll see a broken build and act accordingly) 4. prefer unit tests and group tests by type being tested rather than using a flat structure for tests There's a coverage slippage that I'll compensate in a follow-up diff where I'll focus on unit testing. Reference issue: https://github.com/ooni/probe/issues/2121
185 lines
4.5 KiB
Go
185 lines
4.5 KiB
Go
package tracex
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"errors"
|
|
"net"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/lucas-clemente/quic-go"
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
"github.com/ooni/probe-cli/v3/internal/model/mocks"
|
|
"github.com/ooni/probe-cli/v3/internal/netxlite"
|
|
"github.com/ooni/probe-cli/v3/internal/netxlite/quictesting"
|
|
)
|
|
|
|
type MockDialer struct {
|
|
Dialer model.QUICDialer
|
|
Sess quic.EarlyConnection
|
|
Err error
|
|
}
|
|
|
|
func (d MockDialer) DialContext(ctx context.Context, network, host string,
|
|
tlsCfg *tls.Config, cfg *quic.Config) (quic.EarlyConnection, error) {
|
|
if d.Dialer != nil {
|
|
return d.Dialer.DialContext(ctx, network, host, tlsCfg, cfg)
|
|
}
|
|
return d.Sess, d.Err
|
|
}
|
|
|
|
func TestHandshakeSaverSuccess(t *testing.T) {
|
|
nextprotos := []string{"h3"}
|
|
servername := quictesting.Domain
|
|
tlsConf := &tls.Config{
|
|
NextProtos: nextprotos,
|
|
ServerName: servername,
|
|
}
|
|
saver := &Saver{}
|
|
dlr := saver.WrapQUICDialer(&netxlite.QUICDialerQUICGo{
|
|
QUICListener: &netxlite.QUICListenerStdlib{},
|
|
})
|
|
sess, err := dlr.DialContext(context.Background(), "udp",
|
|
quictesting.Endpoint("443"), tlsConf, &quic.Config{})
|
|
if err != nil {
|
|
t.Fatal("unexpected error", err)
|
|
}
|
|
if sess == nil {
|
|
t.Fatal("unexpected nil sess")
|
|
}
|
|
ev := saver.Read()
|
|
if len(ev) != 2 {
|
|
t.Fatal("unexpected number of events")
|
|
}
|
|
if ev[0].Name != "quic_handshake_start" {
|
|
t.Fatal("unexpected Name")
|
|
}
|
|
if ev[0].TLSServerName != quictesting.Domain {
|
|
t.Fatal("unexpected TLSServerName")
|
|
}
|
|
if !reflect.DeepEqual(ev[0].TLSNextProtos, nextprotos) {
|
|
t.Fatal("unexpected TLSNextProtos")
|
|
}
|
|
if ev[0].Time.After(time.Now()) {
|
|
t.Fatal("unexpected Time")
|
|
}
|
|
if ev[1].Duration <= 0 {
|
|
t.Fatal("unexpected Duration")
|
|
}
|
|
if ev[1].Err != nil {
|
|
t.Fatal("unexpected Err", ev[1].Err)
|
|
}
|
|
if ev[1].Name != "quic_handshake_done" {
|
|
t.Fatal("unexpected Name")
|
|
}
|
|
if !reflect.DeepEqual(ev[1].TLSNextProtos, nextprotos) {
|
|
t.Fatal("unexpected TLSNextProtos")
|
|
}
|
|
if ev[1].TLSServerName != quictesting.Domain {
|
|
t.Fatal("unexpected TLSServerName")
|
|
}
|
|
if ev[1].Time.Before(ev[0].Time) {
|
|
t.Fatal("unexpected Time")
|
|
}
|
|
}
|
|
|
|
func TestHandshakeSaverHostNameError(t *testing.T) {
|
|
nextprotos := []string{"h3"}
|
|
servername := "example.com"
|
|
tlsConf := &tls.Config{
|
|
NextProtos: nextprotos,
|
|
ServerName: servername,
|
|
}
|
|
saver := &Saver{}
|
|
dlr := saver.WrapQUICDialer(&netxlite.QUICDialerQUICGo{
|
|
QUICListener: &netxlite.QUICListenerStdlib{},
|
|
})
|
|
sess, err := dlr.DialContext(context.Background(), "udp",
|
|
quictesting.Endpoint("443"), tlsConf, &quic.Config{})
|
|
if err == nil {
|
|
t.Fatal("expected an error here")
|
|
}
|
|
if sess != nil {
|
|
t.Fatal("expected nil sess here")
|
|
}
|
|
for _, ev := range saver.Read() {
|
|
if ev.Name != "quic_handshake_done" {
|
|
continue
|
|
}
|
|
if ev.NoTLSVerify == true {
|
|
t.Fatal("expected NoTLSVerify to be false")
|
|
}
|
|
if !strings.HasSuffix(ev.Err.Error(), "tls: handshake failure") {
|
|
t.Fatal("unexpected error", ev.Err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestQUICListenerSaverCannotListen(t *testing.T) {
|
|
expected := errors.New("mocked error")
|
|
saver := &Saver{}
|
|
qls := saver.WrapQUICListener(&mocks.QUICListener{
|
|
MockListen: func(addr *net.UDPAddr) (model.UDPLikeConn, error) {
|
|
return nil, expected
|
|
},
|
|
})
|
|
pconn, err := qls.Listen(&net.UDPAddr{
|
|
IP: []byte{},
|
|
Port: 8080,
|
|
Zone: "",
|
|
})
|
|
if !errors.Is(err, expected) {
|
|
t.Fatal("unexpected error", err)
|
|
}
|
|
if pconn != nil {
|
|
t.Fatal("expected nil pconn here")
|
|
}
|
|
}
|
|
|
|
func TestSystemDialerSuccessWithReadWrite(t *testing.T) {
|
|
// This is the most common use case for collecting reads, writes
|
|
tlsConf := &tls.Config{
|
|
NextProtos: []string{"h3"},
|
|
ServerName: quictesting.Domain,
|
|
}
|
|
saver := &Saver{}
|
|
systemdialer := &netxlite.QUICDialerQUICGo{
|
|
QUICListener: saver.WrapQUICListener(&netxlite.QUICListenerStdlib{}),
|
|
}
|
|
_, err := systemdialer.DialContext(context.Background(), "udp",
|
|
quictesting.Endpoint("443"), tlsConf, &quic.Config{})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
ev := saver.Read()
|
|
if len(ev) < 2 {
|
|
t.Fatal("unexpected number of events")
|
|
}
|
|
last := len(ev) - 1
|
|
for idx := 1; idx < last; idx++ {
|
|
if ev[idx].Data == nil {
|
|
t.Fatal("unexpected Data")
|
|
}
|
|
if ev[idx].Duration <= 0 {
|
|
t.Fatal("unexpected Duration")
|
|
}
|
|
if ev[idx].Err != nil {
|
|
t.Fatal("unexpected Err")
|
|
}
|
|
if ev[idx].NumBytes <= 0 {
|
|
t.Fatal("unexpected NumBytes")
|
|
}
|
|
switch ev[idx].Name {
|
|
case netxlite.ReadFromOperation, netxlite.WriteToOperation:
|
|
default:
|
|
t.Fatal("unexpected Name")
|
|
}
|
|
if ev[idx].Time.Before(ev[idx-1].Time) {
|
|
t.Fatal("unexpected Time", ev[idx].Time, ev[idx-1].Time)
|
|
}
|
|
}
|
|
}
|