utils

Documentation

Index

• Variables
• func BuildGossamer() (err error)
• func GenerateGenesisAuths(t *testing.T, numAuths int) (genesisPath string)
• func NewTestWriter(t *testing.T) (writer io.Writer)
• type Framework
  • func InitFramework(ctx context.Context, t *testing.T, qtyNodes int, tomlConfig cfg.Config) (*Framework, error)
  • func NewFramework() (framework *Framework)
  • func (fw *Framework) CallRPC(ctx context.Context, idx int, method, params string) (respJSON interface{}, err error)
  • func (fw *Framework) CheckEqual(c1, c2 int, field string) bool
  • func (fw *Framework) GetRecord(callIdx int) interface{}
  • func (fw *Framework) PrintDB()
  • func (fw *Framework) StartNodes(ctx context.Context, t *testing.T) (runtimeErrors []<-chan error, startErr error)
• type TestWriter
  • func (tw *TestWriter) Write(p []byte) (n int, err error)

Variables

var (
	// MODE is the value for the environnent variable MODE.
	MODE = os.Getenv("MODE")

	// PORT is the value for the environnent variable PORT.
	PORT = os.Getenv("PORT")

	// LOGLEVEL is the value for the environnent variable LOGLEVEL.
	LOGLEVEL = os.Getenv("LOG")
)

var Logger = log.NewFromGlobal(log.AddContext("pkg", "test/utils"))

Logger is the utils package local logger.

Functions

func BuildGossamer

func BuildGossamer() (err error)

BuildGossamer finds the project root path and builds the Gossamer binary to ./bin/gossamer at the project root path.

func GenerateGenesisAuths

func GenerateGenesisAuths(t *testing.T, numAuths int) (genesisPath string)

GenerateGenesisAuths generates a genesis file with numAuths authorities and returns the file path to the genesis file. The genesis file is automatically removed when the test ends.

func NewTestWriter

func NewTestWriter(t *testing.T) (writer io.Writer)

NewTestWriter creates a new writer which uses the Go test logger to write out.

Types

type Framework

type Framework struct {
	// contains filtered or unexported fields
}

Framework struct to hold references to framework data

func InitFramework

func InitFramework(ctx context.Context, t *testing.T, qtyNodes int,
	tomlConfig cfg.Config) (*Framework, error)

InitFramework creates given quantity of nodes

func NewFramework

func NewFramework() (framework *Framework)

NewFramework creates a new framework.

func (*Framework) CallRPC

func (fw *Framework) CallRPC(ctx context.Context, idx int, method, params string) (
	respJSON interface{}, err error)

CallRPC call RPC method with given params for node at idx

func (*Framework) CheckEqual

func (fw *Framework) CheckEqual(c1, c2 int, field string) bool

CheckEqual returns true if the field values are equal

func (*Framework) GetRecord

func (fw *Framework) GetRecord(callIdx int) interface{}

GetRecord return value of record for node and call index

func (*Framework) PrintDB

func (fw *Framework) PrintDB()

PrintDB prints all records for given node

func (*Framework) StartNodes

func (fw *Framework) StartNodes(ctx context.Context, t *testing.T) (
	runtimeErrors []<-chan error, startErr error)

StartNodes calls RestartGossamer for all nodes

type TestWriter

type TestWriter struct {
	// contains filtered or unexported fields
}

TestWriter is a writer implementing `io.Writer` using the Go test logger `t.Log()`.

func (*TestWriter) Write

func (tw *TestWriter) Write(p []byte) (n int, err error)