shared

README

Shared Vars

Shared provides space and contract to share variables between test helpers and libraries.

Documentation

Overview

Package shared provides space to share variables.

Index

• func VarToContext(ctx context.Context, key string, value interface{}) context.Context
• func VarsFromContext(ctx context.Context) map[string]interface{}
• type Vars
  • func (v *Vars) Fork(ctx context.Context) (context.Context, *Vars)
  • func (v *Vars) Get(s string) (interface{}, bool)
  • func (v *Vars) GetAll() map[string]interface{}
  • func (v *Vars) IsVar(s string) bool
  • func (v *Vars) OnSet(f func(key string, val interface{}))
  • func (v *Vars) Reset()
  • func (v *Vars) Set(key string, val interface{})

Functions

func VarToContext

func VarToContext(ctx context.Context, key string, value interface{}) context.Context

VarToContext adds variable to context.

func VarsFromContext

func VarsFromContext(ctx context.Context) map[string]interface{}

VarsFromContext returns variables from context.

Types

type Vars

type Vars struct {
	// VarPrefix determines which cell values should be collected as vars and replaced with values in usages.
	// Default is '$', e.g. $id1 would be treated as variable.
	VarPrefix string
	// contains filtered or unexported fields
}

Vars keeps values of named variables.

func (*Vars) Fork

func (v *Vars) Fork(ctx context.Context) (context.Context, *Vars)

Fork instruments context with a copy of Vars or returns Vars that are already in context.

func (*Vars) Get

func (v *Vars) Get(s string) (interface{}, bool)

Get returns variable value if is exists.

func (*Vars) GetAll

func (v *Vars) GetAll() map[string]interface{}

GetAll returns all variables with values.

func (*Vars) IsVar

func (v *Vars) IsVar(s string) bool

IsVar checks if string looks like a variable name.

func (*Vars) OnSet

func (v *Vars) OnSet(f func(key string, val interface{}))

OnSet adds callback to invoke when variable is set.

All callbacks are removed on Reset.

func (*Vars) Reset

func (v *Vars) Reset()

Reset removes all variables.

func (*Vars) Set

func (v *Vars) Set(key string, val interface{})

Set sets variable by name.