fix: heredocs in lines with escaped newlines #87
Merged
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
Fix parsing error with heredocs within command chains with escaped
newlines.
When chaining commands in a `RUN` instructions, it is possible that one
of the middle commands takes a heredoc. It is often convenient to also
break up the resulting long line with escapes, e.g.:
```Dockerfile
RUN foo \
&& bar <<EOF >> bar.txt \
&& baz
inside heredoc
content
EOF
```
The heredoc parser should not fail on escaped newlines in this command
chain.
This requires two modifications:
- Parsing the rest of the command chain, after a heredoc should not
end on the literal '\n' character, but should be done with the
`untilEol` parser, which respects the escaped newlins
- Parsing the command chain before the heredoc requires casting
escaped newlines to spaces as to not fail the parser on a '\n'
character
This approach works with the caveat that the command chain after the
heredoc is ignored and will not end up in the parsed text.
fixes: hadolint/hadolint#923
Signed-off-by: Moritz Röhrich <moritz@ildefons.de>
|
great job! |
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.
Fix parsing error with heredocs within command chains with escaped newlines.
When chaining commands in a
RUNinstructions, it is possible that one of the middle commands takes a heredoc. It is often convenient to also break up the resulting long line with escapes, e.g.:RUN foo \ && bar <<EOF >> bar.txt \ && baz inside heredoc content EOFThe heredoc parser should not fail on escaped newlines in this command chain.
This requires two modifications:
untilEolparser, which respects the escaped newlinsThis approach works with the caveat that the command chain after the heredoc is ignored and will not end up in the parsed text.
fixes: hadolint/hadolint#923
Signed-off-by: Moritz Röhrich moritz@ildefons.de