Merge pull request #1422 from snyk/feat/add-reachable-vulns-support-f…

…or-gradle feat: add reachable vulnerabilities support for gradle
snyk · Sep 30, 2020 · 70f8a2c · 70f8a2c
2 parents 50ab9b0 + a0e7460
commit 70f8a2c
Show file tree

Hide file tree

Showing 6 changed files with 109 additions and 7 deletions.
diff --git a/package.json b/package.json
@@ -79,7 +79,7 @@
     "snyk-cpp-plugin": "2.0.0",
     "snyk-docker-plugin": "3.24.0",
     "snyk-go-plugin": "1.16.2",
-    "snyk-gradle-plugin": "3.6.3",
+    "snyk-gradle-plugin": "3.7.0",
     "snyk-module": "3.1.0",
     "snyk-mvn-plugin": "2.19.4",
     "snyk-nodejs-lockfile-parser": "1.28.1",

diff --git a/src/lib/monitor/index.ts b/src/lib/monitor/index.ts
@@ -390,6 +390,43 @@ export async function monitorDepGraph(
   // this graph will be pruned only if is too dense
   depGraph = await pruneGraph(depGraph, packageManager);
 
+  let callGraphPayload;
+  if (
+    options.reachableVulns &&
+    (scannedProject.callGraph as CallGraphError)?.innerError
+  ) {
+    const err = scannedProject.callGraph as CallGraphError;
+    analytics.add(
+      'callGraphError',
+      abridgeErrorMessage(
+        err.innerError.toString(),
+        ANALYTICS_PAYLOAD_MAX_LENGTH,
+      ),
+    );
+    alerts.registerAlerts([
+      {
+        type: 'error',
+        name: 'missing-call-graph',
+        msg: err.message,
+      },
+    ]);
+  } else if (scannedProject.callGraph) {
+    const { callGraph, nodeCount, edgeCount } = serializeCallGraphWithMetrics(
+      scannedProject.callGraph as CallGraph,
+    );
+    debug(
+      `Adding call graph to payload, node count: ${nodeCount}, edge count: ${edgeCount}`,
+    );
+
+    const callGraphMetrics = _.get(pluginMeta, 'meta.callGraphMetrics', {});
+    analytics.add('callGraphMetrics', {
+      callGraphEdgeCount: edgeCount,
+      callGraphNodeCount: nodeCount,
+      ...callGraphMetrics,
+    });
+    callGraphPayload = callGraph;
+  }
+
   return new Promise((resolve, reject) => {
     if (!depGraph) {
       debug(
@@ -432,6 +469,7 @@ export async function monitorDepGraph(
           targetFile: getTargetFile(scannedProject, pluginMeta),
           targetFileRelativePath,
           contributors,
+          callGraph: callGraphPayload,
         } as MonitorBody,
         gzip: true,
         method: 'PUT',

diff --git a/src/lib/package-managers.ts b/src/lib/package-managers.ts
@@ -54,4 +54,5 @@ export const PINNING_SUPPORTED_PACKAGE_MANAGERS: SupportedPackageManagers[] = [
 ];
 export const REACHABLE_VULNS_SUPPORTED_PACKAGE_MANAGERS: SupportedPackageManagers[] = [
   'maven',
+  'gradle',
 ];
diff --git a/test/acceptance/cli-reachable-vulns.test.ts b/test/acceptance/cli-reachable-vulns.test.ts
@@ -48,7 +48,7 @@ before('prime config', async (t) => {
 
 test('test vulnerable project with --reachable-vulns not supported package manager', async (t) => {
   try {
-    await cli.test('gradle', {
+    await cli.test('npm-package', {
       reachableVulns: true,
     });
     t.fail('expected test to throw exception');
@@ -66,13 +66,13 @@ test('monitor vulnerable project with --reachable-vulns not supported package ma
   try {
     await cli.monitor('.', {
       reachableVulns: true,
-      packageManager: 'gradle',
+      packageManager: 'npm',
     });
     t.fail('expected test to throw exception');
   } catch (err) {
     t.match(
       err.message,
-      `'Reachable vulns' is not supported for package manager 'gradle'. For a list of supported package managers go to https://support.snyk.io/hc/en-us/articles/360010554837-Reachable-Vulnerabilities`,
+      `'Reachable vulns' is not supported for package manager 'npm'. For a list of supported package managers go to https://support.snyk.io/hc/en-us/articles/360010554837-Reachable-Vulnerabilities`,
     );
   }
 });

diff --git a/test/acceptance/cli-test/cli-test.gradle.spec.ts b/test/acceptance/cli-test/cli-test.gradle.spec.ts
@@ -2,6 +2,7 @@ import * as sinon from 'sinon';
 import { legacyPlugin as pluginApi } from '@snyk/cli-interface';
 import { AcceptanceTests } from './cli-test.acceptance.test';
 import { CommandResult } from '../../../src/cli/commands/types';
+import { createCallGraph } from '../../utils';
 
 export const GradleTests: AcceptanceTests = {
   language: 'Gradle',
@@ -92,6 +93,64 @@ export const GradleTests: AcceptanceTests = {
       );
     },
 
+    '`test gradle-app --reachable-vulns` sends call graph': (
+      params,
+      utils,
+    ) => async (t) => {
+      utils.chdirWorkspaces();
+      const callGraphPayload = require('../fixtures/call-graphs/maven.json');
+      const callGraph = createCallGraph(callGraphPayload);
+      const plugin = {
+        async inspect() {
+          return {
+            package: {},
+            plugin: { name: 'testplugin', runtime: 'testruntime' },
+            callGraph,
+          };
+        },
+      };
+      const spyPlugin = sinon.spy(plugin, 'inspect');
+      const loadPlugin = sinon.stub(params.plugins, 'loadPlugin');
+      t.teardown(loadPlugin.restore);
+      loadPlugin.withArgs('gradle').returns(plugin);
+      await params.cli.test('gradle-app', {
+        reachableVulns: true,
+      });
+      const req = params.server.popRequest();
+      t.equal(req.method, 'POST', 'makes POST request');
+      t.equal(
+        req.headers['x-snyk-cli-version'],
+        params.versionNumber,
+        'sends version number',
+      );
+      t.match(req.url, '/test-dep-graph', 'posts to correct url');
+      t.match(req.body.targetFile, undefined, 'target is undefined');
+      t.equal(req.body.depGraph.pkgManager.name, 'gradle');
+      t.deepEqual(
+        req.body.callGraph,
+        callGraphPayload,
+        'correct call graph sent',
+      );
+      t.same(
+        spyPlugin.getCall(0).args,
+        [
+          'gradle-app',
+          'build.gradle',
+          {
+            args: null,
+            file: 'build.gradle',
+            org: null,
+            projectName: null,
+            packageManager: 'gradle',
+            path: 'gradle-app',
+            showVulnPaths: 'some',
+            reachableVulns: true,
+          },
+        ],
+        'calls gradle plugin',
+      );
+    },
+
     '`test gradle-app --all-sub-projects` sends `allSubProjects` argument to plugin': (
       params,
       utils,

diff --git a/test/reachable-vulns.test.ts b/test/reachable-vulns.test.ts
@@ -15,6 +15,7 @@ import {
 } from '../src/lib/reachable-vulns';
 import {
   SUPPORTED_PACKAGE_MANAGER_NAME,
+  REACHABLE_VULNS_SUPPORTED_PACKAGE_MANAGERS,
   SupportedPackageManagers,
 } from '../src/lib/package-managers';
 import * as featureFlags from '../src/lib/feature-flags';
@@ -166,9 +167,12 @@ test('formatReachablePaths', (t) => {
 });
 
 test('validatePayload - not supported package manager', async (t) => {
-  const pkgManagers = Object.keys(SUPPORTED_PACKAGE_MANAGER_NAME);
-  const mavenIndex = pkgManagers.indexOf('maven');
-  pkgManagers.splice(mavenIndex, 1); // remove maven as it's supported
+  const pkgManagers = Object.keys(SUPPORTED_PACKAGE_MANAGER_NAME).filter(
+    (name) =>
+      !REACHABLE_VULNS_SUPPORTED_PACKAGE_MANAGERS.includes(
+        name as SupportedPackageManagers,
+      ),
+  );
   t.plan(pkgManagers.length * 3);
 
   for (const pkgManager of pkgManagers) {