Skip to content

fix: correctly handle object licenses in SBOM generation#6969

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

Merged
wraithgar merged 2 commits into from
Nov 6, 2023
Merged

fix: correctly handle object licenses in SBOM generation #6969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
002be85
Document current license SPDX behaviour
jamietanna Nov 6, 2023
0d1d79f
Correctly handle license objects in SBOM generation
jamietanna Nov 6, 2023
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
11 changes: 9 additions & 2 deletions lib/utils/sbom-cyclonedx.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

let parsedLicense
try {
parsedLicense = parseLicense(node.package?.license)
let license = node.package?.license
if (license) {
if (typeof license === 'object') {
license = license.type
}
}

parsedLicense = parseLicense(license)
} catch (err) {
parsedLicense = null
}
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
// If license is a single SPDX license, use the license field
if (parsedLicense?.license) {
component.licenses = [{ license: { id: parsedLicense.license } }]
// If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
} else if (parsedLicense?.conjunction) {
component.licenses = [{ expression: node.package.license }]
}
Expand Down
9 changes: 8 additions & 1 deletion lib/utils/sbom-spdx.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
location = node.linksIn.values().next().value.location
}

let license = node.package?.license
if (license) {
if (typeof license === 'object') {
license = license.type
}
}

const pkg = {
name: node.packageName,
SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
filesAnalyzed: false,
homepage: node.package?.homepage || NO_ASSERTION,
licenseDeclared: node.package?.license || NO_ASSERTION,
licenseDeclared: license || NO_ASSERTION,
externalRefs: [
{
referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down
55 changes: 55 additions & 0 deletions tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
"$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
"bomFormat": "CycloneDX",
"specVersion": "1.5",
"serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
"version": 1,
"metadata": {
"timestamp": "2020-01-01T00:00:00.000Z",
"lifecycles": [
{
"phase": "build"
}
],
"tools": [
{
"vendor": "npm",
"name": "cli",
"version": "10.0.0 "
}
],
"component": {
"bom-ref": "root@1.0.0",
"type": "library",
"name": "root",
"version": "1.0.0",
"scope": "required",
"author": "Author",
"purl": "pkg:npm/root@1.0.0",
"properties": [
{
"name": "cdx:npm:package:path",
"value": ""
}
],
"externalReferences": [],
"licenses": [
{
"license": {
"id": "MIT"
}
}
]
}
},
"components": [],
"dependencies": [
{
"ref": "root@1.0.0",
"dependsOn": []
}
]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
"$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down
135 changes: 135 additions & 0 deletions tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
"spdxVersion": "SPDX-2.3",
"dataLicense": "CC0-1.0",
"SPDXID": "SPDXRef-DOCUMENT",
"name": "root@1.0.0",
"documentNamespace": "docns",
"creationInfo": {
"created": "2020-01-01T00:00:00.000Z",
"creators": [
"Tool: npm/cli-10.0.0 "
]
},
"documentDescribes": [
"SPDXRef-Package-root-1.0.0"
],
"packages": [
{
"name": "root",
"SPDXID": "SPDXRef-Package-root-1.0.0",
"versionInfo": "1.0.0",
"packageFileName": "",
"downloadLocation": "NOASSERTION",
"filesAnalyzed": false,
"homepage": "NOASSERTION",
"licenseDeclared": "(MIT OR Apache-2.0)",
"externalRefs": [
{
"referenceCategory": "PACKAGE-MANAGER",
"referenceType": "purl",
"referenceLocator": "pkg:npm/root@1.0.0"
}
]
}
],
"relationships": [
{
"spdxElementId": "SPDXRef-DOCUMENT",
"relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
"relationshipType": "DESCRIBES"
}
]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
"spdxVersion": "SPDX-2.3",
"dataLicense": "CC0-1.0",
"SPDXID": "SPDXRef-DOCUMENT",
"name": "root@1.0.0",
"documentNamespace": "docns",
"creationInfo": {
"created": "2020-01-01T00:00:00.000Z",
"creators": [
"Tool: npm/cli-10.0.0 "
]
},
"documentDescribes": [
"SPDXRef-Package-root-1.0.0"
],
"packages": [
{
"name": "root",
"SPDXID": "SPDXRef-Package-root-1.0.0",
"versionInfo": "1.0.0",
"packageFileName": "",
"downloadLocation": "NOASSERTION",
"filesAnalyzed": false,
"homepage": "NOASSERTION",
"licenseDeclared": "MIT",
"externalRefs": [
{
"referenceCategory": "PACKAGE-MANAGER",
"referenceType": "purl",
"referenceLocator": "pkg:npm/root@1.0.0"
}
]
}
],
"relationships": [
{
"spdxElementId": "SPDXRef-DOCUMENT",
"relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
"relationshipType": "DESCRIBES"
}
]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
"spdxVersion": "SPDX-2.3",
"dataLicense": "CC0-1.0",
"SPDXID": "SPDXRef-DOCUMENT",
"name": "root@1.0.0",
"documentNamespace": "docns",
"creationInfo": {
"created": "2020-01-01T00:00:00.000Z",
"creators": [
"Tool: npm/cli-10.0.0 "
]
},
"documentDescribes": [
"SPDXRef-Package-root-1.0.0"
],
"packages": [
{
"name": "root",
"SPDXID": "SPDXRef-Package-root-1.0.0",
"versionInfo": "1.0.0",
"packageFileName": "",
"downloadLocation": "NOASSERTION",
"filesAnalyzed": false,
"homepage": "NOASSERTION",
"licenseDeclared": "ISC",
"externalRefs": [
{
"referenceCategory": "PACKAGE-MANAGER",
"referenceType": "purl",
"referenceLocator": "pkg:npm/root@1.0.0"
}
]
}
],
"relationships": [
{
"spdxElementId": "SPDXRef-DOCUMENT",
"relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
"relationshipType": "DESCRIBES"
}
]
}
`
20 changes: 18 additions & 2 deletions test/lib/utils/sbom-cyclonedx.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
t.end()
})

t.test('single node - with license object', t => {
const pkg = {
...rootPkg,
license: {
type: 'MIT',
url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
},
}
const node = { ...root, package: pkg }
const res = cyclonedxOutput({ npm, nodes: [node] })
t.matchSnapshot(JSON.stringify(res))
t.end()
})

t.test('single node - from git url', t => {
const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
const node = { ...root,
const node = {
...root,
edgesOut: [
{ to: dep1 },
{ to: dep2 },
{ to: undefined },
{ to: { pkgid: 'foo' } },
] }
],
}
const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
t.matchSnapshot(JSON.stringify(res))
t.end()
Expand Down
30 changes: 30 additions & 0 deletions test/lib/utils/sbom-spdx.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
t.end()
})

t.test('single node - with single license', t => {
const pkg = { ...rootPkg, license: 'ISC' }
const node = { ...root, package: pkg }
const res = spdxOutput({ npm, nodes: [node] })
t.matchSnapshot(JSON.stringify(res))
t.end()
})

t.test('single node - with license object', t => {
const pkg = {
...rootPkg,
license: {
type: 'MIT',
url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
},
}
const node = { ...root, package: pkg }
const res = spdxOutput({ npm, nodes: [node] })
t.matchSnapshot(JSON.stringify(res))
t.end()
})

t.test('single node - with license expression', t => {
const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
const node = { ...root, package: pkg }
const res = spdxOutput({ npm, nodes: [node] })
t.matchSnapshot(JSON.stringify(res))
t.end()
})

t.test('single node - with description', t => {
const pkg = { ...rootPkg, description: 'Package description' }
const node = { ...root, package: pkg }
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
fix: correctly handle object licenses in SBOM generation by jamietanna · Pull Request #6969 · npm/cli · GitHub
Skip to content
fix: correctly handle object licenses in SBOM generation#6969

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

 Merged

wraithgar
merged 2 commits into

from

Nov 6, 2023
 Merged


fix: correctly handle object licenses in SBOM generation
#6969
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
002be85

Document current license SPDX behaviour


jamietanna Nov 6, 2023
0d1d79f

Correctly handle license objects in SBOM generation


jamietanna Nov 6, 2023

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


11 changes: 9 additions & 2 deletions
lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,14 @@ const toCyclonedxItem = (node, { packageType }) => {

 let parsedLicense
 try {
 parsedLicense = parseLicense(node.package?.license)
 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 parsedLicense = parseLicense(license)
 } catch (err) {
 parsedLicense = null
 }
Expand DownExpand Up@@ -152,7 +159,7 @@ const toCyclonedxItem = (node, { packageType }) => {
 // If license is a single SPDX license, use the license field
 if (parsedLicense?.license) {
 component.licenses = [{ license: { id: parsedLicense.license } }]
 // If license is a conjunction, use the expression field
// If license is a conjunction, use the expression field
 } else if (parsedLicense?.conjunction) {
 component.licenses = [{ expression: node.package.license }]
 }
Expand Down

9 changes: 8 additions & 1 deletion
lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -93,6 +93,13 @@ const toSpdxItem = (node, { packageType }) => {
 location = node.linksIn.values().next().value.location
 }

 let license = node.package?.license
 if (license) {
 if (typeof license === 'object') {
 license = license.type
 }
 }

 const pkg = {
 name: node.packageName,
 SPDXID: toSpdxID(node),
Expand All@@ -103,7 +110,7 @@ const toSpdxItem = (node, { packageType }) => {
 downloadLocation: (node.isLink ? undefined : node.resolved) || NO_ASSERTION,
 filesAnalyzed: false,
 homepage: node.package?.homepage || NO_ASSERTION,
 licenseDeclared: node.package?.license || NO_ASSERTION,
 licenseDeclared: license || NO_ASSERTION,
 externalRefs: [
 {
 referenceCategory: REF_CAT_PACKAGE_MANAGER,
Expand Down

55 changes: 55 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-cyclonedx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -912,6 +912,61 @@ exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license express
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
 "bomFormat": "CycloneDX",
 "specVersion": "1.5",
 "serialNumber": "urn:uuid:00000000-0000-0000-0000-000000000000",
 "version": 1,
 "metadata": {
 "timestamp": "2020-01-01T00:00:00.000Z",
 "lifecycles": [
 {
 "phase": "build"
 }
 ],
 "tools": [
 {
 "vendor": "npm",
 "name": "cli",
 "version": "10.0.0 "
 }
 ],
 "component": {
 "bom-ref": "root@1.0.0",
 "type": "library",
 "name": "root",
 "version": "1.0.0",
 "scope": "required",
 "author": "Author",
 "purl": "pkg:npm/root@1.0.0",
 "properties": [
 {
 "name": "cdx:npm:package:path",
 "value": ""
 }
 ],
 "externalReferences": [],
 "licenses": [
 {
 "license": {
 "id": "MIT"
 }
 }
 ]
 }
 },
 "components": [],
 "dependencies": [
 {
 "ref": "root@1.0.0",
 "dependsOn": []
 }
 ]
}
`

exports[`test/lib/utils/sbom-cyclonedx.js TAP single node - with repository url > must match snapshot 1`] = `
{
 "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
Expand Down

135 changes: 135 additions & 0 deletions
tap-snapshots/test/lib/utils/sbom-spdx.js.test.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -504,3 +504,138 @@ exports[`test/lib/utils/sbom-spdx.js TAP single node - with integrity > must mat
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license expression > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "(MIT OR Apache-2.0)",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with license object > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "MIT",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

exports[`test/lib/utils/sbom-spdx.js TAP single node - with single license > must match snapshot 1`] = `
{
 "spdxVersion": "SPDX-2.3",
 "dataLicense": "CC0-1.0",
 "SPDXID": "SPDXRef-DOCUMENT",
 "name": "root@1.0.0",
 "documentNamespace": "docns",
 "creationInfo": {
 "created": "2020-01-01T00:00:00.000Z",
 "creators": [
 "Tool: npm/cli-10.0.0 "
 ]
 },
 "documentDescribes": [
 "SPDXRef-Package-root-1.0.0"
 ],
 "packages": [
 {
 "name": "root",
 "SPDXID": "SPDXRef-Package-root-1.0.0",
 "versionInfo": "1.0.0",
 "packageFileName": "",
 "downloadLocation": "NOASSERTION",
 "filesAnalyzed": false,
 "homepage": "NOASSERTION",
 "licenseDeclared": "ISC",
 "externalRefs": [
 {
 "referenceCategory": "PACKAGE-MANAGER",
 "referenceType": "purl",
 "referenceLocator": "pkg:npm/root@1.0.0"
 }
 ]
 }
 ],
 "relationships": [
 {
 "spdxElementId": "SPDXRef-DOCUMENT",
 "relatedSpdxElement": "SPDXRef-Package-root-1.0.0",
 "relationshipType": "DESCRIBES"
 }
 ]
}
`

20 changes: 18 additions & 2 deletions
test/lib/utils/sbom-cyclonedx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -190,6 +190,20 @@ t.test('single node - with license expression', t => {
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = cyclonedxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - from git url', t => {
 const node = { ...root, type: 'git', resolved: 'https://github.com/foo/bar#1234' }
 const res = cyclonedxOutput({ npm, nodes: [node] })
Expand All@@ -205,13 +219,15 @@ t.test('single node - no package info', t => {
})

t.test('node - with deps', t => {
 const node = { ...root,
 const node = {
 ...root,
 edgesOut: [
 { to: dep1 },
 { to: dep2 },
 { to: undefined },
 { to: { pkgid: 'foo' } },
 ] }
 ],
 }
 const res = cyclonedxOutput({ npm, nodes: [node, dep1, dep2, dep2Link] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
Expand Down

30 changes: 30 additions & 0 deletions
test/lib/utils/sbom-spdx.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,36 @@ t.test('single node - application package type', t => {
 t.end()
})

t.test('single node - with single license', t => {
 const pkg = { ...rootPkg, license: 'ISC' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license object', t => {
 const pkg = {
 ...rootPkg,
 license: {
 type: 'MIT',
 url: 'http://github.com/kriskowal/q/raw/master/LICENSE',
 },
 }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with license expression', t => {
 const pkg = { ...rootPkg, license: '(MIT OR Apache-2.0)' }
 const node = { ...root, package: pkg }
 const res = spdxOutput({ npm, nodes: [node] })
 t.matchSnapshot(JSON.stringify(res))
 t.end()
})

t.test('single node - with description', t => {
 const pkg = { ...rootPkg, description: 'Package description' }
 const node = { ...root, package: pkg }
Expand Down