Standardize on only two value dumping/diffing libraries #669
Conversation
|
Hmm interesting... this failed in a strange way when running under GitHub Actions, which doesn't readily reproduce on my own computer. I'm going to make this a draft while I investigate further. |
|
The difference in behavior is because we are running |
Due to the quite messy heritage of this codebase -- including a large part of it being just a fork of my earlier personal project ZCL -- there were many different conventions for how to pretty-print and diff values in the tests in different parts of the codebase. To reduce the dependency sprawl, this commit now standardizes on: - github.com/davecgh/go-spew for pretty-printing - github.com/google/go-cmp for diffing These two dependencies were already present anyway, are the most general out of all of the candidates, and are also already in use by at least some of HCL's most significant callers, such as HashiCorp Terraform. The version of go-cmp we were previously using seems to have a bug that causes the tests to crash when run under the Go race detector, so I've also upgraded that dependency to latest here to clear that bug.
apparentlymart
force-pushed
the
shed-pretty-deps
branch
from
25675bc
to
7499a3d
Compare
|
The failure seems to have been caused by this upstream bug: google/go-cmp#167 Therefore I've modified this change to also upgrade to the latest version of go-cmp, where the bug is fixed and the tests can now pass without crashing under the race detector too. |
| @@ -2197,6 +2194,7 @@ block "valid" {} | |||
| "a": { | |||
| Name: "a", | |||
| Expr: &LiteralValueExpr{ | |||
| Val: cty.DynamicVal, | |||
There was a problem hiding this comment.
The previous approach to this test was, it turns out, quietly not actually checking the Val field at all, because cty.Value has only unexported fields.
Switching to cmp brought attention to that first by requiring the use of ctydebug.CmpOptions (which teaches cmp how to compare two cty.Value values) and then by showing failures for this test and the other similar one below.
Due to the quite messy heritage of this codebase -- including a large part of it starting as a fork of my earlier personal project ZCL, which had made different choices -- there were many different conventions for how to pretty-print and diff values in the tests in different parts of the codebase.
To reduce the dependency sprawl, this commit now standardizes on:
github.com/davecgh/go-spewfor pretty-printinggithub.com/google/go-cmpfor diffingThese two dependencies were already present anyway, are the most general out of all of the candidates, and are also already in use by at least some of HCL's most significant callers, such as HashiCorp Terraform.
Since this potentially affects how the tests report failure, I visited each test I changed and made it intentionally fail to verify that the result is still readable and includes similar information as before, even though some of them are now displaying slightly differently.
This only changes
_test.gofiles, so it cannot affect any real behavior of the library when consumed by other modules.