Skip to content

feat: support package+license specific exclusions #1047

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

Open
erikburt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support package+license specific exclusions #1047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 50 additions & 10 deletions __tests__/licenses.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,10 @@ test('it does not filter out changes that are on the exclusions list', async ()
const changes: Changes = [pipChange, npmChange, rubyChange]
const licensesConfig = {
allow: ['BSD-3-Clause'],
licenseExclusions: ['pkg:pypi/package-1@1.1.1', 'pkg:npm/reeuhq@1.0.2']
allowedDependenciesLicenses: [
'pkg:pypi/package-1@1.1.1',
'pkg:npm/reeuhq@1.0.2'
]
}
const invalidLicenses = await getInvalidLicenseChanges(
changes,
Expand All @@ -254,13 +257,16 @@ test('it does not filter out changes that are on the exclusions list', async ()
})

test('it does not fail when the packages dont have a valid PURL', async () => {
const emptyPurlChange = pipChange
const emptyPurlChange = {...pipChange}
emptyPurlChange.package_url = ''

const changes: Changes = [emptyPurlChange, npmChange, rubyChange]
const licensesConfig = {
allow: ['BSD-3-Clause'],
licenseExclusions: ['pkg:pypi/package-1@1.1.1', 'pkg:npm/reeuhq@1.0.2']
allowedDependenciesLicenses: [
'pkg:pypi/package-1@1.1.1',
'pkg:npm/reeuhq@1.0.2'
]
}

const invalidLicenses = await getInvalidLicenseChanges(
Expand All @@ -274,7 +280,7 @@ test('it does filters out changes if they are not on the exclusions list', async
const changes: Changes = [pipChange, npmChange, rubyChange]
const licensesConfig = {
allow: ['BSD-3-Clause'],
licenseExclusions: [
allowedDependenciesLicenses: [
'pkg:pypi/notmypackage-1@1.1.1',
'pkg:npm/alsonot@1.0.2'
]
Expand All @@ -290,6 +296,40 @@ test('it does filters out changes if they are not on the exclusions list', async
expect(invalidLicenses.forbidden[1]).toBe(npmChange)
})

test('it does filter out changes that are on the exclusions list with license qualifier', async () => {
const changes: Changes = [pipChange, npmChange, rubyChange]
const licensesConfig = {
allow: ['BSD-3-Clause'],
// Will filter out pipChange as license matches
allowedDependenciesLicenses: [
'pkg:pypi/package-1@1.1.1?license=MIT',
'pkg:npm/reeuhq@1.0.2?license=MIT'
]
}
const invalidLicenses = await getInvalidLicenseChanges(
changes,
licensesConfig
)
expect(invalidLicenses.forbidden.length).toEqual(0)
})

test('it does not filter out changes that are on the exclusions list with license qualifier', async () => {
const changes: Changes = [pipChange, npmChange, rubyChange]
const licensesConfig = {
allow: ['BSD-3-Clause'],
// Will not filter out pipChange as license does not match
allowedDependenciesLicenses: [
'pkg:pypi/package-1@1.1.1?license=Apache-2.0',
'pkg:npm/reeuhq@1.0.2'
]
}
const invalidLicenses = await getInvalidLicenseChanges(
changes,
licensesConfig
)
expect(invalidLicenses.forbidden).toEqual([pipChange])
})

test('it does not fail if there is a license expression in the allow list', async () => {
const changes: Changes = [
{...npmChange, license: 'MIT AND Apache-2.0'},
Expand Down Expand Up @@ -342,24 +382,24 @@ describe('GH License API fallback', () => {
})

test('it does not call licenses API if the package is excluded', async () => {
const {unlicensed} = await getInvalidLicenseChanges([unlicensedChange], {
licenseExclusions: [
const result = await getInvalidLicenseChanges([unlicensedChange], {
allowedDependenciesLicenses: [
'pkg:githubactions/foo-org/actions-repo/.github/workflows/some-action.yml'
]
})

expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
expect(unlicensed.length).toEqual(0)
expect(result.unlicensed.length).toEqual(0)
})

test('it checks namespaces when doing exclusions', async () => {
const {unlicensed} = await getInvalidLicenseChanges([unlicensedChange], {
licenseExclusions: [
const result = await getInvalidLicenseChanges([unlicensedChange], {
allowedDependenciesLicenses: [
'pkg:githubactions/bar-org/actions-repo/.github/workflows/some-action.yml'
]
})

expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
expect(unlicensed.length).toEqual(1)
expect(result.unlicensed.length).toEqual(1)
})
})
29 changes: 27 additions & 2 deletions __tests__/purl.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ test('parsePURL returns a PURL with the correct values in the happy case', () =>
test('parsePURL table test', () => {
const examples = [
{
purl: 'pkg:npm/@n4m3SPACE/Name@^1.2.3',
purl: 'pkg:npm/@n4m3SPACE/Name@^1.2.3?license=MIT&foo=bar',
expected: {
type: 'npm',
namespace: '@n4m3SPACE',
name: 'Name',
version: '^1.2.3',
original: 'pkg:npm/@n4m3SPACE/Name@^1.2.3',
license: 'MIT',
original: 'pkg:npm/@n4m3SPACE/Name@^1.2.3?license=MIT&foo=bar',
error: null
}
},
Expand All @@ -52,6 +53,7 @@ test('parsePURL table test', () => {
namespace: 'gopkg.in',
name: 'DataDog/dd-trace-go.v1',
version: '1.63.1',
license: null,
original: 'pkg:golang/gopkg.in/DataDog/dd-trace-go.v1@1.63.1',
error: null
}
Expand All @@ -64,6 +66,7 @@ test('parsePURL table test', () => {
namespace: 'github.com',
name: 'pelletier/go-toml/v2',
version: null,
license: null,
original: 'pkg:golang/github.com/pelletier/go-toml/v2',
error: null
}
Expand All @@ -75,6 +78,7 @@ test('parsePURL table test', () => {
namespace: '@ns foo',
name: 'n@me',
version: '1./2.3',
license: null,
original: 'pkg:npm/%40ns%20foo/n%40me@1.%2f2.3',
error: null
}
Expand All @@ -86,6 +90,7 @@ test('parsePURL table test', () => {
namespace: null,
name: 'name',
version: 'version',
license: null,
original: 'pkg:ecosystem/name@version',
error: null
}
Expand All @@ -97,6 +102,7 @@ test('parsePURL table test', () => {
namespace: 'namespace',
name: null,
version: null,
license: null,
original: 'pkg:npm/namespace/',
error: null
}
Expand All @@ -108,6 +114,7 @@ test('parsePURL table test', () => {
namespace: null,
name: 'name',
version: null,
license: null,
original: 'pkg:ecosystem/name',
error: null
}
Expand All @@ -119,6 +126,7 @@ test('parsePURL table test', () => {
namespace: null,
name: null,
version: null,
license: null,
original: 'pkg:/?',
error: 'package-url must contain a type'
}
Expand All @@ -130,6 +138,7 @@ test('parsePURL table test', () => {
namespace: null,
name: null,
version: null,
license: null,
original: 'pkg:ecosystem/#',
error: 'package-url must contain a namespace or name'
}
Expand All @@ -141,6 +150,7 @@ test('parsePURL table test', () => {
namespace: null,
name: 'name',
version: 'version',
license: null,
original: 'pkg:ecosystem/name@version#subpath?attributes=123',
error: null
}
Expand All @@ -152,6 +162,7 @@ test('parsePURL table test', () => {
namespace: null,
name: 'name',
version: 'version',
license: null,
original: 'pkg:ecosystem/name@version#subpath',
error: null
}
Expand All @@ -163,6 +174,7 @@ test('parsePURL table test', () => {
namespace: 'namespace',
name: 'name',
version: 'version',
license: null,
original: 'pkg:ecosystem/namespace/name@version?attributes',
error: null
}
Expand All @@ -174,9 +186,22 @@ test('parsePURL table test', () => {
namespace: null,
name: 'name',
version: null,
license: null,
original: 'pkg:ecosystem/name#subpath?attributes',
error: null
}
},
{
purl: 'pkg:ecosystem/name#subpath?license=MIT&foo=bar',
expected: {
type: 'ecosystem',
namespace: null,
name: 'name',
version: null,
license: 'MIT',
original: 'pkg:ecosystem/name#subpath?license=MIT&foo=bar',
error: null
}
}
]
for (const example of examples) {
Expand Down
Loading