Prevent telemetry popup from making the test instance hang

Author: aeisenberg

.vscode/launch.json

@@ -20,7 +20,7 @@
       "env": {
         // change to 'true' debug the IDE or Query servers
         "IDE_SERVER_JAVA_DEBUG": "false",
-        "QUERY_SERVER_JAVA_DEBUG": "false",
+        "QUERY_SERVER_JAVA_DEBUG": "false"
       }
     },
     {
@@ -47,7 +47,10 @@
       "stopOnEntry": false,
       "sourceMaps": true,
       "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen"
+      "internalConsoleOptions": "neverOpen",
+      "env": {
+        "VSCODE_TEST": "true"
+      }
     },
     {
       "name": "Launch Integration Tests - No Workspace (vscode-codeql)",
@@ -63,6 +66,9 @@
       "outFiles": [
         "${workspaceRoot}/extensions/ql-vscode/out/**/*.js",
       ],
+      "env": {
+        "VSCODE_TEST": "true"
+      }
     },
     {
       "name": "Launch Integration Tests - Minimal Workspace (vscode-codeql)",
@@ -79,6 +85,9 @@
       "outFiles": [
         "${workspaceRoot}/extensions/ql-vscode/out/**/*.js",
       ],
+      "env": {
+        "VSCODE_TEST": "true"
+      }
     },
     {
       "name": "Launch Integration Tests - With CLI",
@@ -91,13 +100,16 @@
         "${workspaceRoot}/extensions/ql-vscode/src/vscode-tests/cli-integration/data",
         // Add a path to a checked out instance of the codeql repository so the libraries are
         // available in the workspace for the tests.
-        // "${workspaceRoot}/../codeql"
+        "${workspaceRoot}/../codeql"
       ],
       "stopOnEntry": false,
       "sourceMaps": true,
       "outFiles": [
         "${workspaceRoot}/extensions/ql-vscode/out/**/*.js",
       ],
+      "env": {
+        "VSCODE_TEST": "true"
+      }
     }
   ]
 }

extensions/ql-vscode/src/helpers.ts

@@ -80,6 +80,19 @@ async function internalShowAndLog(
   return result;
 }
 
+/**
+ * Always avoid modal dialogs during tests. During tests, the VSCODE_TEST
+ * env variable is set. Use that to override the requested value of modal.
+ *
+ * Modals prevent the vscode process from ending when tests are complete.
+ *
+ * @param modal
+ */
+function showModal(modal: boolean) {
+  const isTest = !!process.env.VSCODE_TEST;
+  return !isTest && modal;
+}
+
 /**
  * Opens a modal dialog for the user to make a yes/no choice.
  *
@@ -95,7 +108,7 @@ async function internalShowAndLog(
 export async function showBinaryChoiceDialog(message: string, modal = true): Promise<boolean | undefined> {
   const yesItem = { title: 'Yes', isCloseAffordance: false };
   const noItem = { title: 'No', isCloseAffordance: true };
-  const chosenItem = await Window.showInformationMessage(message, { modal }, yesItem, noItem);
+  const chosenItem = await Window.showInformationMessage(message, { modal: showModal(modal) }, yesItem, noItem);
   if (!chosenItem) {
     return undefined;
   }
@@ -106,8 +119,6 @@ export async function showBinaryChoiceDialog(message: string, modal = true): Pro
  * Opens a modal dialog for the user to make a yes/no choice.
  *
  * @param message The message to show.
- * @param modal If true (the default), show a modal dialog box, otherwise dialog is non-modal and can
- *        be closed even if the user does not make a choice.
  *
  * @return
  *  `true` if the user clicks 'Yes',
@@ -124,7 +135,7 @@ export async function showBinaryChoiceWithUrlDialog(message: string, url: string
   // To prevent an infinite loop, if the user clicks 'more information' 5 times, close the dialog and return cancelled
   let count = 0;
   do {
-    chosenItem = await Window.showInformationMessage(message, { modal: true }, urlItem, yesItem, noItem);
+    chosenItem = await Window.showInformationMessage(message, { modal: showModal(true) }, urlItem, yesItem, noItem);
     if (chosenItem === urlItem) {
       await env.openExternal(Uri.parse(url, true));
     }

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

@@ -1,13 +1,16 @@
-import * as assert from 'assert';
-import * as vscode from 'vscode';
+import { expect } from 'chai';
+import { Extension, extensions } from 'vscode';
+import { CodeQLExtensionInterface } from '../../extension';
 
 // Note that this may open the most recent VSCode workspace.
 describe('launching with no specified workspace', () => {
-  const ext = vscode.extensions.getExtension('GitHub.vscode-codeql');
-  it('should install the extension', () => {
-    assert(ext);
+  let ext: Extension<CodeQLExtensionInterface> | undefined;
+  beforeEach(async () => {
+    ext = await extensions.getExtension<CodeQLExtensionInterface>('GitHub.vscode-codeql');
   });
-  it('should not activate the extension at first', () => {
-    assert(ext!.isActive === false);
+
+  it('should not activate the extension at first', async () => {
+    expect(ext).not.to.be.undefined;
+    expect(ext!.isActive).to.be.false;
   });
 });

extensions/ql-vscode/src/vscode-tests/no-workspace/telemetry.test.ts

@@ -67,6 +67,12 @@ describe('telemetry reporting', function() {
     }
   });
 
+  it('should avoid modal dialogs', () => {
+    // This test ensures that modal dialogs will not show up. This is a cause of hanging
+    // tests.
+    expect(!!process.env.VSCODE_TEST).to.be.true;
+  });
+
   it('should initialize telemetry when both options are enabled', async () => {
     await telemetryListener.initialize();
 

extensions/ql-vscode/src/vscode-tests/run-integration-tests.ts

@@ -96,7 +96,10 @@ async function main() {
         vscodeExecutablePath,
         extensionDevelopmentPath,
         extensionTestsPath: path.resolve(__dirname, dir, 'index'),
-        launchArgs
+        launchArgs,
+        extensionTestsEnv: {
+          VSCODE_TEST: 'true'
+        }
       }, 3);
     }
   } catch (err) {