Add checkPacksForOverlayCompatibility()

Author: cklin

src/init.test.ts

@@ -1,9 +1,14 @@
 import * as fs from "fs";
 import path from "path";
 
-import test from "ava";
+import test, { ExecutionContext } from "ava";
 
-import { cleanupDatabaseClusterDirectory } from "./init";
+import { setCodeQL } from "./codeql";
+import {
+  checkPacksForOverlayCompatibility,
+  cleanupDatabaseClusterDirectory,
+} from "./init";
+import { Language } from "./languages";
 import {
   LoggedMessage,
   createTestConfig,
@@ -106,3 +111,287 @@ for (const { runnerEnv, ErrorConstructor, message } of [
     });
   });
 }
+
+type PackInfo = {
+  language: Language;
+  packinfoContents: string | undefined;
+  sourceOnlyPack?: boolean;
+};
+
+const testCheckPacksForOverlayCompatibility = test.macro({
+  exec: async (
+    t: ExecutionContext,
+    _title: string,
+    {
+      cliOverlayVersion,
+      languages,
+      packs,
+      expectedResult,
+    }: {
+      cliOverlayVersion: number | undefined;
+      languages: Language[];
+      packs: Record<string, PackInfo>;
+      expectedResult: boolean;
+    },
+  ) => {
+    await withTmpDir(async (tmpDir) => {
+      const packDirsByLanguage = new Map<Language, string[]>();
+
+      for (const [packName, packInfo] of Object.entries(packs)) {
+        const packPath = path.join(tmpDir, packName);
+        fs.mkdirSync(packPath, { recursive: true });
+        if (packInfo.packinfoContents) {
+          fs.writeFileSync(
+            path.join(packPath, ".packinfo"),
+            packInfo.packinfoContents,
+          );
+        }
+        fs.writeFileSync(
+          path.join(packPath, "qlpack.yml"),
+          packInfo.sourceOnlyPack
+            ? `name: ${packName}\nversion: 1.0.0\n`
+            : `name: ${packName}\nversion: 1.0.0\nbuildMetadata:\n sha: 123abc\n`,
+        );
+
+        if (!packDirsByLanguage.has(packInfo.language)) {
+          packDirsByLanguage.set(packInfo.language, []);
+        }
+        packDirsByLanguage.get(packInfo.language)!.push(packPath);
+      }
+
+      const codeql = setCodeQL({
+        getVersion: async () => ({
+          version: "2.22.2",
+          overlayVersion: cliOverlayVersion,
+        }),
+        resolveQueriesStartingPacks: async (suitePaths: string[]) => {
+          for (const language of packDirsByLanguage.keys()) {
+            const suiteForLanguage = path.join(
+              language,
+              "temp",
+              "config-queries.qls",
+            );
+            if (suitePaths[0].endsWith(suiteForLanguage)) {
+              return packDirsByLanguage.get(language) || [];
+            }
+          }
+          return [];
+        },
+      });
+
+      const messages: LoggedMessage[] = [];
+      const result = await checkPacksForOverlayCompatibility(
+        codeql,
+        createTestConfig({ dbLocation: tmpDir, languages }),
+        getRecordingLogger(messages),
+      );
+      t.is(result, expectedResult);
+      t.deepEqual(
+        messages.length,
+        expectedResult ? 0 : 1,
+        "Expected log messages",
+      );
+    });
+  },
+  title: (_, title) => `checkPacksForOverlayCompatibility: ${title}`,
+});
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns false when CLI does not support overlay",
+  {
+    cliOverlayVersion: undefined,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+    },
+    expectedResult: false,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns true when there are no query packs",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {},
+    expectedResult: true,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns true when query pack has not been compiled",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: undefined,
+        sourceOnlyPack: true,
+      },
+    },
+    expectedResult: true,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns true when query pack has expected overlay version",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+    },
+    expectedResult: true,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns true when query packs for all languages to analyze are compatible",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.cpp, Language.java],
+    packs: {
+      "codeql/cpp-queries": {
+        language: Language.cpp,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+    },
+    expectedResult: true,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns true when query pack for a language not analyzed is incompatible",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/cpp-queries": {
+        language: Language.cpp,
+        packinfoContents: undefined,
+      },
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+    },
+    expectedResult: true,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns false when query pack for a language to analyze is incompatible",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.cpp, Language.java],
+    packs: {
+      "codeql/cpp-queries": {
+        language: Language.cpp,
+        packinfoContents: '{"overlayVersion":1}',
+      },
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+    },
+    expectedResult: false,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns false when query pack is missing .packinfo",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+      "custom/queries": {
+        language: Language.java,
+        packinfoContents: undefined,
+      },
+    },
+    expectedResult: false,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns false when query pack has different overlay version",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+      "custom/queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":1}',
+      },
+    },
+    expectedResult: false,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns false when query pack is missing overlayVersion in .packinfo",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+      "custom/queries": {
+        language: Language.java,
+        packinfoContents: "{}",
+      },
+    },
+    expectedResult: false,
+  },
+);
+
+test(
+  testCheckPacksForOverlayCompatibility,
+  "returns false when .packinfo is not valid JSON",
+  {
+    cliOverlayVersion: 2,
+    languages: [Language.java],
+    packs: {
+      "codeql/java-queries": {
+        language: Language.java,
+        packinfoContents: '{"overlayVersion":2}',
+      },
+      "custom/queries": {
+        language: Language.java,
+        packinfoContents: "this_is_not_valid_json",
+      },
+    },
+    expectedResult: false,
+  },
+);