(#821) Allow for unbalanced JSON fragments in RSpec output #822
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 isn't working for |
rodjek
force-pushed
the
gh821_unbalanced_rspec_json
branch
from
411b575 to
a87b9c6
Compare
rodjek
force-pushed
the
gh821_unbalanced_rspec_json
branch
from
052e66f to
4817abc
Compare
glennsarti
reviewed
Mar 3, 2020
lib/pdk/util.rb
Outdated
| @@ -196,7 +197,7 @@ def in_module_root?(path = Dir.pwd) | |||
| # @return [Hash, nil] subset of text as Hash of first valid JSON found, or nil if no valid | |||
| # JSON found in the text | |||
| def find_first_json_in(text) | |||
| find_valid_json_in(text) | |||
| PDK::Util::JSONFinder.new(text).objects.first | |||
There was a problem hiding this comment.
nit: Should this just be find_all_json_in(text).first ?
glennsarti
reviewed
Mar 3, 2020
spec/acceptance/test_unit_spec.rb
Outdated
| end | ||
|
|
||
| after(:all) do | ||
| FileUtils.rm_rf(File.join('spec', 'unit')) |
There was a problem hiding this comment.
This seems dangerous. What's cwd at this point?
There was a problem hiding this comment.
cwd is the test module directory, but i can replace this with a couple of safer methods
There was a problem hiding this comment.
👍 I imagine my face if this ever went hay-wire would be 😕💥😢
Absolute path would be nice but that could be hard to get 🤷♂️
…tput This is an initial attempt at making the PDK::Util.find_valid_json_in method tolerate unbalanced JSON fragments nested as values inside of a larger, valid JSON document. Resolves puppetlabs#821
Regex + infinitely recursive data structures like JSON == sadness. It
can be done, but its just not the right tool for the job.
As the JSON formatter from rspec always outputs a condensed object, we
can say with surety that each document will be on its own line. So
rather than trying to scan for JSON objects using a regex, we can just
split the output by lines and look for lines that start with `{` and
end with `}` and attempt to parse them.
rodjek
force-pushed
the
gh821_unbalanced_rspec_json
branch
from
4817abc to
984c140
Compare
rodjek
changed the title
glennsarti
reviewed
Mar 9, 2020
| around(:all) do |example| | ||
| path = File.join('spec', 'unit', filename) | ||
| FileUtils.mkdir_p(File.dirname(path)) | ||
| File.open(path, 'w') { |f| f.puts content } |
There was a problem hiding this comment.
Do we care about line endings here? (not wb so on Windows it'll use CRLF)
There was a problem hiding this comment.
Nope, for the purposes of these short lived files, the line endings don't matter
glennsarti
approved these changes
Mar 9, 2020
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 is an initial attempt at making the PDK::Util.find_valid_json_in
method tolerate unbalanced JSON fragments nested as values inside of
a larger, valid JSON document.
The simple change of making the closing brace optional allows the regex to more greedily match the largest valid document, but I would like to see this tested against more complex samples before declaring this a sufficient fix.
Resolves #821