Merge pull request #2501 from microsoft/extract-uplicate-code-as-a-common-base-class

Extract duplicate code as a common base class

Author: EmmaYuan1015

test/smoke/suites/activation.test.ts

@@ -1,44 +1,20 @@
 // 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 assert = require("assert");
 import { ElementHelper } from "./helper/elementHelper";
 import { Constant } from "./helper/constants";
+import { BaseSmokeTest } from "./helper/baseSmokeTest";
+import { SmokeTestLogger } from "./helper/smokeTestLogger";
 import { TimeoutConstants } from "./helper/timeoutConstants";
 
 export function startExtensionActivationTests(): void {
     describe("ExtensionActivationTest", () => {
-        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);
+        afterEach(BaseSmokeTest.dispose);
 
         it("Verify extension is activated", async () => {
             let isActivited = false;
-            await initApp();
+            await BaseSmokeTest.initApp();
 
             try {
                 await ElementHelper.WaitElementSelectorVisible(

test/smoke/suites/cdpNodeVersionCompatibility.test.ts

@@ -1,44 +1,20 @@
 // 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 * as assert from "assert";
 import { ComponentHelper } from "./helper/componentHelper";
 import { ElementHelper } from "./helper/elementHelper";
 import { Element } from "./helper/constants";
+import { BaseSmokeTest } from "./helper/baseSmokeTest";
+import { SmokeTestLogger } from "./helper/smokeTestLogger";
 import { TimeoutConstants } from "./helper/timeoutConstants";
 
 export function startCDPNodeVersionCompatibilityTests(): void {
     describe("CDPNodeVersionCompatibilityTest", () => {
-        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);
+        afterEach(BaseSmokeTest.dispose);
 
         it("Verify Run and Debug tab is accessible for debugging operations", async () => {
-            await initApp();
+            await BaseSmokeTest.initApp();
 
             await ComponentHelper.openRunAndDebugTab();
             await ElementHelper.WaitElementClassNameVisible(
@@ -50,7 +26,7 @@ export function startCDPNodeVersionCompatibilityTests(): void {
         });
 
         it("Verify command palette can access debug-related commands", async () => {
-            await initApp();
+            await BaseSmokeTest.initApp();
 
             await ComponentHelper.openCommandPalette();
             await ElementHelper.WaitElementClassNameVisible(
@@ -70,7 +46,7 @@ export function startCDPNodeVersionCompatibilityTests(): void {
         });
 
         it("Verify React Native packager is available for debugging", async () => {
-            await initApp();
+            await BaseSmokeTest.initApp();
 
             await ComponentHelper.getReactNativePackager();
             SmokeTestLogger.info("React Native packager is available for debugging");

test/smoke/suites/helper/baseSmokeTest.ts

@@ -0,0 +1,41 @@
+// 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 "./smokeTestLogger";
+import { app, screenshots } from "../main";
+
+/**
+ * Base class for smoke tests that provides common setup and teardown functionality
+ */
+export class BaseSmokeTest {
+    /**
+     * Initialize the application and return the main page
+     */
+    public static async initApp(): Promise<Page> {
+        await app.launch();
+        return app.getMainPage();
+    }
+
+    /**
+     * Common dispose function to be called after each test
+     * Takes screenshots on failure and closes the app
+     */
+    public static async dispose(this: any): Promise<void> {
+        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}`);
+        }
+    }
+}