signal

package
v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2026 License: GPL-3.0 Imports: 8 Imported by: 1

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

View Source
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

func (m Measurer) ExperimentName() string

ExperimentName implements ExperimentMeasurer.ExperimentName

func (Measurer) ExperimentVersion

func (m Measurer) ExperimentVersion() string

ExperimentVersion implements ExperimentMeasurer.ExperimentVersion

func (Measurer) Run

func (m Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error

Run implements ExperimentMeasurer.Run

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

func (t *Target) Category() string

Category implements model.ExperimentTarget.

func (*Target) Country added in v0.37.0

func (t *Target) Country() string

Country implements model.ExperimentTarget.

func (*Target) Input added in v0.37.0

func (t *Target) Input() string

Input implements model.ExperimentTarget.

func (*Target) Options added in v0.37.0

func (t *Target) Options() []string

Options implements model.ExperimentTarget.

func (*Target) String added in v0.37.0

func (t *Target) String() string

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 NewTestKeys

func NewTestKeys() *TestKeys

NewTestKeys creates new signal TestKeys.

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL