Merge pull request #266 from snyk/dotkas/SUP-2164/test-monitor-projec…

…tname-discrepancy feat: [SUP-2164] Change dependency graph root name logic
snyk · Nov 18, 2023 · 0305fef · 0305fef
2 parents 830160f + 6f4d956
commit 0305fef
Show file tree

Hide file tree

Showing 27 changed files with 214 additions and 139 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -75,13 +75,25 @@ commands:
   install_sdkman:
     description: Install SDKMAN
     steps:
+      - restore_cache:
+          name: Restore SDKMan executable
+          keys:
+            - sdkman-cli-{{ arch }}-v1
       - run:
           name: Installing SDKMAN
           command: |
-            curl -s "https://get.sdkman.io?rcupdate=false" | bash
+            if ! command -v sdk &> /dev/null
+            then
+              curl -s "https://get.sdkman.io?rcupdate=false" | bash
+            fi
+            
             echo -e '\nsource "/home/circleci/.sdkman/bin/sdkman-init.sh"' >> $BASH_ENV
             source $BASH_ENV
             sdk list java
+      - save_cache:
+          key: sdkman-cli-{{ arch }}-v1
+          paths:
+            - ~/.sdkman
   install_gradle_unix:
     description: Install gradle
     parameters:

diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,7 @@ test/fixtures/**/build
 npm-debug.log
 .DS_Store
 coverage
+.idea/
 
-# Diagnostic reports (https://nodejs.org/api/report.html) 
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
diff --git a/lib/graph.ts b/lib/graph.ts
@@ -17,15 +17,15 @@ interface QueueItem {
 
 export async function buildGraph(
   snykGraph: SnykGraph,
-  projectName: string,
+  rootPkgName: string,
   projectVersion: string,
   coordinateMap?: CoordinateMap,
 ) {
   const pkgManager: PkgManager = { name: 'gradle' };
   const isEmptyGraph = !snykGraph || Object.keys(snykGraph).length === 0;
 
   const depGraphBuilder = new DepGraphBuilder(pkgManager, {
-    name: projectName,
+    name: rootPkgName,
     version: projectVersion || '0.0.0',
   });
 

diff --git a/lib/index.ts b/lib/index.ts
@@ -6,7 +6,6 @@ import * as tmp from 'tmp';
 import * as pMap from 'p-map';
 import * as chalk from 'chalk';
 import { DepGraph } from '@snyk/dep-graph';
-import debugModule = require('debug');
 import { legacyCommon, legacyPlugin as api } from '@snyk/cli-interface';
 
 import { MissingSubProjectError } from './errors';
@@ -19,6 +18,7 @@ import type {
   SnykHttpClient,
 } from './types';
 import { getMavenPackageInfo } from './search';
+import debugModule = require('debug');
 
 type ScannedProject = legacyCommon.ScannedProject;
 
@@ -526,11 +526,7 @@ async function getAllDeps(
         concurrency: 100,
       });
     }
