hab pkg download file read is fragile #7040
Assignees
Labels
Type: Bug
Issues that describe broken functionality
Comments
markan
added a commit
that referenced
this issue
Oct 18, 2019
As reported in #7040, the file reader for hab pkg download is fragile. Trailing whitespace gives an unpleasant error, and there's no way to comment. This alters the file reader to ignore whitespace, and adds '#' as a comment character, similar to the usage in many other interpreted languages. Signed-off-by: Mark Anderson <mark@chef.io>
markan
added a commit
that referenced
this issue
Oct 18, 2019
As reported in #7040, the file reader for hab pkg download is fragile. Trailing whitespace gives an unpleasant error, and there's no way to comment. This alters the file reader to ignore whitespace, and adds '#' as a comment character, similar to the usage in many other interpreted languages. Signed-off-by: Mark Anderson <mark@chef.io>
markan
added a commit
that referenced
this issue
Oct 18, 2019
As reported in #7040, the file reader for hab pkg download is fragile. Trailing whitespace gives an unpleasant error, and there's no way to comment. This alters the file reader to ignore whitespace, and adds '#' as a comment character, similar to the usage in many other interpreted languages. Signed-off-by: Mark Anderson <mark@chef.io>
markan
added a commit
that referenced
this issue
Oct 21, 2019
As reported in #7040, the file reader for hab pkg download is fragile. Trailing whitespace gives an unpleasant error, and there's no way to comment. This alters the file reader to ignore whitespace, and adds '#' as a comment character, similar to the usage in many other interpreted languages. Signed-off-by: Mark Anderson <mark@chef.io>
christophermaier
added
Type: Bug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The hab pkg download command accepts a file of newline separated identifiers as input with the --file flag. The code to read this file is very sensitive to whitespace, and doesn't return terribly great errors. In particular, a trailing newline gives a very opaque error.
To fix this, we should filter out whitespace and skip blank lines before trying to parse the package idents.
When we fix this, I'd like to suggest one additional change.
It seems like going forward we're going to be treating those files as artifacts that we're maintaining (see #6902). While they are meant to be easily machine readable, it would be very useful to have a comment mechanism to allow inline annotations in the files themselves.
As a part of being more robust to spaces it would be a trivial extension to allow the '#' to act as a line comment. (as is done in many scripting languages (i.e. bash, powershell, ruby....)
In terms of cost, this would be one additional line of code, I suspect
.split("#").nth(0)would be enough.The text was updated successfully, but these errors were encountered: