feat: add kas parser #143
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| package kas | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "golang.org/x/xerrors" | ||
| "gopkg.in/yaml.v3" | ||
|
|
||
| dio "github.com/aquasecurity/go-dep-parser/pkg/io" | ||
| giturls "github.com/whilp/git-urls" | ||
|
|
||
| "github.com/aquasecurity/go-dep-parser/pkg/types" | ||
| "github.com/aquasecurity/go-dep-parser/pkg/utils" | ||
| ) | ||
|
|
||
| type Repo struct { | ||
| Url string `yaml:"url,omitempty"` | ||
| RefSpec string `yaml:"refspec,omitempty"` | ||
| } | ||
|
|
||
| type KasFile struct { | ||
| Repos map[string]Repo `yaml:"repos,omitempty"` | ||
| } | ||
|
|
||
| type Parser struct{} | ||
|
|
||
| func NewParser() types.Parser { | ||
| return &Parser{} | ||
| } | ||
|
|
||
| func (p *Parser) Parse(r dio.ReadSeekerAt) ([]types.Library, []types.Dependency, error) { | ||
| var kasFile KasFile | ||
| decoder := yaml.NewDecoder(r) | ||
| err := decoder.Decode(&kasFile) | ||
| if err != nil { | ||
| return nil, nil, xerrors.Errorf("decode error: %w", err) | ||
| } | ||
|
|
||
| libs, deps := p.parse(&kasFile) | ||
|
|
||
| return libs, deps, nil | ||
| } | ||
|
|
||
| func (p *Parser) parse(kasFile *KasFile) ([]types.Library, []types.Dependency) { | ||
| var libs []types.Library | ||
|
|
||
| for _, repo := range kasFile.Repos { | ||
| name := getRepoNamefromUri(repo.Url) | ||
| if name == "" || repo.Url == "" { | ||
| continue | ||
| } | ||
|
|
||
| version := repo.RefSpec | ||
| if version == "" { | ||
| version = "latest" | ||
| } | ||
|
Comment on lines
+54
to
+57
There was a problem hiding this comment. I add the latest here because without a |
||
|
|
||
| libs = append(libs, types.Library{ | ||
| ID: utils.PackageID(name, version), | ||
| Name: name, | ||
| Version: version, | ||
| }) | ||
| } | ||
|
|
||
| return libs, nil | ||
| } | ||
|
|
||
| func getRepoNamefromUri(rawUri string) string { | ||
| uri, err := giturls.Parse(rawUri) | ||
| if err != nil { | ||
| return "" | ||
| } | ||
|
|
||
| name := strings.TrimSuffix(uri.Path, ".git") | ||
| name = strings.TrimLeft(name, "/") | ||
| return fmt.Sprintf("%s/%s", uri.Host, name) | ||
| } | ||
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,52 @@ | ||
| package kas | ||
|
|
||
| import ( | ||
| "os" | ||
| "path" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/aquasecurity/go-dep-parser/pkg/types" | ||
| ) | ||
|
|
||
| func TestParse(t *testing.T) { | ||
| vectors := []struct { | ||
| file string | ||
| want []types.Library | ||
| }{ | ||
| { | ||
| file: "testdata/kas.yml", | ||
| want: kasRepo, | ||
| }, | ||
| { | ||
| file: "testdata/kas-no-refspec.yml", | ||
| want: kasRepoLatest, | ||
| }, | ||
| { | ||
| file: "testdata/kas-git-url.yml", | ||
| want: kasRepoGitUrl, | ||
| }, | ||
| { | ||
| file: "testdata/kas-git-url.yml", | ||
| want: kasRepoSshUrl, | ||
| }, | ||
| { | ||
| file: "testdata/kas-multiple-repos.yml", | ||
| want: kasRepos, | ||
| }, | ||
| } | ||
|
|
||
| for _, v := range vectors { | ||
| t.Run(path.Base(v.file), func(t *testing.T) { | ||
| f, err := os.Open(v.file) | ||
| require.NoError(t, err) | ||
|
|
||
| got, _, err := NewParser().Parse(f) | ||
| require.NoError(t, err) | ||
|
|
||
| assert.Equal(t, v.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,50 @@ | ||
| package kas | ||
|
|
||
| import "github.com/aquasecurity/go-dep-parser/pkg/types" | ||
|
|
||
| var ( | ||
| kasRepo = []types.Library{ | ||
| { | ||
| ID: "github.com/org/[email protected]", | ||
| Name: "github.com/org/kas", | ||
| Version: "1.0.0", | ||
| }, | ||
| } | ||
|
|
||
| kasRepoLatest = []types.Library{ | ||
| { | ||
| ID: "github.com/org/kas@latest", | ||
| Name: "github.com/org/kas", | ||
| Version: "latest", | ||
| }, | ||
| } | ||
|
|
||
| kasRepoGitUrl = []types.Library{ | ||
| { | ||
| ID: "github.com/org/[email protected]", | ||
| Name: "github.com/org/kas", | ||
| Version: "1.0.0", | ||
| }, | ||
| } | ||
|
|
||
| kasRepoSshUrl = []types.Library{ | ||
| { | ||
| ID: "github.com/org/[email protected]", | ||
| Name: "github.com/org/kas", | ||
| Version: "1.0.0", | ||
| }, | ||
| } | ||
|
|
||
| kasRepos = []types.Library{ | ||
| { | ||
| ID: "github.com/org/[email protected]", | ||
| Name: "github.com/org/kas", | ||
| Version: "1.0.0", | ||
| }, | ||
| { | ||
| ID: "github.com/user/[email protected]", | ||
| Name: "github.com/user/repo", | ||
| Version: "2.0.0", | ||
| }, | ||
| } | ||
| ) |
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,12 @@ | ||
| header: | ||
| version: 11 | ||
| includes: | ||
| - repo: externalrepo | ||
| file: tests/test_layers/test.yml | ||
|
|
||
| repos: | ||
| this: | ||
|
|
||
| externalrepo: | ||
| url: [email protected]:org/kas.git | ||
| refspec: 1.0.0 |
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,16 @@ | ||
| header: | ||
| version: 11 | ||
| includes: | ||
| - repo: externalrepo | ||
| file: tests/test_layers/test.yml | ||
|
|
||
| repos: | ||
| this: | ||
|
|
||
| externalrepo: | ||
| url: https://github.com/org/kas.git | ||
| refspec: 1.0.0 | ||
|
|
||
| userrepo: | ||
| url: https://github.com/user/repo.git | ||
| refspec: 2.0.0 |
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,11 @@ | ||
| header: | ||
| version: 11 | ||
| includes: | ||
| - repo: externalrepo | ||
| file: tests/test_layers/test.yml | ||
|
|
||
| repos: | ||
| this: | ||
|
|
||
| externalrepo: | ||
| url: https://github.com/org/kas.git |
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,12 @@ | ||
| header: | ||
| version: 11 | ||
| includes: | ||
| - repo: externalrepo | ||
| file: tests/test_layers/test.yml | ||
|
|
||
| repos: | ||
| this: | ||
|
|
||
| externalrepo: | ||
| url: ssh://[email protected]/org/kas.git | ||
| refspec: 1.0.0 |
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,12 @@ | ||
| header: | ||
| version: 11 | ||
| includes: | ||
| - repo: externalrepo | ||
| file: tests/test_layers/test.yml | ||
|
|
||
| repos: | ||
| this: | ||
|
|
||
| externalrepo: | ||
| url: https://github.com/org/kas.git | ||
| refspec: 1.0.0 |
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.
Not sure how you'll feel about adding this little package. But still seemed better than manually parsing, especially if more git-based parsers are added later.