label

Documentation

Overview

Package label contains types to manage labels for tests. Labels are treated as named values that are present or absent on a particular test.

The labels are reported through the test reporter, in the JSON output. There is currently no support for using labels to filter which tests to run, but it should be trivial to postprocess the test report using labels.

Index

• func RegisterChainLabel(l Chain)
• func RegisterRelayerLabel(l Relayer)
• type Chain
  • func (l Chain) IsKnown() bool
• type Relayer
  • func (l Relayer) IsKnown() bool
• type Test
  • func (l Test) IsKnown() bool

Functions

func RegisterChainLabel

func RegisterChainLabel(l Chain)

RegisterChainLabel is available for external packages that may import ibctest, to register any external chain implementations they may provide.

func RegisterRelayerLabel

func RegisterRelayerLabel(l Relayer)

RegisterRelayerLabel is available for external packages that may import ibctest, to register any external relayer implementations they may provide.

Types

type Chain

type Chain string

Chain is a label associated with a chain during tests. Chain values must be registered through RegisterChainLabel, typically inside init functions.

const (
	// Cosmos-based chains should include this label.
	Cosmos Chain = "cosmos"

	Gaia    Chain = "gaia"
	Osmosis Chain = "osmosis"
	Juno    Chain = "juno"
	Agoric  Chain = "agoric"

	Penumbra Chain = "penumbra"
)

func (Chain) IsKnown

func (l Chain) IsKnown() bool

type Relayer

type Relayer string

Relayer is a label associated with a relayer during tests. Relayer values must be registered through RegisterRelayerLabel, typically inside init functions.

const (
	Rly    Relayer = "rly"
	Hermes Relayer = "hermes"
)

func (Relayer) IsKnown

func (l Relayer) IsKnown() bool

type Test

type Test string

Test is a label associated with an individual test. All test labels are known at compile time.

const (
	Timeout          Test = "timeout"
	HeightTimeout    Test = "height_timeout"
	TimestampTimeout Test = "timestamp_timeout"
)

func (Test) IsKnown

func (l Test) IsKnown() bool