-
Notifications
You must be signed in to change notification settings - Fork 318
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(pnpm): Fix parsing of JSON output for nested projects
If PNPM encounters nested projects, the output of the `list` command is not well-formed JSON, but consists of multiple arrays. Change the `parsePnpmList()` function to handle this format correctly. In `Pnpm`, only analyze the top-level project, since nested projects will be handled by the `pnpm` command transparently. Fixes #9784. Signed-off-by: Oliver Heger <[email protected]>
- Loading branch information
1 parent
c15996b
commit 6a6170b
Showing
5 changed files
with
194 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
plugins/package-managers/node/src/test/assets/pnpm-list.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| [ | ||
| { | ||
| "name": "some-project", | ||
| "version": "1.0.0", | ||
| "path": "/tmp/work/root", | ||
| "private": false, | ||
| "dependencies": { | ||
| "eslint-scope": { | ||
| "from": "eslint-scope", | ||
| "version": "link:node_modules/.pnpm/[email protected]/node_modules/eslint-scope", | ||
| "path": "/tmp/work/root/node_modules/.pnpm/[email protected]/node_modules/eslint-scope" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "other-project", | ||
| "version": "1.0.1", | ||
| "path": "/tmp/work/other_root", | ||
| "private": false, | ||
| "dependencies": { | ||
| "@types/eslint": { | ||
| "from": "@types/eslint", | ||
| "version": "link:node_modules/.pnpm/@[email protected]/node_modules/@types/eslint", | ||
| "path": "/tmp/work/other_root/node_modules/.pnpm/@[email protected]/node_modules/@types/eslint" | ||
| } | ||
| } | ||
| } | ||
| ] |
24 changes: 24 additions & 0 deletions
24
plugins/package-managers/node/src/test/assets/pnpm-multi-list.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| [ | ||
| { | ||
| "name": "outer-project", | ||
| "version": "1.0.0", | ||
| "path": "/tmp/work/top", | ||
| "private": false, | ||
| "dependencies": { | ||
| "eslint-scope": { | ||
| "from": "eslint-scope", | ||
| "version": "link:node_modules/.pnpm/[email protected]/node_modules/eslint-scope", | ||
| "path": "/tmp/work/top/node_modules/.pnpm/[email protected]/node_modules/eslint-scope" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
|
|
||
| [ | ||
| { | ||
| "name": "nested-project", | ||
| "version": "1.0.0", | ||
| "path": "/tmp/work/top/nested", | ||
| "private": false | ||
| } | ||
| ] |
103 changes: 103 additions & 0 deletions
103
plugins/package-managers/node/src/test/kotlin/pnpm/ModuleInfoTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Copyright (C) 2025 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>) | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * License-Filename: LICENSE | ||
| */ | ||
|
|
||
| package org.ossreviewtoolkit.plugins.packagemanagers.node.pnpm | ||
|
|
||
| import io.kotest.core.spec.style.WordSpec | ||
| import io.kotest.matchers.sequences.shouldContainExactly | ||
|
|
||
| import java.io.File | ||
|
|
||
| class ModuleInfoTest : WordSpec({ | ||
| "parsePnpmList()" should { | ||
| "handle normal PNPM output" { | ||
| val input = File("src/test/assets/pnpm-list.json").readText() | ||
|
|
||
| val expectedResults = sequenceOf( | ||
| listOf( | ||
| ModuleInfo( | ||
| name = "some-project", | ||
| version = "1.0.0", | ||
| path = "/tmp/work/root", | ||
| private = false, | ||
| dependencies = mapOf( | ||
| "eslint-scope" to ModuleInfo.Dependency( | ||
| from = "eslint-scope", | ||
| version = "link:node_modules/.pnpm/[email protected]/node_modules/eslint-scope", | ||
| path = "/tmp/work/root/node_modules/.pnpm/[email protected]/node_modules/eslint-scope" | ||
| ) | ||
| ) | ||
| ), | ||
| ModuleInfo( | ||
| name = "other-project", | ||
| version = "1.0.1", | ||
| path = "/tmp/work/other_root", | ||
| private = false, | ||
| dependencies = mapOf( | ||
| "@types/eslint" to ModuleInfo.Dependency( | ||
| from = "@types/eslint", | ||
| version = "link:node_modules/.pnpm/@[email protected]/node_modules/@types/eslint", | ||
| path = "/tmp/work/other_root/node_modules/.pnpm/@[email protected]" + | ||
| "/node_modules/@types/eslint" | ||
| ) | ||
| ) | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| val moduleInfos = parsePnpmList(input) | ||
|
|
||
| moduleInfos shouldContainExactly expectedResults | ||
| } | ||
|
|
||
| "handle multiple JSON arrays" { | ||
| val input = File("src/test/assets/pnpm-multi-list.json").readText() | ||
|
|
||
| val expectedResults = sequenceOf( | ||
| listOf( | ||
| ModuleInfo( | ||
| name = "outer-project", | ||
| version = "1.0.0", | ||
| path = "/tmp/work/top", | ||
| private = false, | ||
| dependencies = mapOf( | ||
| "eslint-scope" to ModuleInfo.Dependency( | ||
| from = "eslint-scope", | ||
| version = "link:node_modules/.pnpm/[email protected]/node_modules/eslint-scope", | ||
| path = "/tmp/work/top/node_modules/.pnpm/[email protected]/node_modules/eslint-scope" | ||
| ) | ||
| ) | ||
| ) | ||
| ), | ||
| listOf( | ||
| ModuleInfo( | ||
| name = "nested-project", | ||
| version = "1.0.0", | ||
| path = "/tmp/work/top/nested", | ||
| private = false | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| val moduleInfos = parsePnpmList(input) | ||
|
|
||
| moduleInfos shouldContainExactly expectedResults | ||
| } | ||
| } | ||
| }) |