Skip to content
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

fix(license): return license separation using separators ,, or, etc. #6916

Merged
merged 6 commits into from
Jun 14, 2024
Merged

fix(license): return license separation using separators ,, or, etc. #6916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ab64725
refactor(parser): use `SplitLicenses` for meta and python packaging
DmitriyLewen Jun 13, 2024
c076667
refactor(parser): parse string/[]string for composer licenses
DmitriyLewen Jun 13, 2024
cd97260
test: update tests
DmitriyLewen Jun 13, 2024
f60f929
Merge branch 'main' of github.com:DmitriyLewen/trivy into fix-license…
DmitriyLewen Jun 13, 2024
fa2d913
fix linter error
DmitriyLewen Jun 13, 2024
b45b3ac
Merge branch 'main' of github.com:DmitriyLewen/trivy into fix-license…
DmitriyLewen Jun 14, 2024
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
4 changes: 2 additions & 2 deletions pkg/dependency/parser/conda/meta/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ package meta
import (
"encoding/json"

"github.com/samber/lo"
"golang.org/x/xerrors"

ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
"github.com/aquasecurity/trivy/pkg/licensing"
xio "github.com/aquasecurity/trivy/pkg/x/io"
)

Expand Down Expand Up @@ -40,7 +40,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]ftypes.Package, []ftypes.Dependenc
{
Name: data.Name,
Version: data.Version,
Licenses: lo.Ternary(data.License != "", []string{data.License}, nil),
Licenses: licensing.SplitLicenses(data.License),
},
}, nil, nil
}
25 changes: 23 additions & 2 deletions pkg/dependency/parser/php/composer/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

