feat(oonirun): improve tests (#915)
See https://github.com/ooni/probe/issues/2184 While there, rename `runtimex.PanicIfFalse` to `runtimex.Assert` (it was about time...)
This commit is contained in:
Simone Basso
GitHub
parent
a8a29cc0dd
commit
d0da224a2a
32 changed files with 1837 additions and 112 deletions
|
|
@ -2,42 +2,24 @@ package oonirun
|
|||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"errors"
|
||||
"reflect"
|
||||
"sort"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/ooni/probe-cli/v3/internal/engine"
|
||||
"github.com/ooni/probe-cli/v3/internal/kvstore"
|
||||
"github.com/ooni/probe-cli/v3/internal/model"
|
||||
"github.com/ooni/probe-cli/v3/internal/version"
|
||||
"github.com/ooni/probe-cli/v3/internal/model/mocks"
|
||||
"github.com/ooni/probe-cli/v3/internal/testingx"
|
||||
)
|
||||
|
||||
// TODO(bassosimone): it would be cool to write unit tests. However, to do that
|
||||
// we need to ~redesign the engine package for unit-testability.
|
||||
|
||||
func newSession(ctx context.Context, t *testing.T) *engine.Session {
|
||||
config := engine.SessionConfig{
|
||||
AvailableProbeServices: []model.OOAPIService{},
|
||||
KVStore: &kvstore.Memory{},
|
||||
Logger: model.DiscardLogger,
|
||||
ProxyURL: nil,
|
||||
SoftwareName: "miniooni",
|
||||
SoftwareVersion: version.Version,
|
||||
TempDir: os.TempDir(),
|
||||
TorArgs: []string{},
|
||||
TorBinary: "",
|
||||
TunnelDir: "",
|
||||
}
|
||||
sess, err := engine.NewSession(ctx, config)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return sess
|
||||
}
|
||||
|
||||
func TestExperimentRunWithExample(t *testing.T) {
|
||||
func TestExperimentRunWithFailureToSubmitAndShuffle(t *testing.T) {
|
||||
shuffledInputsPrev := experimentShuffledInputs.Load()
|
||||
var calledSetOptionsAny int
|
||||
var failedToSubmit int
|
||||
var calledKibiBytesReceived int
|
||||
var calledKibiBytesSent int
|
||||
ctx := context.Background()
|
||||
desc := &Experiment{
|
||||
Annotations: map[string]string{
|
||||
|
|
@ -46,19 +28,89 @@ func TestExperimentRunWithExample(t *testing.T) {
|
|||
ExtraOptions: map[string]any{
|
||||
"SleepTime": int64(10 * time.Millisecond),
|
||||
},
|
||||
Inputs: []string{},
|
||||
Inputs: []string{
|
||||
"a", "b", "c",
|
||||
},
|
||||
InputFilePaths: []string{},
|
||||
MaxRuntime: 0,
|
||||
Name: "example",
|
||||
NoCollector: true,
|
||||
NoJSON: true,
|
||||
Random: false,
|
||||
Random: true, // to test randomness
|
||||
ReportFile: "",
|
||||
Session: newSession(ctx, t),
|
||||
Session: &mocks.Session{
|
||||
MockNewExperimentBuilder: func(name string) (model.ExperimentBuilder, error) {
|
||||
eb := &mocks.ExperimentBuilder{
|
||||
MockInputPolicy: func() model.InputPolicy {
|
||||
return model.InputOptional
|
||||
},
|
||||
MockSetOptionsAny: func(options map[string]any) error {
|
||||
calledSetOptionsAny++
|
||||
return nil
|
||||
},
|
||||
MockNewExperiment: func() model.Experiment {
|
||||
exp := &mocks.Experiment{
|
||||
MockMeasureAsync: func(ctx context.Context, input string) (<-chan *model.Measurement, error) {
|
||||
out := make(chan *model.Measurement)
|
||||
go func() {
|
||||
defer close(out)
|
||||
ff := &testingx.FakeFiller{}
|
||||
var meas model.Measurement
|
||||
ff.Fill(&meas)
|
||||
out <- &meas
|
||||
}()
|
||||
return out, nil
|
||||
},
|
||||
MockKibiBytesReceived: func() float64 {
|
||||
calledKibiBytesReceived++
|
||||
return 1.453
|
||||
},
|
||||
MockKibiBytesSent: func() float64 {
|
||||
calledKibiBytesSent++
|
||||
return 1.648
|
||||
},
|
||||
}
|
||||
return exp
|
||||
},
|
||||
}
|
||||
return eb, nil
|
||||
},
|
||||
MockLogger: func() model.Logger {
|
||||
return model.DiscardLogger
|
||||
},
|
||||
},
|
||||
newExperimentBuilderFn: nil,
|
||||
newInputLoaderFn: nil,
|
||||
newSubmitterFn: func(ctx context.Context) (engine.Submitter, error) {
|
||||
subm := &mocks.Submitter{
|
||||
MockSubmit: func(ctx context.Context, m *model.Measurement) error {
|
||||
failedToSubmit++
|
||||
return errors.New("mocked error")
|
||||
},
|
||||
}
|
||||
return subm, nil
|
||||
},
|
||||
newSaverFn: nil,
|
||||
newInputProcessorFn: nil,
|
||||
}
|
||||
if err := desc.Run(ctx); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if failedToSubmit < 1 {
|
||||
t.Fatal("expected to see failure to submit")
|
||||
}
|
||||
if experimentShuffledInputs.Load() != shuffledInputsPrev+1 {
|
||||
t.Fatal("did not shuffle inputs")
|
||||
}
|
||||
if calledSetOptionsAny < 1 {
|
||||
t.Fatal("should have called SetOptionsAny")
|
||||
}
|
||||
if calledKibiBytesReceived < 1 {
|
||||
t.Fatal("did not call KibiBytesReceived")
|
||||
}
|
||||
if calledKibiBytesSent < 1 {
|
||||
t.Fatal("did not call KibiBytesSent")
|
||||
}
|
||||
}
|
||||
|
||||
func Test_experimentOptionsToStringList(t *testing.T) {
|
||||
|
|
@ -102,3 +154,257 @@ func Test_experimentOptionsToStringList(t *testing.T) {
|
|||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestExperimentRun(t *testing.T) {
|
||||
errMocked := errors.New("mocked error")
|
||||
type fields struct {
|
||||
Annotations map[string]string
|
||||
ExtraOptions map[string]any
|
||||
Inputs []string
|
||||
InputFilePaths []string
|
||||
MaxRuntime int64
|
||||
Name string
|
||||
NoCollector bool
|
||||
NoJSON bool
|
||||
Random bool
|
||||
ReportFile string
|
||||
Session Session
|
||||
newExperimentBuilderFn func(experimentName string) (model.ExperimentBuilder, error)
|
||||
newInputLoaderFn func(inputPolicy model.InputPolicy) inputLoader
|
||||
newSubmitterFn func(ctx context.Context) (engine.Submitter, error)
|
||||
newSaverFn func(experiment model.Experiment) (engine.Saver, error)
|
||||
newInputProcessorFn func(experiment model.Experiment, inputList []model.OOAPIURLInfo, saver engine.Saver, submitter engine.Submitter) inputProcessor
|
||||
}
|
||||
type args struct {
|
||||
ctx context.Context
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
args args
|
||||
expectErr error
|
||||
}{{
|
||||
name: "cannot construct an experiment builder",
|
||||
fields: fields{
|
||||
newExperimentBuilderFn: func(experimentName string) (model.ExperimentBuilder, error) {
|
||||
return nil, errMocked
|
||||
},
|
||||
},
|
||||
args: args{},
|
||||
expectErr: errMocked,
|
||||
}, {
|
||||
name: "cannot load input",
|
||||
fields: fields{
|
||||
newExperimentBuilderFn: func(experimentName string) (model.ExperimentBuilder, error) {
|
||||
eb := &mocks.ExperimentBuilder{
|
||||
MockInputPolicy: func() model.InputPolicy {
|
||||
return model.InputOptional
|
||||
},
|
||||
}
|
||||
return eb, nil
|
||||
},
|
||||
newInputLoaderFn: func(inputPolicy model.InputPolicy) inputLoader {
|
||||
return &mocks.ExperimentInputLoader{
|
||||
MockLoad: func(ctx context.Context) ([]model.OOAPIURLInfo, error) {
|
||||
return nil, errMocked
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
args: args{},
|
||||
expectErr: errMocked,
|
||||
}, {
|
||||
name: "cannot set options",
|
||||
fields: fields{
|
||||
newExperimentBuilderFn: func(experimentName string) (model.ExperimentBuilder, error) {
|
||||
eb := &mocks.ExperimentBuilder{
|
||||
MockInputPolicy: func() model.InputPolicy {
|
||||
return model.InputOptional
|
||||
},
|
||||
MockSetOptionsAny: func(options map[string]any) error {
|
||||
return errMocked
|
||||
},
|
||||
}
|
||||
return eb, nil
|
||||
},
|
||||
newInputLoaderFn: func(inputPolicy model.InputPolicy) inputLoader {
|
||||
return &mocks.ExperimentInputLoader{
|
||||
MockLoad: func(ctx context.Context) ([]model.OOAPIURLInfo, error) {
|
||||
return []model.OOAPIURLInfo{}, nil
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
args: args{},
|
||||
expectErr: errMocked,
|
||||
}, {
|
||||
name: "cannot create new submitter",
|
||||
fields: fields{
|
||||
Session: &mocks.Session{
|
||||
MockLogger: func() model.Logger {
|
||||
return model.DiscardLogger
|
||||
},
|
||||
},
|
||||
newExperimentBuilderFn: func(experimentName string) (model.ExperimentBuilder, error) {
|
||||
eb := &mocks.ExperimentBuilder{
|
||||
MockInputPolicy: func() model.InputPolicy {
|
||||
return model.InputOptional
|
||||
},
|
||||
MockSetOptionsAny: func(options map[string]any) error {
|
||||
return nil
|
||||
},
|
||||
MockNewExperiment: func() model.Experiment {
|
||||
exp := &mocks.Experiment{
|
||||
MockKibiBytesReceived: func() float64 {
|
||||
return 0
|
||||
},
|
||||
MockKibiBytesSent: func() float64 {
|
||||
return 0
|
||||
},
|
||||
}
|
||||
return exp
|
||||
},
|
||||
}
|
||||
return eb, nil
|
||||
},
|
||||
newInputLoaderFn: func(inputPolicy model.InputPolicy) inputLoader {
|
||||
return &mocks.ExperimentInputLoader{
|
||||
MockLoad: func(ctx context.Context) ([]model.OOAPIURLInfo, error) {
|
||||
return []model.OOAPIURLInfo{}, nil
|
||||
},
|
||||
}
|
||||
},
|
||||
newSubmitterFn: func(ctx context.Context) (engine.Submitter, error) {
|
||||
return nil, errMocked
|
||||
},
|
||||
},
|
||||
args: args{},
|
||||
expectErr: errMocked,
|
||||
}, {
|
||||
name: "cannot create new saver",
|
||||
fields: fields{
|
||||
Session: &mocks.Session{
|
||||
MockLogger: func() model.Logger {
|
||||
return model.DiscardLogger
|
||||
},
|
||||
},
|
||||
newExperimentBuilderFn: func(experimentName string) (model.ExperimentBuilder, error) {
|
||||
eb := &mocks.ExperimentBuilder{
|
||||
MockInputPolicy: func() model.InputPolicy {
|
||||
return model.InputOptional
|
||||
},
|
||||
MockSetOptionsAny: func(options map[string]any) error {
|
||||
return nil
|
||||
},
|
||||
MockNewExperiment: func() model.Experiment {
|
||||
exp := &mocks.Experiment{
|
||||
MockKibiBytesReceived: func() float64 {
|
||||
return 0
|
||||
},
|
||||
MockKibiBytesSent: func() float64 {
|
||||
return 0
|
||||
},
|
||||
}
|
||||
return exp
|
||||
},
|
||||
}
|
||||
return eb, nil
|
||||
},
|
||||
newInputLoaderFn: func(inputPolicy model.InputPolicy) inputLoader {
|
||||
return &mocks.ExperimentInputLoader{
|
||||
MockLoad: func(ctx context.Context) ([]model.OOAPIURLInfo, error) {
|
||||
return []model.OOAPIURLInfo{}, nil
|
||||
},
|
||||
}
|
||||
},
|
||||
newSubmitterFn: func(ctx context.Context) (engine.Submitter, error) {
|
||||
return &mocks.Submitter{}, nil
|
||||
},
|
||||
newSaverFn: func(experiment model.Experiment) (engine.Saver, error) {
|
||||
return nil, errMocked
|
||||
},
|
||||
},
|
||||
args: args{},
|
||||
expectErr: errMocked,
|
||||
}, {
|
||||
name: "input processor fails",
|
||||
fields: fields{
|
||||
Session: &mocks.Session{
|
||||
MockLogger: func() model.Logger {
|
||||
return model.DiscardLogger
|
||||
},
|
||||
},
|
||||
newExperimentBuilderFn: func(experimentName string) (model.ExperimentBuilder, error) {
|
||||
eb := &mocks.ExperimentBuilder{
|
||||
MockInputPolicy: func() model.InputPolicy {
|
||||
return model.InputOptional
|
||||
},
|
||||
MockSetOptionsAny: func(options map[string]any) error {
|
||||
return nil
|
||||
},
|
||||
MockNewExperiment: func() model.Experiment {
|
||||
exp := &mocks.Experiment{
|
||||
MockKibiBytesReceived: func() float64 {
|
||||
return 0
|
||||
},
|
||||
MockKibiBytesSent: func() float64 {
|
||||
return 0
|
||||
},
|
||||
}
|
||||
return exp
|
||||
},
|
||||
}
|
||||
return eb, nil
|
||||
},
|
||||
newInputLoaderFn: func(inputPolicy model.InputPolicy) inputLoader {
|
||||
return &mocks.ExperimentInputLoader{
|
||||
MockLoad: func(ctx context.Context) ([]model.OOAPIURLInfo, error) {
|
||||
return []model.OOAPIURLInfo{}, nil
|
||||
},
|
||||
}
|
||||
},
|
||||
newSubmitterFn: func(ctx context.Context) (engine.Submitter, error) {
|
||||
return &mocks.Submitter{}, nil
|
||||
},
|
||||
newSaverFn: func(experiment model.Experiment) (engine.Saver, error) {
|
||||
return &mocks.Saver{}, nil
|
||||
},
|
||||
newInputProcessorFn: func(experiment model.Experiment, inputList []model.OOAPIURLInfo,
|
||||
saver engine.Saver, submitter engine.Submitter) inputProcessor {
|
||||
return &mocks.ExperimentInputProcessor{
|
||||
MockRun: func(ctx context.Context) error {
|
||||
return errMocked
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
args: args{},
|
||||
expectErr: errMocked,
|
||||
}}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ed := &Experiment{
|
||||
Annotations: tt.fields.Annotations,
|
||||
ExtraOptions: tt.fields.ExtraOptions,
|
||||
Inputs: tt.fields.Inputs,
|
||||
InputFilePaths: tt.fields.InputFilePaths,
|
||||
MaxRuntime: tt.fields.MaxRuntime,
|
||||
Name: tt.fields.Name,
|
||||
NoCollector: tt.fields.NoCollector,
|
||||
NoJSON: tt.fields.NoJSON,
|
||||
Random: tt.fields.Random,
|
||||
ReportFile: tt.fields.ReportFile,
|
||||
Session: tt.fields.Session,
|
||||
newExperimentBuilderFn: tt.fields.newExperimentBuilderFn,
|
||||
newInputLoaderFn: tt.fields.newInputLoaderFn,
|
||||
newSubmitterFn: tt.fields.newSubmitterFn,
|
||||
newSaverFn: tt.fields.newSaverFn,
|
||||
newInputProcessorFn: tt.fields.newInputProcessorFn,
|
||||
}
|
||||
err := ed.Run(tt.args.ctx)
|
||||
if !errors.Is(err, tt.expectErr) {
|
||||
t.Fatalf("Experiment.Run() error = %v, expectErr %v", err, tt.expectErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue