Merge pull request #236 from github/ignore-temp-dir

Exclude the temporary directory from scanning.
github · Oct 5, 2020 · 5cdfcab · 5cdfcab
2 parents d0afe92 + 11c1460
commit 5cdfcab
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 11 deletions.
diff --git a/lib/analysis-paths.js b/lib/analysis-paths.js
diff --git a/lib/analysis-paths.js.map b/lib/analysis-paths.js.map
diff --git a/lib/analysis-paths.test.js b/lib/analysis-paths.test.js
diff --git a/lib/analysis-paths.test.js.map b/lib/analysis-paths.test.js.map
diff --git a/src/analysis-paths.test.ts b/src/analysis-paths.test.ts
@@ -1,3 +1,5 @@
+import * as path from "path";
+
 import test from "ava";
 
 import * as analysisPaths from "./analysis-paths";
@@ -46,3 +48,23 @@ test("nonEmptyPaths", async (t) => {
     );
   });
 });
+
+test("exclude temp dir", async (t) => {
+  return await util.withTmpDir(async (toolCacheDir) => {
+    const tempDir = path.join(process.cwd(), "codeql-runner-temp");
+    const config = {
+      languages: [],
+      queries: {},
+      pathsIgnore: [],
+      paths: [],
+      originalUserInput: {},
+      tempDir,
+      toolCacheDir,
+      codeQLCmd: "",
+    };
+    analysisPaths.includeAndExcludeAnalysisPaths(config);
+    t.is(process.env["LGTM_INDEX_INCLUDE"], undefined);
+    t.is(process.env["LGTM_INDEX_EXCLUDE"], "codeql-runner-temp");
+    t.is(process.env["LGTM_INDEX_FILTERS"], undefined);
+  });
+});
diff --git a/src/analysis-paths.ts b/src/analysis-paths.ts
@@ -1,3 +1,5 @@
+import * as path from "path";
+
 import * as configUtils from "./config-utils";
 import { Logger } from "./logging";
 
@@ -48,10 +50,21 @@ export function includeAndExcludeAnalysisPaths(config: configUtils.Config) {
   if (config.paths.length !== 0) {
     process.env["LGTM_INDEX_INCLUDE"] = buildIncludeExcludeEnvVar(config.paths);
   }
-  if (config.pathsIgnore.length !== 0) {
-    process.env["LGTM_INDEX_EXCLUDE"] = buildIncludeExcludeEnvVar(
-      config.pathsIgnore
-    );
+  // If the temporary or tools directory is in the working directory ignore that too.
+  const tempRelativeToWorking = path.relative(process.cwd(), config.tempDir);
+  const toolsRelativeToWorking = path.relative(
+    process.cwd(),
+    config.toolCacheDir
+  );
+  let pathsIgnore = config.pathsIgnore;
+  if (!tempRelativeToWorking.startsWith("..")) {
+    pathsIgnore = pathsIgnore.concat(tempRelativeToWorking);
+  }
+  if (!toolsRelativeToWorking.startsWith("..")) {
+    pathsIgnore = pathsIgnore.concat(toolsRelativeToWorking);
+  }
+  if (pathsIgnore.length !== 0) {
+    process.env["LGTM_INDEX_EXCLUDE"] = buildIncludeExcludeEnvVar(pathsIgnore);
   }
 
   // The 'LGTM_INDEX_FILTERS' environment variable controls which files are