analysis-paths.test.ts

import * as path from "path";

import test from "ava";

import * as analysisPaths from "./analysis-paths";
import { setupTests } from "./testing-utils";
import * as util from "./util";

setupTests(test);

test("emptyPaths", async (t) => {
  return await util.withTmpDir(async (tmpDir) => {
    const config = {
      languages: [],
      queries: {},
      pathsIgnore: [],
      paths: [],
      originalUserInput: {},
      tempDir: tmpDir,
      codeQLCmd: "",
      gitHubVersion: { type: util.GitHubVariant.DOTCOM } as util.GitHubVersion,
      dbLocation: path.resolve(tmpDir, "codeql_databases"),
      packs: {},
      debugMode: false,
      debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
      debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
      augmentationProperties: {
        injectedMlQueries: false,
        packsInputCombines: false,
        queriesInputCombines: false,
      },
      trapCaches: {},
      trapCacheDownloadTime: 0,
    };
    analysisPaths.includeAndExcludeAnalysisPaths(config);
    t.is(process.env["LGTM_INDEX_INCLUDE"], undefined);
    t.is(process.env["LGTM_INDEX_EXCLUDE"], undefined);
    t.is(process.env["LGTM_INDEX_FILTERS"], undefined);
  });
});

test("nonEmptyPaths", async (t) => {
  return await util.withTmpDir(async (tmpDir) => {
    const config = {
      languages: [],
      queries: {},
      paths: ["path1", "path2", "**/path3"],
      pathsIgnore: ["path4", "path5", "path6/**"],
      originalUserInput: {},
      tempDir: tmpDir,
      codeQLCmd: "",
      gitHubVersion: { type: util.GitHubVariant.DOTCOM } as util.GitHubVersion,
      dbLocation: path.resolve(tmpDir, "codeql_databases"),
      packs: {},
      debugMode: false,
      debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
      debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
      augmentationProperties: {
        injectedMlQueries: false,
        packsInputCombines: false,
        queriesInputCombines: false,
      },
      trapCaches: {},
      trapCacheDownloadTime: 0,
    };
    analysisPaths.includeAndExcludeAnalysisPaths(config);
    t.is(process.env["LGTM_INDEX_INCLUDE"], "path1\npath2");
    t.is(process.env["LGTM_INDEX_EXCLUDE"], "path4\npath5");
    t.is(
      process.env["LGTM_INDEX_FILTERS"],
      "include:path1\ninclude:path2\ninclude:**/path3\nexclude:path4\nexclude:path5\nexclude:path6/**",
    );
  });
});

test("exclude temp dir", async (t) => {
  const tempDir = path.join(process.cwd(), "codeql-runner-temp");
  const config = {
    languages: [],
    queries: {},
    pathsIgnore: [],
    paths: [],
    originalUserInput: {},
    tempDir,
    codeQLCmd: "",
    gitHubVersion: { type: util.GitHubVariant.DOTCOM } as util.GitHubVersion,
    dbLocation: path.resolve(tempDir, "codeql_databases"),
    packs: {},
    debugMode: false,
    debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
    debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
    augmentationProperties: {
      injectedMlQueries: false,
      packsInputCombines: false,
      queriesInputCombines: false,
    },
    trapCaches: {},
    trapCacheDownloadTime: 0,
  };
  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);
});