-
-
Notifications
You must be signed in to change notification settings - Fork 697
Refactor error position parsing to support path with colon. #1673
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
base: master
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,7 @@ | |
| "path" | ||
| "path/filepath" | ||
| "reflect" | ||
| "regexp" | ||
| "runtime/debug" | ||
| "strconv" | ||
| "strings" | ||
|
|
@@ -761,20 +762,24 @@ | |
| return nil, nil | ||
| } | ||
| errs := make(map[string][]Error) | ||
| var posRegexp = regexp.MustCompile(`^(.*?)(?::(\w+))?(?::(\w+))?$`) | ||
| for _, pkgErr := range pkg.Errors { | ||
| parts := strings.Split(pkgErr.Pos, ":") | ||
| file := parts[0] | ||
| matches := posRegexp.FindStringSubmatch(pkgErr.Pos) | ||
| file := pkgErr.Pos | ||
| var err error | ||
| var line int | ||
| if len(parts) > 1 { | ||
| if line, err = strconv.Atoi(parts[1]); err != nil { | ||
| return nil, fmt.Errorf("parsing line: %w", err) | ||
| var line, column int | ||
| if len(matches) > 0 { | ||
| file = matches[1] | ||
| file = strings.TrimSuffix(file, ":") | ||
| if matches[2] != "" { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You still need to check if matches is greater than |
||
| if line, err = strconv.Atoi(matches[2]); err != nil { | ||
| return nil, fmt.Errorf("parsing line: %w", err) | ||
| } | ||
| } | ||
| } | ||
| var column int | ||
| if len(parts) > 2 { | ||
| if column, err = strconv.Atoi(parts[2]); err != nil { | ||
| return nil, fmt.Errorf("parsing column: %w", err) | ||
| if matches[3] != "" { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the same here |
||
| if column, err = strconv.Atoi(matches[3]); err != nil { | ||
| return nil, fmt.Errorf("parsing column: %w", err) | ||
| } | ||
| } | ||
| } | ||
| msg := strings.TrimSpace(pkgErr.Msg) | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1803,6 +1803,26 @@ func main() { | |
| Expect(err).Should(HaveOccurred()) | ||
| }) | ||
|
|
||
| It("should properly parse the errors with colons in path", func() { | ||
| pkg := &packages.Package{ | ||
| Errors: []packages.Error{ | ||
| { | ||
| Pos: "C:\\file:1:2", | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you also add an Linux example of path? For instance: It is a valid file name in Linux/Unix. Can you also add a tests for a path without build errors. |
||
| Msg: "build error", | ||
| }, | ||
| }, | ||
| } | ||
| errors, err := gosec.ParseErrors(pkg) | ||
| Expect(err).ShouldNot(HaveOccurred()) | ||
| Expect(errors).To(HaveLen(1)) | ||
| for _, ferr := range errors { | ||
| Expect(ferr).To(HaveLen(1)) | ||
| Expect(ferr[0].Line).To(Equal(1)) | ||
| Expect(ferr[0].Column).To(Equal(2)) | ||
| Expect(ferr[0].Err).Should(MatchRegexp(`build error`)) | ||
| } | ||
| }) | ||
|
|
||
| It("should append error to the same file", func() { | ||
| pkg := &packages.Package{ | ||
| Errors: []packages.Error{ | ||
|
|
||
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.
What about the Linux/Unix file systems? Does this regex cover the case of this file paths:
This is a valid path in LInux/Unix.
Uh oh!
There was an error while loading. Please reload this page.
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.
The original regex used
\d, but it will not throw errors for positions with invalid path likepath.go:one:twoand will instead treat the position as path.I updated to regex to use
\win order to throw errors when parsing positions with invalid line/column. However it will fail path with colons but without extension to fail if the position has no line nor column.So the updated regex actually worked for your particular case (because of the
.txt) but won't work if it'smy:file:with:colons.