Add CBOR diagnostic files for ease of code review #659
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #656 This adds a human-readable `.diag` file containing the CBOR diagnostic representation for the corresponding `.dhallb` file, for ease of reviewing changes to encoded expressions. This also adds: * A new `./scripts/generate-diagnostic-files.sh` script for keeping the `*.diag` files up-to-date * A new CI check to ensure the contributor hasn't forgotten to update those files This also removes the `./tests/diff-binary.sh` script since it's no longer necessary.
Closed
philandstuff
approved these changes
Jul 21, 2019
sjakobi
approved these changes
Jul 21, 2019
|
CI seems to work: 👍 |
sjakobi
reviewed
Jul 21, 2019
ocharles
reviewed
Jul 21, 2019
| ${pkgsNew.rsync}/bin/rsync --archive ${pkgsNew.expected-diagnostic-files}/ ./tests.expected | ||
| ${pkgsNew.rsync}/bin/rsync --archive ${./tests}/ ./tests.actual | ||
|
|
||
| ${pkgsNew.diffutils}/bin/diff --recursive ./tests.{actual,expected} |
There was a problem hiding this comment.
Don't you need to do something here to assert that there are no differences? Or does diff exit with non-zero if there are differences?
There was a problem hiding this comment.
@ocharles: diff exits with a non-zero exit code if there are differences
f-f
approved these changes
Jul 21, 2019
Co-Authored-By: Simon Jakobi <simon.jakobi@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #656
This adds a human-readable
.diagfile containing the CBOR diagnosticrepresentation for the corresponding
.dhallbfile, for ease ofreviewing changes to encoded expressions.
This also adds:
./scripts/generate-diagnostic-files.shscript for keeping the*.diagfiles up-to-datefiles
This also removes the
./tests/diff-binary.shscript since it's no longernecessary.