f3912188e1
After https://github.com/ooni/probe-cli/pull/764, the build for CGO_ENABLED=0 has been broken for miniooni: https://github.com/ooni/probe-cli/runs/6636995859?check_suite_focus=true Likewise, it's not possible to run tests with CGO_ENABLED=0. To make tests work with `CGO_ENABLED=0`, I needed to sacrifice some unit tests run for the CGO case. It is not fully clear to me what was happening here, but basically `getaddrinfo_cgo_test.go` was compiled with CGO being disabled, even though the ``//go:build cgo` flag was specified. Additionally, @hellais previously raised a valid point in the review of https://github.com/ooni/probe-cli/pull/698: > Another issue we should consider is that, if I understand how > this works correctly, depending on whether or not we have built > with CGO_ENABLED=0 on or not, we are going to be measuring > things in a different way (using our cgo inspired getaddrinfo > implementation or using netgo). This might present issues when > analyzing or interpreting the data. > > Do we perhaps want to add some field to the output data format that > gives us an indication of which DNS resolution code was used to > generate the the metric? This comment is relevant to the current commit because https://github.com/ooni/probe-cli/pull/698 is the previous iteration of https://github.com/ooni/probe-cli/pull/764. So, while fixing the build and test issues, let us also distinguish between the CGO_ENABLED=1 and CGO_ENABLED=0 cases. Before this commit, OONI used "system" to indicate the case where we were using net.DefaultResolver. This behavior dates back to the Measurement Kit days. While it is true that ooni/probe-engine and ooni/probe-cli could have been using netgo in the past when we said "system" as the resolver, it also seems reasonable to continue to use "system" top indicate getaddrinfo. So, the choice here is basically to use "netgo" from now on to indicate the cases in which we were built with CGO_ENABLED=0. This change will need to be documented into ooni/spec along with the introduction of the `android_dns_cache_no_data` error. ## 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/2029 - [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/242
336 lines
9.5 KiB
Go
336 lines
9.5 KiB
Go
package quicping
|
|
|
|
import (
|
|
"context"
|
|
"encoding/hex"
|
|
"errors"
|
|
"net"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/apex/log"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/mockable"
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
"github.com/ooni/probe-cli/v3/internal/model/mocks"
|
|
)
|
|
|
|
// FailStdLib is a failing model.UnderlyingNetworkLibrary.
|
|
type FailStdLib struct {
|
|
conn model.UDPLikeConn
|
|
err error
|
|
writeErr error
|
|
readErr error
|
|
}
|
|
|
|
// ListenUDP implements model.UnderlyingNetworkLibrary.ListenUDP.
|
|
func (f *FailStdLib) ListenUDP(network string, laddr *net.UDPAddr) (model.UDPLikeConn, error) {
|
|
conn, _ := net.ListenUDP(network, laddr)
|
|
f.conn = model.UDPLikeConn(conn)
|
|
if f.err != nil {
|
|
return nil, f.err
|
|
}
|
|
if f.writeErr != nil {
|
|
return &mocks.UDPLikeConn{
|
|
MockWriteTo: func(p []byte, addr net.Addr) (int, error) {
|
|
return 0, f.writeErr
|
|
},
|
|
MockReadFrom: func(p []byte) (int, net.Addr, error) {
|
|
return f.conn.ReadFrom(p)
|
|
},
|
|
MockSetDeadline: func(t time.Time) error {
|
|
return f.conn.SetDeadline(t)
|
|
},
|
|
MockClose: func() error {
|
|
return f.conn.Close()
|
|
},
|
|
}, nil
|
|
}
|
|
if f.readErr != nil {
|
|
return &mocks.UDPLikeConn{
|
|
MockWriteTo: func(p []byte, addr net.Addr) (int, error) {
|
|
return f.conn.WriteTo(p, addr)
|
|
},
|
|
MockReadFrom: func(p []byte) (int, net.Addr, error) {
|
|
return 0, nil, f.readErr
|
|
},
|
|
MockSetDeadline: func(t time.Time) error {
|
|
return f.conn.SetDeadline(t)
|
|
},
|
|
MockClose: func() error {
|
|
return f.conn.Close()
|
|
},
|
|
}, nil
|
|
}
|
|
return &mocks.UDPLikeConn{}, nil
|
|
}
|
|
|
|
// DefaultResolver implements model.UnderlyingNetworkLibrary.DefaultResolver.
|
|
func (f *FailStdLib) DefaultResolver() model.SimpleResolver {
|
|
return f
|
|
}
|
|
|
|
// LookupHost implements model.SimpleResolver.LookupHost.
|
|
func (f *FailStdLib) LookupHost(ctx context.Context, domain string) ([]string, error) {
|
|
return nil, f.err
|
|
}
|
|
|
|
// Network implements model.SimpleResolver.Network.
|
|
func (f *FailStdLib) Network() string {
|
|
return "fail_stdlib"
|
|
}
|
|
|
|
// NewSimpleDialer implements UnderlyingNetworkLibrary.NewSimpleDialer.
|
|
func (f *FailStdLib) NewSimpleDialer(timeout time.Duration) model.SimpleDialer {
|
|
return nil
|
|
}
|
|
|
|
func TestNewExperimentMeasurer(t *testing.T) {
|
|
measurer := NewExperimentMeasurer(Config{})
|
|
if measurer.ExperimentName() != "quicping" {
|
|
t.Fatal("unexpected name")
|
|
}
|
|
if measurer.ExperimentVersion() != "0.1.0" {
|
|
t.Fatal("unexpected version")
|
|
}
|
|
}
|
|
|
|
func TestInvalidHost(t *testing.T) {
|
|
measurer := NewExperimentMeasurer(Config{
|
|
Port: 443,
|
|
Repetitions: 1,
|
|
})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("a.a.a.a")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err == nil {
|
|
t.Fatal("expected an error here")
|
|
}
|
|
if _, ok := err.(*net.DNSError); !ok {
|
|
t.Fatal("unexpected error type")
|
|
}
|
|
}
|
|
|
|
func TestURLInput(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skip test in short mode")
|
|
}
|
|
measurer := NewExperimentMeasurer(Config{
|
|
Repetitions: 1,
|
|
})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("https://google.com/")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err != nil {
|
|
t.Fatal("unexpected error")
|
|
}
|
|
tk := measurement.TestKeys.(*TestKeys)
|
|
if tk.Domain != "google.com" {
|
|
t.Fatal("unexpected domain")
|
|
}
|
|
|
|
}
|
|
|
|
func TestSuccess(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skip test in short mode")
|
|
}
|
|
measurer := NewExperimentMeasurer(Config{})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("google.com")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err != nil {
|
|
t.Fatal("did not expect an error here")
|
|
}
|
|
tk := measurement.TestKeys.(*TestKeys)
|
|
if tk.Domain != "google.com" {
|
|
t.Fatal("unexpected domain")
|
|
}
|
|
if tk.Repetitions != 10 {
|
|
t.Fatal("unexpected number of repetitions, default is 10")
|
|
}
|
|
if tk.Pings == nil || len(tk.Pings) != 10 {
|
|
t.Fatal("unexpected number of pings", len(tk.Pings))
|
|
}
|
|
for i, ping := range tk.Pings {
|
|
if ping.Failure != nil {
|
|
t.Fatal("ping failed unexpectedly", i, *ping.Failure)
|
|
}
|
|
for _, resp := range ping.Responses {
|
|
if resp.Failure != nil {
|
|
t.Fatal("unexepcted response failure")
|
|
}
|
|
if resp.SupportedVersions == nil || len(resp.SupportedVersions) == 0 {
|
|
t.Fatal("server did not respond with supported versions")
|
|
}
|
|
}
|
|
}
|
|
sk, err := measurer.GetSummaryKeys(measurement)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if _, ok := sk.(SummaryKeys); !ok {
|
|
t.Fatal("invalid type for summary keys")
|
|
}
|
|
}
|
|
|
|
func TestWithCancelledContext(t *testing.T) {
|
|
measurer := NewExperimentMeasurer(Config{})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("google.com")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
cancel()
|
|
err := measurer.Run(ctx, sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err != nil {
|
|
t.Fatal("did not expect an error here")
|
|
}
|
|
tk := measurement.TestKeys.(*TestKeys)
|
|
if len(tk.Pings) > 0 {
|
|
t.Fatal("there should not be any measurements")
|
|
}
|
|
}
|
|
|
|
func TestListenFails(t *testing.T) {
|
|
expected := errors.New("expected")
|
|
measurer := NewExperimentMeasurer(Config{
|
|
networkLib: &FailStdLib{err: expected, readErr: nil, writeErr: nil},
|
|
})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("google.com")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err == nil {
|
|
t.Fatal("expected an error here")
|
|
}
|
|
if err != expected {
|
|
t.Fatal("unexpected error type")
|
|
}
|
|
}
|
|
|
|
func TestWriteFails(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skip test in short mode")
|
|
}
|
|
expected := errors.New("expected")
|
|
measurer := NewExperimentMeasurer(Config{
|
|
networkLib: &FailStdLib{err: nil, readErr: nil, writeErr: expected},
|
|
Repetitions: 1,
|
|
})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("google.com")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err != nil {
|
|
t.Fatal("unexpected error")
|
|
}
|
|
tk := measurement.TestKeys.(*TestKeys)
|
|
if tk.Pings == nil || len(tk.Pings) != 1 {
|
|
t.Fatal("unexpected number of pings", len(tk.Pings))
|
|
}
|
|
for i, ping := range tk.Pings {
|
|
if ping.Failure == nil {
|
|
t.Fatal("expected an error here, ping", i)
|
|
}
|
|
if !strings.Contains(*ping.Failure, "expected") {
|
|
t.Fatal("ping: unexpected error type", i, *ping.Failure)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestReadFails(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skip test in short mode")
|
|
}
|
|
expected := errors.New("expected")
|
|
measurer := NewExperimentMeasurer(Config{
|
|
networkLib: &FailStdLib{err: nil, readErr: expected, writeErr: nil},
|
|
Repetitions: 1,
|
|
})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("google.com")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err != nil {
|
|
t.Fatal("unexpected error")
|
|
}
|
|
tk := measurement.TestKeys.(*TestKeys)
|
|
if tk.Pings == nil || len(tk.Pings) != 1 {
|
|
t.Fatal("unexpected number of pings", len(tk.Pings))
|
|
}
|
|
for i, ping := range tk.Pings {
|
|
if ping.Failure == nil {
|
|
t.Fatal("expected an error here, ping", i)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestNoResponse(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skip test in short mode")
|
|
}
|
|
measurer := NewExperimentMeasurer(Config{
|
|
Repetitions: 1,
|
|
})
|
|
measurement := new(model.Measurement)
|
|
measurement.Input = model.MeasurementTarget("ooni.org")
|
|
sess := &mockable.Session{MockableLogger: log.Log}
|
|
err := measurer.Run(context.Background(), sess, measurement,
|
|
model.NewPrinterCallbacks(log.Log))
|
|
if err != nil {
|
|
t.Fatal("did not expect an error here")
|
|
}
|
|
tk := measurement.TestKeys.(*TestKeys)
|
|
if tk.Pings == nil || len(tk.Pings) != 1 {
|
|
t.Fatal("unexpected number of pings", len(tk.Pings))
|
|
}
|
|
if tk.Pings[0].Failure == nil {
|
|
t.Fatal("expected an error here")
|
|
}
|
|
if *tk.Pings[0].Failure != "generic_timeout_error" {
|
|
t.Fatal("unexpected error type")
|
|
}
|
|
}
|
|
|
|
func TestDissect(t *testing.T) {
|
|
// destID--srcID: 040b9649d3fd4c038ab6c073966f3921--44d064031288e97646451f
|
|
versionNegotiationResponse, _ := hex.DecodeString("eb0000000010040b9649d3fd4c038ab6c073966f39210b44d064031288e97646451f00000001ff00001dff00001cff00001b")
|
|
measurer := NewExperimentMeasurer(Config{})
|
|
destID := "040b9649d3fd4c038ab6c073966f3921"
|
|
_, dst, err := measurer.(*Measurer).dissectVersionNegotiation(versionNegotiationResponse)
|
|
if err != nil {
|
|
t.Fatal("unexpected error", err)
|
|
}
|
|
if hex.EncodeToString(dst) != destID {
|
|
t.Fatal("unexpected destination connection ID")
|
|
}
|
|
|
|
versionNegotiationResponse[1] = byte(0xff)
|
|
_, _, err = measurer.(*Measurer).dissectVersionNegotiation(versionNegotiationResponse)
|
|
if err == nil {
|
|
t.Fatal("expected an error here", err)
|
|
}
|
|
if !strings.HasSuffix(err.Error(), "unexpected Version Negotiation format") {
|
|
t.Fatal("unexpected error type", err)
|
|
}
|
|
|
|
versionNegotiationResponse[0] = byte(0x01)
|
|
_, _, err = measurer.(*Measurer).dissectVersionNegotiation(versionNegotiationResponse)
|
|
if err == nil {
|
|
t.Fatal("expected an error here", err)
|
|
}
|
|
if !strings.HasSuffix(err.Error(), "not a long header packet") {
|
|
t.Fatal("unexpected error type", err)
|
|
}
|
|
}
|