starlarktest

Documentation

Overview

Package starlarktest defines utilities for testing Starlark programs.

Clients can call LoadAssertModule to load a module that defines several functions useful for testing. See assert.star for its definition.

The assert.error function, which reports errors to the current Go testing.T, requires that clients call SetTest(thread, t) before use.

Index

• Variables
• func LoadAssertModule() (starlark.StringDict, error)
• func SetReporter(thread *starlark.Thread, r Reporter)
• type Reporter
  • func GetReporter(thread *starlark.Thread) Reporter

Variables

var DataFile = func(pkgdir, filename string) string {
	return filepath.Join(build.Default.GOPATH, "src/go.starlark.net", pkgdir, filename)
}

DataFile returns the effective filename of the specified test data resource. The function abstracts differences between 'go build', under which a test runs in its package directory, and Blaze, under which a test runs in the root of the tree.

Functions

func LoadAssertModule

func LoadAssertModule() (starlark.StringDict, error)

LoadAssertModule loads the assert module. It is concurrency-safe and idempotent.

func SetReporter

func SetReporter(thread *starlark.Thread, r Reporter)

SetReporter associates an error reporter (such as a testing.T in a Go test) with the Starlark thread so that Starlark programs may report errors to it.

Types

type Reporter

type Reporter interface {
	Error(args ...interface{})
}

A Reporter is a value to which errors may be reported. It is satisfied by *testing.T.

func GetReporter

func GetReporter(thread *starlark.Thread) Reporter

GetReporter returns the Starlark thread's error reporter. It must be preceded by a call to SetReporter.