Skip to content

Commit

Permalink
chore: attempt to upgrade all tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@bassosimone
bassosimone committed Jun 28, 2024
1 parent c4675c5 commit 6f1c8e9
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 218 deletions.
4 changes: 4 additions & 0 deletions pkg/oonimkall/taskmodel.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,4 +316,8 @@ type settingsOptions struct {
// SoftwareVersion is the software version. If this option is not
// present, then the library startup will fail.
SoftwareVersion string `json:"software_version,omitempty"`

// TODO(bassosimone,DecFox): to support OONI Run v2 descriptors with
// richer input from mobile, here we also need a string-serialization
// of the descriptor options to load.
}
3 changes: 3 additions & 0 deletions pkg/oonimkall/taskrunner.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,9 @@ func (r *runnerForTask) Run(rootCtx context.Context) {
}

// notify the mobile app that we are about to measure a specific target
//
// note that here we provide also the CategoryCode and the CountryCode
// so that the mobile app can update its URLs table here
logger.Infof("Starting measurement with index %d", idx)
r.emitter.Emit(eventTypeStatusMeasurementStart, eventMeasurementGeneric{
CategoryCode: target.Category(),
Expand Down
271 changes: 53 additions & 218 deletions pkg/oonimkall/taskrunner_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine"
"github.com/ooni/probe-cli/v3/internal/mocks"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/targetloading"
)

func TestMeasurementSubmissionEventName(t *testing.T) {
Expand Down Expand Up @@ -103,6 +102,10 @@ func TestTaskRunnerRun(t *testing.T) {
assertCountEventsByKey(events, eventTypeFailureStartup, 1)
})

//
// Failure in creating a new measurement session:
//

t.Run("with failure when creating a new kvstore", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
// override the kvstore builder to provoke an error
Expand Down Expand Up @@ -166,6 +169,10 @@ func TestTaskRunnerRun(t *testing.T) {
}
})

//
// Test cases where we successfully create a new measurement session:
//

type eventKeyCount struct {
Key string
Count int
Expand Down Expand Up @@ -305,7 +312,7 @@ func TestTaskRunnerRun(t *testing.T) {
}
}

