Merge pull request #294 from jcreedcmu/jcreed/fix-quick-eval

Fix quick-eval in .qll error

Author: jcreedcmu

common/config/rush/pnpm-lock.yaml

@@ -444,6 +444,8 @@
     "webpack-cli": "^3.3.2",
     "eslint": "~6.8.0",
     "@typescript-eslint/eslint-plugin": "~2.23.0",
-    "@typescript-eslint/parser": "~2.23.0"
+    "@typescript-eslint/parser": "~2.23.0",
+    "chai-as-promised": "~7.1.1",
+    "@types/chai-as-promised": "~7.1.2"
   }
 }

extensions/ql-vscode/package.json

@@ -313,7 +313,7 @@ type SelectedQuery = {
  * @param selectedResourceUri The selected resource when the command was run.
  * @param quickEval Whether the command being run is `Quick Evaluation`.
 */
-async function determineSelectedQuery(selectedResourceUri: vscode.Uri | undefined, quickEval: boolean): Promise<SelectedQuery> {
+export async function determineSelectedQuery(selectedResourceUri: vscode.Uri | undefined, quickEval: boolean): Promise<SelectedQuery> {
   const editor = vscode.window.activeTextEditor;
 
   // Choose which QL file to use.
@@ -336,8 +336,15 @@ async function determineSelectedQuery(selectedResourceUri: vscode.Uri | undefine
   }
   const queryPath = queryUri.fsPath || '';
 
-  if (!queryPath.endsWith('.ql')) {
-    throw new Error('The selected resource is not a CodeQL query file; It should have the extension ".ql".');
+  if (quickEval) {
+    if (!(queryPath.endsWith('.ql') || queryPath.endsWith('.qll'))) {
+      throw new Error('The selected resource is not a CodeQL file; It should have the extension ".ql" or ".qll".');
+    }
+  }
+  else {
+    if (!(queryPath.endsWith('.ql'))) {
+      throw new Error('The selected resource is not a CodeQL query file; It should have the extension ".ql".');
+    }
   }
 
   // Whether we chose the file from the active editor or from a context menu,

extensions/ql-vscode/src/run-queries.ts

@@ -1,6 +1,12 @@
 import * as assert from 'assert';
+import * as chai from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+import 'mocha';
 import * as path from 'path';
 import * as vscode from 'vscode';
+import * as determiningSelectedQueryTest from './determining-selected-query-test';
+
+chai.use(chaiAsPromised);
 
 describe('launching with a minimal workspace', async () => {
   const ext = vscode.extensions.getExtension('GitHub.vscode-codeql');
@@ -24,3 +30,5 @@ describe('launching with a minimal workspace', async () => {
     }, 1000);
   });
 });
+
+determiningSelectedQueryTest.run();

extensions/ql-vscode/src/vscode-tests/minimal-workspace/activation.test.ts

@@ -0,0 +1,44 @@
+import { expect } from 'chai';
+import * as path from 'path';
+import * as vscode from 'vscode';
+import { Uri } from 'vscode';
+import { determineSelectedQuery } from '../../run-queries';
+
+async function showQlDocument(name: string): Promise<vscode.TextDocument> {
+  const folderPath = vscode.workspace.workspaceFolders![0].uri.fsPath;
+  const documentPath = path.resolve(folderPath, name);
+  const document = await vscode.workspace.openTextDocument(documentPath);
+  await vscode.window.showTextDocument(document!);
+  return document;
+}
+
+export function run() {
+  describe('Determining selected query', async () => {
+    it('should allow ql files to be queried', async () => {
+      const q = await determineSelectedQuery(Uri.parse('file:///tmp/queryname.ql'), false);
+      expect(q.queryPath).to.equal(path.join('/', 'tmp', 'queryname.ql'));
+      expect(q.quickEvalPosition).to.equal(undefined);
+    });
+
+    it('should allow ql files to be quick-evaled', async () => {
+      const doc = await showQlDocument('query.ql');
+      const q = await determineSelectedQuery(doc.uri, true);
+      expect(q.queryPath).to.satisfy((p: string) => p.endsWith(path.join('ql-vscode', 'test', 'data', 'query.ql')));
+    });
+
+    it('should allow qll files to be quick-evaled', async () => {
+      const doc = await showQlDocument('library.qll');
+      const q = await determineSelectedQuery(doc.uri, true);
+      expect(q.queryPath).to.satisfy((p: string) => p.endsWith(path.join('ql-vscode', 'test', 'data', 'library.qll')));
+    });
+
+    it('should reject non-ql files when running a query', async () => {
+      await expect(determineSelectedQuery(Uri.parse('file:///tmp/queryname.txt'), false)).to.be.rejectedWith(Error, 'The selected resource is not a CodeQL query file');
+      await expect(determineSelectedQuery(Uri.parse('file:///tmp/queryname.qll'), false)).to.be.rejectedWith(Error, 'The selected resource is not a CodeQL query file');
+    });
+
+    it('should reject non-ql[l] files when running a quick eval', async () => {
+      await expect(determineSelectedQuery(Uri.parse('file:///tmp/queryname.txt'), true)).to.be.rejectedWith(Error, 'The selected resource is not a CodeQL file');
+    });
+  });
+}

extensions/ql-vscode/src/vscode-tests/minimal-workspace/determining-selected-query-test.ts

@@ -0,0 +1,3 @@
+predicate foo() {
+ 1 == 1
+}