Verify .vscode folder will be created automatically when extension is activated (#2411)

EzioLi01 · web-flow · commit 7301a364c11a · 2025-09-10T13:50:35.000+08:00
diff --git a/test/smoke/suites/activation.test.ts b/test/smoke/suites/activation.test.ts
@@ -16,19 +16,13 @@ export function startExtensionActivationTests(): void {
         }
 
         async function dispose() {
-            try {
-                if (this.currentTest?.state === "failed") {
-                    SmokeTestLogger.info("Test failed, taking screenshot ...");
-                    await screenshots.takeScreenshots(
-                        this.currentTest.parent?.title || "Others",
-                        this.currentTest.title.replace(/\s+/g, "_"),
-                    );
-                }
-            } catch (error) {
-                // Log error when screenshot get error, but not throw exception
-                SmokeTestLogger.log(`Error with taking screenshot: ${error}`);
+            if (this.currentTest?.state === "failed") {
+                SmokeTestLogger.info("Test failed, taking screenshot ...");
+                await screenshots.takeScreenshots(
+                    this.currentTest.parent?.title || "Others",
+                    this.currentTest.title.replace(/\s+/g, "_"),
+                );
             }
-
             try {
                 SmokeTestLogger.info(`Dispose test: "${this.currentTest.title}" ...`);
                 if (app) {
diff --git a/test/smoke/suites/commands.test.ts b/test/smoke/suites/commands.test.ts
@@ -7,6 +7,7 @@ import { app, screenshots } from "./main";
 import * as assert from "assert";
 import { ElementHelper } from "./helper/elementHelper";
 import { Element } from "./helper/constants";
+import { ComponentHelper } from "./helper/componentHelper";
 
 export function startCommandPaletteTests(): void {
     describe("CommandPaletteTest", () => {
@@ -16,19 +17,13 @@ export function startCommandPaletteTests(): void {
         }
 
         async function dispose() {
-            try {
-                if (this.currentTest?.state === "failed") {
-                    SmokeTestLogger.info("Test failed, taking screenshot ...");
-                    await screenshots.takeScreenshots(
-                        this.currentTest.parent?.title || "Others",
-                        this.currentTest.title.replace(/\s+/g, "_"),
-                    );
-                }
-            } catch (error) {
-                // Log error when screenshot get error, but not throw exception
-                SmokeTestLogger.log(`Error with taking screenshot: ${error}`);
+            if (this.currentTest?.state === "failed") {
+                SmokeTestLogger.info("Test failed, taking screenshot ...");
+                await screenshots.takeScreenshots(
+                    this.currentTest.parent?.title || "Others",
+                    this.currentTest.title.replace(/\s+/g, "_"),
+                );
             }
-
             try {
                 SmokeTestLogger.info(`Dispose test: "${this.currentTest.title}" ...`);
                 if (app) {
@@ -45,7 +40,7 @@ export function startCommandPaletteTests(): void {
             const text = "React Native: Start Packager";
             await initApp();
 
-            await ElementHelper.openCommandPalette();
+            await ComponentHelper.openCommandPalette();
             await ElementHelper.WaitElementClassNameVisible(Element.commandPaletteClassName, 5000);
 
             await ElementHelper.inputText(text);
diff --git a/test/smoke/suites/fileExplorer.test.ts b/test/smoke/suites/fileExplorer.test.ts
@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for details.
+
+import { Page } from "playwright";
+import { SmokeTestLogger } from "./helper/smokeTestLogger";
+import { app, screenshots } from "./main";
+import { CommonHelper } from "./helper/commonHelper";
+import { ComponentHelper } from "./helper/componentHelper";
+import assert = require("assert");
+
+export function startFileExplorerTests(): void {
+    describe("FileExplorerTest", () => {
+        async function initApp(): Promise<Page> {
+            await app.launch();
+            return app.getMainPage();
+        }
+
+        async function dispose() {
+            if (this.currentTest?.state === "failed") {
+                SmokeTestLogger.info("Test failed, taking screenshot ...");
+                await screenshots.takeScreenshots(
+                    this.currentTest.parent?.title || "Others",
+                    this.currentTest.title.replace(/\s+/g, "_"),
+                );
+            }
+            try {
+                SmokeTestLogger.info(`Dispose test: "${this.currentTest.title}" ...`);
+                if (app) {
+                    await app.close();
+                }
+            } catch (error) {
+                SmokeTestLogger.error(`Error while dispose: ${error}`);
+            }
+        }
+
+        afterEach(dispose);
+
+        it("Verify .vscode folder will be created when extension is activated", async () => {
+            const projectName = "sampleReactNativeProject";
+            const folderName = ".vscode";
+            await CommonHelper.findAndDeleteVSCodeSettingsDirectory(projectName);
+
+            await initApp();
+
+            await ComponentHelper.openFileExplorer();
+            const folder = await ComponentHelper.WaitFileVisibleInFileExplorer(folderName);
+
+            assert.notStrictEqual(folder, null);
+        });
+    });
+}
diff --git a/test/smoke/suites/helper/commonHelper.ts b/test/smoke/suites/helper/commonHelper.ts
@@ -0,0 +1,33 @@
+import * as fs from "fs";
+import * as rimraf from "rimraf";
+import * as path from "path";
+import { SmokeTestLogger } from "./smokeTestLogger";
+
+export class CommonHelper {
+    public static async findAndDeleteDirectory(projectPath: string): Promise<void> {
+        const isExisting = await this.isDirectoryExisting(projectPath);
+        if (isExisting) {
+            try {
+                rimraf.sync(projectPath);
+                SmokeTestLogger.log(`Complete to delete target dir: ${projectPath}`);
+            } catch (error) {
+                throw new Error(`Fail to delete target dir: ${projectPath}`);
+            }
+        }
+    }
+
+    public static async isDirectoryExisting(projectPath: string): Promise<boolean> {
+        if (fs.existsSync(projectPath)) {
+            SmokeTestLogger.log(`Target dir is existing: ${projectPath}`);
+            return true;
+        } else {
+            SmokeTestLogger.log(`Target dir is not existing: ${projectPath}`);
+            return false;
+        }
+    }
+
+    public static async findAndDeleteVSCodeSettingsDirectory(projectName: string): Promise<void> {
+        const projectPath = path.join(__dirname, "..", "..", "resources", projectName, ".vscode");
+        await this.findAndDeleteDirectory(projectPath);
+    }
+}
diff --git a/test/smoke/suites/helper/componentHelper.ts b/test/smoke/suites/helper/componentHelper.ts
@@ -0,0 +1,46 @@
+import { ElementHandle, Page } from "playwright";
+import { app } from "../main";
+import { ElementHelper } from "./elementHelper";
+import { Element } from "./constants";
+import { SmokeTestLogger } from "./smokeTestLogger";
+
+export class ComponentHelper {
+    static setPage(): Page {
+        const application = app;
+        return application.getMainPage();
+    }
+
+    public static async openCommandPalette() {
+        const cmdKey = process.platform === "darwin" ? "Meta" : "Control";
+        await ElementHelper.sendKeys(`${cmdKey}+Shift+P`);
+    }
+
+    public static async openFileExplorer() {
+        try {
+            await ElementHelper.WaitElementSelectorVisible(`[id="${Element.fileExplorerViewId}"]`);
+            SmokeTestLogger.log("File explorer view is already opened.");
+        } catch {
+            const explorerIcon = await ElementHelper.WaitElementSelectorVisible(
+                Element.fileExplorerIconSelector,
+            );
+            explorerIcon.click();
+            await ElementHelper.WaitElementSelectorVisible(
+                `[id="${Element.fileExplorerViewId}"]`,
+                2000,
+            );
+        }
+    }
+
+    public static async WaitFileVisibleInFileExplorer(
+        fileName: string,
+    ): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        try {
+            return await ElementHelper.WaitElementSelectorVisible(
+                `[aria-label="${fileName}"]`,
+                2000,
+            );
+        } catch {
+            return null;
+        }
+    }
+}
diff --git a/test/smoke/suites/helper/constants.ts b/test/smoke/suites/helper/constants.ts
@@ -7,4 +7,6 @@ export class Element {
     public static vscodeWorkbenchClassName = "monaco-workbench";
     public static commandPaletteClassName = "quick-input-widget";
     public static commandPaletteFocusedItemSelector = "#quickInput_list .monaco-list-row.focused";
+    public static fileExplorerIconSelector = ".action-label.codicon.codicon-explorer-view-icon";
+    public static fileExplorerViewId = "workbench.view.explorer";
 }
diff --git a/test/smoke/suites/helper/elementHelper.ts b/test/smoke/suites/helper/elementHelper.ts
@@ -7,34 +7,33 @@ export class ElementHelper {
         return application.getMainPage();
     }
 
-    public static async openCommandPalette() {
-        const cmdKey = process.platform === "darwin" ? "Meta" : "Control";
-        await this.setPage().keyboard.press(`${cmdKey}+Shift+P`);
-    }
-
     public static async inputText(input: string) {
         await this.setPage().keyboard.type(input);
     }
 
+    public static async sendKeys(keys: string) {
+        await this.setPage().keyboard.press(keys);
+    }
+
     public static async WaitElementClassNameVisible(
         className: string,
-        timeout: number,
+        timeout: number = 1000,
     ): Promise<ElementHandle<SVGElement | HTMLElement>> {
         const element = await this.setPage().waitForSelector(`.${className}`, { timeout: timeout });
         return element;
     }
 
     public static async WaitElementIdVisible(
         id: string,
-        timeout: number,
+        timeout: number = 1000,
     ): Promise<ElementHandle<SVGElement | HTMLElement>> {
         const element = await this.setPage().waitForSelector(`#${id}`, { timeout: timeout });
         return element;
     }
 
     public static async WaitElementSelectorVisible(
         selector: string,
-        timeout: number,
+        timeout: number = 1000,
     ): Promise<ElementHandle<SVGElement | HTMLElement>> {
         const element = await this.setPage().waitForSelector(selector, { timeout: timeout });
         return element;
diff --git a/test/smoke/suites/helper/screenshot.ts b/test/smoke/suites/helper/screenshot.ts
@@ -2,6 +2,7 @@ import * as fs from "fs";
 import * as mkdirp from "mkdirp";
 import * as path from "path";
 import { app } from "../main";
+import { SmokeTestLogger } from "./smokeTestLogger";
 
 export class Screenshots {
     private application = app;
@@ -30,12 +31,17 @@ export class Screenshots {
     }
 
     async takeScreenshots(suiteName: string, fileName: string): Promise<void> {
-        const platform = await this.prepareScreenshotFolderForPlatform();
+        try {
+            const platform = await this.prepareScreenshotFolderForPlatform();
 
-        const mainPage = this.application.getMainPage();
-        await mainPage.screenshot({
-            path: `screenshots/${platform}/${suiteName}/${fileName}.jpg`,
-            fullPage: true,
-        });
+            const mainPage = this.application.getMainPage();
+            await mainPage.screenshot({
+                path: `screenshots/${platform}/${suiteName}/${fileName}.jpg`,
+                fullPage: true,
+            });
+        } catch (error) {
+            // Log error when screenshot get error, but not throw exception
+            SmokeTestLogger.log(`Error with taking screenshot: ${error}`);
+        }
     }
 }
diff --git a/test/smoke/suites/helper/utilities.ts b/test/smoke/suites/helper/utilities.ts
@@ -182,58 +182,6 @@ export function findStringInFile(filePath: string, strToFind: string): boolean {
     return false;
 }
 
-export async function findStringInFileWithTimeout(
-    filePath: string,
-    strToFind: string,
-    timeout?: number,
-): Promise<boolean> {
-    const condition = () => findStringInFile(filePath, strToFind);
-    return waitUntil(condition, timeout, 3000);
-}
-
-export function retrieveStringsFromLogFile(
-    filePath: string,
-    pattern: RegExp,
-): RegExpMatchArray | null {
-    if (fs.existsSync(filePath)) {
-        const content = fs.readFileSync(filePath).toString().trim();
-        return content.match(pattern);
-    }
-    return null;
-}
-
-export async function retrieveStringsFromLogFileWithTimeout(
-    filePath: string,
-    pattern: RegExp,
-    timeout?: number,
-): Promise<RegExpMatchArray | null> {
-    let result: RegExpMatchArray | null = null;
-    const condition = () => {
-        result = retrieveStringsFromLogFile(filePath, pattern);
-        return !!result;
-    };
-    await waitUntil(condition, timeout, 3000);
-    return result;
-}
-
-export function objectsContains(object: any, subObject: any): boolean {
-    for (let i = 0; i < Object.keys(subObject).length; i++) {
-        const key = Object.keys(subObject)[i];
-        if (typeof subObject[key] === "object" && subObject[key] !== null) {
-            if (typeof object[key] === "object" && object[key] !== null) {
-                if (!objectsContains(object[key], subObject[key])) {
-                    return false;
-                }
-            } else {
-                return false;
-            }
-        } else if (subObject[key] !== object[key]) {
-            return false;
-        }
-    }
-    return true;
-}
-
 export function waitUntil(
     condition: () => boolean,
     timeout: number = 30000,
diff --git a/test/smoke/suites/smoke.test.ts b/test/smoke/suites/smoke.test.ts
@@ -3,6 +3,7 @@
 
 import { startExtensionActivationTests } from "./activation.test";
 import { startCommandPaletteTests } from "./commands.test";
+import { startFileExplorerTests } from "./fileExplorer.test";
 import { SmokeTestLogger } from "./helper/smokeTestLogger";
 import { smokeTestFail } from "./helper/utilities";
 
@@ -26,5 +27,6 @@ export function startSmokeTests(setup: () => Promise<void>, cleanUp: () => Promi
         startExtensionActivationTests();
 
         startCommandPaletteTests();
+        startFileExplorerTests();
     });
 }

Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,6 @@ export class Element {`
`7`	`7`	`public static vscodeWorkbenchClassName = "monaco-workbench";`
`8`	`8`	`public static commandPaletteClassName = "quick-input-widget";`
`9`	`9`	`public static commandPaletteFocusedItemSelector = "#quickInput_list .monaco-list-row.focused";`
	`10`	`+ public static fileExplorerIconSelector = ".action-label.codicon.codicon-explorer-view-icon";`
	`11`	`+ public static fileExplorerViewId = "workbench.view.explorer";`
`10`	`12`	`}`