3b029ee0d6
We use ExperimentOrchestraClient in several places to help us calling probe-services APIs. We need to call CheckIn because we want to use CheckIn in InputLoader. (We also want to remove the URLs API, but that is not something doable now, since the mobile app is still using this API via the wrappers at pkg/oonimkall.) Work part of https://github.com/ooni/probe/issues/1299.
85 lines
2.8 KiB
Go
85 lines
2.8 KiB
Go
package model
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
)
|
|
|
|
// ExperimentOrchestraClient is the experiment's view of
|
|
// a client for querying the OONI orchestra API.
|
|
type ExperimentOrchestraClient interface {
|
|
// CheckIn calls the check-in API.
|
|
CheckIn(ctx context.Context, config CheckInConfig) (*CheckInInfo, error)
|
|
|
|
// FetchPsiphonConfig returns psiphon config from the API.
|
|
FetchPsiphonConfig(ctx context.Context) ([]byte, error)
|
|
|
|
// FetchTorTargets returns tor targets from the API.
|
|
FetchTorTargets(ctx context.Context, cc string) (map[string]TorTarget, error)
|
|
|
|
// FetchURLList returns URLs from the API.
|
|
// This method is deprecated and will be removed soon.
|
|
FetchURLList(ctx context.Context, config URLListConfig) ([]URLInfo, error)
|
|
}
|
|
|
|
// ExperimentSession is the experiment's view of a session.
|
|
type ExperimentSession interface {
|
|
ASNDatabasePath() string
|
|
GetTestHelpersByName(name string) ([]Service, bool)
|
|
DefaultHTTPClient() *http.Client
|
|
Logger() Logger
|
|
NewOrchestraClient(ctx context.Context) (ExperimentOrchestraClient, error)
|
|
ProbeCC() string
|
|
ResolverIP() string
|
|
TempDir() string
|
|
TorArgs() []string
|
|
TorBinary() string
|
|
UserAgent() string
|
|
}
|
|
|
|
// ExperimentCallbacks contains experiment event-handling callbacks
|
|
type ExperimentCallbacks interface {
|
|
// OnProgress provides information about an experiment progress.
|
|
OnProgress(percentage float64, message string)
|
|
}
|
|
|
|
// PrinterCallbacks is the default event handler
|
|
type PrinterCallbacks struct {
|
|
Logger
|
|
}
|
|
|
|
// NewPrinterCallbacks returns a new default callback handler
|
|
func NewPrinterCallbacks(logger Logger) PrinterCallbacks {
|
|
return PrinterCallbacks{Logger: logger}
|
|
}
|
|
|
|
// OnProgress provides information about an experiment progress.
|
|
func (d PrinterCallbacks) OnProgress(percentage float64, message string) {
|
|
d.Logger.Infof("[%5.1f%%] %s", percentage*100, message)
|
|
}
|
|
|
|
// ExperimentMeasurer is the interface that allows to run a
|
|
// measurement for a specific experiment.
|
|
type ExperimentMeasurer interface {
|
|
// ExperimentName returns the experiment name.
|
|
ExperimentName() string
|
|
|
|
// ExperimentVersion returns the experiment version.
|
|
ExperimentVersion() string
|
|
|
|
// Run runs the experiment with the specified context, session,
|
|
// measurement, and experiment calbacks. This method should only
|
|
// return an error in case the experiment could not run (e.g.,
|
|
// a required input is missing). Otherwise, the code should just
|
|
// set the relevant OONI error inside of the measurmeent and
|
|
// return nil. This is important because the caller may not submit
|
|
// the measurement if this method returns an error.
|
|
Run(
|
|
ctx context.Context, sess ExperimentSession,
|
|
measurement *Measurement, callbacks ExperimentCallbacks,
|
|
) error
|
|
|
|
// GetSummaryKeys returns summary keys expected by ooni/probe-cli.
|
|
GetSummaryKeys(*Measurement) (interface{}, error)
|
|
}
|