-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dotnet): add support for .Net core .deps.json files (#2487)
Co-authored-by: DmitriyLewen <[email protected]> Co-authored-by: knqyf263 <[email protected]>
- Loading branch information
3 people
authored
Jul 11, 2022
1 parent
56265a9
commit a6685b1
Showing
9 changed files
with
190 additions
and
22 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package deps | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "golang.org/x/xerrors" | ||
|
|
||
| core "github.com/aquasecurity/go-dep-parser/pkg/dotnet/core_deps" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer/language" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/types" | ||
| ) | ||
|
|
||
| func init() { | ||
| analyzer.RegisterAnalyzer(&depsLibraryAnalyzer{}) | ||
| } | ||
|
|
||
| const ( | ||
| version = 1 | ||
| depsExtension = ".deps.json" | ||
| ) | ||
|
|
||
| type depsLibraryAnalyzer struct{} | ||
|
|
||
| func (a depsLibraryAnalyzer) Analyze(_ context.Context, input analyzer.AnalysisInput) (*analyzer.AnalysisResult, error) { | ||
| parser := core.NewParser() | ||
| res, err := language.Analyze(types.DotNetCore, input.FilePath, input.Content, parser) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf(".Net Core dependencies analysis error: %w", err) | ||
| } | ||
|
|
||
| return res, nil | ||
| } | ||
|
|
||
| func (a depsLibraryAnalyzer) Required(filePath string, _ os.FileInfo) bool { | ||
| return strings.HasSuffix(filePath, depsExtension) | ||
| } | ||
|
|
||
| func (a depsLibraryAnalyzer) Type() analyzer.Type { | ||
| return analyzer.TypeDotNetDeps | ||
| } | ||
|
|
||
| func (a depsLibraryAnalyzer) 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,95 @@ | ||
| package deps | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/types" | ||
| ) | ||
|
|
||
| func Test_depsLibraryAnalyzer_Analyze(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| inputFile string | ||
| want *analyzer.AnalysisResult | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "happy path", | ||
| inputFile: "testdata/datacollector.deps.json", | ||
| want: &analyzer.AnalysisResult{ | ||
| Applications: []types.Application{ | ||
| { | ||
| Type: types.DotNetCore, | ||
| FilePath: "testdata/datacollector.deps.json", | ||
| Libraries: []types.Package{ | ||
| { | ||
| Name: "Newtonsoft.Json", | ||
| Version: "9.0.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "sad path", | ||
| inputFile: "testdata/invalid.txt", | ||
| wantErr: ".Net Core dependencies analysis error", | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| f, err := os.Open(tt.inputFile) | ||
| require.NoError(t, err) | ||
| defer f.Close() | ||
|
|
||
| a := depsLibraryAnalyzer{} | ||
| ctx := context.Background() | ||
| got, err := a.Analyze(ctx, analyzer.AnalysisInput{ | ||
| FilePath: tt.inputFile, | ||
| Content: f, | ||
| }) | ||
|
|
||
| if tt.wantErr != "" { | ||
| require.NotNil(t, err) | ||
| assert.Contains(t, err.Error(), tt.wantErr) | ||
| return | ||
| } | ||
|
|
||
| assert.NoError(t, err) | ||
| assert.Equal(t, tt.want, got) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func Test_depsLibraryAnalyzer_Required(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| filePath string | ||
| want bool | ||
| }{ | ||
| { | ||
| name: "config", | ||
| filePath: "test/datacollector.deps.json", | ||
| want: true, | ||
| }, | ||
| { | ||
| name: "zip", | ||
| filePath: "test.zip", | ||
| want: false, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| a := depsLibraryAnalyzer{} | ||
| got := a.Required(tt.filePath, nil) | ||
| assert.Equal(t, tt.want, got) | ||
| }) | ||
| } | ||
| } |
21 changes: 21 additions & 0 deletions
21
pkg/fanal/analyzer/language/dotnet/deps/testdata/datacollector.deps.json
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,21 @@ | ||
| { | ||
| "runtimeTarget": { | ||
| "name": ".NETCoreApp,Version=v2.1", | ||
| "signature": "" | ||
| }, | ||
| "compilationOptions": {}, | ||
| "libraries": { | ||
| "Newtonsoft.Json/9.0.1": { | ||
| "type": "package", | ||
| "serviceable": true, | ||
| "sha512": "sha512-U82mHQSKaIk+lpSVCbWYKNavmNH1i5xrExDEquU1i6I5pV6UMOqRnJRSlKO3cMPfcpp0RgDY+8jUXHdQ4IfXvw==", | ||
| "path": "newtonsoft.json/9.0.1", | ||
| "hashPath": "newtonsoft.json.9.0.1.nupkg.sha512" | ||
| }, | ||
| "Microsoft.VisualStudio.TestPlatform.Common/17.2.0-release-20220408-11": { | ||
| "type": "project", | ||
| "serviceable": false, | ||
| "sha512": "" | ||
| } | ||
| } | ||
| } |
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 @@ | ||
| test |
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