chore: merge probe-engine into probe-cli (#201)
This is how I did it: 1. `git clone https://github.com/ooni/probe-engine internal/engine` 2. ``` (cd internal/engine && git describe --tags) v0.23.0 ``` 3. `nvim go.mod` (merging `go.mod` with `internal/engine/go.mod` 4. `rm -rf internal/.git internal/engine/go.{mod,sum}` 5. `git add internal/engine` 6. `find . -type f -name \*.go -exec sed -i 's@/ooni/probe-engine@/ooni/probe-cli/v3/internal/engine@g' {} \;` 7. `go build ./...` (passes) 8. `go test -race ./...` (temporary failure on RiseupVPN) 9. `go mod tidy` 10. this commit message Once this piece of work is done, we can build a new version of `ooniprobe` that is using `internal/engine` directly. We need to do more work to ensure all the other functionality in `probe-engine` (e.g. making mobile packages) are still WAI. Part of https://github.com/ooni/probe/issues/1335
This commit is contained in:
Simone Basso
GitHub
parent
b1ce300c8d
commit
d57c78bc71
535 changed files with 66182 additions and 23 deletions
459
internal/engine/experiment/webconnectivity/summary_test.go
Normal file
459
internal/engine/experiment/webconnectivity/summary_test.go
Normal file
|
|
@ -0,0 +1,459 @@
|
|||
package webconnectivity_test
|
||||
|
||||
import (
|
||||
"io"
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/ooni/probe-cli/v3/internal/engine/experiment/webconnectivity"
|
||||
"github.com/ooni/probe-cli/v3/internal/engine/netx/archival"
|
||||
"github.com/ooni/probe-cli/v3/internal/engine/netx/errorx"
|
||||
)
|
||||
|
||||
func TestSummarize(t *testing.T) {
|
||||
var (
|
||||
genericFailure = io.EOF.Error()
|
||||
dns = "dns"
|
||||
falseValue = false
|
||||
httpDiff = "http-diff"
|
||||
httpFailure = "http-failure"
|
||||
nilstring *string
|
||||
probeConnectionRefused = errorx.FailureConnectionRefused
|
||||
probeConnectionReset = errorx.FailureConnectionReset
|
||||
probeEOFError = errorx.FailureEOFError
|
||||
probeNXDOMAIN = errorx.FailureDNSNXDOMAINError
|
||||
probeTimeout = errorx.FailureGenericTimeoutError
|
||||
probeSSLInvalidHost = errorx.FailureSSLInvalidHostname
|
||||
probeSSLInvalidCert = errorx.FailureSSLInvalidCertificate
|
||||
probeSSLUnknownAuth = errorx.FailureSSLUnknownAuthority
|
||||
tcpIP = "tcp_ip"
|
||||
trueValue = true
|
||||
)
|
||||
type args struct {
|
||||
tk *webconnectivity.TestKeys
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
wantOut webconnectivity.Summary
|
||||
}{{
|
||||
name: "with an HTTPS request with no failure",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Request: archival.HTTPRequest{
|
||||
URL: "https://www.kernel.org/",
|
||||
},
|
||||
Failure: nil,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: false,
|
||||
Accessible: &trueValue,
|
||||
Status: webconnectivity.StatusSuccessSecure,
|
||||
},
|
||||
}, {
|
||||
name: "with failure in contacting the control",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
ControlFailure: &genericFailure,
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: nilstring,
|
||||
Accessible: nil,
|
||||
Status: webconnectivity.StatusAnomalyControlUnreachable,
|
||||
},
|
||||
}, {
|
||||
name: "with non-existing website",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSExperimentFailure: &probeNXDOMAIN,
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSConsistent,
|
||||
},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: false,
|
||||
Accessible: &trueValue,
|
||||
Status: webconnectivity.StatusSuccessNXDOMAIN |
|
||||
webconnectivity.StatusExperimentDNS,
|
||||
},
|
||||
}, {
|
||||
name: "with NXDOMAIN measured only by the probe",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSExperimentFailure: &probeNXDOMAIN,
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSInconsistent,
|
||||
},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &dns,
|
||||
Blocking: &dns,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusAnomalyDNS |
|
||||
webconnectivity.StatusExperimentDNS,
|
||||
},
|
||||
}, {
|
||||
name: "with TCP total failure and consistent DNS",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSConsistent,
|
||||
},
|
||||
TCPConnectAttempts: 7,
|
||||
TCPConnectSuccesses: 0,
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &tcpIP,
|
||||
Blocking: &tcpIP,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusAnomalyConnect |
|
||||
webconnectivity.StatusExperimentConnect,
|
||||
},
|
||||
}, {
|
||||
name: "with TCP total failure and inconsistent DNS",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSInconsistent,
|
||||
},
|
||||
TCPConnectAttempts: 7,
|
||||
TCPConnectSuccesses: 0,
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &dns,
|
||||
Blocking: &dns,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusAnomalyConnect |
|
||||
webconnectivity.StatusExperimentConnect |
|
||||
webconnectivity.StatusAnomalyDNS,
|
||||
},
|
||||
}, {
|
||||
name: "with TCP total failure and unexpected DNS consistency",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: func() *string {
|
||||
s := "ANTANI"
|
||||
return &s
|
||||
}(),
|
||||
},
|
||||
TCPConnectAttempts: 7,
|
||||
TCPConnectSuccesses: 0,
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: nilstring,
|
||||
Accessible: nil,
|
||||
Status: webconnectivity.StatusAnomalyConnect |
|
||||
webconnectivity.StatusExperimentConnect |
|
||||
webconnectivity.StatusAnomalyUnknown,
|
||||
},
|
||||
}, {
|
||||
name: "with failed control HTTP request",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Control: webconnectivity.ControlResponse{
|
||||
HTTPRequest: webconnectivity.ControlHTTPRequestResult{
|
||||
Failure: &genericFailure,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: nilstring,
|
||||
Accessible: nil,
|
||||
Status: webconnectivity.StatusAnomalyControlFailure,
|
||||
},
|
||||
}, {
|
||||
name: "with less that one request entry",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: nilstring,
|
||||
Accessible: nil,
|
||||
Status: webconnectivity.StatusBugNoRequests,
|
||||
},
|
||||
}, {
|
||||
name: "with connection refused",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeConnectionRefused,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyConnect,
|
||||
},
|
||||
}, {
|
||||
name: "with connection reset",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeConnectionReset,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyReadWrite,
|
||||
},
|
||||
}, {
|
||||
name: "with NXDOMAIN",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeNXDOMAIN,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &dns,
|
||||
Blocking: &dns,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyDNS,
|
||||
},
|
||||
}, {
|
||||
name: "with EOF",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeEOFError,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyReadWrite,
|
||||
},
|
||||
}, {
|
||||
name: "with timeout",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeTimeout,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyUnknown,
|
||||
},
|
||||
}, {
|
||||
name: "with SSL invalid hostname",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeSSLInvalidHost,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyTLSHandshake,
|
||||
},
|
||||
}, {
|
||||
name: "with SSL invalid cert",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeSSLInvalidCert,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyTLSHandshake,
|
||||
},
|
||||
}, {
|
||||
name: "with SSL unknown auth",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeSSLUnknownAuth,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyTLSHandshake,
|
||||
},
|
||||
}, {
|
||||
name: "with SSL unknown auth _and_ untrustworthy DNS",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSInconsistent,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeSSLUnknownAuth,
|
||||
}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &dns,
|
||||
Blocking: &dns,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyTLSHandshake |
|
||||
webconnectivity.StatusAnomalyDNS,
|
||||
},
|
||||
}, {
|
||||
name: "with SSL unknown auth _and_ untrustworthy DNS _and_ a longer chain",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSInconsistent,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{
|
||||
Failure: &probeSSLUnknownAuth,
|
||||
}, {}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpFailure,
|
||||
Blocking: &httpFailure,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusExperimentHTTP |
|
||||
webconnectivity.StatusAnomalyTLSHandshake,
|
||||
},
|
||||
}, {
|
||||
name: "with status code and body length matching",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
HTTPAnalysisResult: webconnectivity.HTTPAnalysisResult{
|
||||
StatusCodeMatch: &trueValue,
|
||||
BodyLengthMatch: &trueValue,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: falseValue,
|
||||
Accessible: &trueValue,
|
||||
Status: webconnectivity.StatusSuccessCleartext,
|
||||
},
|
||||
}, {
|
||||
name: "with status code and headers matching",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
HTTPAnalysisResult: webconnectivity.HTTPAnalysisResult{
|
||||
StatusCodeMatch: &trueValue,
|
||||
HeadersMatch: &trueValue,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: falseValue,
|
||||
Accessible: &trueValue,
|
||||
Status: webconnectivity.StatusSuccessCleartext,
|
||||
},
|
||||
}, {
|
||||
name: "with status code and title matching",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
HTTPAnalysisResult: webconnectivity.HTTPAnalysisResult{
|
||||
StatusCodeMatch: &trueValue,
|
||||
TitleMatch: &trueValue,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{}},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: nil,
|
||||
Blocking: falseValue,
|
||||
Accessible: &trueValue,
|
||||
Status: webconnectivity.StatusSuccessCleartext,
|
||||
},
|
||||
}, {
|
||||
name: "with suspect http-diff and inconsistent DNS",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
HTTPAnalysisResult: webconnectivity.HTTPAnalysisResult{
|
||||
StatusCodeMatch: &falseValue,
|
||||
TitleMatch: &trueValue,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{}},
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSInconsistent,
|
||||
},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &dns,
|
||||
Blocking: &dns,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusAnomalyHTTPDiff |
|
||||
webconnectivity.StatusAnomalyDNS,
|
||||
},
|
||||
}, {
|
||||
name: "with suspect http-diff and consistent DNS",
|
||||
args: args{
|
||||
tk: &webconnectivity.TestKeys{
|
||||
HTTPAnalysisResult: webconnectivity.HTTPAnalysisResult{
|
||||
StatusCodeMatch: &falseValue,
|
||||
TitleMatch: &trueValue,
|
||||
},
|
||||
Requests: []archival.RequestEntry{{}},
|
||||
DNSAnalysisResult: webconnectivity.DNSAnalysisResult{
|
||||
DNSConsistency: &webconnectivity.DNSConsistent,
|
||||
},
|
||||
},
|
||||
},
|
||||
wantOut: webconnectivity.Summary{
|
||||
BlockingReason: &httpDiff,
|
||||
Blocking: &httpDiff,
|
||||
Accessible: &falseValue,
|
||||
Status: webconnectivity.StatusAnomalyHTTPDiff,
|
||||
},
|
||||
}}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
gotOut := webconnectivity.Summarize(tt.args.tk)
|
||||
if diff := cmp.Diff(tt.wantOut, gotOut); diff != "" {
|
||||
t.Fatal(diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue