c/ooni-probe-cli
Watch
1
0
Fork
You've already forked ooni-probe-cli
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

refactor: start pivoting netx (#396)

Browse source 
What do I mean by pivoting? Netx is currently organized by row:

```
               | dialer | quicdialer | resolver | ...
 saving        |        |            |          | ...
 errorwrapping |        |            |          | ...
 logging       |        |            |          | ...
 mocking/sys   |        |            |          | ...
```

Every row needs to implement saving, errorwrapping, logging, mocking (or
adapting to the system or to some underlying library).

This causes cross package dependencies and, in turn, complexity. For
example, we need the `trace` package for supporting saving.

And `dialer`, `quickdialer`, et al. need to depend on such a package.

The same goes for errorwrapping.

This arrangement further complicates testing. For example, I am
currently working on https://github.com/ooni/probe/issues/1505 and
I realize it need to repeat integration tests in multiple places.

Let's say instead we pivot the above matrix as follows:

```
             | saving | errorwrapping | logging | ...
 dialer      |        |               |         | ...
 quicdialer  |        |               |         | ...
 logging     |        |               |         | ...
 mocking/sys |        |               |         | ...
 ...
```

In this way, now every row contains everything related to a specific
action to perform. We can now share code without relying on extra
support packages. What's more, we can write tests and, judding from
the way in which things are made, it seems we only need integration
testing in `errorwrapping` because it's where data quality matters
whereas, in all other cases, unit testing is fine.

I am going, therefore, to proceed with these changes and "pivot"
`netx`. Hopefully, it won't be too painful.
This commit is contained in:
Simone Basso 2021-06-23 15:53:12 +02:00 • committed by GitHub
commit 8a0beee808
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
27 changed files with 455 additions and 351 deletions
Download patch file Download diff file Expand all files Collapse all files

19
internal/engine/netx/netx_test.go
View file

@ -15,6 +15,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/tlsdialer"
"github.com/ooni/probe-cli/v3/internal/engine/netx/tlsx"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/netxlite"
)
func TestNewResolverVanilla(t *testing.T) {
@ -31,7 +32,7 @@ func TestNewResolverVanilla(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
_, ok = ar.Resolver.(resolver.SystemResolver)
_, ok = ar.Resolver.(netxlite.ResolverSystem)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -81,7 +82,7 @@ func TestNewResolverWithBogonFilter(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
_, ok = ar.Resolver.(resolver.SystemResolver)
_, ok = ar.Resolver.(netxlite.ResolverSystem)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -95,7 +96,7 @@ func TestNewResolverWithLogging(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
lr, ok := ir.Resolver.(resolver.LoggingResolver)
lr, ok := ir.Resolver.(netxlite.ResolverLogger)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -110,7 +111,7 @@ func TestNewResolverWithLogging(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
_, ok = ar.Resolver.(resolver.SystemResolver)
_, ok = ar.Resolver.(netxlite.ResolverSystem)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -140,7 +141,7 @@ func TestNewResolverWithSaver(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
_, ok = ar.Resolver.(resolver.SystemResolver)
_, ok = ar.Resolver.(netxlite.ResolverSystem)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -169,7 +170,7 @@ func TestNewResolverWithReadWriteCache(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
_, ok = ar.Resolver.(resolver.SystemResolver)
_, ok = ar.Resolver.(netxlite.ResolverSystem)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -203,7 +204,7 @@ func TestNewResolverWithPrefilledReadonlyCache(t *testing.T) {
if !ok {
t.Fatal("not the resolver we expected")
}
_, ok = ar.Resolver.(resolver.SystemResolver)
_, ok = ar.Resolver.(netxlite.ResolverSystem)
if !ok {
t.Fatal("not the resolver we expected")
}
@ -597,7 +598,7 @@ func TestNewDNSClientSystemResolver(t *testing.T) {
if err != nil {
t.Fatal(err)
}
if _, ok := dnsclient.Resolver.(resolver.SystemResolver); !ok {
if _, ok := dnsclient.Resolver.(netxlite.ResolverSystem); !ok {
t.Fatal("not the resolver we expected")
}
dnsclient.CloseIdleConnections()
@ -609,7 +610,7 @@ func TestNewDNSClientEmpty(t *testing.T) {
if err != nil {
t.Fatal(err)
}
if _, ok := dnsclient.Resolver.(resolver.SystemResolver); !ok {
if _, ok := dnsclient.Resolver.(netxlite.ResolverSystem); !ok {
t.Fatal("not the resolver we expected")
}
dnsclient.CloseIdleConnections()