"github.com/aquasecurity/trivy/pkg/dependency"
ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
"github.com/aquasecurity/trivy/pkg/licensing"
"github.com/aquasecurity/trivy/pkg/log"
xio "github.com/aquasecurity/trivy/pkg/x/io"
)
Expand All @@ -22,7 +23,7 @@ type packageInfo struct {
Name string `json:"name"`
Version string `json:"version"`
Require map[string]string `json:"require"`
License []string `json:"license"`
License any `json:"license"`
StartLine int
EndLine int
}
Expand Down Expand Up @@ -55,7 +56,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]ftypes.Package, []ftypes.Dependenc
Name: lpkg.Name,
Version: lpkg.Version,
Relationship: ftypes.RelationshipUnknown, // composer.lock file doesn't have info about direct/indirect dependencies
Licenses: lpkg.License,
Licenses: licenses(lpkg.License),
Locations: []ftypes.Location{
{
StartLine: lpkg.StartLine,
Expand Down Expand Up @@ -114,3 +115,23 @@ func (t *packageInfo) UnmarshalJSONWithMetadata(node jfather.Node) error {
t.EndLine = node.Range().End.Line
return nil
}

// licenses returns slice of licenses from string, string with separators (`or`, `and`, etc.) or string array
// cf. https://getcomposer.org/doc/04-schema.md#license
func licenses(val any) []string {
switch v := val.(type) {
case string:
if v != "" {
return licensing.SplitLicenses(v)
}
case []any:
var lics []string
for _, l := range v {
if lic, ok := l.(string); ok {
lics = append(lics, lic)
}
}
return lics
}
return nil
}
8 changes: 4 additions & 4 deletions pkg/dependency/parser/php/composer/parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,19 +98,19 @@ var (
Locations: []ftypes.Location{
{
StartLine: 502,
EndLine: 585,
EndLine: 583,
},
},
},
{
ID: "symfony/[email protected]",
Name: "symfony/polyfill-php72",
Version: "v1.27.0",
Licenses: []string{"MIT"},
Licenses: []string{"MIT", "BSD-2-Clause"},
Locations: []ftypes.Location{
{
StartLine: 586,
EndLine: 661,
StartLine: 584,
EndLine: 657,
},
},
},
Expand Down
8 changes: 2 additions & 6 deletions pkg/dependency/parser/php/composer/testdata/composer_happy.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,9 +541,7 @@
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"license": "MIT",
"authors": [
{
"name": "Nicolas Grekas",
Expand Down Expand Up @@ -619,9 +617,7 @@
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"license": "MIT or BSD-2-Clause",
"authors": [
{
"name": "Nicolas Grekas",
Expand Down
4 changes: 2 additions & 2 deletions pkg/dependency/parser/python/packaging/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import (
"net/textproto"
"strings"

"github.com/samber/lo"
"golang.org/x/xerrors"

ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
"github.com/aquasecurity/trivy/pkg/licensing"
"github.com/aquasecurity/trivy/pkg/log"
xio "github.com/aquasecurity/trivy/pkg/x/io"
)
Expand Down Expand Up @@ -87,7 +87,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]ftypes.Package, []ftypes.Dependenc
{
Name: name,
Version: version,
Licenses: lo.Ternary(license != "", []string{license}, nil),
Licenses: licensing.SplitLicenses(license),
},
}, nil, nil
}
74 changes: 47 additions & 27 deletions pkg/dependency/parser/python/packaging/parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@ func TestParse(t *testing.T) {
// tr "\n" "\t" | awk -F "\t" '{printf("\{\""$1"\", \""$2"\", \""$3"\"\}\n")}'
want: []ftypes.Package{
{
Name: "setuptools",
Version: "51.3.3",
Licenses: []string{"UNKNOWN"},
Name: "setuptools",
Version: "51.3.3",
Licenses: []string{
"UNKNOWN",
},
},
},
},
Expand All @@ -46,9 +48,11 @@ func TestParse(t *testing.T) {
input: "testdata/unidecode-egg-info.PKG-INFO",
want: []ftypes.Package{
{
Name: "Unidecode",
Version: "0.4.1",
Licenses: []string{"UNKNOWN"},
Name: "Unidecode",
Version: "0.4.1",
Licenses: []string{
"UNKNOWN",
},
},
},
},
Expand All @@ -63,9 +67,11 @@ func TestParse(t *testing.T) {
// tr "\n" "\t" | awk -F "\t" '{printf("\{\""$1"\", \""$2"\", \""$3"\"\}\n")}'
want: []ftypes.Package{
{
Name: "distlib",
Version: "0.3.1",
Licenses: []string{"Python license"},
Name: "distlib",
Version: "0.3.1",
Licenses: []string{
"Python license",
},
},
},
},
Expand Down Expand Up @@ -96,9 +102,11 @@ func TestParse(t *testing.T) {
input: "testdata/distlib-0.3.1.METADATA",
want: []ftypes.Package{
{
Name: "distlib",
Version: "0.3.1",
Licenses: []string{"Python Software Foundation License"},
Name: "distlib",
Version: "0.3.1",
Licenses: []string{
"Python Software Foundation License",
},
},
},
},
Expand All @@ -109,9 +117,11 @@ func TestParse(t *testing.T) {

want: []ftypes.Package{
{
Name: "asyncssh",
Version: "2.14.2",
Licenses: []string{"Eclipse Public License v2.0"},
Name: "asyncssh",
Version: "2.14.2",
Licenses: []string{
"Eclipse Public License v2.0",
},
},
},
},
Expand All @@ -122,9 +132,13 @@ func TestParse(t *testing.T) {

want: []ftypes.Package{
{
Name: "pyphen",
Version: "0.14.0",
Licenses: []string{"GNU General Public License v2 or later (GPLv2+), GNU Lesser General Public License v2 or later (LGPLv2+), Mozilla Public License 1.1 (MPL 1.1)"},
Name: "pyphen",
Version: "0.14.0",
Licenses: []string{
"GNU General Public License v2 or later (GPLv2+)",
"GNU Lesser General Public License v2 or later (LGPLv2+)",
"Mozilla Public License 1.1 (MPL 1.1)",
},
},
},
},
Expand All @@ -138,9 +152,11 @@ func TestParse(t *testing.T) {
input: "testdata/iniconfig-2.0.0.METADATA",
want: []ftypes.Package{
{
Name: "iniconfig",
Version: "2.0.0",
Licenses: []string{"MIT"},
Name: "iniconfig",
Version: "2.0.0",
Licenses: []string{
"MIT",
},
},
},
},
Expand All @@ -149,9 +165,11 @@ func TestParse(t *testing.T) {
input: "testdata/zipp-3.12.1.METADATA",
want: []ftypes.Package{
{
Name: "zipp",
Version: "3.12.1",
Licenses: []string{"MIT License"},
Name: "zipp",
Version: "3.12.1",
Licenses: []string{
"MIT License",
},
},
},
},
Expand All @@ -160,9 +178,11 @@ func TestParse(t *testing.T) {
input: "testdata/networkx-3.0.METADATA",
want: []ftypes.Package{
{
Name: "networkx",
Version: "3.0",
Licenses: []string{"file://LICENSE.txt"},
Name: "networkx",
Version: "3.0",
Licenses: []string{
"file://LICENSE.txt",
},
},
},
},
Expand Down