types_test

Documentation

Index

• type AssertEqualer
• type CodecEvaluator
• type ContractConfigTrackerEvaluator
• type ContractReaderTester
• type ContractTransmitterEvaluator
• type ErrorLogEvaluator
• type Evaluator
• type MedianProviderTester
• type OCR3CapabilityProviderTester
• type OCR3ContractTransmitterEvaluator
• type OffchainConfigDigesterEvaluator
• type PipelineEvaluator
• type PluginProviderTester
• type RelayerTester
• type ReportingPluginTester
• type TelemetryEvaluator
• type ValidationEvaluator

Types

type AssertEqualer

type AssertEqualer[T any] interface {
	AssertEqual(ctx context.Context, t *testing.T, other T)
}

AssertEqualer is a helper interface for testing types implementations must run all the methods asserting for equality with the other type and no error. Implementations should use parallel subcomponent testing eg t.Parallel() and t.Run("subcomponentX", func(t *testing.T) { ... })

type CodecEvaluator

type CodecEvaluator interface {
	types.Codec
	Evaluator[types.Codec]
}

CodecEvaluator is a helper interface for testing Codecs

type ContractConfigTrackerEvaluator

type ContractConfigTrackerEvaluator interface {
	libocr.ContractConfigTracker
	Evaluator[libocr.ContractConfigTracker]
}

ContractConfigTrackerEvaluator is a helper interface for testing ContractConfigTrackers

type ContractReaderTester

type ContractReaderTester interface {
	types.ContractReader
	Evaluator[types.ContractReader]
}

ContractReaderTester is a helper interface for testing ContractReaders

type ContractTransmitterEvaluator

type ContractTransmitterEvaluator interface {
	libocr.ContractTransmitter
	Evaluator[libocr.ContractTransmitter]
}

ContractTransmitterEvaluator is a helper interface for testing ContractTransmitters

type ErrorLogEvaluator

type ErrorLogEvaluator interface {
	core.ErrorLog
	Evaluator[core.ErrorLog]
}

ErrorLogEvaluator is a helper interface for testing ErrorLogs

type Evaluator

type Evaluator[T any] interface {
	Evaluate(ctx context.Context, other T) error
}

Evaluator is a helper interface for testing types implementations must run all the methods of the other type and 1. return on the first error encounter 2. return an error the first time that the result of an executed method does not match the expected result

type MedianProviderTester

type MedianProviderTester interface {
	types.MedianProvider
	Evaluator[types.MedianProvider]
	AssertEqualer[types.MedianProvider]
}

type OCR3CapabilityProviderTester

type OCR3CapabilityProviderTester interface {
	types.OCR3CapabilityProvider
	AssertEqualer[types.OCR3CapabilityProvider]
	Evaluator[types.OCR3CapabilityProvider]
}

type OCR3ContractTransmitterEvaluator

type OCR3ContractTransmitterEvaluator interface {
	ocr3types.ContractTransmitter[[]byte]
	Evaluator[ocr3types.ContractTransmitter[[]byte]]
}

OCR3ContractTransmitterEvaluator is a helper interface for testing OCR3 ContractTransmitters

type OffchainConfigDigesterEvaluator

type OffchainConfigDigesterEvaluator interface {
	libocr.OffchainConfigDigester
	Evaluator[libocr.OffchainConfigDigester]
}

OffchainConfigDigesterEvaluator is a helper interface for testing OffchainConfigDigesters

type PipelineEvaluator

type PipelineEvaluator interface {
	core.PipelineRunnerService
	Evaluator[core.PipelineRunnerService]
}

PipelineEvaluator is a helper interface for testing PipelineRunnerServices

type PluginProviderTester

type PluginProviderTester interface {
	types.PluginProvider
	AssertEqualer[types.PluginProvider]
	Evaluator[types.PluginProvider]
}

type RelayerTester

type RelayerTester interface {
	looptypes.PluginRelayer
	looptypes.Relayer
	// implements all the possible providers as a one-stop shop for testing
	looptypes.MercuryProvider
	looptypes.MedianProvider
	looptypes.CCIPExecProvider
	looptypes.CCIPCommitProvider
	looptypes.OCR3CapabilityProvider

	AssertEqualer[looptypes.Relayer]
}

type ReportingPluginTester

type ReportingPluginTester interface {
	libocr.ReportingPlugin
	AssertEqualer[libocr.ReportingPlugin]
}

type TelemetryEvaluator

type TelemetryEvaluator interface {
	core.TelemetryClient
	Evaluator[core.TelemetryClient]
}

TelemetryEvaluator is a helper interface for testing TelemetryClients

type ValidationEvaluator

type ValidationEvaluator interface {
	core.ValidationService
	Evaluator[core.ValidationService]
}

ValidationEvaluator is a helper interface for testing ValidationService