common

Documentation

Overview

Package common contains helpers for interacting with the JavaScript runtime.

Index

• Constants
• func FieldName(t reflect.Type, f reflect.StructField) string
• func FreezeObject(rt *goja.Runtime, obj goja.Value) error
• func GetReader(data interface{}) (io.Reader, error)
• func IsInterruptError(err error) bool
• func MethodName(t reflect.Type, m reflect.Method) string
• func NewRandSource() goja.RandSource
• func RunWithPanicCatching(logger logrus.FieldLogger, rt *goja.Runtime, fn func() error) (err error)
• func Throw(rt *goja.Runtime, err error)
• func ToBytes(data interface{}) ([]byte, error)
• func ToString(data interface{}) (string, error)
• func UnwrapGojaInterruptedError(err error) error
• type FieldNameMapper
  • func (FieldNameMapper) FieldName(t reflect.Type, f reflect.StructField) string
  • func (FieldNameMapper) MethodName(t reflect.Type, m reflect.Method) string
• type InitContextError
  • func NewInitContextError(msg string) InitContextError
  • func (i InitContextError) Error() string
  • func (i InitContextError) String() string
• type InitEnvironment
  • func (ie *InitEnvironment) GetAbsFilePath(filename string) string
• type InterruptError
  • func (i *InterruptError) Error() string
  • func (i *InterruptError) ExitCode() errext.ExitCode

Constants

const AbortTest = "test aborted"

AbortTest is the reason emitted when a test script calls test.abort()

Functions

func FieldName

func FieldName(t reflect.Type, f reflect.StructField) string

FieldName Returns the JS name for an exported struct field. The name is snake_cased, with respect for certain common initialisms (URL, ID, HTTP, etc).

func FreezeObject

func FreezeObject(rt *goja.Runtime, obj goja.Value) error

FreezeObject replicates the JavaScript Object.freeze function.

func GetReader

func GetReader(data interface{}) (io.Reader, error)

GetReader tries to return an io.Reader value from an exported goja value.

func IsInterruptError

func IsInterruptError(err error) bool

IsInterruptError returns true if err is *InterruptError.

func MethodName

func MethodName(t reflect.Type, m reflect.Method) string

MethodName Returns the JS name for an exported method. The first letter of the method's name is lowercased, otherwise it is unaltered.

func NewRandSource

func NewRandSource() goja.RandSource

NewRandSource is copied from goja's source code: https://github.com/dop251/goja/blob/master/goja/main.go#L44 The returned RandSource is NOT safe for concurrent use: https://golang.org/pkg/math/rand/#NewSource

func RunWithPanicCatching

func RunWithPanicCatching(logger logrus.FieldLogger, rt *goja.Runtime, fn func() error) (err error)

RunWithPanicCatching catches panic and converts into an InterruptError error that should abort a script

func Throw

func Throw(rt *goja.Runtime, err error)

Throw a JS error; avoids re-wrapping GoErrors.

func ToBytes

func ToBytes(data interface{}) ([]byte, error)

ToBytes tries to return a byte slice from compatible types.

func ToString

func ToString(data interface{}) (string, error)

ToString tries to return a string from compatible types.

func UnwrapGojaInterruptedError

func UnwrapGojaInterruptedError(err error) error

UnwrapGojaInterruptedError returns the internal error handled by goja.

Types

type FieldNameMapper

type FieldNameMapper struct{}

FieldNameMapper for goja.Runtime.SetFieldNameMapper()

func (FieldNameMapper) FieldName

func (FieldNameMapper) FieldName(t reflect.Type, f reflect.StructField) string

FieldName is part of the goja.FieldNameMapper interface https://godoc.org/github.com/dop251/goja#FieldNameMapper

func (FieldNameMapper) MethodName

func (FieldNameMapper) MethodName(t reflect.Type, m reflect.Method) string

MethodName is part of the goja.FieldNameMapper interface https://godoc.org/github.com/dop251/goja#FieldNameMapper

type InitContextError

type InitContextError string

InitContextError is an error that happened during the a test init context

func NewInitContextError

func NewInitContextError(msg string) InitContextError

NewInitContextError returns a new InitContextError with the provided message

func (InitContextError) Error

func (i InitContextError) Error() string

func (InitContextError) String

func (i InitContextError) String() string

type InitEnvironment

type InitEnvironment struct {
	Logger      logrus.FieldLogger
	FileSystems map[string]afero.Fs
	CWD         *url.URL
	Registry    *metrics.Registry
}

InitEnvironment contains properties that can be accessed by Go code executed in the k6 init context. It can be accessed by calling common.GetInitEnv().

func (*InitEnvironment) GetAbsFilePath

func (ie *InitEnvironment) GetAbsFilePath(filename string) string

GetAbsFilePath should be used to access the FileSystems, since afero has a bug when opening files with relative paths - it caches them from the FS root, not the current working directory... So, if necessary, this method will transform any relative paths into absolute ones, using the CWD.

TODO: refactor? It was copied from https://github.com/k6io/k6/blob/c51095ad7304bdd1e82cdb33c91abc331533b886/js/initcontext.go#L211-L222

type InterruptError

type InterruptError struct {
	Reason string
}

InterruptError is an error that halts engine execution

func (*InterruptError) Error

func (i *InterruptError) Error() string

Error returns the reason of the interruption.

func (*InterruptError) ExitCode

func (i *InterruptError) ExitCode() errext.ExitCode

ExitCode returns the status code used when the k6 process exits.