Skip to content

Commit

Permalink
Merge pull request #494 from actions/fix-purl-bug
Browse files Browse the repository at this point in the history
Empty PURLs should not block the action from running
  • Loading branch information
febuiles authored May 31, 2023
2 parents 554aaf5 + 123b587 commit 1360a34
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 7 deletions.
17 changes: 17 additions & 0 deletions __tests__/licenses.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,23 @@ test('it does not filter out changes that are on the exclusions list', async ()
expect(invalidLicenses.forbidden.length).toEqual(0)
})

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

const changes: Changes = [emptyPurlChange, npmChange, rubyChange]
const licensesConfig = {
allow: ['BSD'],
licenseExclusions: ['pkg:pip/[email protected]', 'pkg:npm/[email protected]']
}

const invalidLicenses = await getInvalidLicenseChanges(
changes,
licensesConfig
)
expect(invalidLicenses.forbidden.length).toEqual(1)
})

test('it does filters out changes if they are not on the exclusions list', async () => {
const changes: Changes = [pipChange, npmChange, rubyChange]
const licensesConfig = {
Expand Down
7 changes: 6 additions & 1 deletion dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dependency-review-action",
"version": "3.0.5",
"version": "3.0.6",
"private": true,
"description": "A GitHub Action for Dependency Review",
"main": "lib/main.js",
Expand Down Expand Up @@ -60,4 +60,4 @@
"ts-jest": "^27.1.4",
"typescript": "^4.9.5"
}
}
}
7 changes: 6 additions & 1 deletion src/licenses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ export async function getInvalidLicenseChanges(
// Takes the changes from the groupedChanges object and filters out the ones that are part of the exclusions list
// It does by creating a new PackageURL object from the change and comparing it to the exclusions list
groupedChanges.licensed = groupedChanges.licensed.filter(change => {
if (change.package_url.length === 0) {
return true
}

const changeAsPackageURL = PackageURL.fromString(change.package_url)

// We want to find if the licenseExclussion list contains the PackageURL of the Change
Expand All @@ -56,8 +60,9 @@ export async function getInvalidLicenseChanges(
) !== -1
) {
return false
} else {
return true
}
return true
})
const licensedChanges: Changes = groupedChanges.licensed

Expand Down

0 comments on commit 1360a34

Please sign in to comment.