ooni-probe-cli/internal/engine/experiment/telegram/telegram_test.go
Simone Basso 83440cf110
refactor: split errorsx in good and legacy (#477)
The legacy part for now is internal/errorsx. It will stay there until
I figure out whether it also needs some extra bug fixing.

The good part is now in internal/netxlite/errorsx and contains all the
logic for mapping errors. We need to further improve upon this logic
by writing more thorough integration tests for QUIC.

We also need to copy the various dialer, conn, etc adapters that set
errors. We will put them inside netxlite and we will generate errors in
a way that is less crazy with respect to the major operation. (The
idea is to always wrap, given that now we measure in an incremental way
and we don't measure every operation together.)

Part of https://github.com/ooni/probe/issues/1591
2021-09-07 17:09:30 +02:00

417 lines
10 KiB
Go

package telegram_test
import (
"context"
"fmt"
"io"
"testing"
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/internal/atomicx"
"github.com/ooni/probe-cli/v3/internal/engine/experiment/telegram"
"github.com/ooni/probe-cli/v3/internal/engine/experiment/urlgetter"
"github.com/ooni/probe-cli/v3/internal/engine/mockable"
"github.com/ooni/probe-cli/v3/internal/engine/model"
"github.com/ooni/probe-cli/v3/internal/netxlite/errorsx"
)
func TestNewExperimentMeasurer(t *testing.T) {
measurer := telegram.NewExperimentMeasurer(telegram.Config{})
if measurer.ExperimentName() != "telegram" {
t.Fatal("unexpected name")
}
if measurer.ExperimentVersion() != "0.2.0" {
t.Fatal("unexpected version")
}
}
func TestGood(t *testing.T) {
measurer := telegram.NewExperimentMeasurer(telegram.Config{})
measurement := new(model.Measurement)
err := measurer.Run(
context.Background(),
&mockable.Session{
MockableLogger: log.Log,
},
measurement,
model.NewPrinterCallbacks(log.Log),
)
if err != nil {
t.Fatal(err)
}
tk := measurement.TestKeys.(*telegram.TestKeys)
if tk.Agent != "redirect" {
t.Fatal("unexpected Agent")
}
if tk.FailedOperation != nil {
t.Fatal("unexpected FailedOperation")
}
if tk.Failure != nil {
t.Fatal("unexpected Failure")
}
if len(tk.NetworkEvents) <= 0 {
t.Fatal("no NetworkEvents?!")
}
if len(tk.Queries) <= 0 {
t.Fatal("no Queries?!")
}
if len(tk.Requests) <= 0 {
t.Fatal("no Requests?!")
}
if len(tk.TCPConnect) <= 0 {
t.Fatal("no TCPConnect?!")
}
if len(tk.TLSHandshakes) <= 0 {
t.Fatal("no TLSHandshakes?!")
}
if tk.TelegramHTTPBlocking != false {
t.Fatal("unexpected TelegramHTTPBlocking")
}
if tk.TelegramTCPBlocking != false {
t.Fatal("unexpected TelegramTCPBlocking")
}
if tk.TelegramWebFailure != nil {
t.Fatal("unexpected TelegramWebFailure")
}
if tk.TelegramWebStatus != "ok" {
t.Fatal("unexpected TelegramWebStatus")
}
sk, err := measurer.GetSummaryKeys(measurement)
if err != nil {
t.Fatal(err)
}
if _, ok := sk.(telegram.SummaryKeys); !ok {
t.Fatal("invalid type for summary keys")
}
}
func TestUpdateWithNoAccessPointsBlocking(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50/",
},
TestKeys: urlgetter.TestKeys{
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50:443/",
},
TestKeys: urlgetter.TestKeys{
Failure: nil, // this should be enough to declare success
},
})
if tk.TelegramHTTPBlocking == true {
t.Fatal("there should be no TelegramHTTPBlocking")
}
if tk.TelegramTCPBlocking == true {
t.Fatal("there should be no TelegramTCPBlocking")
}
}
func TestUpdateWithNilFailedOperation(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50/",
},
TestKeys: urlgetter.TestKeys{
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50:443/",
},
TestKeys: urlgetter.TestKeys{
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
if tk.TelegramHTTPBlocking == false {
t.Fatal("there should be TelegramHTTPBlocking")
}
if tk.TelegramTCPBlocking == true {
t.Fatal("there should be no TelegramTCPBlocking")
}
}
func TestUpdateWithNonConnectFailedOperation(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50/",
},
TestKeys: urlgetter.TestKeys{
FailedOperation: (func() *string {
s := errorsx.ConnectOperation
return &s
})(),
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50:443/",
},
TestKeys: urlgetter.TestKeys{
FailedOperation: (func() *string {
s := errorsx.HTTPRoundTripOperation
return &s
})(),
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
if tk.TelegramHTTPBlocking == false {
t.Fatal("there should be TelegramHTTPBlocking")
}
if tk.TelegramTCPBlocking == true {
t.Fatal("there should be no TelegramTCPBlocking")
}
}
func TestUpdateWithAllConnectsFailed(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50/",
},
TestKeys: urlgetter.TestKeys{
FailedOperation: (func() *string {
s := errorsx.ConnectOperation
return &s
})(),
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "POST"},
Target: "http://149.154.175.50:443/",
},
TestKeys: urlgetter.TestKeys{
FailedOperation: (func() *string {
s := errorsx.ConnectOperation
return &s
})(),
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
if tk.TelegramHTTPBlocking == false {
t.Fatal("there should be TelegramHTTPBlocking")
}
if tk.TelegramTCPBlocking == false {
t.Fatal("there should be TelegramTCPBlocking")
}
}
func TestUpdateWebWithMixedResults(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "GET"},
Target: "http://web.telegram.org/",
},
TestKeys: urlgetter.TestKeys{
FailedOperation: (func() *string {
s := errorsx.HTTPRoundTripOperation
return &s
})(),
Failure: (func() *string {
s := errorsx.FailureEOFError
return &s
})(),
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "GET"},
Target: "https://web.telegram.org/",
},
TestKeys: urlgetter.TestKeys{
HTTPResponseBody: `<title>Telegram Web</title>`,
HTTPResponseStatus: 200,
},
})
if tk.TelegramWebStatus != "blocked" {
t.Fatal("TelegramWebStatus should be blocked")
}
if *tk.TelegramWebFailure != errorsx.FailureEOFError {
t.Fatal("invalid TelegramWebFailure")
}
}
func TestWeConfigureWebChecksToFailOnHTTPError(t *testing.T) {
called := &atomicx.Int64{}
failOnErrorHTTPS := &atomicx.Int64{}
failOnErrorHTTP := &atomicx.Int64{}
measurer := telegram.Measurer{
Config: telegram.Config{},
Getter: func(ctx context.Context, g urlgetter.Getter) (urlgetter.TestKeys, error) {
called.Add(1)
switch g.Target {
case "https://web.telegram.org/":
if g.Config.FailOnHTTPError {
failOnErrorHTTPS.Add(1)
}
case "http://web.telegram.org/":
if g.Config.FailOnHTTPError {
failOnErrorHTTP.Add(1)
}
}
return urlgetter.DefaultMultiGetter(ctx, g)
},
}
ctx := context.Background()
sess := &mockable.Session{
MockableLogger: log.Log,
}
measurement := new(model.Measurement)
callbacks := model.NewPrinterCallbacks(log.Log)
if err := measurer.Run(ctx, sess, measurement, callbacks); err != nil {
t.Fatal(err)
}
if called.Load() < 1 {
t.Fatal("not called")
}
if failOnErrorHTTPS.Load() != 1 {
t.Fatal("not configured fail on error for HTTPS")
}
if failOnErrorHTTP.Load() != 1 {
t.Fatal("not configured fail on error for HTTP")
}
}
func TestUpdateWithMissingTitle(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "GET"},
Target: "http://web.telegram.org/",
},
TestKeys: urlgetter.TestKeys{
HTTPResponseStatus: 200,
HTTPResponseBody: "<HTML><title>Telegram Web</title></HTML>",
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "GET"},
Target: "http://web.telegram.org/",
},
TestKeys: urlgetter.TestKeys{
HTTPResponseStatus: 200,
HTTPResponseBody: "<HTML><title>Antani Web</title></HTML>",
},
})
if tk.TelegramWebStatus != "blocked" {
t.Fatal("TelegramWebStatus should be blocked")
}
if *tk.TelegramWebFailure != "telegram_missing_title_error" {
t.Fatal("invalid TelegramWebFailure")
}
}
func TestUpdateWithAllGood(t *testing.T) {
tk := telegram.NewTestKeys()
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "GET"},
Target: "http://web.telegram.org/",
},
TestKeys: urlgetter.TestKeys{
HTTPResponseStatus: 200,
HTTPResponseBody: "<HTML><title>Telegram Web</title></HTML>",
},
})
tk.Update(urlgetter.MultiOutput{
Input: urlgetter.MultiInput{
Config: urlgetter.Config{Method: "GET"},
Target: "http://web.telegram.org/",
},
TestKeys: urlgetter.TestKeys{
HTTPResponseStatus: 200,
HTTPResponseBody: "<HTML><title>Telegram Web</title></HTML>",
},
})
if tk.TelegramWebStatus != "ok" {
t.Fatal("TelegramWebStatus should be ok")
}
if tk.TelegramWebFailure != nil {
t.Fatal("invalid TelegramWebFailure")
}
}
func TestSummaryKeysInvalidType(t *testing.T) {
measurement := new(model.Measurement)
m := &telegram.Measurer{}
_, err := m.GetSummaryKeys(measurement)
if err.Error() != "invalid test keys type" {
t.Fatal("not the error we expected")
}
}
func TestSummaryKeysWorksAsIntended(t *testing.T) {
failure := io.EOF.Error()
tests := []struct {
tk telegram.TestKeys
isAnomaly bool
}{{
tk: telegram.TestKeys{},
isAnomaly: false,
}, {
tk: telegram.TestKeys{TelegramTCPBlocking: true},
isAnomaly: true,
}, {
tk: telegram.TestKeys{TelegramHTTPBlocking: true},
isAnomaly: true,
}, {
tk: telegram.TestKeys{TelegramWebFailure: &failure},
isAnomaly: true,
}}
for idx, tt := range tests {
t.Run(fmt.Sprintf("%d", idx), func(t *testing.T) {
m := &telegram.Measurer{}
measurement := &model.Measurement{TestKeys: &tt.tk}
got, err := m.GetSummaryKeys(measurement)
if err != nil {
t.Fatal(err)
return
}
sk := got.(telegram.SummaryKeys)
if sk.IsAnomaly != tt.isAnomaly {
t.Fatal("unexpected isAnomaly value")
}
})
}
}