README
¶
toml-test is a language-agnostic test suite to verify the correctness of
TOML parsers and writers.
Tests are divided into two groups: "invalid" and "valid". Decoders or encoders that reject "invalid" tests pass the tests, and decoders that accept "valid" tests and output precisely what is expected pass the tests. The output format is JSON, described below.
Both encoders and decoders share valid tests, except an encoder accepts JSON and outputs TOML rather than the reverse. The TOML representations are read with a blessed decoder and is compared. Encoders have their own set of invalid tests in the invalid-encoder directory. The JSON given to a TOML encoder is in the same format as the JSON that a TOML decoder should output.
Compatible with TOML version v1.0.0.
Installation
There are binaries on the release page; these are statically compiled and should run in most environments. It's recommended you use a binary, or a tagged release if you build from source especially in CI environments. This prevents your tests from breaking on changes to tests in this tool.
To compile from source you will need Go 1.16 or newer (older versions will not work):
$ git clone https://github.com/BurntSushi/toml-test.git
$ cd toml-test
$ go build ./cmd/toml-test
This will build a ./toml-test binary.
Usage
toml-test accepts an encoder or decoder as the first positional argument, for
example:
$ toml-test my-toml-decoder
$ toml-test my-toml-encoder -encoder
The -encoder flag is used to signal that this is an encoder rather than a
decoder.
For example, to run the tests against the Go TOML library:
# Install my parser
$ go install github.com/BurntSushi/toml/cmd/toml-test-decoder@master
$ go install github.com/BurntSushi/toml/cmd/toml-test-encoder@master
$ toml-test toml-test-decoder
toml-test [toml-test-decoder]: using embeded tests: 278 passed
$ toml-test -encoder toml-test-encoder
toml-test [toml-test-encoder]: using embeded tests: 94 passed, 0 failed
The default is to use the tests compiled in the binary; you can use -testdir
to load tests from the filesystem. You can use -run [name] or -skip [name]
to run or skip specific tests. Both flags can be given more than once and accept
glob patterns: -run 'valid/string/*'.
See toml-test -help for detailed usage.
Implementing a decoder
For your decoder to be compatible with toml-test it must satisfy the
expected interface:
- Your decoder must accept TOML data on
stdinuntil EOF. - If the TOML data is invalid, your decoder must return with a non-zero exit, code indicating an error.
- If the TOML data is valid, your decoder must output a JSON encoding of
that data on
stdoutand return with a zero exit code indicating success.
An example in pseudocode:
toml_data = read_stdin()
parsed_toml = decode_toml(toml_data)
if error_parsing_toml():
print_error_to_stderr()
exit(1)
print_as_tagged_json(parsed_toml)
exit(0)
Details on the tagged JSON is explained below in "JSON encoding".
Implementing an encoder
For your encoder to be compatible with toml-test, it must satisfy the
expected interface:
- Your encoder must accept JSON data on
stdinuntil EOF. - If the JSON data cannot be converted to a valid TOML representation, your encoder must return with a non-zero exit code indicating an error.
- If the JSON data can be converted to a valid TOML representation, your encoder
must output a TOML encoding of that data on
stdoutand return with a zero exit code indicating success.
An example in pseudocode:
json_data = read_stdin()
parsed_json_with_tags = decode_json(json_data)
if error_parsing_json():
print_error_to_stderr()
exit(1)
print_as_toml(parsed_json_with_tags)
exit(0)
JSON encoding
The following JSON encoding applies equally to both encoders and decoders:
- TOML tables correspond to JSON objects.
- TOML table arrays correspond to JSON arrays.
- TOML values correspond to a special JSON object of the form:
{"type": "{TTYPE}", "value": {TVALUE}}
In the above, TTYPE may be one of:
- string
- integer
- float
- bool
- datetime
- datetime-local
- date-local
- time-local
TVALUE is always a JSON string.
Empty hashes correspond to empty JSON objects ({}) and empty arrays correspond
to empty JSON arrays ([]).
Offset datetimes should be encoded in RFC 3339; Local datetimes should be encoded following RFC 3339 without the offset part. Local dates should be encoded as the date part of RFC 3339 and Local times as the time part.
Examples:
TOML JSON
a = 42 {"type": "integer": "value": "42}
[tbl] {"tbl": {
a = 42 "a": {"type": "integer": "value": "42}
}}
a = ["a", 2] {"a": [
{"type": "string", "value": "1"},
{"type: "integer": "value": "2"}
]}
Or a more complex example:
best-day-ever = 1987-07-05T17:45:00Z
[numtheory]
boring = false
perfection = [6, 28, 496]
And the JSON encoding expected by toml-test is:
{
"best-day-ever": {"type": "datetime", "value": "1987-07-05T17:45:00Z"},
"numtheory": {
"boring": {"type": "bool", "value": "false"},
"perfection": [
{"type": "integer", "value": "6"},
{"type": "integer", "value": "28"},
{"type": "integer", "value": "496"}
]
}
}
Note that the only JSON values ever used are objects, arrays and strings.
An example implementation can be found in the BurnSushi/toml:
Implementation-defined behaviour
This only tests behaviour that's should be true for every encoder implementing TOML; a few things are left up to implementations, and are not tested here.
-
Millisecond precision (4 digits) is required for datetimes and times, and further precision is implementation-specific, and any greater precision than is supported must be truncated (not rounded).
This tests only millisecond precision, and not any further precision or the truncation of it.
Assumptions of Truth
The following are taken as ground truths by toml-test:
- All tests classified as
invalidare invalid. - All tests classified as
validare valid. - All expected outputs in
valid/test-name.jsonare exactly correct. - The Go standard library package
encoding/jsondecodes JSON correctly. - When testing encoders, the TOML decoder at BurntSushi/toml is assumed to be correct. (Note that this assumption is not made when testing decoders!)
Of particular note is that no TOML decoder is taken as ground truth when
testing decoders. This means that most changes to the spec will only require an
update of the tests in toml-test. (Bigger changes may require an adjustment of
how two things are considered equal. Particularly if a new type of data is
added.) Obviously, this advantage does not apply to testing TOML encoders since
there must exist a TOML decoder that conforms to the specification in order to
read the output of a TOML encoder.
Adding tests
toml-test was designed so that tests can be easily added and removed. As
mentioned above, tests are split into two groups: invalid and valid tests.
Invalid tests only check if a decoder rejects invalid TOML data. Or, in the
case of testing encoders, invalid tests only check if an encoder rejects an
invalid representation of TOML (e.g., a hetergeneous array). Therefore, all
invalid tests should try to test one thing and one thing only. Invalid tests
should be named after the fault it is trying to expose. Invalid tests for
decoders are in the tests/invalid directory while invalid tests for encoders
are in the tests/invalid-encoder directory.
Valid tests check that a decoder accepts valid TOML data and that the parser has the correct representation of the TOML data. Therefore, valid tests need a JSON encoding in addition to the TOML data. The tests should be small enough that writing the JSON encoding by hand will not give you brain damage. The exact reverse is true when testing encoders.
A valid test without either a .json or .toml file will automatically fail.
If you have tests that you'd like to add, please submit a pull request.
Why JSON?
In order for a language agnostic test suite to work, we need some kind of data exchange format. TOML cannot be used, as it would imply that a particular parser has a blessing of correctness.
My decision to use JSON was not a careful one. It was based on expediency. The
Go standard library has an excellent encoding/json package built in, which
made it easy to compare JSON data.
The problem with JSON is that the types in TOML are not in one-to-one correspondence with JSON. This is why every TOML value represented in JSON is tagged with a type annotation, as described above.
YAML may be closer in correspondence with TOML, but I don't believe we should rely on that correspondence. Making things explicit with JSON means that writing tests is a little more cumbersome, but it also reduces the number of assumptions we need to make.
Documentation
¶
Index ¶
- Constants
- func EmbeddedTests() fs.FS
- type CommandParser
- type Parser
- type Runner
- type Test
- func (r Test) CompareJSON(want, have interface{}) Test
- func (r Test) CompareTOML(want, have interface{}) Test
- func (t Test) Failed() bool
- func (t Test) ReadInput(fsys fs.FS) (path, data string, err error)
- func (t Test) ReadWant(fsys fs.FS) (path, data string, err error)
- func (t *Test) ReadWantJSON(fsys fs.FS) (v interface{}, err error)
- func (t *Test) ReadWantTOML(fsys fs.FS) (v interface{}, err error)
- func (t Test) Run(p Parser, fsys fs.FS) Test
- func (t Test) Type() testType
- type Tests
Constants ¶
const ( TypeValid testType = iota TypeInvalid )
Variables ¶
This section is empty.
Functions ¶
func EmbeddedTests ¶
EmbeddedTests are the tests embedded in toml-test, rooted to the "test/" directory.
Types ¶
type CommandParser ¶
type CommandParser struct {
// contains filtered or unexported fields
}
CommandParser calls an external command.
func NewCommandParser ¶
func NewCommandParser(fsys fs.FS, cmd []string) CommandParser
type Parser ¶
type Parser interface {
// Encode a JSON string to TOML.
//
// The output is the TOML string; if outputIsError is true then it's assumed
// that an encoding error occurred.
//
// An error return should only be used in case an unrecoverable error
// occurred; failing to encode to TOML is not an error, but the encoder
// unexpectedly panicking is.
Encode(jsonInput string) (output string, outputIsError bool, err error)
// Decode a TOML string to JSON. The same semantics as Encode apply.
Decode(tomlInput string) (output string, outputIsError bool, err error)
}
A Parser instance is used to call the TOML parser we test.
By default this is done through an external command.
type Runner ¶
type Runner struct {
Files fs.FS // Test files.
Encoder bool // Are we testing an encoder?
RunTests []string // Tests to run; run all if blank.
SkipTests []string // Tests to skip.
Parser Parser // Send data to a parser.
Version string // TOML version to run tests for.
}
Runner runs a set of tests.
The validity of the parameters is not checked extensively; the caller should verify this if need be. See ./cmd/toml-test for an example.
type Test ¶
type Test struct {
Path string // Path of test, e.g. "valid/string-test"
Skipped bool // Skipped this test?
Failure string // Failure message.
Key string // TOML key the failure occured on; may be blank.
Encoder bool // Encoder test?
Input string // The test case that we sent to the external program.
Output string // Output from the external program.
Want string // The output we want.
OutputFromStderr bool // The Output came from stderr, not stdout.
}
Result is the result of a single test.
func (Test) CompareJSON ¶ added in v1.0.0
CompareJSON compares the given arguments.
The returned value is a copy of Test with Failure set to a (human-readable) description of the first element that is unequal. If both arguments are equal, Test is returned unchanged.
reflect.DeepEqual could work here, but it won't tell us how the two structures are different.
func (Test) CompareTOML ¶ added in v1.0.0
CompareTOML compares the given arguments.
The returned value is a copy of Test with Failure set to a (human-readable) description of the first element that is unequal. If both arguments are equal Test is returned unchanged.
Reflect.DeepEqual could work here, but it won't tell us how the two structures are different.
Source Files