Merge pull request #92 from snyk/chore/introduce-jest

chore: introduce Jest

.gitignore

@@ -14,3 +14,6 @@ package-lock.json
 .nyc_output
 
 .eslintcache
+
+# Test output reports, coverage, etc
+reports/

jest.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+  verbose: true,
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  collectCoverage: false, // Run yarn test:coverage to generate coverage reports
+  collectCoverageFrom: ['lib/**/*.ts'],
+  coverageReporters: ['html', 'text-summary'],
+  coverageDirectory: '<rootDir>/reports/coverage',
+  testMatch: ['**/*.spec.ts'], // Remove when all tests are using Jest
+  modulePathIgnorePatterns: ['<rootDir>/dist', '<rootDir/reports>'],
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: '<rootDir>/reports/jest',
+      },
+    ],
+  ],
+};

package.json

@@ -15,7 +15,7 @@
     "format": "prettier --write '{lib,test}/**/*.{js,ts}'",
     "prepare": "npm run build",
     "test": "npm run test:pysrc && npm run test:js",
-    "test:js": "cross-env TS_NODE_PROJECT=tsconfig-test.json tap --node-arg=-r --node-arg=ts-node/register ./test/*.test.{js,ts} -R spec --timeout=900",
+    "test:js": "cross-env TS_NODE_PROJECT=tsconfig-test.json tap --node-arg=-r --node-arg=ts-node/register ./test/*.test.{js,ts} -R spec --timeout=900 && jest",
     "test:pysrc": "python -m unittest discover pysrc",
     "lint": "npm run build-tests && npm run format:check && eslint --cache '{lib,test}/**/*.{js,ts}'",
     "semantic-release": "semantic-release"
@@ -28,16 +28,20 @@
   },
   "devDependencies": {
     "@snyk/types-tap": "^1.1.0",
+    "@types/jest": "^24.0.23",
     "@types/node": "^6.14.6",
     "@types/tmp": "^0.1.0",
     "@typescript-eslint/eslint-plugin": "^1.13.0",
     "@typescript-eslint/parser": "^1.13.0",
     "cross-env": "^5.2.0",
     "eslint": "^5.16.0",
     "eslint-config-prettier": "^6.0.0",
+    "jest": "^24.9.0",
+    "jest-junit": "^10.0.0",
     "prettier": "^1.18.2",
     "sinon": "^2.3.2",
     "tap": "^12.6.1",
+    "ts-jest": "^24.2.0",
     "ts-node": "^8.1.0",
     "typescript": "^3.4.5"
   }

test/remediation.spec.ts

@@ -0,0 +1,117 @@
+import { readdirSync, readFileSync } from 'fs';
+import * as path from 'path';
+import { applyRemediationToManifests } from '../lib';
+import { chdirWorkspaces, deactivateVirtualenv } from './test-utils';
+import { activateVirtualenv, pipInstall } from './test-utils';
+
+function readDirAsFiles(dir: string) {
+  return readdirSync(dir).reduce(
+    (files: { [fileName: string]: string }, fileName) => {
+      files[fileName] = readFileSync(path.join(dir, fileName), 'utf8');
+      return files;
+    },
+    {}
+  );
+}
+
+describe('remediation', () => {
+  beforeEach(() => {
+    activateVirtualenv('remediation');
+  });
+
+  afterEach(() => {
+    deactivateVirtualenv();
+  });
+
+  it('fixes a pip app', async () => {
+    chdirWorkspaces('pip-app');
+    pipInstall();
+
+    const upgrades = {
+      '[email protected]': { upgradeTo: '[email protected]' },
+      '[email protected]': { upgradeTo: '[email protected]' },
+    };
+
+    const manifests = {
+      'requirements.txt': readFileSync('requirements.txt', 'utf8'),
+    };
+
+    const expectedUpdatedManifests = readDirAsFiles(
+      '../../fixtures/updated-manifest'
+    );
+
+    const result = await applyRemediationToManifests(
+      '.',
+      manifests,
+      upgrades,
+      {}
+    );
+
+    expect(result).toEqual(expectedUpdatedManifests);
+  });
+
+  it('retains python markers', async () => {
+    chdirWorkspaces('pip-app-with-python-markers');
+    pipInstall();
+
+    const upgrades = {
+      '[email protected]': { upgradeTo: '[email protected]' },
+    };
+
+    const manifests = {
+      'requirements.txt': readFileSync('requirements.txt', 'utf8'),
+    };
+
+    const expectedUpdatedManifests = readDirAsFiles(
+      '../../fixtures/updated-manifests-with-python-markers'
+    );
+
+    const result = await applyRemediationToManifests(
+      '.',
+      manifests,
+      upgrades,
+      {}
+    );
+
+    expect(result).toEqual(expectedUpdatedManifests);
+  });
+
+  it('handles no-op upgrades', async () => {
+    chdirWorkspaces('pip-app');
+    pipInstall();
+
+    const upgrades = {};
+
+    const manifests = {
+      'requirements.txt': readFileSync('requirements.txt', 'utf8'),
+    };
+
+    const result = await applyRemediationToManifests(
+      '.',
+      manifests,
+      upgrades,
+      {}
+    );
+
+    expect(result).toEqual(manifests);
+  });
+
+  it('cannot fix a Pipfile app', async () => {
+    chdirWorkspaces('pipfile-pipapp');
+
+    const upgrades = {
+      '[email protected]': { upgradeTo: '[email protected]' },
+      '[email protected]': { upgradeTo: '[email protected]' },
+    };
+
+    const manifests = {
+      Pipfile: readFileSync('Pipfile', 'utf8'),
+    };
+
+    await expect(
+      applyRemediationToManifests('.', manifests, upgrades, {})
+    ).rejects.toMatchObject({
+      message: 'Remediation only supported for requirements.txt file',
+    });
+  });
+});

test/test-utils.ts

@@ -24,7 +24,7 @@ function getActiveVenvName() {
     : null;
 }
 
-function activateVirtualenv(venvName) {
+function activateVirtualenv(venvName: string) {
   const venvDir = path.join(path.resolve(__dirname), '.venvs', venvName);
 
   const binDir = path.resolve(venvDir, binDirName);
@@ -78,7 +78,7 @@ function deactivateVirtualenv() {
   };
 }
 
-function ensureVirtualenv(venvName) {
+function ensureVirtualenv(venvName: string) {
   const venvsBaseDir = path.join(path.resolve(__dirname), '.venvs');
   try {
     fs.accessSync(venvsBaseDir, fs.constants.R_OK);
@@ -96,7 +96,7 @@ function ensureVirtualenv(venvName) {
   }
 }
 
-function createVenv(venvDir) {
+function createVenv(venvDir: string) {
   let revert = () => {};
   if (process.env.VIRTUAL_ENV) {
     revert = deactivateVirtualenv();
@@ -140,7 +140,7 @@ function pipInstall() {
   }
 }
 
-function pipUninstall(pkgName) {
+function pipUninstall(pkgName: string) {
   const proc = subProcess.executeSync('pip', ['uninstall', '-y', pkgName]);
   if (proc.status !== 0) {
     throw new Error(
@@ -182,6 +182,6 @@ function setWorkonHome() {
   };
 }
 
-export function chdirWorkspaces(dir) {
+export function chdirWorkspaces(dir: string) {
   process.chdir(path.resolve(__dirname, 'workspaces', dir));
 }

test/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["**/*.ts", "setup.ts"]
+}