Skip to content

fix: support special characters and invalid ignore rules when filtering files #477

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: support special characters and invalid ignore rules when filtering files #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,5 @@ Thumbs.db
.DS_Store
._*
webidentity.json
.cursor
.cursor
.windsurf
52 changes: 44 additions & 8 deletions pkg/utils/file_filter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ import (
"gopkg.in/yaml.v3"
)

// by default, all rules are valid
var defaultInvalidRules = []string{}

type FileFilter struct {
path string
defaultRules []string
Expand Down Expand Up @@ -179,10 +182,10 @@ func (fw *FileFilter) parseDotSnykFile(content []byte, filePath string) []string

var globs []string
for _, codeRule := range rules.Exclude.Code {
globs = append(globs, parseIgnoreRuleToGlobs(codeRule, filePath)...)
globs = append(globs, parseIgnoreRuleToGlobs(codeRule, filePath, defaultInvalidRules)...)
}
for _, codeRule := range rules.Exclude.Global {
globs = append(globs, parseIgnoreRuleToGlobs(codeRule, filePath)...)
globs = append(globs, parseIgnoreRuleToGlobs(codeRule, filePath, defaultInvalidRules)...)
}

return globs
Expand All @@ -193,23 +196,52 @@ func parseIgnoreFile(content []byte, filePath string) []string {
var ignores []string
lines := strings.Split(string(content), "\n")

// Invalid .gitignore style patterns
invalidRules := []string{"."}

for _, line := range lines {
if strings.HasPrefix(line, "#") || strings.TrimSpace(line) == "" {
continue
}
globs := parseIgnoreRuleToGlobs(line, filePath)
globs := parseIgnoreRuleToGlobs(line, filePath, invalidRules)
ignores = append(ignores, globs...)
}
return ignores
}

// escapeSpecialGlobChars escapes special characters that should be treated literally in glob patterns.
// Special Characters to escape: $
func escapeSpecialGlobChars(rule string) string {
var result strings.Builder
for i := 0; i < len(rule); i++ {
ch := rule[i]
switch ch {
case '$':
result.WriteByte('\\')
result.WriteByte(ch)
default:
result.WriteByte(ch)
}
}
return result.String()
}

// parseIgnoreRuleToGlobs contains the business logic to build glob patterns from a given ignore file
func parseIgnoreRuleToGlobs(rule string, filePath string) (globs []string) {
// we try to implement the same logic as gitignore pattern format - https://git-scm.com/docs/gitignore#_pattern_format
func parseIgnoreRuleToGlobs(rule string, filePath string, invalidRules []string) (globs []string) {
// Mappings from .gitignore format to glob format:
// `/foo/` => `/foo/**` (meaning: Ignore root (not sub) foo dir and its paths underneath.)
// `/foo` => `/foo/**`, `/foo` (meaning: Ignore root (not sub) file and dir and its paths underneath.)
// `foo/` => `**/foo/**` (meaning: Ignore (root/sub) foo dirs and their paths underneath.)
// `foo` => `**/foo/**`, `foo` (meaning: Ignore (root/sub) foo filesToFilter and dirs and their paths underneath.)

// If a rule is invalid, we skip it
for _, invalidRule := range invalidRules {
if strings.TrimSpace(rule) == invalidRule {
return globs
}
}

prefix := ""
const negation = "!"
const slash = "/"
Expand All @@ -235,24 +267,28 @@ func parseIgnoreRuleToGlobs(rule string, filePath string) (globs []string) {
// case `/foo/`, `/foo` => `{baseDir}/foo/**`
// case `**/foo/`, `**/foo` => `{baseDir}/**/foo/**`
if !endingGlobstar {
globs = append(globs, filepath.ToSlash(prefix+filepath.Join(baseDir, rule, all)))
glob := filepath.ToSlash(prefix + filepath.Join(baseDir, rule, all))
globs = append(globs, escapeSpecialGlobChars(glob))
}
// case `/foo` => `{baseDir}/foo`
// case `**/foo` => `{baseDir}/**/foo`
// case `/foo/**` => `{baseDir}/foo/**`
// case `**/foo/**` => `{baseDir}/**/foo/**`
if !endingSlash {
globs = append(globs, filepath.ToSlash(prefix+filepath.Join(baseDir, rule)))
glob := filepath.ToSlash(prefix + filepath.Join(baseDir, rule))
globs = append(globs, escapeSpecialGlobChars(glob))
}
} else {
// case `foo/`, `foo` => `{baseDir}/**/foo/**`
if !endingGlobstar {
globs = append(globs, filepath.ToSlash(prefix+filepath.Join(baseDir, all, rule, all)))
glob := filepath.ToSlash(prefix + filepath.Join(baseDir, all, rule, all))
globs = append(globs, escapeSpecialGlobChars(glob))
}
// case `foo` => `{baseDir}/**/foo`
// case `foo/**` => `{baseDir}/**/foo/**`
if !endingSlash {
globs = append(globs, filepath.ToSlash(prefix+filepath.Join(baseDir, all, rule)))
glob := filepath.ToSlash(prefix + filepath.Join(baseDir, all, rule))
globs = append(globs, escapeSpecialGlobChars(glob))
}
}
return globs
Expand Down
57 changes: 41 additions & 16 deletions pkg/utils/file_filter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,59 +382,84 @@ func TestParseIgnoreRuleToGlobs(t *testing.T) {
name string
rule string
baseDir string
invalidRules []string
expectedGlobs []string
}{
{
name: "invalid rules are ignored",
rule: ".",
baseDir: "/tmp/test",
invalidRules: []string{"."},
expectedGlobs: []string{},
},
{
name: "handles special characters",
rule: "*$",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{
"/tmp/test/**/*\\$",
"/tmp/test/**/*\\$/**",
},
},
{
name: "single slash has no effect",
rule: "/",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{},
},
{
name: "negated single slash has no effect",
rule: "!/",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{},
},
{
name: "slash with star ignores everything",
rule: "/*",
baseDir: "/tmp/test",
name: "slash with star ignores everything",
rule: "/*",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{
"/tmp/test/*/**",
"/tmp/test/*",
},
},
{
name: "root directory pattern",
rule: "/foo",
baseDir: "/tmp/test",
name: "root directory pattern",
rule: "/foo",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{
"/tmp/test/foo/**",
"/tmp/test/foo",
},
},
{
name: "root directory with trailing slash",
rule: "/foo/",
baseDir: "/tmp/test",
name: "root directory with trailing slash",
rule: "/foo/",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{
"/tmp/test/foo/**",
},
},
{
name: "non-root directory pattern",
rule: "foo",
baseDir: "/tmp/test",
name: "non-root directory pattern",
rule: "foo",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{
"/tmp/test/**/foo/**",
"/tmp/test/**/foo",
},
},
{
name: "non-root directory with trailing slash",
rule: "foo/",
baseDir: "/tmp/test",
name: "non-root directory with trailing slash",
rule: "foo/",
baseDir: "/tmp/test",
invalidRules: []string{},
expectedGlobs: []string{
"/tmp/test/**/foo/**",
},
Expand All @@ -443,7 +468,7 @@ func TestParseIgnoreRuleToGlobs(t *testing.T) {

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
globs := parseIgnoreRuleToGlobs(tc.rule, tc.baseDir)
globs := parseIgnoreRuleToGlobs(tc.rule, tc.baseDir, tc.invalidRules)
assert.ElementsMatch(t, tc.expectedGlobs, globs,
"Rule: %q, Expected: %v, Got: %v", tc.rule, tc.expectedGlobs, globs)
})
Expand Down