ba9151d4fa
This diff adds the prototype websteps implementation that used to live at https://github.com/ooni/probe-cli/pull/506. The code is reasonably good already and it's pointing to a roaming test helper that I've properly configured. You can run websteps with: ``` ./miniooni -n websteps ``` This will go over the test list for your country. At this stage the mechanics of the experiment is set, but we still need to have a conversation on the following topics: 1. whether we're okay with reusing the data format used by other OONI experiments, or we would like to use a more compact data format (which may either be a more compact JSON or we can choose to always submit compressed measurements for websteps); 2. the extent to which we would like to keep the measurement as a collection of "the experiment saw this" and "the test helper saw that" and let the pipeline choose an overall score: this is clearly an option, but there is also the opposite option to build a summary of the measurement on the probe. Compared to the previous prototype of websteps, the main architectural change we have here is that we are following the point of view of the probe and the test helper is much more dumb. Basically, the probe will choose which redirection to follow and ask the test helper every time it discovers a new URL to measure it w/o redirections. Reference issue: https://github.com/ooni/probe/issues/1733
363 lines
11 KiB
Go
363 lines
11 KiB
Go
package engine
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/dash"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/dnscheck"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/example"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/fbmessenger"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/hhfm"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/hirl"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/httphostheader"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/ndt7"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/psiphon"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/riseupvpn"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/run"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/signal"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/sniblocking"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/stunreachability"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/telegram"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/tlstool"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/tor"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/torsf"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/urlgetter"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/webconnectivity"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/webstepsx"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/experiment/whatsapp"
|
|
)
|
|
|
|
var experimentsByName = map[string]func(*Session) *ExperimentBuilder{
|
|
"dash": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, dash.NewExperimentMeasurer(
|
|
*config.(*dash.Config),
|
|
))
|
|
},
|
|
config: &dash.Config{},
|
|
interruptible: true,
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"dnscheck": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, dnscheck.NewExperimentMeasurer(
|
|
*config.(*dnscheck.Config),
|
|
))
|
|
},
|
|
config: &dnscheck.Config{},
|
|
inputPolicy: InputStrictlyRequired,
|
|
}
|
|
},
|
|
|
|
"example": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, example.NewExperimentMeasurer(
|
|
*config.(*example.Config), "example",
|
|
))
|
|
},
|
|
config: &example.Config{
|
|
Message: "Good day from the example experiment!",
|
|
SleepTime: int64(time.Second),
|
|
},
|
|
interruptible: true,
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"example_with_input": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, example.NewExperimentMeasurer(
|
|
*config.(*example.Config), "example_with_input",
|
|
))
|
|
},
|
|
config: &example.Config{
|
|
Message: "Good day from the example with input experiment!",
|
|
SleepTime: int64(time.Second),
|
|
},
|
|
interruptible: true,
|
|
inputPolicy: InputStrictlyRequired,
|
|
}
|
|
},
|
|
|
|
// TODO(bassosimone): when we can set experiment options using the JSON
|
|
// we need to get rid of all these multiple experiments.
|
|
//
|
|
// See https://github.com/ooni/probe-engine/issues/413
|
|
"example_with_input_non_interruptible": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, example.NewExperimentMeasurer(
|
|
*config.(*example.Config), "example_with_input_non_interruptible",
|
|
))
|
|
},
|
|
config: &example.Config{
|
|
Message: "Good day from the example with input experiment!",
|
|
SleepTime: int64(time.Second),
|
|
},
|
|
interruptible: false,
|
|
inputPolicy: InputStrictlyRequired,
|
|
}
|
|
},
|
|
|
|
"example_with_failure": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, example.NewExperimentMeasurer(
|
|
*config.(*example.Config), "example_with_failure",
|
|
))
|
|
},
|
|
config: &example.Config{
|
|
Message: "Good day from the example with failure experiment!",
|
|
ReturnError: true,
|
|
SleepTime: int64(time.Second),
|
|
},
|
|
interruptible: true,
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"facebook_messenger": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, fbmessenger.NewExperimentMeasurer(
|
|
*config.(*fbmessenger.Config),
|
|
))
|
|
},
|
|
config: &fbmessenger.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"http_header_field_manipulation": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, hhfm.NewExperimentMeasurer(
|
|
*config.(*hhfm.Config),
|
|
))
|
|
},
|
|
config: &hhfm.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"http_host_header": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, httphostheader.NewExperimentMeasurer(
|
|
*config.(*httphostheader.Config),
|
|
))
|
|
},
|
|
config: &httphostheader.Config{},
|
|
inputPolicy: InputOrQueryBackend,
|
|
}
|
|
},
|
|
|
|
"http_invalid_request_line": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, hirl.NewExperimentMeasurer(
|
|
*config.(*hirl.Config),
|
|
))
|
|
},
|
|
config: &hirl.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"ndt": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, ndt7.NewExperimentMeasurer(
|
|
*config.(*ndt7.Config),
|
|
))
|
|
},
|
|
config: &ndt7.Config{},
|
|
interruptible: true,
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"psiphon": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, psiphon.NewExperimentMeasurer(
|
|
*config.(*psiphon.Config),
|
|
))
|
|
},
|
|
config: &psiphon.Config{},
|
|
inputPolicy: InputOptional,
|
|
}
|
|
},
|
|
|
|
"riseupvpn": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, riseupvpn.NewExperimentMeasurer(
|
|
*config.(*riseupvpn.Config),
|
|
))
|
|
},
|
|
config: &riseupvpn.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"run": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, run.NewExperimentMeasurer(
|
|
*config.(*run.Config),
|
|
))
|
|
},
|
|
config: &run.Config{},
|
|
inputPolicy: InputStrictlyRequired,
|
|
}
|
|
},
|
|
|
|
"signal": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, signal.NewExperimentMeasurer(
|
|
*config.(*signal.Config),
|
|
))
|
|
},
|
|
config: &signal.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"sni_blocking": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, sniblocking.NewExperimentMeasurer(
|
|
*config.(*sniblocking.Config),
|
|
))
|
|
},
|
|
config: &sniblocking.Config{},
|
|
inputPolicy: InputOrQueryBackend,
|
|
}
|
|
},
|
|
|
|
"stunreachability": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, stunreachability.NewExperimentMeasurer(
|
|
*config.(*stunreachability.Config),
|
|
))
|
|
},
|
|
config: &stunreachability.Config{},
|
|
inputPolicy: InputOptional,
|
|
}
|
|
},
|
|
|
|
"telegram": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, telegram.NewExperimentMeasurer(
|
|
*config.(*telegram.Config),
|
|
))
|
|
},
|
|
config: &telegram.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"tlstool": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, tlstool.NewExperimentMeasurer(
|
|
*config.(*tlstool.Config),
|
|
))
|
|
},
|
|
config: &tlstool.Config{},
|
|
inputPolicy: InputOrQueryBackend,
|
|
}
|
|
},
|
|
|
|
"tor": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, tor.NewExperimentMeasurer(
|
|
*config.(*tor.Config),
|
|
))
|
|
},
|
|
config: &tor.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"torsf": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, torsf.NewExperimentMeasurer(
|
|
*config.(*torsf.Config),
|
|
))
|
|
},
|
|
config: &torsf.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
|
|
"urlgetter": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, urlgetter.NewExperimentMeasurer(
|
|
*config.(*urlgetter.Config),
|
|
))
|
|
},
|
|
config: &urlgetter.Config{},
|
|
inputPolicy: InputStrictlyRequired,
|
|
}
|
|
},
|
|
|
|
"web_connectivity": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, webconnectivity.NewExperimentMeasurer(
|
|
*config.(*webconnectivity.Config),
|
|
))
|
|
},
|
|
config: &webconnectivity.Config{},
|
|
inputPolicy: InputOrQueryBackend,
|
|
}
|
|
},
|
|
|
|
"websteps": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, webstepsx.NewExperimentMeasurer(
|
|
*config.(*webstepsx.Config),
|
|
))
|
|
},
|
|
config: &webstepsx.Config{},
|
|
inputPolicy: InputOrQueryBackend,
|
|
}
|
|
},
|
|
|
|
"whatsapp": func(session *Session) *ExperimentBuilder {
|
|
return &ExperimentBuilder{
|
|
build: func(config interface{}) *Experiment {
|
|
return NewExperiment(session, whatsapp.NewExperimentMeasurer(
|
|
*config.(*whatsapp.Config),
|
|
))
|
|
},
|
|
config: &whatsapp.Config{},
|
|
inputPolicy: InputNone,
|
|
}
|
|
},
|
|
}
|
|
|
|
// AllExperiments returns the name of all experiments
|
|
func AllExperiments() []string {
|
|
var names []string
|
|
for key := range experimentsByName {
|
|
names = append(names, key)
|
|
}
|
|
return names
|
|
}
|