-    return await processProjectsInExtractedJSON(
-      root,
-      extractedJSON,
-      coordinateMap,
-    );
+    return await processProjectsInExtractedJSON(extractedJSON, coordinateMap);
   } catch (err) {
     const error: Error = err;
     const gradleErrorMarkers = /^\s*>\s.*$/;
@@ -614,7 +610,6 @@ ${chalk.red.bold(mainErrorMessage)}`;
 }
 
 export async function processProjectsInExtractedJSON(
-  root: string,
   extractedJSON: JsonDepsScriptResult,
   coordinateMap?: CoordinateMap,
 ) {
@@ -626,21 +621,16 @@ export async function processProjectsInExtractedJSON(
       continue;
     }
 
-    const invalidValues = [null, undefined, ''];
-    const isValidRootDir = invalidValues.indexOf(root) === -1;
     const isSubProject = projectId !== defaultProjectKey;
 
-    let projectName = isValidRootDir ? path.basename(root) : defaultProject;
-
+    let rootPkgName = defaultProject;
     if (isSubProject) {
-      projectName = isValidRootDir
-        ? `${path.basename(root)}/${projectId}`
-        : `${defaultProject}/${projectId}`;
+      rootPkgName = `${defaultProject}/${projectId}`;
     }
 
     extractedJSON.projects[projectId].depGraph = await buildGraph(
       snykGraph,
-      projectName,
+      rootPkgName,
       projectVersion,
       coordinateMap,
     );

diff --git a/package.json b/package.json
@@ -19,7 +19,7 @@
     "lint": "eslint --color --cache '{lib,test}/**/*.{js,ts}' && prettier --check '{lib,test}/**/*.{js,ts}'",
     "format": "prettier --write '{lib,test}/**/*.{js,ts}'",
     "prepare": "npm run build",
-    "test": "tsc -p tsconfig-test.json && jest -b --maxWorkers=2 --testTimeout=150000"
+    "test": "tsc -p tsconfig-test.json && jest --maxWorkers=2 --testTimeout=150000"
   },
   "author": "snyk.io",
   "license": "Apache-2.0",

diff --git a/test/fixtures-with-wrappers/basic-with-deps/dep-graph-gradleNormalizeDeps-failed-search.json b/test/fixtures-with-wrappers/basic-with-deps/dep-graph-gradleNormalizeDeps-failed-search.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "basic-with-deps@unspecified",
       "info": {
-        "name": ".",
+        "name": "basic-with-deps",
         "version": "unspecified"
       }
     },
@@ -66,7 +66,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "basic-with-deps@unspecified",
         "deps": [
           {
             "nodeId": "unknown:guava-87e0fd1df874ea3cbe577702fe6f17068b790fd8@unknown"

diff --git a/test/fixtures-with-wrappers/basic-with-deps/dep-graph.json b/test/fixtures-with-wrappers/basic-with-deps/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "basic-with-deps@unspecified",
       "info": {
-        "name": ".",
+        "name": "basic-with-deps",
         "version": "unspecified"
       }
     },
@@ -66,7 +66,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "basic-with-deps@unspecified",
         "deps": [
           {
             "nodeId": "com.google.guava:[email protected]"

diff --git a/test/fixtures-with-wrappers/basic-with-failed-dep/dep-graph.json b/test/fixtures-with-wrappers/basic-with-failed-dep/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "basic-with-failed-dep@unspecified",
       "info": {
-        "name": ".",
+        "name": "basic-with-failed-dep",
         "version": "unspecified"
       }
     },
@@ -66,7 +66,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "basic-with-failed-dep@unspecified",
         "deps": [
           {
             "nodeId": "com.google.guava:[email protected]"

diff --git a/test/fixtures-with-wrappers/configuration-consistency/dep-graph.json b/test/fixtures-with-wrappers/configuration-consistency/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "configuration-consistency@unspecified",
       "info": {
-        "name": ".",
+        "name": "configuration-consistency",
         "version": "unspecified"
       }
     },
@@ -73,7 +73,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "configuration-consistency@unspecified",
         "deps": [
           {
             "nodeId": "org.codehaus.groovy:[email protected]"

diff --git a/test/fixtures-with-wrappers/custom-configuration/dep-graph.json b/test/fixtures-with-wrappers/custom-configuration/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "custom-configuration@unspecified",
       "info": {
-        "name": ".",
+        "name": "custom-configuration",
         "version": "unspecified"
       }
     },
@@ -38,7 +38,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "custom-configuration@unspecified",
         "deps": [
           {
             "nodeId": "org.mockito:[email protected]"

diff --git a/test/fixtures-with-wrappers/empty-build-gradle-in-root/dep-graph.json b/test/fixtures-with-wrappers/empty-build-gradle-in-root/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "no-build-gradle-in-root@unspecified",
       "info": {
-        "name": ".",
+        "name": "no-build-gradle-in-root",
         "version": "unspecified"
       }
     }
@@ -17,7 +17,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "no-build-gradle-in-root@unspecified",
         "deps": []
       }
     ]

diff --git a/test/fixtures-with-wrappers/empty-project/dep-graph.json b/test/fixtures-with-wrappers/empty-project/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "basic@unspecified",
       "info": {
-        "name": ".",
+        "name": "basic",
         "version": "unspecified"
       }
     }
@@ -17,7 +17,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "basic@unspecified",
         "deps": []
       }
     ]

diff --git a/test/fixtures-with-wrappers/kts-basic-with-deps/dep-graph.json b/test/fixtures-with-wrappers/kts-basic-with-deps/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@1.0.0-SNAPSHOT",
+      "id": "kts-basic-with-deps@1.0.0-SNAPSHOT",
       "info": {
-        "name": ".",
+        "name": "kts-basic-with-deps",
         "version": "1.0.0-SNAPSHOT"
       }
     },
@@ -101,7 +101,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@1.0.0-SNAPSHOT",
+        "pkgId": "kts-basic-with-deps@1.0.0-SNAPSHOT",
         "deps": [
           {
             "nodeId": "org.jetbrains.kotlin:[email protected]"

diff --git a/test/fixtures-with-wrappers/kts-configuration-consistency/dep-graph.json b/test/fixtures-with-wrappers/kts-configuration-consistency/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@1.0.0-SNAPSHOT",
+      "id": "kts-configuration-consistency@1.0.0-SNAPSHOT",
       "info": {
-        "name": ".",
+        "name": "kts-configuration-consistency",
         "version": "1.0.0-SNAPSHOT"
       }
     },
@@ -101,7 +101,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@1.0.0-SNAPSHOT",
+        "pkgId": "kts-configuration-consistency@1.0.0-SNAPSHOT",
         "deps": [
           {
             "nodeId": "org.jetbrains.kotlin:[email protected]"

diff --git a/test/fixtures-with-wrappers/kts-strict-lock-mode/dep-graph.json b/test/fixtures-with-wrappers/kts-strict-lock-mode/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@1.0.0-SNAPSHOT",
+      "id": "kts-strict-lock-mode@1.0.0-SNAPSHOT",
       "info": {
-        "name": ".",
+        "name": "kts-strict-lock-mode",
         "version": "1.0.0-SNAPSHOT"
       }
     },
@@ -101,7 +101,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@1.0.0-SNAPSHOT",
+        "pkgId": "kts-strict-lock-mode@1.0.0-SNAPSHOT",
         "deps": [
           {
             "nodeId": "org.jetbrains.kotlin:[email protected]"

diff --git a/test/fixtures-with-wrappers/kts-version-catalog-module/dep-graph.json b/test/fixtures-with-wrappers/kts-version-catalog-module/dep-graph.json
@@ -1,13 +1,13 @@
 {
   "graph": {
-    "nodes": [{ "deps": [], "nodeId": "root-node", "pkgId": ".@1.0" }],
+    "nodes": [{ "deps": [], "nodeId": "root-node", "pkgId": "kts-version-catalog-module@1.0" }],
     "rootNodeId": "root-node"
   },
   "pkgManager": { "name": "gradle" },
   "pkgs": [
     {
-      "id": ".@1.0",
-      "info": { "name": ".", "version": "1.0" }
+      "id": "kts-version-catalog-module@1.0",
+      "info": { "name": "kts-version-catalog-module", "version": "1.0" }
     }
   ],
   "schemaVersion": "1.2.0"

diff --git a/test/fixtures-with-wrappers/platform-project-mvn-bom/dep-graph.json b/test/fixtures-with-wrappers/platform-project-mvn-bom/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "platform-project-mvn-bom@unspecified",
       "info": {
-        "name": ".",
+        "name": "platform-project-mvn-bom",
         "version": "unspecified"
       }
     },
@@ -45,7 +45,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "platform-project-mvn-bom@unspecified",
         "deps": [
           {
             "nodeId": "org.springframework.boot:[email protected]"

diff --git a/test/fixtures-with-wrappers/repo-content-filtering/dep-graph.json b/test/fixtures-with-wrappers/repo-content-filtering/dep-graph.json
@@ -5,9 +5,9 @@
   },
   "pkgs": [
     {
-      "id": ".@unspecified",
+      "id": "repo-content-filtering@unspecified",
       "info": {
-        "name": ".",
+        "name": "repo-content-filtering",
         "version": "unspecified"
       }
     },
@@ -80,7 +80,7 @@
     "nodes": [
       {
         "nodeId": "root-node",
-        "pkgId": ".@unspecified",
+        "pkgId": "repo-content-filtering@unspecified",
         "deps": [
           {
             "nodeId": "com.google.guava:[email protected]"