Merge pull request #4820 from microsoft/mimatias/test-timeout-fix

Fix integration tests timeouts and events

Author: michelleangela

Extension/package.json

@@ -1762,7 +1762,7 @@
     "mkdirp": "^0.5.1",
     "plist": "^3.0.1",
     "tmp": "^0.1.0",
-    "vscode-cpptools": "3.0.1",
+    "vscode-cpptools": "^3.1.0",
     "vscode-debugadapter": "^1.35.0",
     "vscode-debugprotocol": "^1.35.0",
     "vscode-extension-telemetry": "^0.1.2",

Extension/src/LanguageServer/client.ts

@@ -11,7 +11,7 @@ import {
     RequestType, ErrorAction, CloseAction, DidOpenTextDocumentParams, Range, Position, DocumentFilter
 } from 'vscode-languageclient';
 import { SourceFileConfigurationItem, WorkspaceBrowseConfiguration, SourceFileConfiguration, Version } from 'vscode-cpptools';
-import { Status } from 'vscode-cpptools/out/testApi';
+import { Status, IntelliSenseStatus } from 'vscode-cpptools/out/testApi';
 import * as util from '../common';
 import * as configs from './configurations';
 import { CppSettings, OtherSettings } from './settings';
@@ -1681,11 +1681,13 @@ export class DefaultClient implements Client {
         let testHook: TestHook = getTestHook();
         if (message.endsWith("Indexing...")) {
             this.model.isTagParsing.Value = true;
-            testHook.updateStatus(Status.TagParsingBegun);
+            let status: IntelliSenseStatus = { status: Status.TagParsingBegun };
+            testHook.updateStatus(status);
         } else if (message.endsWith("Updating IntelliSense...")) {
             timeStamp = Date.now();
             this.model.isUpdatingIntelliSense.Value = true;
-            testHook.updateStatus(Status.IntelliSenseCompiling);
+            let status: IntelliSenseStatus = { status: Status.IntelliSenseCompiling };
+            testHook.updateStatus(status);
         } else if (message.endsWith("IntelliSense Ready")) {
             let settings: CppSettings = new CppSettings(this.RootUri);
             if (settings.loggingLevel === "Debug") {
@@ -1694,11 +1696,18 @@ export class DefaultClient implements Client {
                 out.appendLine(localize("update.intellisense.time", "Update IntelliSense time (sec): {0}", duration / 1000));
             }
             this.model.isUpdatingIntelliSense.Value = false;
-            testHook.updateStatus(Status.IntelliSenseReady);
+            let status: IntelliSenseStatus = { status: Status.IntelliSenseReady };
+            testHook.updateStatus(status);
         } else if (message.endsWith("Ready")) { // Tag Parser Ready
             this.model.isTagParsing.Value = false;
-            testHook.updateStatus(Status.TagParsingDone);
+            let status: IntelliSenseStatus = { status: Status.TagParsingDone };
+            testHook.updateStatus(status);
             util.setProgress(util.getProgressParseRootSuccess());
+        } else if (message.includes("Squiggles Finished - File name:")) {
+            let index: number = message.lastIndexOf(":");
+            let name: string = message.substring(index + 2);
+            let status: IntelliSenseStatus = { status: Status.IntelliSenseReady, filename: name, };
+            testHook.updateStatus(status);
         } else if (message.endsWith("No Squiggles")) {
             util.setIntelliSenseProgress(util.getProgressIntelliSenseNoSquiggles());
         } else if (message.endsWith("Unresolved Headers") && this.configuration.CurrentConfiguration.configurationProvider === undefined) {

Extension/src/testHook.ts

@@ -4,25 +4,33 @@
  * ------------------------------------------------------------------------------------------ */
 'use strict';
 
-import { CppToolsTestHook, Status } from 'vscode-cpptools/out/testApi';
+import { CppToolsTestHook, Status, IntelliSenseStatus } from 'vscode-cpptools/out/testApi';
 import * as vscode from 'vscode';
 
 export class TestHook implements CppToolsTestHook {
+    private intelliSenseStatusChangedEvent: vscode.EventEmitter<IntelliSenseStatus> = new vscode.EventEmitter<IntelliSenseStatus>();
     private statusChangedEvent: vscode.EventEmitter<Status> = new vscode.EventEmitter<Status>();
 
+    // The StatusChanged event is deprecated in CppToolsTestHook API.
     public get StatusChanged(): vscode.Event<Status> {
         return this.statusChangedEvent.event;
     }
 
+    public get IntelliSenseStatusChanged(): vscode.Event<IntelliSenseStatus> {
+        return this.intelliSenseStatusChangedEvent.event;
+    }
+
     public get valid(): boolean {
-        return !!this.statusChangedEvent;
+        return !!this.intelliSenseStatusChangedEvent;
     }
 
-    public updateStatus(status: Status): void {
-        this.statusChangedEvent.fire(status);
+    public updateStatus(status: IntelliSenseStatus): void {
+        this.intelliSenseStatusChangedEvent.fire(status);
     }
 
     public dispose(): void {
+        this.intelliSenseStatusChangedEvent.dispose();
+        this.intelliSenseStatusChangedEvent = null;
         this.statusChangedEvent.dispose();
         this.statusChangedEvent = null;
     }

Extension/test/integrationTests/languageServer/index.ts

@@ -28,7 +28,7 @@ testRunner.configure({
     ui: 'tdd', 		// the TDD UI is being used in *.test.ts (suite, test, etc.)
     useColors: true, // colored output from test results
     fullStackTrace: true,
-    timeout: 60000
+    timeout: 120000
 });
 
 const logFolder: string = path.join(__dirname, ".logs");

Extension/test/integrationTests/languageServer/languageServer.integration.test.ts

@@ -10,16 +10,12 @@ import * as util from '../../../src/common';
 import * as api from 'vscode-cpptools';
 import * as apit from 'vscode-cpptools/out/testApi';
 import * as config from '../../../src/LanguageServer/configurations';
-import { getActiveClient } from '../../../src/LanguageServer/extension';
-import { initializeTemporaryCommandRegistrar } from '../../../src/commands';
 
-const defaultTimeout: number = 60000;
+const defaultTimeout: number = 100000;
 
 suite("multiline comment setting tests", function(): void {
     suiteSetup(async function(): Promise<void> {
         let extension: vscode.Extension<any> = vscode.extensions.getExtension("ms-vscode.cpptools");
-        util.setExtensionPath(extension.extensionPath);
-        initializeTemporaryCommandRegistrar();
         if (!extension.isActive) {
             await extension.activate();
         }
@@ -93,20 +89,12 @@ function cppPropertiesPath(): string {
 }
 
 async function changeCppProperties(cppProperties: config.ConfigurationJson, disposables: vscode.Disposable[]): Promise<void> {
-    let promise: Promise<void> = new Promise<void>((resolve, reject) => {
-        disposables.push(getActiveClient().ActiveConfigChanged(name => {
-            if (name === cppProperties.configurations[0].name) {
-                resolve();
-            }
-        }));
-
-        // Can't trust the file watcher, so we need to allocate additional time for the backup watcher to fire.
-        setTimeout(() => { reject(new Error("timeout")); }, 4000);
-    });
     await util.writeFileText(cppPropertiesPath(), JSON.stringify(cppProperties));
     let contents: string = await util.readFileText(cppPropertiesPath());
     console.log("    wrote c_cpp_properties.json: " + contents);
-    return promise;
+
+    // Sleep for 4000ms for file watcher
+    return new Promise(r => setTimeout(r, 4000));
 }
 
 /******************************************************************************/
@@ -188,15 +176,16 @@ suite("extensibility tests v3", function(): void {
         disposables.forEach(d => d.dispose());
     });
 
-    test("Check provider", async () => {
+    test("Check provider - main3.cpp", async () => {
         // Open a c++ file to start the language server.
         let path: string = vscode.workspace.workspaceFolders[0].uri.fsPath + "/main3.cpp";
         let uri: vscode.Uri = vscode.Uri.file(path);
 
         let testHook: apit.CppToolsTestHook = cpptools.getTestHook();
         let testResult: any = new Promise<void>((resolve, reject) => {
-            disposables.push(testHook.StatusChanged(status => {
-                if (status === apit.Status.IntelliSenseReady) {
+            disposables.push(testHook.IntelliSenseStatusChanged(result => {
+                result = result as apit.IntelliSenseStatus;
+                if (result.filename === "main3.cpp" && result.status === apit.Status.IntelliSenseReady) {
                     let expected: api.SourceFileConfigurationItem[] = [ {uri: uri.toString(), configuration: defaultConfig} ];
                     assert.deepEqual(lastResult, expected);
                     assert.deepEqual(lastBrowseResult, defaultFolderBrowseConfig);
@@ -280,15 +269,16 @@ suite("extensibility tests v2", function(): void {
         disposables.forEach(d => d.dispose());
     });
 
-    test("Check provider", async () => {
+    test("Check provider - main2.cpp", async () => {
         // Open a c++ file to start the language server.
         let path: string = vscode.workspace.workspaceFolders[0].uri.fsPath + "/main2.cpp";
         let uri: vscode.Uri = vscode.Uri.file(path);
 
         let testHook: apit.CppToolsTestHook = cpptools.getTestHook();
         let testResult: any = new Promise<void>((resolve, reject) => {
-            disposables.push(testHook.StatusChanged(status => {
-                if (status === apit.Status.IntelliSenseReady) {
+            disposables.push(testHook.IntelliSenseStatusChanged(result => {
+                result = result as apit.IntelliSenseStatus;
+                if (result.filename === "main2.cpp" && result.status === apit.Status.IntelliSenseReady) {
                     let expected: api.SourceFileConfigurationItem[] = [ {uri: uri.toString(), configuration: defaultConfig} ];
                     assert.deepEqual(lastResult, expected);
                     assert.deepEqual(lastBrowseResult, defaultBrowseConfig);
@@ -357,15 +347,16 @@ suite("extensibility tests v1", function(): void {
         disposables.forEach(d => d.dispose());
     });
 
-    test("Check provider", async () => {
+    test("Check provider - main1.cpp", async () => {
         // Open a c++ file to start the language server.
         let path: string = vscode.workspace.workspaceFolders[0].uri.fsPath + "/main1.cpp";
         let uri: vscode.Uri = vscode.Uri.file(path);
 
         let testHook: apit.CppToolsTestHook = cpptools.getTestHook();
         let testResult: any = new Promise<void>((resolve, reject) => {
-            disposables.push(testHook.StatusChanged(status => {
-                if (status === apit.Status.IntelliSenseReady) {
+            disposables.push(testHook.IntelliSenseStatusChanged(result => {
+                result = result as apit.IntelliSenseStatus;
+                if (result.filename === "main1.cpp" && result.status === apit.Status.IntelliSenseReady) {
                     let expected: api.SourceFileConfigurationItem[] = [ {uri: uri.toString(), configuration: defaultConfig} ];
                     assert.deepEqual(lastResult, expected);
                     resolve();
@@ -430,15 +421,16 @@ suite("extensibility tests v0", function(): void {
         await util.deleteFile(cppPropertiesPath());
     });
 
-    test("Check provider", async () => {
+    test("Check provider - main.cpp", async () => {
         // Open a C++ file to start the language server.
         let path: string = vscode.workspace.workspaceFolders[0].uri.fsPath + "/main.cpp";
         let uri: vscode.Uri = vscode.Uri.file(path);
 
         let testHook: apit.CppToolsTestHook = cpptools.getTestHook();
         let testResult: any = new Promise<void>((resolve, reject) => {
-            disposables.push(testHook.StatusChanged(status => {
-                if (status === apit.Status.IntelliSenseReady) {
+            disposables.push(testHook.IntelliSenseStatusChanged(result => {
+                result = result as apit.IntelliSenseStatus;
+                if (result.filename === "main.cpp" && result.status === apit.Status.IntelliSenseReady) {
                     let expected: api.SourceFileConfigurationItem[] = [ {uri: uri.toString(), configuration: defaultConfig} ];
                     assert.deepEqual(lastResult, expected);
                     resolve();

Extension/yarn.lock

@@ -5160,10 +5160,10 @@ vrsource-tslint-rules@^6.0.0:
   resolved "https://registry.yarnpkg.com/vrsource-tslint-rules/-/vrsource-tslint-rules-6.0.0.tgz#a4e25e8f3fdd487684174f423c090c35d60f37a9"
   integrity sha512-pmcnJdIVziZTk1V0Cqehmh3gIabBRkBYXkv9vx+1CZDNEa41kNGUBFwQLzw21erYOd2QnD8jJeZhBGqnlT1HWw==
 
-vscode-cpptools@3.0.1:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/vscode-cpptools/-/vscode-cpptools-3.0.1.tgz#35ea986a48ac14eda85f3989ba5eedc64886c0c2"
-  integrity sha512-KAbwWhG36Ahnug9frcCOvWI3dUb3mzWeTqB6NQjIkzAazRTJWT/PiZ7gxpY/+jQIUylbbiU9ezWmzIIm8nP+TQ==
+vscode-cpptools@^3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/vscode-cpptools/-/vscode-cpptools-3.1.0.tgz#fbc0e493e81a05baf01702ea8b9467c39fba257d"
+  integrity sha512-z4W/A1TQMEtqTEWNY3Hb4HJcJ2J3HeaLHp3TyqCotoRkLU8ovH4jmDb5tNTyh3DgIiaAAnDalO03A4wm5IvNBg==
 
 vscode-debugadapter@^1.35.0:
   version "1.37.1"