Merge pull request #518 from github/aibaars-no-queries

Ensure queries[language] objects are initialized

lib/analyze.js

@@ -87,7 +87,8 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
     for (const language of config.languages) {
         logger.startGroup(`Analyzing ${language}`);
         const queries = config.queries[language];
-        if (queries.builtin.length === 0 && queries.custom.length === 0) {
+        if (queries === undefined ||
+            (queries.builtin.length === 0 && queries.custom.length === 0)) {
             throw new Error(`Unable to analyse ${language} as no queries were selected for this language`);
         }
         try {

lib/config-utils.js

@@ -394,6 +394,12 @@ function shouldAddConfigFileQueries(queriesInput) {
 async function getDefaultConfig(languagesInput, queriesInput, dbLocation, repository, tempDir, toolCacheDir, codeQL, checkoutPath, gitHubVersion, apiDetails, logger) {
     const languages = await getLanguages(languagesInput, repository, apiDetails, logger);
     const queries = {};
+    for (const language of languages) {
+        queries[language] = {
+            builtin: [],
+            custom: [],
+        };
+    }
     await addDefaultQueries(codeQL, languages, queries);
     if (queriesInput) {
         await addQueriesFromWorkflow(codeQL, queriesInput, languages, queries, tempDir, checkoutPath, apiDetails, logger);
@@ -437,6 +443,12 @@ async function loadConfig(languagesInput, queriesInput, configFile, dbLocation,
     }
     const languages = await getLanguages(languagesInput, repository, apiDetails, logger);
     const queries = {};
+    for (const language of languages) {
+        queries[language] = {
+            builtin: [],
+            custom: [],
+        };
+    }
     const pathsIgnore = [];
     const paths = [];
     let disableDefaultQueries = false;
@@ -491,16 +503,6 @@ async function loadConfig(languagesInput, queriesInput, configFile, dbLocation,
             paths.push(validateAndSanitisePath(includePath, PATHS_PROPERTY, configFile, logger));
         }
     }
-    // The list of queries should not be empty for any language. If it is then
-    // it is a user configuration error.
-    for (const language of languages) {
-        if (queries[language] === undefined ||
-            (queries[language].builtin.length === 0 &&
-                queries[language].custom.length === 0)) {
-            throw new Error(`Did not detect any queries to run for ${language}. ` +
-                "Please make sure that the default queries are enabled, or you are specifying queries to run.");
-        }
-    }
     return {
         languages,
         queries,
@@ -533,6 +535,16 @@ async function initConfig(languagesInput, queriesInput, configFile, dbLocation,
     else {
         config = await loadConfig(languagesInput, queriesInput, configFile, dbLocation, repository, tempDir, toolCacheDir, codeQL, checkoutPath, gitHubVersion, apiDetails, logger);
     }
+    // The list of queries should not be empty for any language. If it is then
+    // it is a user configuration error.
+    for (const language of config.languages) {
+        if (config.queries[language] === undefined ||
+            (config.queries[language].builtin.length === 0 &&
+                config.queries[language].custom.length === 0)) {
+            throw new Error(`Did not detect any queries to run for ${language}. ` +
+                "Please make sure that the default queries are enabled, or you are specifying queries to run.");
+        }
+    }
     // Save the config so we can easily access it again in the future
     await saveConfig(config, logger);
     return config;

lib/config-utils.test.js

@@ -66,7 +66,10 @@ ava_1.default("load empty config", async (t) => {
         const codeQL = codeql_1.setCodeQL({
             async resolveQueries() {
                 return {
-                    byLanguage: {},
+                    byLanguage: {
+                        javascript: { queries: ["query1.ql"] },
+                        python: { queries: ["query2.ql"] },
+                    },
                     noDeclaredLanguage: {},
                     multipleDeclaredLanguages: {},
                 };
@@ -82,7 +85,10 @@ ava_1.default("loading config saves config", async (t) => {
         const codeQL = codeql_1.setCodeQL({
             async resolveQueries() {
                 return {
-                    byLanguage: {},
+                    byLanguage: {
+                        javascript: { queries: ["query1.ql"] },
+                        python: { queries: ["query2.ql"] },
+                    },
                     noDeclaredLanguage: {},
                     multipleDeclaredLanguages: {},
                 };

src/analyze.ts

@@ -162,7 +162,10 @@ export async function runQueries(
     logger.startGroup(`Analyzing ${language}`);
 
     const queries = config.queries[language];
-    if (queries.builtin.length === 0 && queries.custom.length === 0) {
+    if (
+      queries === undefined ||
+      (queries.builtin.length === 0 && queries.custom.length === 0)
+    ) {
       throw new Error(
         `Unable to analyse ${language} as no queries were selected for this language`
       );

src/config-utils.test.ts

@@ -68,7 +68,10 @@ test("load empty config", async (t) => {
     const codeQL = setCodeQL({
       async resolveQueries() {
         return {
-          byLanguage: {},
+          byLanguage: {
+            javascript: { queries: ["query1.ql"] },
+            python: { queries: ["query2.ql"] },
+          },
           noDeclaredLanguage: {},
           multipleDeclaredLanguages: {},
         };
@@ -116,7 +119,10 @@ test("loading config saves config", async (t) => {
     const codeQL = setCodeQL({
       async resolveQueries() {
         return {
-          byLanguage: {},
+          byLanguage: {
+            javascript: { queries: ["query1.ql"] },
+            python: { queries: ["query2.ql"] },
+          },
           noDeclaredLanguage: {},
           multipleDeclaredLanguages: {},
         };

src/config-utils.ts

@@ -760,6 +760,12 @@ export async function getDefaultConfig(
     logger
   );
   const queries: Queries = {};
+  for (const language of languages) {
+    queries[language] = {
+      builtin: [],
+      custom: [],
+    };
+  }
   await addDefaultQueries(codeQL, languages, queries);
   if (queriesInput) {
     await addQueriesFromWorkflow(
@@ -834,6 +840,12 @@ async function loadConfig(
   );
 
   const queries: Queries = {};
+  for (const language of languages) {
+    queries[language] = {
+      builtin: [],
+      custom: [],
+    };
+  }
   const pathsIgnore: string[] = [];
   const paths: string[] = [];
 
@@ -925,21 +937,6 @@ async function loadConfig(
     }
   }
 
-  // The list of queries should not be empty for any language. If it is then
-  // it is a user configuration error.
-  for (const language of languages) {
-    if (
-      queries[language] === undefined ||
-      (queries[language].builtin.length === 0 &&
-        queries[language].custom.length === 0)
-    ) {
-      throw new Error(
-        `Did not detect any queries to run for ${language}. ` +
-          "Please make sure that the default queries are enabled, or you are specifying queries to run."
-      );
-    }
-  }
-
   return {
     languages,
     queries,
@@ -1016,6 +1013,21 @@ export async function initConfig(
     );
   }
 
+  // The list of queries should not be empty for any language. If it is then
+  // it is a user configuration error.
+  for (const language of config.languages) {
+    if (
+      config.queries[language] === undefined ||
+      (config.queries[language].builtin.length === 0 &&
+        config.queries[language].custom.length === 0)
+    ) {
+      throw new Error(
+        `Did not detect any queries to run for ${language}. ` +
+          "Please make sure that the default queries are enabled, or you are specifying queries to run."
+      );
+    }
+  }
+
   // Save the config so we can easily access it again in the future
   await saveConfig(config, logger);
   return config;