Skip to content

Commit d9c1ae4

Browse files
Strum355Strum355
authored
fix(pnpm): select correct workspace member from pnpm ls array (guacsec#484)
Implements TC-4180
1 parent a783c26 commit d9c1ae4

10 files changed

Lines changed: 168 additions & 2 deletions

File tree

‎src/providers/javascript_pnpm.js‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,21 @@ export default class Javascript_pnpm extends Base_javascript {
1111
}
1212

1313
_listCmdArgs(includeTransitive) {
14-
return ['ls', includeTransitive ? '--depth=Infinity' : '--depth=0', '--prod', '--json'];
14+
return ['ls', includeTransitive ? '--depth=Infinity' : '--depth=0', '--prod', '--json', '-r'];
1515
}
1616

1717
_updateLockFileCmdArgs() {
1818
return ['install', '--frozen-lockfile'];
1919
}
2020

2121
_buildDependencyTree(includeTransitive, opts = {}) {
22+
// pnpm ls --json returns an array with one entry per workspace package.
23+
// When analyzing a workspace member, find its entry by name instead of
24+
// blindly taking the first element (which is the workspace root).
2225
const tree = super._buildDependencyTree(includeTransitive, opts);
2326
if (Array.isArray(tree) && tree.length > 0) {
24-
return tree[0];
27+
const memberName = this._getManifest().name;
28+
return tree.find(pkg => pkg.name === memberName) || tree[0];
2529
}
2630
return {};
2731
}

‎test/providers/javascript.test.js‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,32 @@ suite('testing the javascript-npm data provider', async () => {
106106

107107
});
108108

109+
[
110+
{ providerName: 'pnpm', testCase: 'workspace_member' },
111+
].forEach(({ providerName, testCase }) => {
112+
test(`verify workspace member data for ${providerName} - stack analysis`, async () => {
113+
let expectedSbom = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/stack_expected_sbom.json`).toString();
114+
let listing = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/listing_stack.json`).toString();
115+
116+
const provider = await createMockProvider(providerName, listing);
117+
const manifestPath = `test/providers/tst_manifests/${providerName}/${testCase}/packages/member-a/package.json`;
118+
let providedDataForStack = provider.provideStack(manifestPath);
119+
120+
compareSboms(providedDataForStack.content, expectedSbom);
121+
}).timeout(30000);
122+
123+
test(`verify workspace member data for ${providerName} - component analysis`, async () => {
124+
let expectedSbom = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/component_expected_sbom.json`).toString();
125+
let listing = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/listing_component.json`).toString();
126+
127+
const provider = await createMockProvider(providerName, listing);
128+
const manifestPath = `test/providers/tst_manifests/${providerName}/${testCase}/packages/member-a/package.json`;
129+
let providedDataForComponent = provider.provideComponent(manifestPath);
130+
131+
compareSboms(providedDataForComponent.content, expectedSbom);
132+
}).timeout(15000);
133+
});
134+
109135
[
110136
{ providerName: 'yarn-berry', testCase: 'workspace_member' },
111137
].forEach(({ providerName, testCase }) => {

‎test/providers/tst_manifests/pnpm/workspace_member/component_expected_sbom.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"bomFormat": "CycloneDX",
3+
"specVersion": "1.4",
4+
"version": 1,
5+
"metadata": {
6+
"timestamp": "2023-08-07T00:00:00.000Z",
7+
"component": {
8+
"name": "member-a",
9+
"version": "1.0.0",
10+
"purl": "pkg:npm/member-a@1.0.0",
11+
"type": "application",
12+
"bom-ref": "pkg:npm/member-a@1.0.0"
13+
}
14+
},
15+
"components": [
16+
{
17+
"name": "axios",
18+
"version": "0.21.1",
19+
"purl": "pkg:npm/axios@0.21.1",
20+
"type": "library",
21+
"bom-ref": "pkg:npm/axios@0.21.1"
22+
}
23+
],
24+
"dependencies": [
25+
{
26+
"ref": "pkg:npm/member-a@1.0.0",
27+
"dependsOn": [
28+
"pkg:npm/axios@0.21.1"
29+
]
30+
},
31+
{
32+
"ref": "pkg:npm/axios@0.21.1",
33+
"dependsOn": []
34+
}
35+
]
36+
}

‎test/providers/tst_manifests/pnpm/workspace_member/listing_component.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[
2+
{
3+
"name": "test-workspace-root"
4+
},
5+
{
6+
"name": "member-a",
7+
"version": "1.0.0",
8+
"dependencies": {
9+
"axios": {
10+
"version": "0.21.1",
11+
"resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz"
12+
}
13+
}
14+
}
15+
]

‎test/providers/tst_manifests/pnpm/workspace_member/listing_stack.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[
2+
{
3+
"name": "test-workspace-root"
4+
},
5+
{
6+
"name": "member-a",
7+
"version": "1.0.0",
8+
"dependencies": {
9+
"axios": {
10+
"version": "0.21.1",
11+
"resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
12+
"dependencies": {
13+
"follow-redirects": {
14+
"version": "1.16.0",
15+
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.16.0.tgz"
16+
}
17+
}
18+
}
19+
}
20+
}
21+
]

‎test/providers/tst_manifests/pnpm/workspace_member/package.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "test-workspace-root",
3+
"private": true,
4+
"version": "1.0.0"
5+
}

‎test/providers/tst_manifests/pnpm/workspace_member/packages/member-a/package.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"name": "member-a",
3+
"version": "1.0.0",
4+
"dependencies": {
5+
"axios": "0.21.1"
6+
}
7+
}

‎test/providers/tst_manifests/pnpm/workspace_member/pnpm-lock.yaml‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎test/providers/tst_manifests/pnpm/workspace_member/pnpm-workspace.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
packages:
2+
- "packages/*"

‎test/providers/tst_manifests/pnpm/workspace_member/stack_expected_sbom.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"bomFormat": "CycloneDX",
3+
"specVersion": "1.4",
4+
"version": 1,
5+
"metadata": {
6+
"timestamp": "2023-08-07T00:00:00.000Z",
7+
"component": {
8+
"name": "member-a",
9+
"version": "1.0.0",
10+
"purl": "pkg:npm/member-a@1.0.0",
11+
"type": "application",
12+
"bom-ref": "pkg:npm/member-a@1.0.0"
13+
}
14+
},
15+
"components": [
16+
{
17+
"name": "axios",
18+
"version": "0.21.1",
19+
"purl": "pkg:npm/axios@0.21.1",
20+
"type": "library",
21+
"bom-ref": "pkg:npm/axios@0.21.1"
22+
},
23+
{
24+
"name": "follow-redirects",
25+
"version": "1.16.0",
26+
"purl": "pkg:npm/follow-redirects@1.16.0",
27+
"type": "library",
28+
"bom-ref": "pkg:npm/follow-redirects@1.16.0"
29+
}
30+
],
31+
"dependencies": [
32+
{
33+
"ref": "pkg:npm/member-a@1.0.0",
34+
"dependsOn": [
35+
"pkg:npm/axios@0.21.1"
36+
]
37+
},
38+
{
39+
"ref": "pkg:npm/axios@0.21.1",
40+
"dependsOn": [
41+
"pkg:npm/follow-redirects@1.16.0"
42+
]
43+
},
44+
{
45+
"ref": "pkg:npm/follow-redirects@1.16.0",
46+
"dependsOn": []
47+
}
48+
]
49+
}

0 commit comments

Comments
 (0)