c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor(netxlite): hide details without breaking the rest of the tree (#454)

Browse Source 
## Description

This PR continues the refactoring of `netx` under the following principles:

1. do not break the rest of the tree and do not engage in extensive tree-wide refactoring yet
2. move under `netxlite` clearly related subpackages (e.g., `iox`, `netxmocks`)
3. move into `internal/netxlite/internal` stuff that is clearly private of `netxlite`
4. hide implementation details in `netxlite` pending new factories
5. refactor `tls` code in `netxlite` to clearly separate `crypto/tls` code from `utls` code

After each commit, I run `go test -short -race ./...` locally. Each individual commit explains what it does. I will squash, but this operation will preserve the original commit titles, so this will give further insight on each step.

## Commits

* refactor: rename netxmocks -> netxlite/mocks

Part of https://github.com/ooni/probe/issues/1591

* refactor: rename quicx -> netxlite/quicx

See https://github.com/ooni/probe/issues/1591

* refactor: rename iox -> netxlite/iox

Regenerate sources and make sure the tests pass.

See https://github.com/ooni/probe/issues/1591.

* refactor(iox): move MockableReader to netxlite/mocks

See https://github.com/ooni/probe/issues/1591

* refactor(netxlite): generator is an implementation detail

See https://github.com/ooni/probe/issues/1591

* refactor(netxlite): separate tls and utls code

See https://github.com/ooni/probe/issues/1591

* refactor(netxlite): hide most types but keep old names as legacy

With this change we avoid breaking the rest of the tree, but we start
hiding some implementation details a bit. Factories will follow.

See https://github.com/ooni/probe/issues/1591
This commit is contained in:
Simone Basso
2021-09-05 14:49:38 +02:00
committed by GitHub
parent ae799c4942
commit 2e0118d1a6
137 changed files with 1244 additions and 1173 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/engine/experiment/dash/dash.go
+1 -1
View File
@@ -19,7 +19,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/humanize"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
const (
internal/engine/experiment/hhfm/fake_test.go
+1 -1
View File
@@ -6,7 +6,7 @@ import (
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type FakeDialer struct {
internal/engine/experiment/hhfm/hhfm.go
+1 -1
View File
@@ -20,7 +20,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/archival"
"github.com/ooni/probe-cli/v3/internal/engine/netx/dialer"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
"github.com/ooni/probe-cli/v3/internal/randx"
)
internal/engine/experiment/ndt7/download.go
+1 -1
View File
@@ -7,7 +7,7 @@ import (
"time"
"github.com/gorilla/websocket"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type downloadManager struct {
internal/engine/experiment/urlgetter/runner.go
+1 -1
View File
@@ -12,7 +12,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/httpheader"
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
"github.com/ooni/probe-cli/v3/internal/runtimex"
)
internal/engine/experiment/websteps/websteps.go
+1 -1
View File
@@ -66,7 +66,7 @@ func (m Measurer) ExperimentVersion() string {
// SupportedQUICVersions are the H3 over QUIC versions we currently support
var SupportedQUICVersions = map[string]bool{
"h3": true,
"h3": true,
}
var (
internal/engine/geolocate/fake_test.go
+1 -1
View File
@@ -4,7 +4,7 @@ import (
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type FakeTransport struct {
internal/engine/httpx/fake_test.go
+1 -1
View File
@@ -4,7 +4,7 @@ import (
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type FakeTransport struct {
internal/engine/httpx/jsonapi.go
+1 -1
View File
@@ -10,7 +10,7 @@ import (
"net/http"
"net/url"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
// Logger is the definition of Logger used by this package.
internal/engine/legacy/netx/emitterdialer_test.go
+4 -4
View File
@@ -10,7 +10,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/handlers"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
"github.com/ooni/probe-cli/v3/internal/netxmocks"
"github.com/ooni/probe-cli/v3/internal/netxlite/mocks"
)
func TestEmitterFailure(t *testing.T) {
@@ -20,7 +20,7 @@ func TestEmitterFailure(t *testing.T) {
Beginning: time.Now(),
Handler: saver,
})
d := EmitterDialer{Dialer: &netxmocks.Dialer{
d := EmitterDialer{Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return nil, io.EOF
},
@@ -69,9 +69,9 @@ func TestEmitterSuccess(t *testing.T) {
Beginning: time.Now(),
Handler: saver,
})
d := EmitterDialer{Dialer: &netxmocks.Dialer{
d := EmitterDialer{Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return &netxmocks.Conn{
return &mocks.Conn{
MockRead: func(b []byte) (int, error) {
return 0, io.EOF
},
internal/engine/legacy/netx/http_test.go
+1 -1
View File
@@ -14,7 +14,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func dowithclient(t *testing.T, client *netx.HTTPClient) {
internal/engine/legacy/netx/oldhttptransport/bodytracer_test.go
+1 -1
View File
@@ -5,7 +5,7 @@ import (
"net/http"
"testing"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestBodyTracerSuccess(t *testing.T) {
internal/engine/legacy/netx/oldhttptransport/httptransport_test.go
+1 -1
View File
@@ -5,7 +5,7 @@ import (
"net/http"
"testing"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestGood(t *testing.T) {
internal/engine/legacy/netx/oldhttptransport/tracetripper.go
+1 -1
View File
@@ -13,7 +13,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/atomicx"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
// TraceTripper performs single HTTP transactions.
internal/engine/legacy/netx/oldhttptransport/tracetripper_test.go
+1 -1
View File
@@ -13,7 +13,7 @@ import (
"github.com/miekg/dns"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestTraceTripperSuccess(t *testing.T) {
internal/engine/legacy/netxlogger/netxlogger_test.go
+1 -1
View File
@@ -10,7 +10,7 @@ import (
"github.com/apex/log/handlers/discard"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestGood(t *testing.T) {
internal/engine/legacy/oonitemplates/oonitemplates.go
+1 -1
View File
@@ -24,7 +24,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/handlers"
"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
"github.com/ooni/probe-cli/v3/internal/runtimex"
"gitlab.com/yawning/obfs4.git/transports"
obfs4base "gitlab.com/yawning/obfs4.git/transports/base"
internal/engine/netx/dialer/bytecounter_test.go
+3 -3
View File
@@ -9,8 +9,8 @@ import (
"testing"
"github.com/ooni/probe-cli/v3/internal/bytecounter"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxmocks"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/mocks"
)
func dorequest(ctx context.Context, url string) error {
@@ -76,7 +76,7 @@ func TestByteCounterNoHandlers(t *testing.T) {
}
func TestByteCounterConnectFailure(t *testing.T) {
dialer := &byteCounterDialer{Dialer: &netxmocks.Dialer{
dialer := &byteCounterDialer{Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return nil, io.EOF
},
internal/engine/netx/dialer/proxy_test.go
+3 -3
View File
@@ -8,13 +8,13 @@ import (
"net/url"
"testing"
"github.com/ooni/probe-cli/v3/internal/netxmocks"
"github.com/ooni/probe-cli/v3/internal/netxlite/mocks"
)
func TestProxyDialerDialContextNoProxyURL(t *testing.T) {
expected := errors.New("mocked error")
d := &proxyDialer{
Dialer: &netxmocks.Dialer{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return nil, expected
},
@@ -45,7 +45,7 @@ func TestProxyDialerDialContextInvalidScheme(t *testing.T) {
func TestProxyDialerDialContextWithEOF(t *testing.T) {
const expect = "10.0.0.1:9050"
d := &proxyDialer{
Dialer: &netxmocks.Dialer{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
if address != expect {
return nil, errors.New("unexpected address")
internal/engine/netx/dialer/saver_test.go
+5 -5
View File
@@ -10,14 +10,14 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/netxmocks"
"github.com/ooni/probe-cli/v3/internal/netxlite/mocks"
)
func TestSaverDialerFailure(t *testing.T) {
expected := errors.New("mocked error")
saver := &trace.Saver{}
dlr := &saverDialer{
Dialer: &netxmocks.Dialer{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return nil, expected
},
@@ -59,7 +59,7 @@ func TestSaverConnDialerFailure(t *testing.T) {
expected := errors.New("mocked error")
saver := &trace.Saver{}
dlr := &saverConnDialer{
Dialer: &netxmocks.Dialer{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return nil, expected
},
@@ -79,9 +79,9 @@ func TestSaverConnDialerSuccess(t *testing.T) {
saver := &trace.Saver{}
dlr := &saverConnDialer{
Dialer: &saverDialer{
Dialer: &netxmocks.Dialer{
Dialer: &mocks.Dialer{
MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
return &netxmocks.Conn{
return &mocks.Conn{
MockRead: func(b []byte) (int, error) {
return 0, io.EOF
},
internal/engine/netx/dialer/shaping_disabled.go
+1
View File
@@ -1,3 +1,4 @@
//go:build !shaping
// +build !shaping
package dialer
internal/engine/netx/dialer/shaping_enabled.go
+1
View File
@@ -1,3 +1,4 @@
//go:build shaping
// +build shaping
package dialer
internal/engine/netx/fake_test.go
+1 -1
View File
@@ -6,7 +6,7 @@ import (
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type FakeDialer struct {
internal/engine/netx/httptransport/bytecounter_test.go
+1 -1
View File
@@ -10,7 +10,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/bytecounter"
"github.com/ooni/probe-cli/v3/internal/engine/netx/httptransport"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestByteCounterFailure(t *testing.T) {
internal/engine/netx/httptransport/fake_test.go
+1 -1
View File
@@ -6,7 +6,7 @@ import (
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type FakeDialer struct {
internal/engine/netx/httptransport/saver.go
+1 -1
View File
@@ -10,7 +10,7 @@ import (
"time"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
// SaverPerformanceHTTPTransport is a RoundTripper that saves
internal/engine/netx/httptransport/saver_test.go
+1 -1
View File
@@ -11,7 +11,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/httptransport"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestSaverPerformanceNoMultipleEvents(t *testing.T) {
internal/engine/netx/integration_test.go
+1 -1
View File
@@ -11,7 +11,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func TestSuccess(t *testing.T) {
internal/engine/netx/quicdialer/system.go
+1 -1
View File
@@ -6,7 +6,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/quicx"
"github.com/ooni/probe-cli/v3/internal/netxlite/quicx"
)
// QUICListener listens for QUIC connections.
internal/engine/netx/quicdialer/system_test.go
+3 -3
View File
@@ -12,14 +12,14 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/errorsx"
"github.com/ooni/probe-cli/v3/internal/netxlite"
"github.com/ooni/probe-cli/v3/internal/netxmocks"
"github.com/ooni/probe-cli/v3/internal/quicx"
"github.com/ooni/probe-cli/v3/internal/netxlite/mocks"
"github.com/ooni/probe-cli/v3/internal/netxlite/quicx"
)
func TestQUICListenerSaverCannotListen(t *testing.T) {
expected := errors.New("mocked error")
qls := &quicdialer.QUICListenerSaver{
QUICListener: &netxmocks.QUICListener{
QUICListener: &mocks.QUICListener{
MockListen: func(addr *net.UDPAddr) (quicx.UDPLikeConn, error) {
return nil, expected
},
internal/engine/netx/resolver/dnsoverhttps.go
+1 -1
View File
@@ -8,7 +8,7 @@ import (
"time"
"github.com/ooni/probe-cli/v3/internal/engine/httpheader"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
// DNSOverHTTPS is a DNS over HTTPS RoundTripper. Requests are submitted over
internal/engine/probeservices/collector_test.go
+1 -1
View File
@@ -15,7 +15,7 @@ import (
"github.com/google/go-cmp/cmp"
"github.com/ooni/probe-cli/v3/internal/engine/model"
"github.com/ooni/probe-cli/v3/internal/engine/probeservices"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
type fakeTestKeys struct {
internal/engine/probeservices/probeservices_test.go
+1 -1
View File
@@ -16,7 +16,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/model"
"github.com/ooni/probe-cli/v3/internal/engine/probeservices"
"github.com/ooni/probe-cli/v3/internal/engine/probeservices/testorchestra"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
func newclient() *probeservices.Client {
internal/engine/session_integration_test.go
+1 -1
View File
@@ -16,7 +16,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/geolocate"
"github.com/ooni/probe-cli/v3/internal/engine/model"
"github.com/ooni/probe-cli/v3/internal/engine/probeservices"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
"github.com/ooni/probe-cli/v3/internal/version"
)
internal/engine/session_nopsiphon.go
+1
View File
@@ -1,3 +1,4 @@
//go:build !ooni_psiphon_config
// +build !ooni_psiphon_config
package engine
internal/engine/session_nopsiphon_test.go
+1
View File
@@ -1,3 +1,4 @@
//go:build !ooni_psiphon_config
// +build !ooni_psiphon_config
package engine
internal/engine/session_psiphon.go
+2 -1
View File
@@ -1,3 +1,4 @@
//go:build ooni_psiphon_config
// +build ooni_psiphon_config
package engine
@@ -8,7 +9,7 @@ import (
_ "embed"
"filippo.io/age"
"github.com/ooni/probe-cli/v3/internal/iox"
"github.com/ooni/probe-cli/v3/internal/netxlite/iox"
)
//go:embed psiphon-config.json.age
internal/engine/session_psiphon_test.go
+1
View File
@@ -1,3 +1,4 @@
//go:build ooni_psiphon_config
// +build ooni_psiphon_config
package engine