testutils

Documentation

Index

• Constants
• func ObjectsMap(objects ...ast.Object) *orderedmap.Map[string, ast.Object]
• func TrimSpacesDiffComparator(t *testing.T, expectedContent []byte, gotContent []byte, filename string)
• type FileComparator
• type GoldenFilesTestSuite
  • func (x *GoldenFilesTestSuite[GoldenFileType]) Run(t *testing.T, f func(tc *Test[GoldenFileType]))
• type Test
  • func (t *Test[GoldenFileType]) OpenInput(inputFile string) io.Reader
  • func (t *Test[GoldenFileType]) ReadInput(inputFile string) []byte
  • func (t *Test[GoldenFileType]) UnmarshalJSONInput(filename string) GoldenFileType
  • func (t *Test[GoldenFileType]) WriteFile(f *codejen.File)
  • func (t *Test[GoldenFileType]) WriteFiles(files codejen.Files)
  • func (t *Test[GoldenFileType]) WriteJSON(filename string, input any)

Constants

const BuildersContextInputFile = "builders_context.json"

const GeneratorOutputFile = "ir.json"

const RawTypesIRInputFile = "ir.json"

Functions

func ObjectsMap

func ObjectsMap(objects ...ast.Object) *orderedmap.Map[string, ast.Object]

func TrimSpacesDiffComparator

func TrimSpacesDiffComparator(t *testing.T, expectedContent []byte, gotContent []byte, filename string)

TrimSpacesDiffComparator compares the content of two files after trimming leading and trailing spaces.

Types

type FileComparator

type FileComparator func(t *testing.T, expectedContent []byte, gotContent []byte, filename string)

type GoldenFilesTestSuite

type GoldenFilesTestSuite[GoldenFileType any] struct {
	// Run the test suite on this directory.
	TestDataRoot string

	// Name is a unique name for this test. The golden files for this test are
	// expected to live under `${TestDataRoot}/[test]/${Name}`.
	Name string

	// Skip is a map of tests to skip; the key is the test name; the value is the
	// skip message.
	Skip map[string]string

	// FileComparator is called to compare a golden file with its test-generated equivalent.
	// TrimSpacesDiffComparator is used if no comparator is provided.
	FileComparator FileComparator
}

A GoldenFilesTestSuite represents a test run that processes inputs from a given directory and compares results against "golden files". See the Test documentation for more details.

func (*GoldenFilesTestSuite[GoldenFileType]) Run

func (x *GoldenFilesTestSuite[GoldenFileType]) Run(t *testing.T, f func(tc *Test[GoldenFileType]))

Run runs tests defined in `x.TestDataRoot`.

type Test

type Test[GoldenFileType any] struct {
	// Allow Test to be used as a T.
	*testing.T

	// RootDir is the path of the current test directory.
	RootDir string

	// OutputDir is the path where golden files live for this test.
	OutputDir string
	// contains filtered or unexported fields
}

A Test represents a single test.

A Test embeds *testing.T and should be used to report errors.

When the test function has returned, output written with [Test.Write], [Test.Writer], Test.WriteFile and friends is checked against the expected output files.

If the output differs and $COG_UPDATE_GOLDEN is non-empty, the txtar file will be updated and written to disk with the actual output data replacing the out files.

func (*Test[GoldenFileType]) OpenInput

func (t *Test[GoldenFileType]) OpenInput(inputFile string) io.Reader

OpenInput opens the specified input file and returns an io.Reader to it.

func (*Test[GoldenFileType]) ReadInput

func (t *Test[GoldenFileType]) ReadInput(inputFile string) []byte

ReadInput reads the specified input file and its contents.

func (*Test[GoldenFileType]) UnmarshalJSONInput

func (t *Test[GoldenFileType]) UnmarshalJSONInput(filename string) GoldenFileType

UnmarshalJSONInput reads and unmarshals the specified input file.

func (*Test[GoldenFileType]) WriteFile

func (t *Test[GoldenFileType]) WriteFile(f *codejen.File)

WriteFile writes a codejen.File to the main output.

func (*Test[GoldenFileType]) WriteFiles

func (t *Test[GoldenFileType]) WriteFiles(files codejen.Files)

WriteFiles writes a list of codejen.File to the main output.

func (*Test[GoldenFileType]) WriteJSON

func (t *Test[GoldenFileType]) WriteJSON(filename string, input any)

WriteJSON marshals and writes the given input to `filename`.