let the codeql env decide the supported languages

Author: esbena

src/analyze.test.ts

@@ -10,7 +10,7 @@ import { runQueries } from "./analyze";
 import { setCodeQL } from "./codeql";
 import { Config } from "./config-utils";
 import * as count from "./count-loc";
-import { Language } from "./languages";
+import { KnownLanguage } from "./languages";
 import { getRunnerLogger } from "./logging";
 import { setupTests, setupActionsVars } from "./testing-utils";
 import * as util from "./util";
@@ -21,8 +21,8 @@ setupTests(test);
 // and correct case of builtin or custom. Also checks the correct search
 // paths are set in the database analyze invocation.
 test("status report fields and search path setting", async (t) => {
-  const mockLinesOfCode = Object.values(Language).reduce((obj, lang, i) => {
-    // use a different line count for each language
+  const mockLinesOfCode = Object.values(KnownLanguage).reduce((obj, lang, i) => {
+    // use a different line count for each KnownLanguage
     obj[lang] = i + 1;
     return obj;
   }, {});
@@ -35,21 +35,21 @@ test("status report fields and search path setting", async (t) => {
     const addSnippetsFlag = "";
     const threadsFlag = "";
     const packs = {
-      [Language.cpp]: [
+      [KnownLanguage.cpp]: [
         {
           packName: "a/b",
           version: clean("1.0.0")!,
         },
       ],
-      [Language.java]: [
+      [KnownLanguage.java]: [
         {
           packName: "c/d",
           version: clean("2.0.0")!,
         },
       ],
     };
 
-    for (const language of Object.values(Language)) {
+    for (const language of Object.values(KnownLanguage)) {
       setCodeQL({
         packDownload: async () => ({ packs: [] }),
         databaseRunQueries: async (
@@ -203,7 +203,7 @@ test("status report fields and search path setting", async (t) => {
 
   function verifyLineCounts(tmpDir: string) {
     // eslint-disable-next-line github/array-foreach
-    Object.keys(Language).forEach((lang, i) => {
+    Object.keys(KnownLanguage).forEach((lang, i) => {
       verifyLineCountForFile(path.join(tmpDir, `${lang}.sarif`), i + 1);
     });
   }
@@ -249,14 +249,14 @@ test("status report fields and search path setting", async (t) => {
         version: "2.0.0",
       },
     ];
-    for (const lang of Object.values(Language)) {
+    for (const lang of Object.values(KnownLanguage)) {
       t.deepEqual(readContents(`${lang}-queries-builtin.qls`), qlsContent);
       t.deepEqual(readContents(`${lang}-queries-custom-0.qls`), qlsContent);
       t.deepEqual(readContents(`${lang}-queries-custom-1.qls`), qlsContent2);
       const packSuiteName = `${lang}-queries-packs.qls`;
-      if (lang === Language.cpp) {
+      if (lang === KnownLanguage.cpp) {
         t.deepEqual(readContents(packSuiteName), qlsPackContentCpp);
-      } else if (lang === Language.java) {
+      } else if (lang === KnownLanguage.java) {
         t.deepEqual(readContents(packSuiteName), qlsPackContentJava);
       } else {
         t.false(

src/analyze.ts

@@ -8,7 +8,7 @@ import * as analysisPaths from "./analysis-paths";
 import { CODEQL_VERSION_COUNTS_LINES, getCodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
 import { countLoc } from "./count-loc";
-import { isScannedLanguage, Language } from "./languages";
+import { isScannedLanguage, KnownLanguage, Language } from "./languages";
 import { Logger } from "./logging";
 import * as sharedEnv from "./shared-environment";
 import * as util from "./util";
@@ -124,7 +124,7 @@ async function createdDBForScannedLanguages(
     ) {
       logger.startGroup(`Extracting ${language}`);
 
-      if (language === Language.python) {
+      if (language === KnownLanguage.python) {
         await setupPythonExtractor(logger);
       }
 

src/config-utils.test.ts

@@ -9,7 +9,7 @@ import * as sinon from "sinon";
 import * as api from "./api-client";
 import { getCachedCodeQL, setCodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
-import { Language } from "./languages";
+import { KnownLanguage, Language } from "./languages";
 import { getRunnerLogger } from "./logging";
 import { setupTests } from "./testing-utils";
 import * as util from "./util";
@@ -299,7 +299,7 @@ test("load non-empty input", async (t) => {
 
     // And the config we expect it to parse to
     const expectedConfig: configUtils.Config = {
-      languages: [Language.javascript],
+      languages: [KnownLanguage.javascript],
       queries: {
         javascript: {
           builtin: [],
@@ -998,7 +998,7 @@ test("Unknown languages", async (t) => {
     } catch (err) {
       t.deepEqual(
         err,
-        new Error(configUtils.getUnknownLanguagesError(["rubbish", "english"]))
+        new Error(configUtils.getUnsupportedLanguagesError(["rubbish", "english"]))
       );
     }
   });
@@ -1044,7 +1044,7 @@ test("Config specifies packages", async (t) => {
       getRunnerLogger(true)
     );
     t.deepEqual(packs as unknown, {
-      [Language.javascript]: [
+      [KnownLanguage.javascript]: [
         {
           packName: "a/b",
           version: clean("1.2.3"),
@@ -1102,13 +1102,13 @@ test("Config specifies packages for multiple languages", async (t) => {
       getRunnerLogger(true)
     );
     t.deepEqual(packs as unknown, {
-      [Language.javascript]: [
+      [KnownLanguage.javascript]: [
         {
           packName: "a/b",
           version: clean("1.2.3"),
         },
       ],
-      [Language.python]: [
+      [KnownLanguage.python]: [
         {
           packName: "c/d",
           version: clean("1.2.3"),
@@ -1377,8 +1377,8 @@ parsePacksErrorMacro.title = (providedTitle: string) =>
 function invalidPackNameMacro(t: ExecutionContext<unknown>, name: string) {
   parsePacksErrorMacro(
     t,
-    { [Language.cpp]: [name] },
-    [Language.cpp],
+    { [KnownLanguage.cpp]: [name] },
+    [KnownLanguage.cpp],
     new RegExp(
       `The configuration file "/a/b" is invalid: property "packs" "${name}" is not a valid pack`
     )
@@ -1388,8 +1388,8 @@ invalidPackNameMacro.title = (_: string, arg: string) =>
   `Invalid pack string: ${arg}`;
 
 test("no packs", parsePacksMacro, {}, [], {});
-test("two packs", parsePacksMacro, ["a/b", "c/d@1.2.3"], [Language.cpp], {
-  [Language.cpp]: [
+test("two packs", parsePacksMacro, ["a/b", "c/d@1.2.3"], [KnownLanguage.cpp], {
+  [KnownLanguage.cpp]: [
     { packName: "a/b", version: undefined },
     { packName: "c/d", version: clean("1.2.3") },
   ],
@@ -1398,9 +1398,9 @@ test(
   "two packs with spaces",
   parsePacksMacro,
   [" a/b ", " c/d@1.2.3 "],
-  [Language.cpp],
+  [KnownLanguage.cpp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "a/b", version: undefined },
       { packName: "c/d", version: clean("1.2.3") },
     ],
@@ -1410,16 +1410,16 @@ test(
   "two packs with language",
   parsePacksMacro,
   {
-    [Language.cpp]: ["a/b", "c/d@1.2.3"],
-    [Language.java]: ["d/e", "f/g@1.2.3"],
+    [KnownLanguage.cpp]: ["a/b", "c/d@1.2.3"],
+    [KnownLanguage.java]: ["d/e", "f/g@1.2.3"],
   },
-  [Language.cpp, Language.java, Language.csharp],
+  [KnownLanguage.cpp, KnownLanguage.java, KnownLanguage.csharp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "a/b", version: undefined },
       { packName: "c/d", version: clean("1.2.3") },
     ],
-    [Language.java]: [
+    [KnownLanguage.java]: [
       { packName: "d/e", version: undefined },
       { packName: "f/g", version: clean("1.2.3") },
     ],
@@ -1430,21 +1430,21 @@ test(
   "no language",
   parsePacksErrorMacro,
   ["a/b@1.2.3"],
-  [Language.java, Language.python],
+  [KnownLanguage.java, KnownLanguage.python],
   /The configuration file "\/a\/b" is invalid: property "packs" must split packages by language/
 );
 test(
   "invalid language",
   parsePacksErrorMacro,
-  { [Language.java]: ["c/d"] },
-  [Language.cpp],
+  { [KnownLanguage.java]: ["c/d"] },
+  [KnownLanguage.cpp],
   /The configuration file "\/a\/b" is invalid: property "packs" has "java", but it is not one of the languages to analyze/
 );
 test(
   "not an array",
   parsePacksErrorMacro,
-  { [Language.cpp]: "c/d" },
-  [Language.cpp],
+  { [KnownLanguage.cpp]: "c/d" },
+  [KnownLanguage.cpp],
   /The configuration file "\/a\/b" is invalid: property "packs" must be an array of non-empty strings/
 );
 
@@ -1496,18 +1496,18 @@ function parseInputAndConfigErrorMacro(
 parseInputAndConfigErrorMacro.title = (providedTitle: string) =>
   `Parse Packs input and config Error: ${providedTitle}`;
 
-test("input only", parseInputAndConfigMacro, {}, " c/d ", [Language.cpp], {
-  [Language.cpp]: [{ packName: "c/d", version: undefined }],
+test("input only", parseInputAndConfigMacro, {}, " c/d ", [KnownLanguage.cpp], {
+  [KnownLanguage.cpp]: [{ packName: "c/d", version: undefined }],
 });
 
 test(
   "input only with multiple",
   parseInputAndConfigMacro,
   {},
   "a/b , c/d@1.2.3",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "a/b", version: undefined },
       { packName: "c/d", version: "1.2.3" },
     ],
@@ -1519,9 +1519,9 @@ test(
   parseInputAndConfigMacro,
   {},
   "  +  a/b , c/d@1.2.3 ",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "a/b", version: undefined },
       { packName: "c/d", version: "1.2.3" },
     ],
@@ -1533,9 +1533,9 @@ test(
   parseInputAndConfigMacro,
   ["a/b", "c/d"],
   "  ",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "a/b", version: undefined },
       { packName: "c/d", version: undefined },
     ],
@@ -1547,9 +1547,9 @@ test(
   parseInputAndConfigMacro,
   ["a/b", "c/d"],
   " e/f, g/h@1.2.3 ",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "e/f", version: undefined },
       { packName: "g/h", version: "1.2.3" },
     ],
@@ -1561,9 +1561,9 @@ test(
   parseInputAndConfigMacro,
   ["a/b", "c/d"],
   " +e/f, g/h@1.2.3 ",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   {
-    [Language.cpp]: [
+    [KnownLanguage.cpp]: [
       { packName: "e/f", version: undefined },
       { packName: "g/h", version: "1.2.3" },
       { packName: "a/b", version: undefined },
@@ -1586,7 +1586,7 @@ test(
   parseInputAndConfigErrorMacro,
   {},
   "c/d",
-  [Language.cpp, Language.csharp],
+  [KnownLanguage.cpp, KnownLanguage.csharp],
   /multi-language analysis/
 );
 
@@ -1595,7 +1595,7 @@ test(
   parseInputAndConfigErrorMacro,
   {},
   " + ",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   /remove the '\+'/
 );
 
@@ -1604,7 +1604,7 @@ test(
   parseInputAndConfigErrorMacro,
   {},
   " xxx",
-  [Language.cpp],
+  [KnownLanguage.cpp],
   /"xxx" is not a valid pack/
 );
 

src/config-utils.ts

@@ -673,8 +673,8 @@ export function getNoLanguagesError(): string {
   );
 }
 
-export function getUnknownLanguagesError(languages: string[]): string {
-  return `Did not recognise the following languages: ${languages.join(", ")}`;
+export function getUnsupportedLanguagesError(languages: string[]): string {
+  return `Does not support the following languages: ${languages.join(", ")}`;
 }
 
 /**
@@ -714,8 +714,10 @@ async function getLanguagesInRepo(
  * has been set, otherwise it is deduced as all languages in the repo that
  * can be analysed.
  *
- * If no languages could be detected from either the workflow or the repository
+ * If no supported languages could be detected from either the workflow or the repository
  * then throw an error.
+ * 
+ * The set of supported languages is defined by the `codeql resolve languages` command.
  */
 async function getLanguages(
   codeQL: CodeQL,
@@ -731,11 +733,11 @@ async function getLanguages(
     .filter((x) => x.length > 0);
   logger.info(`Languages from configuration: ${JSON.stringify(languages)}`);
 
+  const allSupportedLanguages = new Set(Object.keys(await codeQL.resolveLanguages()));
   if (languages.length === 0) {
     // Obtain languages as all languages in the repo that can be analysed
     languages = await getLanguagesInRepo(repository, apiDetails, logger);
-    const availableLanguages = await codeQL.resolveLanguages();
-    languages = languages.filter((value) => value in availableLanguages);
+    languages = languages.filter((value) => allSupportedLanguages.has(value));
     logger.info(
       `Automatically detected languages: ${JSON.stringify(languages)}`
     );
@@ -748,21 +750,21 @@ async function getLanguages(
   }
 
   // Make sure they are supported
-  const parsedLanguages: Language[] = [];
-  const unknownLanguages: string[] = [];
+  const supportedLanguages: Language[] = [];
+  const unsupportedLanguages: Language[] = [];
   for (const language of languages) {
     const parsedLanguage = parseLanguage(language);
-    if (parsedLanguage === undefined) {
-      unknownLanguages.push(language);
-    } else if (parsedLanguages.indexOf(parsedLanguage) === -1) {
-      parsedLanguages.push(parsedLanguage);
+    if (!allSupportedLanguages.has(parsedLanguage)) {
+      unsupportedLanguages.push(language);
+    } else if (supportedLanguages.indexOf(parsedLanguage) === -1) {
+      supportedLanguages.push(parsedLanguage);
     }
   }
-  if (unknownLanguages.length > 0) {
-    throw new Error(getUnknownLanguagesError(unknownLanguages));
+  if (unsupportedLanguages.length > 0) {
+    throw new Error(getUnsupportedLanguagesError(unsupportedLanguages));
   }
 
-  return parsedLanguages;
+  return supportedLanguages;
 }
 
 async function addQueriesFromWorkflow(
@@ -1071,7 +1073,7 @@ export function parsePacksFromConfig(
     if (!Array.isArray(packsArr)) {
       throw new Error(getPacksInvalid(configFile));
     }
-    if (!languages.includes(lang as Language)) {
+    if (!languages.includes(lang)) {
       throw new Error(getPacksRequireLanguage(lang, configFile));
     }
     packs[lang] = [];