Skip to content

fix(scan): check user include patterns before the extension allowlist #6

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

fix(scan): check user include patterns before the extension allowlist #6

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
9 changes: 6 additions & 3 deletions internal/scan/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,13 +349,16 @@ func (a *Agent) whyExcluded(it model.ScanItem) model.ExcludeReason {
if a.args.FileFilter != nil && a.args.FileFilter.IsUserExcluded(path) {
return model.ExcludeUserRule
}
// User-include is checked before the extension allowlist (matching the
// preview/diff path in internal/agent) so an explicit include glob can
// admit otherwise-unsupported extensions (e.g. .ftl). See #371.
if a.args.FileFilter != nil && a.args.FileFilter.HasInclude() && a.args.FileFilter.IsUserIncluded(path) {
return model.ExcludeNone
}
ext := extFromPath(path)
if ext != "" && !allowedext.IsAllowedExt(ext) {
return model.ExcludeExtension
}
if a.args.FileFilter != nil && a.args.FileFilter.HasInclude() && a.args.FileFilter.IsUserIncluded(path) {
return model.ExcludeNone
}
if allowedext.IsExcludedPath(path) {
return model.ExcludeDefaultPath
}
Expand Down
10 changes: 10 additions & 0 deletions internal/scan/coverage_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,16 @@ func TestWhyExcluded_AllBranches(t *testing.T) {
filter: &rules.FileFilter{Include: []string{"src/**"}},
want: model.ExcludeNone,
},
{
// #371: a user-include glob must override the built-in extension
// allowlist (as it already does on the preview/diff path). A
// non-allowlisted extension (.ftl) with a matching include glob
// must be included, not rejected as ExcludeExtension.
name: "user include overrides extension allowlist",
item: model.ScanItem{Path: "templates/email.ftl", Content: "x"},
filter: &rules.FileFilter{Include: []string{"**/*.ftl"}},
want: model.ExcludeNone,
},
{
name: "default excluded path",
item: model.ScanItem{Path: "pkg/handler_test.go", Content: "x"},
Expand Down