tests

README

GX testing

Files with a .gx extension are used to test the GX compiler and the XLA backend.

GX tests implement the following testing procedures. First, all the GX files are parsed and compiled into the GX intermediate representation (gir). If there are compiling errors, then errors specified in the comments are removed from the set of reported errors. If there are remaining errors, then the test has failed and stops. The remaining errors are reported as test errors. If all errors have been removed, then the test has succeeded.

If the compiler reported no error then, each exported functions with a Test suffix is interpreted into a XLA compute graph. The compute graph is then executed. The graph output is converted into an output string. This output string is compared to the Want: section in the comments. The test fails if an error occurs while building or running the XLA graph or if the string in the comment does not match the output of the graph.

Note that test functions with expected errors cannot be mixed with functions expected to be executed with no errors.

Documentation

Overview

Package tests embed all GX test files.

Index

• Variables
• func CoreBuilder() *builder.Builder
• func Importer() importers.Importer
• func StdlibBuilder(stdlibImpl *impl.Stdlib) *builder.Builder

Variables

var AlgebraicCore = []string{
	"testfiles/core",
}

AlgebraicCore is a set of paths only testing core algebraic operations.

var All = appendAll(Language, Stdlib)

All includes all paths.

var Errors = []string{
	"errors/einsum",
	"errors/ellipsis",
	"errors/meta",
	"errors/process",
	"errors/beforefunc",

	"errors/redefined",
	"errors/slices",
}

Errors is the set of paths testing for compiler errors.

var FS embed.FS

FS is the filesystem containing all GX test files.

var Language = appendAll(LanguageCore, []string{
	"testfiles/einsum",
	"testfiles/trace",
})

Language is a set of paths testing the GX language.

var LanguageCore = appendAll(AlgebraicCore, []string{
	"testfiles/forloops",
	"testfiles/generics",
	"testfiles/ifstmts",
	"testfiles/imports",
	"testfiles/slices",
})

LanguageCore is a set of paths testing the GX core language without built-in like einsum.

var Stdlib = []string{
	"testfiles/bfloat16",
	"testfiles/grad",
	"testfiles/stdlib",
	"testfiles/nn",
	"testfiles/ellipsis",
	"testfiles/compeval",
}

Stdlib is a set of path testing the standard library or where a standard library implementation is required.

var Units = []string{
	"testfiles/units",
}

Units tests each file in the folder as its own package. It is used to facilitate debugging by isolating GX code for each file/package. Tests by default should be added to folders defined above. Only copy a test here to facilitate debugging.

Functions

func CoreBuilder

func CoreBuilder() *builder.Builder

CoreBuilder returns the builder to run core tests.

func Importer

func Importer() importers.Importer

Importer returns the importer for GX tests.

func StdlibBuilder

func StdlibBuilder(stdlibImpl *impl.Stdlib) *builder.Builder

StdlibBuilder returns the builder to run tests with the standard library.