js

Documentation

Overview

Package js is the JavaScript implementation of the lib.Runner and relative concepts for executing concurrent-safe JavaScript code.

Index

• type ActiveVU
  • func (u *ActiveVU) RunOnce() error
• type Bundle
  • func NewBundle(piState *lib.TestPreInitState, src *loader.SourceData, ...) (*Bundle, error)
  • func NewBundleFromArchive(piState *lib.TestPreInitState, arc *lib.Archive) (*Bundle, error)
  • func (b *Bundle) Instantiate(ctx context.Context, vuID uint64) (*BundleInstance, error)
• type BundleInstance
• type Runner
  • func New(piState *lib.TestPreInitState, src *loader.SourceData, ...) (*Runner, error)
  • func NewFromArchive(piState *lib.TestPreInitState, arc *lib.Archive) (*Runner, error)
  • func NewFromBundle(piState *lib.TestPreInitState, b *Bundle) (*Runner, error)
  • func (r *Runner) GetOptions() lib.Options
  • func (r *Runner) GetSetupData() []byte
  • func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[string]io.Reader, error)
  • func (r *Runner) IsExecutable(name string) bool
  • func (r *Runner) MakeArchive() *lib.Archive
  • func (r *Runner) NewVU(ctx context.Context, idLocal, idGlobal uint64, ...) (lib.InitializedVU, error)
  • func (r *Runner) SetOptions(opts lib.Options) error
  • func (r *Runner) SetSetupData(data []byte)
  • func (r *Runner) Setup(ctx context.Context, out chan<- metrics.SampleContainer) error
  • func (r *Runner) Teardown(ctx context.Context, out chan<- metrics.SampleContainer) error
• type VU
  • func (u *VU) Activate(params *lib.VUActivationParams) lib.ActiveVU
  • func (u *VU) GetID() uint64

Types

type ActiveVU

type ActiveVU struct {
	*VU
	*lib.VUActivationParams
	// contains filtered or unexported fields
}

ActiveVU holds a VU and its activation parameters

func (*ActiveVU) RunOnce

func (u *ActiveVU) RunOnce() error

RunOnce runs the configured Exec function once.

type Bundle

type Bundle struct {
	Options lib.Options

	CompatibilityMode lib.CompatibilityMode // parsed value

	ModuleResolver *modules.ModuleResolver
	// contains filtered or unexported fields
}

A Bundle is a self-contained bundle of scripts and resources. You can use this to produce identical BundleInstance objects.

func NewBundle

func NewBundle(
	piState *lib.TestPreInitState, src *loader.SourceData, filesystems map[string]fsext.Fs,
) (*Bundle, error)

NewBundle creates a new bundle from a source file and a filesystem.

func NewBundleFromArchive

func NewBundleFromArchive(piState *lib.TestPreInitState, arc *lib.Archive) (*Bundle, error)

NewBundleFromArchive creates a new bundle from an lib.Archive.

func (*Bundle) Instantiate

func (b *Bundle) Instantiate(ctx context.Context, vuID uint64) (*BundleInstance, error)

Instantiate creates a new runtime from this bundle.

type BundleInstance

type BundleInstance struct {
	Runtime *sobek.Runtime
	// contains filtered or unexported fields
}

A BundleInstance is a self-contained instance of a Bundle.

type Runner

type Runner struct {
	Bundle *Bundle

	BaseDialer net.Dialer
	Resolver   netext.Resolver
	// TODO: Remove ActualResolver, it's a hack to simplify mocking in tests.
	ActualResolver netext.MultiResolver
	RPSLimit       *rate.Limiter
	RunTags        *metrics.TagSet

	BufferPool *lib.BufferPool
	// contains filtered or unexported fields
}

Runner implements lib.Runner and is used to run js tests

func New

func New(piState *lib.TestPreInitState, src *loader.SourceData, filesystems map[string]fsext.Fs) (*Runner, error)

New returns a new Runner for the provided source

func NewFromArchive

func NewFromArchive(piState *lib.TestPreInitState, arc *lib.Archive) (*Runner, error)

NewFromArchive returns a new Runner from the source in the provided archive

func NewFromBundle

func NewFromBundle(piState *lib.TestPreInitState, b *Bundle) (*Runner, error)

NewFromBundle returns a new Runner from the provided Bundle

func (*Runner) GetOptions

func (r *Runner) GetOptions() lib.Options

GetOptions returns the currently calculated lib.Options for the given Runner.

func (*Runner) GetSetupData

func (r *Runner) GetSetupData() []byte

GetSetupData returns the setup data as json if Setup() was specified and executed, nil otherwise

func (*Runner) HandleSummary

func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[string]io.Reader, error)

HandleSummary calls the specified summary callback, if supplied.

func (*Runner) IsExecutable

func (r *Runner) IsExecutable(name string) bool

IsExecutable returns whether the given name is an exported and executable function in the script.

func (*Runner) MakeArchive

func (r *Runner) MakeArchive() *lib.Archive

MakeArchive creates an Archive of the runner. There should be a corresponding NewFromArchive() function that will restore the runner from the archive.

func (*Runner) NewVU

func (r *Runner) NewVU(
	ctx context.Context, idLocal, idGlobal uint64, samplesOut chan<- metrics.SampleContainer,
) (lib.InitializedVU, error)

NewVU returns a new initialized VU.

func (*Runner) SetOptions

func (r *Runner) SetOptions(opts lib.Options) error

SetOptions sets the test Options to the provided data and makes necessary changes to the Runner.

func (*Runner) SetSetupData

func (r *Runner) SetSetupData(data []byte)

SetSetupData saves the externally supplied setup data as json in the runner, so it can be used in VUs

func (*Runner) Setup

func (r *Runner) Setup(ctx context.Context, out chan<- metrics.SampleContainer) error

Setup runs the setup function if there is one and sets the setupData to the returned value

func (*Runner) Teardown

func (r *Runner) Teardown(ctx context.Context, out chan<- metrics.SampleContainer) error

Teardown runs the teardown function if there is one.

type VU

type VU struct {
	BundleInstance

	Runner    *Runner
	Transport *http.Transport
	Dialer    *netext.Dialer
	CookieJar *cookiejar.Jar
	TLSConfig *tls.Config
	ID        uint64 // local to the current instance
	IDGlobal  uint64 // global across all instances

	Console    *console
	BufferPool *lib.BufferPool

	Samples chan<- metrics.SampleContainer
	// contains filtered or unexported fields
}

VU implements the lib.VU interface for the js Runner.

func (*VU) Activate

func (u *VU) Activate(params *lib.VUActivationParams) lib.ActiveVU

Activate the VU so it will be able to run code.

func (*VU) GetID

func (u *VU) GetID() uint64

GetID returns the unique VU ID.