signal

Documentation

Overview

Package signal contains the Signal network experiment.

See https://github.com/ooni/spec/blob/master/nettests/ts-029-signal.md.

Index

• func NewExperimentMeasurer(config Config) model.ExperimentMeasurer
• type Config
• type Measurer
  • func (m Measurer) ExperimentName() string
  • func (m Measurer) ExperimentVersion() string
  • func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error)
  • func (m Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error
• type SummaryKeys
• type TestKeys
  • func NewTestKeys() *TestKeys
  • func (tk *TestKeys) Update(v urlgetter.MultiOutput)

Functions

func NewExperimentMeasurer

func NewExperimentMeasurer(config Config) model.ExperimentMeasurer

NewExperimentMeasurer creates a new ExperimentMeasurer.

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 {
	// Config contains the experiment settings. If empty we
	// will be using default settings.
	Config Config

	// 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) GetSummaryKeys

func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error)

GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys.

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.

Note that this structure is part of the ABI contract with ooniprobe therefore we should be careful when changing it.

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) Update

func (tk *TestKeys) Update(v urlgetter.MultiOutput)

Update updates the TestKeys using the given MultiOutput result.