feat: use SNYK_TMP_PATH env var for temp dir path (#267)

* feat: use SNYK_TMP_PATH env var for temp dir path

* fix: resolve test failures on main

* chore: provide more useful error messge when making and writing to temp dir fails

* fix: resolve test failures

Author: thomasschafer

lib/dependencies/inspect-implementation.ts

@@ -8,6 +8,7 @@ import { buildDepGraph, PartialDepTree } from './build-dep-graph';
 import { FILENAMES } from '../types';
 import {
   EmptyManifestError,
+  FailedToWriteTempFiles,
   RequiredPackagesMissingError,
   UnparsableRequirementError,
 } from '../errors';
@@ -221,11 +222,23 @@ export async function inspectInstalledDeps(
   args?: string[],
   projectName?: string
 ): Promise<DepGraph> {
-  const tempDirObj = tmp.dirSync({
-    unsafeCleanup: true,
-  });
+  const tmp_path = process.env.SNYK_TMP_PATH;
+  let tempDirObj: tmp.DirResult;
+
+  try {
+    tempDirObj = tmp.dirSync({
+      unsafeCleanup: true,
+      ...(tmp_path ? { tmpdir: tmp_path } : {}),
+    });
+    dumpAllFilesInTempDir(tempDirObj.name);
+  } catch (e) {
+    throw new FailedToWriteTempFiles(
+      `Failed to write temporary files:\n` +
+        `${e}\n` +
+        `Try running again with SNYK_TMP_PATH=<some directory>, where <some directory> is a valid directory that you have permissions to write to.`
+    );
+  }
 
-  dumpAllFilesInTempDir(tempDirObj.name);
   try {
     const pythonEnv = getPythonEnv(targetFile);
 

lib/errors.ts

@@ -2,6 +2,7 @@ export enum PythonPluginErrorNames {
   EMPTY_MANIFEST_ERROR = 'EMPTY_MANIFEST_ERROR',
   REQUIRED_PACKAGES_MISSING_ERROR = 'REQUIRED_PACKAGES_MISSING_ERROR',
   UNPARSABLE_REQUIREMENT_ERROR = 'UNPARSABLE_REQUIREMENT_ERROR',
+  FAILED_TO_WRITE_TEMP_FILES = 'FAILED_TO_WRITE_TEMP_FILES',
 }
 
 export class EmptyManifestError extends Error {
@@ -24,3 +25,10 @@ export class UnparsableRequirementError extends Error {
     this.name = PythonPluginErrorNames.UNPARSABLE_REQUIREMENT_ERROR;
   }
 }
+
+export class FailedToWriteTempFiles extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = PythonPluginErrorNames.FAILED_TO_WRITE_TEMP_FILES;
+  }
+}

test/system/inspect.spec.ts

@@ -250,7 +250,6 @@ describe('inspect', () => {
           {
             pkg: {
               name: 'jsonschema',
-              version: '4.23.0',
             },
             directDeps: ['openapi-spec-validator'],
           },
@@ -620,7 +619,6 @@ describe('inspect', () => {
           {
             pkg: {
               name: 'jsonschema',
-              version: '4.23.0',
             },
             directDeps: ['openapi-spec-validator'],
           },

test/test-utils.ts

@@ -176,7 +176,7 @@ function updateSetuptools() {
 
 function setupPyInstall() {
   updateSetuptools();
-  const proc = subProcess.executeSync('python3', ['setup.py', 'install']);
+  const proc = subProcess.executeSync('pip', ['install', '.']);
   if (proc.status !== 0) {
     console.log('' + proc.stderr);
     throw new Error(

test/unit/fixtures/requirements.txt

@@ -0,0 +1 @@
+# no deps

test/unit/inspect-implementation.spec.ts

@@ -0,0 +1,75 @@
+import * as fs from 'fs';
+import * as tmp from 'tmp';
+
+import { inspectInstalledDeps } from '../../lib/dependencies/inspect-implementation';
+
+jest.mock('tmp');
+
+describe('Test inspect-implementation.ts', () => {
+  describe('inspectInstalledDeps', () => {
+    const originalEnv = process.env;
+
+    const dirSyncMock = tmp.dirSync as jest.MockedFunction<typeof tmp.dirSync>;
+
+    beforeEach(() => {
+      jest.resetModules();
+      process.env = { ...originalEnv };
+
+      dirSyncMock.mockClear();
+      dirSyncMock.mockReturnValue({
+        name: 'tempDir',
+        removeCallback: jest.fn(),
+      });
+    });
+
+    afterEach(() => {
+      try {
+        fs.rmSync('tempDir', { recursive: true, force: true });
+      } catch (e) {
+        // Ignore error
+      }
+    });
+
+    afterAll(() => {
+      process.env = originalEnv;
+    });
+
+    it('should call tmp.dirSync with tmpdir option when SNYK_TMP_PATH is set', async () => {
+      const tmpDirPath = './test-temp-dir';
+      process.env.SNYK_TMP_PATH = tmpDirPath;
+
+      await inspectInstalledDeps(
+        'python3',
+        [],
+        '.',
+        'test/unit/fixtures/requirements.txt',
+        false,
+        false,
+        true
+      );
+
+      expect(dirSyncMock).toHaveBeenCalledWith({
+        tmpdir: tmpDirPath,
+        unsafeCleanup: true,
+      });
+      expect(dirSyncMock).toHaveBeenCalledTimes(1);
+    });
+
+    it('should call tmp.dirSync without tmpdir option when SNYK_TMP_PATH is not set', async () => {
+      process.env.SNYK_TMP_PATH = undefined;
+
+      await inspectInstalledDeps(
+        'python3',
+        [],
+        '.',
+        'test/unit/fixtures/requirements.txt',
+        false,
+        false,
+        true
+      );
+
+      expect(dirSyncMock).toHaveBeenCalledWith({ unsafeCleanup: true });
+      expect(dirSyncMock).toHaveBeenCalledTimes(1);
+    });
+  });
+});