feat: add git metadata to monitor payload

package.json

@@ -58,6 +58,7 @@
  "configstore": "^3.1.2",
  "debug": "^3.1.0",
  "diff": "^4.0.1",
+ "git-url-parse": "11.1.2",
  "glob": "^7.1.3",
  "inquirer": "^6.2.2",
  "lodash": "^4.17.11",

src/cli/commands/monitor.ts

@@ -73,7 +73,6 @@ async function monitor(...args0: any[]): Promise<any> {
  if (options['all-sub-projects'] && options['project-name']) {
  throw new Error('`--all-sub-projects` is currently not compatible with `--project-name`');
  }
-
  await apiTokenExists('snyk monitor');
  // Part 1: every argument is a scan target; process them sequentially
  for (const path of args) {
@@ -153,7 +152,7 @@ async function monitor(...args0: any[]): Promise<any> {
  // Post the project dependencies to the Registry
  for (const depRootDeps of perDepRootResults) {
  const res = await promiseOrCleanup(
- snykMonitor(path, meta, depRootDeps),
+ snykMonitor(path, meta, depRootDeps, targetFile),
  spinner.clear(postingMonitorSpinnerLabel));
 
  await spinner.clear(postingMonitorSpinnerLabel)(res);

src/lib/monitor.ts

@@ -7,13 +7,17 @@ import * as _ from 'lodash';
 import * as isCI from './is-ci';
 import * as analytics from './analytics';
 import { SingleDepRootResult, MonitorError } from './types';
+import * as projectMetadata from './project-metadata';
+import * as path from 'path';
 
 // TODO(kyegupov): clean up the type, move to snyk-cli-interface repository
 
 interface MonitorBody {
  meta: Meta;
  policy: string;
  package: {}; // TODO(kyegupov): DepTree
+ target: {};
+ targetFileRelativePath: string;
  targetFile: string;
 }
 
@@ -35,7 +39,7 @@ interface Meta {
  projectName: string;
 }
 
-export function monitor(root, meta, info: SingleDepRootResult): Promise<any> {
+export function monitor(root, meta, info: SingleDepRootResult, targetFile): Promise<any> {
  const pkg = info.package;
  const pluginMeta = info.plugin;
  let policyPath = meta['policy-path'];
@@ -52,8 +56,12 @@ export function monitor(root, meta, info: SingleDepRootResult): Promise<any> {
  return snyk.policy.create();
  }
  return snyk.policy.load(policyLocations, opts);
- }).then((policy) => {
+ }).then(async (policy) => {
  analytics.add('packageManager', packageManager);
+
+ const target = await projectMetadata.getInfo(pkg);
+ const targetFileRelativePath = targetFile ? path.relative(root, targetFile) : '';
+
  // TODO(kyegupov): async/await
  return new Promise((resolve, reject) => {
  request({
@@ -79,7 +87,9 @@ export function monitor(root, meta, info: SingleDepRootResult): Promise<any> {
  package: pkg,
  // we take the targetFile from the plugin,
  // because we want to send it only for specific package-managers
+ target,
  targetFile: pluginMeta.targetFile,
+ targetFileRelativePath,
  } as MonitorBody,
  gzip: true,
  method: 'PUT',

src/lib/project-metadata/index.ts

@@ -0,0 +1,18 @@
+import * as gitTargetBuilder from './target-builders/git';
+import { GitTarget } from './types';
+
+const TARGET_BUILDERS = [
+ gitTargetBuilder,
+];
+
+export async function getInfo(packageInfo): Promise<GitTarget|null> {
+ for (const builder of TARGET_BUILDERS) {
+ const target = await builder.getInfo(packageInfo);
+
+ if (target) {
+ return target;
+ }
+ }
+
+ return null;
+}

src/lib/project-metadata/target-builders/git.ts

@@ -0,0 +1,33 @@
+import fs = require('fs');
+import GitUrlParse = require('git-url-parse');
+
+import subProcess = require('../../sub-process');
+import { GitTarget } from '../types';
+
+export async function getInfo(packageInfo): Promise<GitTarget|null> {
+ let origin: string|null|undefined;
+
+ if (packageInfo.docker) {
+ return null;
+ }
+
+ try {
+ origin = (await subProcess.execute('git', ['remote', 'get-url', 'origin'])).trim();
+
+ if (!origin) {
+ return null;
+ }
+
+ const parsedOrigin = GitUrlParse(origin);
+ const branch = (await subProcess.execute('git', ['rev-parse', '--abbrev-ref', 'HEAD'])).trim();
+
+ return {
+ remoteUrl: parsedOrigin.toString('http'),
+ branch,
+ };
+ } catch (err) {
+ // Swallowing exception since we don't want to break the monitor if there is a problem
+ // executing git commands.
+ return null;
+ }
+}

src/lib/project-metadata/types.ts

@@ -0,0 +1,4 @@
+export interface GitTarget {
+ remoteUrl: string;
+ branch: string;
+}

test/monitor-target.test.ts

@@ -0,0 +1,73 @@
+'use strict';
+
+const test = require('tape').test;
+const zlib = require('zlib');
+const requestLib = require('needle');
+
+import * as _ from 'lodash';
+import * as sinon from 'sinon';
+
+import * as cli from '../src/cli/commands';
+import subProcess = require('../src/lib/sub-process');
+
+test('Make sure that target is sent correctly', async (t) => {
+ const subProcessStub = sinon.stub(subProcess, 'execute');
+
+ subProcessStub.withArgs('git', ['remote', 'get-url', 'origin'])
+ .resolves('http:/snyk/project.git');
+
+ subProcessStub.withArgs('git', ['rev-parse', '--abbrev-ref', 'HEAD'])
+ .resolves('master');
+
+ const { data, spy } = await getMonitorRequestDataAndSpy();
+
+ t.true(spy.calledOnce, 'needle.request was called once');
+ t.true(!_.isEmpty(data.target), 'target passed to request');
+ t.true(!_.isEmpty(data.targetFileRelativePath), 'targetFileRelativePath passed to request');
+ t.equals(data.target.branch, 'master', 'correct branch passed to request');
+ t.equals(data.target.remoteUrl, 'http:/snyk/project.git', 'correct name passed to request');
+ t.equals(data.targetFileRelativePath, 'package.json', 'correct relative target file path passed to request');
+
+ subProcessStub.restore();
+ spy.restore();
+ t.end();
+});
+
+test('Make sure it\'s not failing monitor for non git projects', async (t) => {
+ const subProcessStub = sinon.stub(subProcess, 'execute').resolves('');
+ const { data, spy } = await getMonitorRequestDataAndSpy();
+
+ t.true(spy.calledOnce, 'needle.request was called once');
+ t.true(_.isEmpty(data.target), 'empty target passed to request');
+ t.equals(data.targetFileRelativePath, 'package.json', 'targetFileRelativePath passed to request');
+
+ subProcessStub.restore();
+ spy.restore();
+ t.end();
+});
+
+test('Make sure it\'s not failing if there is no remote configured', async (t) => {
+ const subProcessStub = sinon.stub(subProcess, 'execute').rejects();
+ const { data, spy } = await getMonitorRequestDataAndSpy();
+
+ t.true(spy.calledOnce, 'needle.request was called once');
+ t.true(_.isEmpty(data.target), 'empty target passed to request');
+ t.equals(data.targetFileRelativePath, 'package.json', 'targetFileRelativePath passed to request');
+
+ subProcessStub.restore();
+ spy.restore();
+ t.end();
+});
+
+async function getMonitorRequestDataAndSpy() {
+ const requestSpy = sinon.spy(requestLib, 'request');
+
+ await cli.monitor();
+
+ const data = JSON.parse(zlib.gunzipSync(requestSpy.getCall(0).args[2]).toString());
+
+ return {
+ data,
+ spy: requestSpy,
+ };
+}