feat: add support for gradle.lockfile #2759
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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,47 @@ | ||
| package gradle | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/aquasecurity/go-dep-parser/pkg/gradle/lockfile" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer/language" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/types" | ||
|
|
||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| func init() { | ||
| analyzer.RegisterAnalyzer(&gradleLockAnalyzer{}) | ||
| } | ||
|
|
||
| const ( | ||
| version = 1 | ||
| fileNameSuffix = "gradle.lockfile" | ||
| ) | ||
|
|
||
| // gradleLockAnalyzer analyzes '*gradle.lockfile' | ||
| type gradleLockAnalyzer struct{} | ||
|
|
||
| func (a gradleLockAnalyzer) Analyze(_ context.Context, input analyzer.AnalysisInput) (*analyzer.AnalysisResult, error) { | ||
| p := lockfile.NewParser() | ||
| res, err := language.Analyze(types.GradleLock, input.FilePath, input.Content, p) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("%s parse error: %w", input.FilePath, err) | ||
| } | ||
| return res, nil | ||
| } | ||
|
|
||
| func (a gradleLockAnalyzer) Required(_ string, fileInfo os.FileInfo) bool { | ||
| return strings.HasSuffix(fileInfo.Name(), fileNameSuffix) | ||
| } | ||
|
|
||
| func (a gradleLockAnalyzer) Type() analyzer.Type { | ||
| return analyzer.TypeGradleLock | ||
| } | ||
|
|
||
| func (a gradleLockAnalyzer) Version() int { | ||
| return version | ||
| } | ||
This file contains 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,106 @@ | ||
| package gradle | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/types" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func Test_gradleLockAnalyzer_Analyze(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| inputFile string | ||
| want *analyzer.AnalysisResult | ||
| }{ | ||
| { | ||
| name: "happy path", | ||
| inputFile: "testdata/happy.lockfile", | ||
| want: &analyzer.AnalysisResult{ | ||
| Applications: []types.Application{ | ||
| { | ||
| Type: types.GradleLock, | ||
| FilePath: "testdata/happy.lockfile", | ||
| Libraries: []types.Package{ | ||
| { | ||
| Name: "com.example:example", | ||
| Version: "0.0.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "empty file", | ||
| inputFile: "testdata/empty.lockfile", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| f, err := os.Open(tt.inputFile) | ||
| require.NoError(t, err) | ||
| defer func() { | ||
| err = f.Close() | ||
| assert.NoError(t, err) | ||
| }() | ||
|
|
||
| a := gradleLockAnalyzer{} | ||
| got, err := a.Analyze(nil, analyzer.AnalysisInput{ | ||
| FilePath: tt.inputFile, | ||
| Content: f, | ||
| }) | ||
|
|
||
| assert.NoError(t, err) | ||
| assert.Equal(t, tt.want, got) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func Test_nugetLibraryAnalyzer_Required(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| filePath string | ||
| want bool | ||
| }{ | ||
| { | ||
| name: "default name", | ||
| filePath: "test/gradle.lockfile", | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "name with prefix", | ||
| filePath: "test/settings-gradle.lockfile", | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "txt", | ||
| filePath: "test/test.txt", | ||
| want: false, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| err := os.MkdirAll(filepath.Dir(tt.filePath), 0700) | ||
| assert.NoError(t, err) | ||
| _, err = os.Create(tt.filePath) | ||
| assert.NoError(t, err) | ||
| defer func() { | ||
| err = os.RemoveAll(filepath.Dir(tt.filePath)) | ||
| assert.NoError(t, err) | ||
| }() | ||
|
|
||
| fileInfo, err := os.Stat(tt.filePath) | ||
| assert.NoError(t, err) | ||
|
|
||
| a := gradleLockAnalyzer{} | ||
| got := a.Required("", fileInfo) | ||
| assert.Equal(t, tt.want, got) | ||
| }) | ||
| } | ||
| } |
This file contains 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,4 @@ | ||
| # This is a Gradle generated file for dependency locking. | ||
| # Manual edits can break the build and are not advised. | ||
| # This file is expected to be part of source control. | ||
| empty= |
This file contains 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,5 @@ | ||
| # This is a Gradle generated file for dependency locking. | ||
| # Manual edits can break the build and are not advised. | ||
| # This file is expected to be part of source control. | ||
| com.example:example:0.0.1=classpath | ||
| empty= |
This file contains 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
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.
I can see on GitHub, that user have lock files with another names. is it ok?
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.
It is suffix of filename.
If I understand correctly - we need to check only this suffix.
trivy/pkg/fanal/analyzer/language/java/gradle/lockfile.go
Line 39 in 6dda1d0