Documentation
¶
Overview ¶
Package signal contains the Signal network experiment.
See https://github.com/ooni/spec/blob/master/nettests/ts-029-signal.md.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInputRequired indicates that no richer-input target was provided. ErrInputRequired = targetloading.ErrInputRequired // ErrInvalidInputType indicates that the richer-input target has the wrong type. ErrInvalidInputType = targetloading.ErrInvalidInputType )
Functions ¶
func NewExperimentMeasurer ¶
func NewExperimentMeasurer() model.ExperimentMeasurer
NewExperimentMeasurer creates a new ExperimentMeasurer.
func NewLoader ¶ added in v0.37.0
func NewLoader(loader *targetloading.Loader, gopts any) model.ExperimentTargetLoader
NewLoader constructs a new model.ExperimentTargetLoader instance.
This function PANICS if options is not an instance of *signal.Config.
Types ¶
type Config ¶
type Config struct {
// SignalCA is used to pass in a custom CA in testing
SignalCA string
}
Config contains the signal experiment config.
type Measurer ¶
type Measurer struct {
// Getter is an optional getter to be used for testing.
Getter urlgetter.MultiGetter
}
Measurer performs the measurement
func (Measurer) ExperimentName ¶
ExperimentName implements ExperimentMeasurer.ExperimentName
func (Measurer) ExperimentVersion ¶
ExperimentVersion implements ExperimentMeasurer.ExperimentVersion
type SummaryKeys ¶
type SummaryKeys struct {
SignalBackendStatus string `json:"signal_backend_status"`
SignalBackendFailure *string `json:"signal_backend_failure"`
IsAnomaly bool `json:"-"`
}
SummaryKeys contains summary keys for this experiment.
func (*SummaryKeys) Anomaly ¶ added in v0.28.0
func (tk *SummaryKeys) Anomaly() bool
Anomaly implements model.MeasurementSummaryKeys.
type Target ¶ added in v0.37.0
type Target struct {
// Config contains the configuration.
Config *Config
// URL is the input URL.
URL string
}
Target is a richer-input target that this experiment should measure.
func (*Target) Category ¶ added in v0.37.0
Category implements model.ExperimentTarget.
func (*Target) Country ¶ added in v0.37.0
Country implements model.ExperimentTarget.
func (*Target) Input ¶ added in v0.37.0
Input implements model.ExperimentTarget.
func (*Target) Options ¶ added in v0.37.0
Options implements model.ExperimentTarget.
func (*Target) String ¶ added in v0.37.0
String implements model.ExperimentTarget.
type TestKeys ¶
type TestKeys struct {
urlgetter.TestKeys
SignalBackendStatus string `json:"signal_backend_status"`
SignalBackendFailure *string `json:"signal_backend_failure"`
}
TestKeys contains signal test keys.
func (*TestKeys) MeasurementSummaryKeys ¶ added in v0.28.0
func (tk *TestKeys) MeasurementSummaryKeys() model.MeasurementSummaryKeys
MeasurementSummaryKeys implements model.MeasurementSummaryKeysProvider.
func (*TestKeys) Update ¶
func (tk *TestKeys) Update(v urlgetter.MultiOutput)
Update updates the TestKeys using the given MultiOutput result.