Skip to content

Ingore empty paths in tar files. Fix regex match for .helmignore. #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
derekadams wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Ingore empty paths in tar files. Fix regex match for .helmignore. #201

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d66ae7
Fix empty paths in tar. Fix path matching issues in directory loader.
derekadams Aug 15, 2019
7aa33a6
Fix indentation.
derekadams Aug 16, 2019
2124463
Replace file separators with '\' characters.
derekadams Aug 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
nbactions.xml
src/site/markdown/*.html
target/
/.classpath
/.project
8 changes: 4 additions & 4 deletions src/main/java/org/microbean/helm/chart/HelmIgnorePathMatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,11 +259,11 @@ public void addPatterns(final Collection<? extends String> stringPatterns) {
regex.append("\\.");
break;
case '*':
regex.append("[^").append(File.separator).append("]*");
break;
regex.append("[^").append(File.separator).append(File.separator).append("]*");

@ljnelson ljnelson Aug 16, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your PR. Won't this doubling-up of File.separator be valid only on Windows?

@derekadams derekadams Aug 17, 2019

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's platform-specific since the slash is there to escape the other slash to make the regular expression valid. The use of File.separator is misleading in this scenario because it's really just a slash in the regular expression. We are using the code in Linux-based containers and it's working with no issues.

@ljnelson ljnelson Aug 17, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I'm asking is because normally in a regular expression you escape something with a backslash. And on windows, indeed File.separator would be a backslash. But on Linux, it would be a forward slash, which doesn't escape anything. I'll see if I can put a test together to reproduce the issue you're talking about.

@ljnelson ljnelson Aug 17, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also what's odd in this particular case is that [^x] means "a single character that is not x". So [^/], for example, means "a single character that is not /". You've changed this to be, exactly, [^//], which means...I'm actually not entirely sure what it means 😄. Maybe [^xx] is equivalent to [^x]; not sure. Anyway, I'm somewhat surprised here—not that there isn't a problem; I believe you—but that doubling a forward slash inside a single character negation pattern would somehow be responsible for fixing it.

@derekadams derekadams Aug 18, 2019 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. My guess is that it fails on Windows (or at least doesn't work as intended). I'll replace the file separators with \ characters so that it acts consistently.

@ljnelson ljnelson Aug 19, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But then you'll end up with [^\\], which means "any character that is not a backslash", and I doubt that's actually what you mean. I think we'll need a test here to show the behavior that you're observing.

@derekadams derekadams Aug 19, 2019

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I can't say I understand 100% what this logic is doing. My best guess is that it's attempting to emulate wildcard behavior by skipping all non backslash characters after the * (or one in the case of ?). If that's the case, I think the updated code is valid. There are test cases here for a lot of the potential .helmignore patterns and they are passing with the updated code.

@ljnelson ljnelson Aug 19, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have a link showing the problematic behavior with the current code? Better yet, could you attach such a test case to your PR, such that it fails with the current microbean-helm codebase, but passes with your PR changes? I need to fully understand the problem that these changes are claiming to solve.

break;
case '?':
regex.append("[^").append(File.separator).append("]?");
break;
regex.append("[^").append(File.separator).append(File.separator).append("]?");
break;
default:
regex.append(c);
break;
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/org/microbean/helm/chart/StreamOrientedChartLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,10 @@ private final void addFile(final NavigableMap<String, Chart.Builder> chartBuilde
Objects.requireNonNull(chartBuilders);
Objects.requireNonNull(path);
Objects.requireNonNull(stream);

if (path.length() == 0) {
return;
}

final Chart.Builder builder = getChartBuilder(chartBuilders, path);
if (builder == null) {
Expand Down