testutil

Documentation

Overview

Package testutil provides support functions for unit testing implementations of the kcd.ReadWriter interface.

Index

• Constants
• Variables
• func Run(ctx context.Context, db kcd.ReadWriter) []error
• type TestError
  • func (t *TestError) Error() string

Constants

const (
	Revision  = "1234"
	Corpus    = "ratzafratza"
	FormatKey = "λ"
	Language  = "go"
)

These constants are the expected values used by the Run tests.

Variables

var UnitType *apb.CompilationUnit

UnitType is the type of compilation message stored in the database by the tests in Run.

Functions

func Run

func Run(ctx context.Context, db kcd.ReadWriter) []error

Run applies a sequence of correctness tests to db, which must be initially empty, and returns any errors that occur. If db passes all the tests, the return value is nil; otherwise each error is of concrete type *TestError.

Types

type TestError

type TestError struct {
	Desc   string // Description of the test that failed (human-readable)
	Method string // The name of the method that returned an error
	Err    error  // The underlying error returned by the method
}

TestError is the concrete type of errors returned by the Run function.

func (*TestError) Error

func (t *TestError) Error() string