go
/
hcl
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
hcl/specsuite
History
Martin Atkins 2eaeb36cb3 Use Unicode 13 text segmentation rules 
HCL uses a number of upstream libraries that implement algorithms defined
in Unicode. This commit is updating those libraries all to versions that
have Unicode 13 support.

The main implication of this for HCL directly is that when it returns
column numbers in source locations it will count characters using the
Unicode 13 definition of "character", which includes various new
multi-codeunit characters added in Unicode 13.

These new version dependencies will also make Unicode 13 support available
for other functionality that HCL callers might use, such as the stdlib
functions in upstream cty, even though HCL itself does not directly use
those.
 		2021-02-23 09:05:19 -08:00
..
tests specsuite: Tests for the expression language operators 2019-10-01 15:59:10 -07:00
.gitignore specsuite: Move the Go testing stub into the specsuite directory 2019-10-01 15:59:10 -07:00
README.md Fix various stale links to spec.md 2020-01-09 11:02:20 -08:00
spec_test.go Use Unicode 13 text segmentation rules 2021-02-23 09:05:19 -08:00

README.md

HCL Language Test Suite

This directory contains an implementation-agnostic test suite that can be used to verify the correct behavior not only of the HCL implementation in this repository but also of possible other implementations.

The harness for running this suite -- a Go program in this directory -- uses the hcldec program as a level of abstraction to avoid depending directly on the Go implementation. As a result, other HCL implementations must also include a version of hcldec in order to run this spec.

The tests defined in this suite each correspond to a detail of the HCL spec. This suite is separate from and not a substitute for direct unit tests of a given implementation that would presumably also exercise that implementation's own programmatic API.

To run the suite, first build the harness using Go:

go install github.com/hashicorp/hcl/v2/cmd/hclspecsuite

Then run it, passing it the directory containing the test definitions (the "tests" subdirectory of this directory) and the path to the hcldec executable to use.

For example, if working in the root of this repository and using the hcldec implementation from here:

go install ./cmd/hcldec
hclspecsuite ./specsuite/tests $GOPATH/bin/hcldec

For developers working on the Go implementation of HCL from this repository, please note that this spec suite is run as part of a normal go test ./... execution for this whole repository and so does not need to be run separately.