Fix issue #20 "unexpected end of JSON input" error #64
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
This addresses #20 and ensures input is read from the plan file -- and not via STDIN -- if a plan file argument is provided. This also seeks to improve some of the error messaging to be a bit more clear.
Ideally, tf-summarize would feature a suite of automated tests verifying its functionality. In absenece of that, this demos the issue #20 fix via GH Actions.
mdb
commented
Jan 13, 2024
mdb
commented
Jan 13, 2024
- ensure the generation of the `example` directory data is done in a consistent, reproducible fashion - ensure GH Actions uses the same version of TF expected by the `example` directory - add plan and plan JSON files to source control, for testing purposes
|
👋 Hi @dineshba - Have you been able to take a look at this? I'm curious to hear your thoughts. Thanks! |
dineshba
requested changes
Jan 24, 2024
|
Other than this, all changes good. Really appreciate the effort and the fix 👌 |
@dineshba Good call; I've removed the |
dineshba
approved these changes
Jan 27, 2024
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.
This fixes issue #20 by correcting the
reader.CreateReaderlogic determining whether to use areader.FileReaderorreader.StdinReader. Previously, in some environments (like GH Actions Ubuntu runners),tf-summarizeincorrectly attempted to use areader.StdinReader, even when an explicit filename argument is provided.Ideally,
tf-summarizewould feature automated tests through which I could prove the bug & fix.In absence of such tests,I added ademoGitHub Actions job provingtf-summarizecontinues to work.However, I'm happy to add real tests (either in this PR, or in a followup PR), if you prefer those, @dineshba (I'm also happy to remove thedemoGH Actions job from this PR if you prefer it not clutter.github/workflows/build.yml).Update: I added 2 additional commits:
exampleprojecttf-summarize -md plan.jsonandcat plan.json | tf-summarize -mdboth continue to work as expected.Note that #63 shows reproduction of the bug via a similar GitHub Actions-based demo.