t.Run("with invalid experiment name", func(t *testing.T) {
t.Run("with invalid experiment name causing failure to create an experiment builder", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Session.MockNewExperimentBuilder = func(name string) (model.ExperimentBuilder, error) {
Expand Down Expand Up @@ -366,74 +373,12 @@ func TestTaskRunnerRun(t *testing.T) {
t.Run("with error during target loading", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputOrQueryBackend
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
expect := []eventKeyCount{
{Key: eventTypeStatusQueued, Count: 1},
{Key: eventTypeStatusStarted, Count: 1},
{Key: eventTypeStatusProgress, Count: 3},
{Key: eventTypeStatusGeoIPLookup, Count: 1},
{Key: eventTypeStatusResolverLookup, Count: 1},
{Key: eventTypeFailureStartup, Count: 1},
{Key: eventTypeStatusEnd, Count: 1},
}
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with missing input and InputStrictlyRequired policy", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputStrictlyRequired
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
expect := []eventKeyCount{
{Key: eventTypeStatusQueued, Count: 1},
{Key: eventTypeStatusStarted, Count: 1},
{Key: eventTypeStatusProgress, Count: 3},
{Key: eventTypeStatusGeoIPLookup, Count: 1},
{Key: eventTypeStatusResolverLookup, Count: 1},
{Key: eventTypeFailureStartup, Count: 1},
{Key: eventTypeStatusEnd, Count: 1},
}
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with InputOrStaticDefault policy and experiment with no static input",
func(t *testing.T) {
runner, emitter := newRunnerForTesting()
runner.settings.Name = "Antani" // no input for this experiment
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputOrStaticDefault
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
expect := []eventKeyCount{
{Key: eventTypeStatusQueued, Count: 1},
{Key: eventTypeStatusStarted, Count: 1},
{Key: eventTypeStatusProgress, Count: 3},
{Key: eventTypeStatusGeoIPLookup, Count: 1},
{Key: eventTypeStatusResolverLookup, Count: 1},
{Key: eventTypeFailureStartup, Count: 1},
{Key: eventTypeStatusEnd, Count: 1},
fake.Builder.MockNewTargetLoader = func(config *model.ExperimentTargetLoaderConfig) model.ExperimentTargetLoader {
return &mocks.ExperimentTargetLoader{
MockLoad: func(ctx context.Context) ([]model.ExperimentTarget, error) {
return nil, errors.New("mocked error")
},
}
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with InputNone policy and provided input", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
runner.settings.Inputs = append(runner.settings.Inputs, "https://x.org/")
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputNone
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
Expand Down Expand Up @@ -474,9 +419,6 @@ func TestTaskRunnerRun(t *testing.T) {
t.Run("with success and just a single entry", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputNone
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
Expand All @@ -500,9 +442,6 @@ func TestTaskRunnerRun(t *testing.T) {
t.Run("with failure and just a single entry", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputNone
}
fake.Experiment.MockMeasureWithContext = func(ctx context.Context, target model.ExperimentTarget) (measurement *model.Measurement, err error) {
return nil, errors.New("preconditions error")
}
Expand Down Expand Up @@ -530,9 +469,6 @@ func TestTaskRunnerRun(t *testing.T) {
// which is what was happening in the above referenced issue.
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputNone
}
fake.Experiment.MockMeasureWithContext = func(ctx context.Context, target model.ExperimentTarget) (measurement *model.Measurement, err error) {
return nil, errors.New("preconditions error")
}
Expand All @@ -555,62 +491,25 @@ func TestTaskRunnerRun(t *testing.T) {
{Key: eventTypeStatusEnd, Count: 1},
}
assertReducedEventsLike(t, expect, reduced)
// TODO(bassosimone): we should probably extend this test to
// make sure we're including the annotation as well
})

t.Run("with success and explicit input provided", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
runner.settings.Inputs = []string{"a", "b", "c", "d"}
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputStrictlyRequired
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
expect := []eventKeyCount{
{Key: eventTypeStatusQueued, Count: 1},
{Key: eventTypeStatusStarted, Count: 1},
{Key: eventTypeStatusProgress, Count: 3},
{Key: eventTypeStatusGeoIPLookup, Count: 1},
{Key: eventTypeStatusResolverLookup, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeStatusReportCreate, Count: 1},
//
{Key: eventTypeStatusMeasurementStart, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeMeasurement, Count: 1},
{Key: eventTypeStatusMeasurementSubmission, Count: 1},
{Key: eventTypeStatusMeasurementDone, Count: 1},
//
{Key: eventTypeStatusMeasurementStart, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeMeasurement, Count: 1},
{Key: eventTypeStatusMeasurementSubmission, Count: 1},
{Key: eventTypeStatusMeasurementDone, Count: 1},
//
{Key: eventTypeStatusMeasurementStart, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeMeasurement, Count: 1},
{Key: eventTypeStatusMeasurementSubmission, Count: 1},
{Key: eventTypeStatusMeasurementDone, Count: 1},
//
{Key: eventTypeStatusMeasurementStart, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeMeasurement, Count: 1},
{Key: eventTypeStatusMeasurementSubmission, Count: 1},
{Key: eventTypeStatusMeasurementDone, Count: 1},
//
{Key: eventTypeStatusEnd, Count: 1},
}
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with success and InputOptional and input", func(t *testing.T) {
t.Run("with success and more than one entry", func(t *testing.T) {
inputs := []string{"a", "b", "c", "d"}
runner, emitter := newRunnerForTesting()
runner.settings.Inputs = []string{"a", "b", "c", "d"}
runner.settings.Inputs = inputs // this is basically ignored because we override MockLoad
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputOptional
fake.Builder.MockNewTargetLoader = func(config *model.ExperimentTargetLoaderConfig) model.ExperimentTargetLoader {
return &mocks.ExperimentTargetLoader{
MockLoad: func(ctx context.Context) (targets []model.ExperimentTarget, err error) {
// We need to mimic wht would happen when settings.Inputs is explicitly provided
for _, input := range inputs {
targets = append(targets, model.NewOOAPIURLInfoWithDefaultCategoryAndCountry(input))
}
return
},
}
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
Expand Down Expand Up @@ -653,77 +552,22 @@ func TestTaskRunnerRun(t *testing.T) {
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with success and InputOptional and no input", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputOptional
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
expect := []eventKeyCount{
{Key: eventTypeStatusQueued, Count: 1},
{Key: eventTypeStatusStarted, Count: 1},
{Key: eventTypeStatusProgress, Count: 3},
{Key: eventTypeStatusGeoIPLookup, Count: 1},
{Key: eventTypeStatusResolverLookup, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeStatusReportCreate, Count: 1},
//
{Key: eventTypeStatusMeasurementStart, Count: 1},
{Key: eventTypeMeasurement, Count: 1},
{Key: eventTypeStatusMeasurementSubmission, Count: 1},
{Key: eventTypeStatusMeasurementDone, Count: 1},
//
{Key: eventTypeStatusEnd, Count: 1},
}
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with success and InputOrStaticDefault", func(t *testing.T) {
experimentName := "DNSCheck"
runner, emitter := newRunnerForTesting()
runner.settings.Name = experimentName
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputOrStaticDefault
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
expect := []eventKeyCount{
{Key: eventTypeStatusQueued, Count: 1},
{Key: eventTypeStatusStarted, Count: 1},
{Key: eventTypeStatusProgress, Count: 3},
{Key: eventTypeStatusGeoIPLookup, Count: 1},
{Key: eventTypeStatusResolverLookup, Count: 1},
{Key: eventTypeStatusProgress, Count: 1},
{Key: eventTypeStatusReportCreate, Count: 1},
}
allEntries, err := targetloading.StaticBareInputForExperiment(experimentName)
if err != nil {
t.Fatal(err)
}
// write the correct entries for each expected measurement.
for idx := 0; idx < len(allEntries); idx++ {
expect = append(expect, eventKeyCount{Key: eventTypeStatusMeasurementStart, Count: 1})
expect = append(expect, eventKeyCount{Key: eventTypeStatusProgress, Count: 1})
expect = append(expect, eventKeyCount{Key: eventTypeMeasurement, Count: 1})
expect = append(expect, eventKeyCount{Key: eventTypeStatusMeasurementSubmission, Count: 1})
expect = append(expect, eventKeyCount{Key: eventTypeStatusMeasurementDone, Count: 1})
}
expect = append(expect, eventKeyCount{Key: eventTypeStatusEnd, Count: 1})
assertReducedEventsLike(t, expect, reduced)
})

t.Run("with success and max runtime", func(t *testing.T) {
inputs := []string{"a", "b", "c", "d"}
runner, emitter := newRunnerForTesting()
runner.settings.Inputs = []string{"a", "b", "c", "d"}
runner.settings.Inputs = inputs // this is basically ignored because we override MockLoad
runner.settings.Options.MaxRuntime = 2
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputStrictlyRequired
fake.Builder.MockNewTargetLoader = func(config *model.ExperimentTargetLoaderConfig) model.ExperimentTargetLoader {
return &mocks.ExperimentTargetLoader{
MockLoad: func(ctx context.Context) (targets []model.ExperimentTarget, err error) {
// We need to mimic wht would happen when settings.Inputs is explicitly provided
for _, input := range inputs {
targets = append(targets, model.NewOOAPIURLInfoWithDefaultCategoryAndCountry(input))
}
return
},
}
}
fake.Experiment.MockMeasureWithContext = func(ctx context.Context, target model.ExperimentTarget) (measurement *model.Measurement, err error) {
time.Sleep(1 * time.Second)
Expand Down Expand Up @@ -759,23 +603,25 @@ func TestTaskRunnerRun(t *testing.T) {
})

t.Run("with interrupted experiment", func(t *testing.T) {
inputs := []string{"a", "b", "c", "d"}
runner, emitter := newRunnerForTesting()
runner.settings.Inputs = []string{"a", "b", "c", "d"}
runner.settings.Inputs = inputs // this is basically ignored because we override MockLoad
runner.settings.Options.MaxRuntime = 2
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputStrictlyRequired
fake.Builder.MockNewTargetLoader = func(config *model.ExperimentTargetLoaderConfig) model.ExperimentTargetLoader {
return &mocks.ExperimentTargetLoader{
MockLoad: func(ctx context.Context) (targets []model.ExperimentTarget, err error) {
// We need to mimic wht would happen when settings.Inputs is explicitly provided
for _, input := range inputs {
targets = append(targets, model.NewOOAPIURLInfoWithDefaultCategoryAndCountry(input))
}
return
},
}
}
fake.Builder.MockInterruptible = func() bool {
return true
}
fake.Loader.MockLoad = func(ctx context.Context) ([]model.ExperimentTarget, error) {
targets := []model.ExperimentTarget{}
for _, input := range runner.settings.Inputs {
targets = append(targets, model.NewOOAPIURLInfoWithDefaultCategoryAndCountry(input))
}
return targets, nil
}
ctx, cancel := context.WithCancel(context.Background())
fake.Experiment.MockMeasureWithContext = func(ctx context.Context, target model.ExperimentTarget) (measurement *model.Measurement, err error) {
cancel()
Expand Down Expand Up @@ -803,21 +649,10 @@ func TestTaskRunnerRun(t *testing.T) {

t.Run("with measurement submission failure", func(t *testing.T) {
runner, emitter := newRunnerForTesting()
runner.settings.Inputs = []string{"a"}
fake := fakeSuccessfulDeps()
fake.Builder.MockInputPolicy = func() model.InputPolicy {
return model.InputStrictlyRequired
}
fake.Experiment.MockSubmitAndUpdateMeasurementContext = func(ctx context.Context, measurement *model.Measurement) error {
return errors.New("cannot submit")
}
fake.Loader.MockLoad = func(ctx context.Context) ([]model.ExperimentTarget, error) {
targets := []model.ExperimentTarget{}
for _, input := range runner.settings.Inputs {
targets = append(targets, model.NewOOAPIURLInfoWithDefaultCategoryAndCountry(input))
}
return targets, nil
}
runner.newSession = fake.NewSession
events := runAndCollect(runner, emitter)
reduced := reduceEventsKeysIgnoreLog(t, events)
Expand Down

0 comments on commit 6f1c8e9

Please sign in to comment.