273b70bacc
## Checklist - [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md) - [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885 - [x] related ooni/spec pull request: N/A Location of the issue tracker: https://github.com/ooni/probe ## Description This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package. The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity. An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other. This is what I want to move in `internal/model`: - [x] most important interfaces from `internal/netxlite` - [x] everything that was previously part of `internal/engine/model` - [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage
96 lines
2.8 KiB
Go
96 lines
2.8 KiB
Go
// Package example contains a simple example experiment.
|
|
//
|
|
// You could use this code to boostrap the implementation of
|
|
// a new experiment that you are working on.
|
|
package example
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"time"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
)
|
|
|
|
const testVersion = "0.1.0"
|
|
|
|
// Config contains the experiment config.
|
|
//
|
|
// This contains all the settings that user can set to modify the behaviour
|
|
// of this experiment. By tagging these variables with `ooni:"..."`, we allow
|
|
// miniooni's -O flag to find them and set them.
|
|
type Config struct {
|
|
Message string `ooni:"Message to emit at test completion"`
|
|
ReturnError bool `ooni:"Toogle to return a mocked error"`
|
|
SleepTime int64 `ooni:"Amount of time to sleep for"`
|
|
}
|
|
|
|
// TestKeys contains the experiment's result.
|
|
//
|
|
// This is what will end up into the Measurement.TestKeys field
|
|
// when you run this experiment.
|
|
//
|
|
// In other words, the variables in this struct will be
|
|
// the specific results of this experiment.
|
|
type TestKeys struct {
|
|
Success bool `json:"success"`
|
|
}
|
|
|
|
// Measurer performs the measurement.
|
|
type Measurer struct {
|
|
config Config
|
|
testName string
|
|
}
|
|
|
|
// ExperimentName implements model.ExperimentMeasurer.ExperimentName.
|
|
func (m Measurer) ExperimentName() string {
|
|
return m.testName
|
|
}
|
|
|
|
// ExperimentVersion implements model.ExperimentMeasurer.ExperimentVersion.
|
|
func (m Measurer) ExperimentVersion() string {
|
|
return testVersion
|
|
}
|
|
|
|
// ErrFailure is the error returned when you set the
|
|
// config.ReturnError field to true.
|
|
var ErrFailure = errors.New("mocked error")
|
|
|
|
// Run implements model.ExperimentMeasurer.Run.
|
|
func (m Measurer) Run(
|
|
ctx context.Context, sess model.ExperimentSession,
|
|
measurement *model.Measurement, callbacks model.ExperimentCallbacks,
|
|
) error {
|
|
var err error
|
|
if m.config.ReturnError {
|
|
err = ErrFailure
|
|
}
|
|
testkeys := &TestKeys{Success: err == nil}
|
|
measurement.TestKeys = testkeys
|
|
sess.Logger().Warnf("%s", "Follow the white rabbit.")
|
|
ctx, cancel := context.WithTimeout(ctx, time.Duration(m.config.SleepTime))
|
|
defer cancel()
|
|
<-ctx.Done()
|
|
sess.Logger().Infof("%s", "Knock, knock, Neo.")
|
|
callbacks.OnProgress(1.0, m.config.Message)
|
|
return err
|
|
}
|
|
|
|
// NewExperimentMeasurer creates a new ExperimentMeasurer.
|
|
func NewExperimentMeasurer(config Config, testName string) model.ExperimentMeasurer {
|
|
return Measurer{config: config, testName: testName}
|
|
}
|
|
|
|
// SummaryKeys contains summary keys for this experiment.
|
|
//
|
|
// Note that this structure is part of the ABI contract with probe-cli
|
|
// therefore we should be careful when changing it.
|
|
type SummaryKeys struct {
|
|
IsAnomaly bool `json:"-"`
|
|
}
|
|
|
|
// GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys.
|
|
func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error) {
|
|
return SummaryKeys{IsAnomaly: false}, nil
|
|
}
|