datadriven

func ClearResults ¶

func ClearResults(path string) error

func RunTest ¶

func RunTest(t *testing.T, path string, f func(t *testing.T, d *TestData) string)

RunTest invokes a data-driven test. The test cases are contained in a separate test file and are dynamically loaded, parsed, and executed by this testing framework. By convention, test files are typically located in a sub-directory called "testdata". Each test file has the following format:

<command>[,<command>...] [arg | arg=val | arg=(val1, val2, ...)]...
<input to the command>
----
<expected results>

The command input can contain blank lines. However, by default, the expected results cannot contain blank lines. This alternate syntax allows the use of blank lines:

<command>[,<command>...] [arg | arg=val | arg=(val1, val2, ...)]...
<input to the command>
----
----
<expected results>

<more expected results>
----
----

To execute data-driven tests, pass the path of the test file as well as a function which can interpret and execute whatever commands are present in the test file. The framework invokes the function, passing it information about the test case in a TestData struct.

The function must returns the actual results of the case, which RunTest() compares with the expected results. If the two are not equal, the test is marked to fail.

Note that RunTest() creates a sub-instance of testing.T for each directive in the input file. It is thus unsafe/invalid to call e.g. Fatal() or Skip() on the parent testing.T from inside the callback function. Use the provided testing.T instance instead.

It is possible for a test to test for an "expected error" as follows:

• run the code to test
• if an error occurs, report the detail of the error as actual output.
• place the expected error details in the expected results in the input file.

It is also possible for a test to report an _unexpected_ test error by calling t.Error().

func RunTestAny ¶

func RunTestAny(t testing.TB, path string, f func(t testing.TB, d *TestData) string)

RunTestAny is like RunTest but works over a testing.TB.

func RunTestFromString ¶

func RunTestFromString(t *testing.T, input string, f func(t *testing.T, d *TestData) string)

RunTestFromString is a version of RunTest which takes the contents of a test directly.

func RunTestFromStringAny ¶

func RunTestFromStringAny(t testing.TB, input string, f func(t testing.TB, d *TestData) string)

RunTestFromStringAny is like RunTestFromString but works with a testing.TB.

func Verbose ¶

func Verbose() bool

Verbose returns true iff -datadriven-quiet was not passed.

func Walk ¶

func Walk(t *testing.T, path string, f func(t *testing.T, path string))

Walk goes through all the files in a subdirectory, creating subtests to match the file hierarchy; for each "leaf" file, the given function is called.

This can be used in conjunction with RunTest. For example:

 datadriven.Walk(t, path, func (t *testing.T, path string) {
   // initialize per-test state
   datadriven.RunTest(t, path, func (t *testing.T, d *datadriven.TestData) string {
    // ...
   }
 }

Files:
  testdata/typing
  testdata/logprops/scan
  testdata/logprops/select

If path is "testdata/typing", the function is called once and no subtests are created.

If path is "testdata/logprops", the function is called two times, in separate subtests /scan, /select.

If path is "testdata", the function is called three times, in subtest hierarchy /typing, /logprops/scan, /logprops/select.

func WalkAny ¶

func WalkAny(t testing.TB, path string, f func(t testing.TB, path string))

WalkAny is like Walk but works over a testing.TB.