-
Notifications
You must be signed in to change notification settings - Fork 914
Fix .dockerignore wildcard negation directory descent #6927
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.
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
Honny1
wants to merge
1
commit into
podman-container-tools:main
Choose a base branch
from
Honny1:negation-filter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package excludes | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "go.podman.io/storage/pkg/fileutils" | ||
| ) | ||
|
|
||
| // ShouldDescendExcludedDir checks whether an excluded directory should still be | ||
| // descended into because a negation pattern in pm might match files under it. | ||
| // It handles literal prefix matches (e.g. !cmd/main.go for dir "cmd") and | ||
| // wildcard negations (e.g. !**/*.go, !*/*.go). The wildcard check extracts | ||
| // the literal prefix before the first wildcard and may intentionally | ||
| // overmatch (descend into directories that won't ultimately contain matches), | ||
| // which is safe because actual file-level matching happens later. | ||
| func ShouldDescendExcludedDir(dirPath string, pm *fileutils.PatternMatcher) bool { | ||
| if pm == nil || !pm.Exclusions() { | ||
| return false | ||
| } | ||
| dir := filepath.ToSlash(strings.Trim(dirPath, string(os.PathSeparator))) | ||
| for _, pattern := range pm.Patterns() { | ||
| if !pattern.Exclusion() { | ||
| continue | ||
| } | ||
| slashPattern := filepath.ToSlash(strings.Trim(pattern.String(), string(os.PathSeparator))) | ||
|
|
||
| // Literal-prefix check: the negation spec starts with this | ||
| // directory path, for example: !cmd/main.go matches dir "cmd" | ||
| if strings.HasPrefix(slashPattern, dir+"/") { | ||
| return true | ||
| } | ||
|
|
||
| // Wildcard-aware check: extract the literal prefix before | ||
| // the first wildcard character (*, ?, [), for example: !cmd/**/*.go matches dir "cmd" | ||
| // if the directory is at or under that literal prefix, a file beneath this | ||
| // directory could match the negation, so keep descending. | ||
| if firstWild := strings.IndexAny(slashPattern, "*?["); firstWild >= 0 { | ||
| var literalPrefix string | ||
| if idx := strings.LastIndex(slashPattern[:firstWild], "/"); idx >= 0 { | ||
| literalPrefix = slashPattern[:idx] | ||
| } | ||
| if literalPrefix == "" { | ||
| return true | ||
| } | ||
| if dir == literalPrefix || strings.HasPrefix(dir, literalPrefix+"/") { | ||
| return true | ||
| } | ||
| } | ||
| } | ||
| return false | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| package excludes | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.podman.io/storage/pkg/fileutils" | ||
| ) | ||
|
|
||
| func TestShouldDescendExcludedDir(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| path string | ||
| patterns []string | ||
| want bool | ||
| }{ | ||
| { | ||
| name: "nil matcher", | ||
| path: "cmd", | ||
| patterns: nil, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "no exclusions", | ||
| path: "cmd", | ||
| patterns: []string{"*"}, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "literal prefix match", | ||
| path: "cmd", | ||
| patterns: []string{"*", "!cmd/main.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "literal prefix no match", | ||
| path: "other", | ||
| patterns: []string{"*", "!cmd/main.go"}, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "double star at start matches any dir", | ||
| path: "cmd", | ||
| patterns: []string{"**", "!**/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "double star at start matches nested dir", | ||
| path: "cmd/sub", | ||
| patterns: []string{"**", "!**/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "double star with prefix matches dir under prefix", | ||
| path: "cmd/sub", | ||
| patterns: []string{"**", "!cmd/**/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "double star with prefix no match for other dir", | ||
| path: "other", | ||
| patterns: []string{"**", "!cmd/**/*.go"}, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "single star at start matches any dir", | ||
| path: "cmd", | ||
| patterns: []string{"*", "!*/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "single star at start matches nested dir", | ||
| path: "cmd/sub", | ||
| patterns: []string{"*", "!*/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "single star with prefix matches dir under prefix", | ||
| path: "src/pkg", | ||
| patterns: []string{"**", "!src/*/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "single star with prefix no match for other dir", | ||
| path: "other", | ||
| patterns: []string{"**", "!src/*/*.go"}, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "leading slash is stripped", | ||
| path: "/cmd", | ||
| patterns: []string{"*", "!cmd/main.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "deep nested with double star prefix", | ||
| path: "src/internal/pkg", | ||
| patterns: []string{"**", "!src/**/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "dir prefix match is not a partial match", | ||
| path: "cmds", | ||
| patterns: []string{"*", "!cmd/main.go"}, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "wildcard mid-segment descends parent dir", | ||
| path: "cmd/images", | ||
| patterns: []string{"**", "!cmd/image*/main.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "wildcard mid-segment matches parent", | ||
| path: "cmd", | ||
| patterns: []string{"**", "!cmd/image*"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "question mark wildcard matches any dir", | ||
| path: "cmd", | ||
| patterns: []string{"**", "!cm?/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "question mark wildcard no literal prefix matches any dir", | ||
| path: "other", | ||
| patterns: []string{"**", "!?md/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "bracket wildcard matches dir", | ||
| path: "cmd", | ||
| patterns: []string{"**", "!cm[d]/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "bracket wildcard no literal prefix matches any dir", | ||
| path: "other", | ||
| patterns: []string{"**", "![c]md/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "bracket wildcard with prefix matches dir under prefix", | ||
| path: "src/cmd", | ||
| patterns: []string{"**", "!src/cm[d]/*.go"}, | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "bracket wildcard with prefix no match for other dir", | ||
| path: "other", | ||
| patterns: []string{"**", "!src/cm[d]/*.go"}, | ||
| want: false, | ||
| }, | ||
| { | ||
| name: "non-exclusion patterns are ignored", | ||
| path: "cmd", | ||
| patterns: []string{"cmd/**/*.go"}, | ||
| want: false, | ||
| }, | ||
| } | ||
|
nalind marked this conversation as resolved.
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| var pm *fileutils.PatternMatcher | ||
| if tt.patterns != nil { | ||
| var err error | ||
| pm, err = fileutils.NewPatternMatcher(tt.patterns) | ||
| require.NoError(t, err) | ||
| } | ||
| got := ShouldDescendExcludedDir(tt.path, pm) | ||
| assert.Equal(t, tt.want, got, "ShouldDescendExcludedDir(%q)", tt.path) | ||
| }) | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably out of scope, but the deprecated call could be fixed there as well? https://github.com/podman-container-tools/buildah/blob/main/copier/copier.go#L1087