test: add docker bot sso sample (#11504)

* test: add docker sample --------- Co-authored-by: Ivan_Chen <[email protected]>
OfficeDev · Apr 29, 2024 · f43dc91 · f43dc91
1 parent 1e362ee
commit f43dc91
Show file tree

Hide file tree

Showing 11 changed files with 274 additions and 56 deletions.
diff --git a/.github/workflows/ui-test.yml b/.github/workflows/ui-test.yml
@@ -438,6 +438,12 @@ jobs:
         run: |
           npm run build
 
+      - name: Install docker extension
+        if: contains(matrix.test-case,  'docker')
+        working-directory: packages/tests
+        run: |
+          npx extest install-from-marketplace --storage .test-resources --extensions_dir .test-resources --type stable ms-azuretools.vscode-docker
+
       - name: Install vsix(unix)
         if: matrix.os != 'windows-latest'
         working-directory: packages/tests

diff --git a/packages/tests/README.md b/packages/tests/README.md
@@ -49,6 +49,7 @@ CI_ENABLED=true
 - (**Required**) Run `npx extest get-chromedriver --storage .test-resources --type stable --code_version 1.88.1` to download chromedriver
 - (**Required**) Download TeamsFx vsix file to this project root folder. You can download it from the [artifacts of TeamsFx CD action](https://github.com/OfficeDev/TeamsFx/actions/workflows/cd.yml). Remember to unzip.
 - (**Required**) Run `npx extest install-vsix --storage .test-resources --extensions_dir .test-resources --type stable --vsix_file ${{ YOUR VSIX FILE NAME }} ` to install Teams Toolkit
+- (**OPTIONAL**) If local test docker cases, Run `npx extest install-from-marketplace --storage .test-resources --extensions_dir .test-resources --type stable ms-azuretools.vscode-docker` to install docker extension.
 - (**Required**) Run `npx extest run-tests --storage .test-resources --extensions_dir .test-resources --type stable --code_version 1.88.1 --code_settings ./settings.json ./out/ui-test/**/${{ YOUR TEST CASE }}.test.js` to execute your case
 - (**OPTIONAL**) If you want to debug your case via vscode, replace "YOUR TEST CASE" with your case name in .vscode/launch.json and click F5
 

diff --git a/packages/tests/scripts/randomCases.json b/packages/tests/scripts/randomCases.json
@@ -10,7 +10,8 @@
                 "node-18": []
             },
             "macos-latest": {
-                "node-16": []
+                "node-16": [],
+                "node-18": []
             }
         },
         "cases": [
@@ -171,5 +172,21 @@
             "sample-remotedebug-todo-list-sql",
             "sample-remotedebug-large-scale-notification"
         ]
+    },
+    {
+        "os": {
+            "ubuntu-latest": {
+                "node-16": [],
+                "node-18": []
+            },
+            "macos-latest": {
+                "node-16": [],
+                "node-18": []
+            }
+        },
+        "cases": [
+            "sample-localdebug-bot-sso-docker",
+            "sample-remotedebug-bot-sso-docker"
+        ]
     }
 ]
diff --git a/packages/tests/src/ui-test/cliHelper.ts b/packages/tests/src/ui-test/cliHelper.ts
@@ -17,6 +17,7 @@ import path from "path";
 import * as chai from "chai";
 import { Executor } from "../utils/executor";
 import * as os from "os";
+import { ChildProcess, ChildProcessWithoutNullStreams } from "child_process";
 
 export class CliHelper {
   static async addEnv(
@@ -615,4 +616,81 @@ export class CliHelper {
     }
     console.log("[success] debug successfully !!!");
   }
+
+  static async dockerBuild(
+    projectPath: string,
+    folder: string,
+    path = "./",
+    processEnv: NodeJS.ProcessEnv = process.env,
+    delay: number = 3 * 60 * 1000
+  ): Promise<ChildProcessWithoutNullStreams> {
+    console.log(`[start] docker build ... `);
+    const timeout = timeoutPromise(delay);
+    const childProcess = spawnCommand(
+      "docker",
+      ["build", "-t", folder, path],
+      {
+        cwd: projectPath,
+        env: processEnv ? processEnv : process.env,
+      },
+      (data) => {
+        console.log(data);
+      },
+      (error) => {
+        console.log(error);
+        if (error.includes("Error:")) {
+          chai.assert.fail(error);
+        }
+      }
+    );
+    await Promise.all([timeout, childProcess]);
+    console.log("[success] docker build successfully !!!");
+    return childProcess;
+  }
+
+  static async dockerRun(
+    projectPath: string,
+    folder: string,
+    processEnv: NodeJS.ProcessEnv = process.env,
+    delay: number = 30 * 1000
+  ): Promise<ChildProcessWithoutNullStreams> {
+    console.log(`[start] docker run ... `);
+    const timeout = timeoutPromise(delay);
+    const childProcess = spawnCommand(
+      "docker",
+      ["run", "-p", "3978:80", "--env-file", ".localConfigs", folder],
+      {
+        cwd: projectPath,
+        env: processEnv ? processEnv : process.env,
+      },
+      (data) => {
+        console.log(data);
+      },
+      (error) => {
+        console.log(error);
+        if (error.includes("Error:")) {
+          chai.assert.fail(error);
+        }
+      }
+    );
+    await Promise.all([timeout, childProcess]);
+    console.log("[success] docker run successfully !!!");
+    return childProcess;
+  }
+
+  static async stopAllDocker() {
+    console.log(`[start] docker stop all ... `);
+    let cmd = "";
+    if (os.type() === "Windows_NT") {
+      cmd = "docker ps -q | ForEach-Object { docker stop $_ }";
+    } else {
+      cmd = "docker stop $(docker ps -q)";
+    }
+    const { stderr, stdout } = await execAsync(cmd);
+    if (stderr) {
+      console.log(stderr);
+    }
+    console.log(stdout);
+    console.log("[success] docker stop all successfully !!!");
+  }
 }
diff --git a/packages/tests/src/ui-test/samples/sample-localdebug-bot-sso-docker.test.ts b/packages/tests/src/ui-test/samples/sample-localdebug-bot-sso-docker.test.ts
@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * @author Ivan Chen <[email protected]>
+ */
+
+import { Page } from "playwright";
+import { TemplateProject, LocalDebugTaskLabel } from "../../utils/constants";
+import { validateBot } from "../../utils/playwrightOperation";
+import { CaseFactory } from "./sampleCaseFactory";
+import { Env } from "../../utils/env";
+
+class BotSSODockerTestCase extends CaseFactory {
+  override async onValidate(page: Page): Promise<void> {
+    return await validateBot(page, {
+      botCommand: "show",
+      expected: Env.displayName,
+    });
+  }
+  public override async onCliValidate(page: Page): Promise<void> {
+    return await validateBot(page, {
+      botCommand: "show",
+      expected: Env.displayName,
+    });
+  }
+}
+
+new BotSSODockerTestCase(
+  TemplateProject.BotSSODocker,
+  26577671,
+  "[email protected]",
+  "local",
+  [LocalDebugTaskLabel.StartLocalTunnel, LocalDebugTaskLabel.DockerRun]
+).test();
diff --git a/packages/tests/src/ui-test/samples/sample-remotedebug-bot-sso-docker.test.ts b/packages/tests/src/ui-test/samples/sample-remotedebug-bot-sso-docker.test.ts
@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * @author Ivan Chen <[email protected]>
+ */
+
+import { Page } from "playwright";
+import { TemplateProject, LocalDebugTaskLabel } from "../../utils/constants";
+import { validateBot } from "../../utils/playwrightOperation";
+import { CaseFactory } from "./sampleCaseFactory";
+import { Env } from "../../utils/env";
+
+class BotSSODockerTestCase extends CaseFactory {
+  override async onValidate(page: Page): Promise<void> {
+    return await validateBot(page, {
+      botCommand: "show",
+      expected: Env.displayName,
+    });
+  }
+}
+
+new BotSSODockerTestCase(
+  TemplateProject.BotSSODocker,
+  27852471,
+  "[email protected]",
+  "dev",
+  undefined,
+  { container: true }
+).test();
diff --git a/packages/tests/src/ui-test/samples/sampleCaseFactory.ts b/packages/tests/src/ui-test/samples/sampleCaseFactory.ts
@@ -32,6 +32,7 @@ import path from "path";
 import { Executor } from "../../utils/executor";
 import { ChildProcessWithoutNullStreams } from "child_process";
 import { initDebugPort } from "../../utils/commonUtils";
+import { CliHelper } from "../cliHelper";
 
 const debugMap: Record<LocalDebugTaskLabel, () => Promise<void>> = {
   [LocalDebugTaskLabel.StartFrontend]: async () => {
@@ -97,6 +98,12 @@ const debugMap: Record<LocalDebugTaskLabel, () => Promise<void>> = {
       LocalDebugTaskResult.WebServerSuccess
     );
   },
+  [LocalDebugTaskLabel.DockerRun]: async () => {
+    await waitForTerminal(
+      LocalDebugTaskLabel.DockerRun,
+      LocalDebugTaskResult.WebServerSuccess
+    );
+  },
 };
 
 export abstract class CaseFactory {
@@ -118,6 +125,8 @@ export abstract class CaseFactory {
     debug?: "cli" | "ttk";
     botFlag?: boolean;
     repoPath?: string;
+    container?: boolean;
+    dockerFolder?: string;
   };
 
   public constructor(
@@ -139,6 +148,8 @@ export abstract class CaseFactory {
       debug?: "cli" | "ttk";
       botFlag?: boolean;
       repoPath?: string;
+      container?: boolean;
+      dockerFolder?: string;
     } = {}
   ) {
     this.sampleName = sampleName;
@@ -277,6 +288,7 @@ export abstract class CaseFactory {
       let azSqlHelper: AzSqlHelper | undefined;
       let devtunnelProcess: ChildProcessWithoutNullStreams;
       let debugProcess: ChildProcessWithoutNullStreams;
+      let dockerProcess: ChildProcessWithoutNullStreams;
       let successFlag = true;
       let envContent = "";
       let botFlag = false;
@@ -363,6 +375,9 @@ export abstract class CaseFactory {
                   sampledebugContext.appName,
                   sampledebugContext.projectPath
                 );
+                if (options?.container) {
+                  await Executor.login();
+                }
                 await sampledebugContext.deployProject(
                   sampledebugContext.projectPath,
                   Timeout.botDeploy
@@ -392,11 +407,23 @@ export abstract class CaseFactory {
                 "local"
               );
               expect(provisionSuccess).to.be.true;
-              const { success: deploySuccess } = await Executor.deploy(
-                sampledebugContext.projectPath,
-                "local"
-              );
-              expect(deploySuccess).to.be.true;
+              if (!options.container) {
+                const { success: deploySuccess } = await Executor.deploy(
+                  sampledebugContext.projectPath,
+                  "local"
+                );
+                expect(deploySuccess).to.be.true;
+              } else {
+                await CliHelper.dockerBuild(
+                  sampledebugContext.projectPath,
+                  options.dockerFolder || ""
+                );
+
+                dockerProcess = await CliHelper.dockerRun(
+                  sampledebugContext.projectPath,
+                  options.dockerFolder || ""
+                );
+              }
               const teamsAppId = await sampledebugContext.getTeamsAppId(env);
               expect(teamsAppId).to.not.be.empty;
 
@@ -421,7 +448,8 @@ export abstract class CaseFactory {
                     successFlag = false;
                     expect.fail(errorMsg);
                   }
-                }
+                },
+                options.container
               );
               await new Promise((resolve) =>
                 setTimeout(resolve, 2 * 60 * 1000)
@@ -458,6 +486,10 @@ export abstract class CaseFactory {
               // kill process
               await Executor.closeProcess(debugProcess);
               if (botFlag) await Executor.closeProcess(devtunnelProcess);
+              if (dockerProcess) {
+                await Executor.closeProcess(dockerProcess);
+                await CliHelper.stopAllDocker();
+              }
               await initDebugPort();
             }
 

diff --git a/packages/tests/src/utils/constants.ts b/packages/tests/src/utils/constants.ts
@@ -57,6 +57,7 @@ export enum TemplateProject {
   RetailDashboard = "Contoso Retail Dashboard",
   TabSSOApimProxy = "SSO Enabled Tab via APIM Proxy",
   LargeScaleBot = "Large Scale Notification Bot",
+  BotSSODocker = "Containerized Bot App with SSO Enabled",
 }
 
 export enum TemplateProjectFolder {
@@ -128,6 +129,7 @@ export const sampleProjectMap: Record<TemplateProject, TemplateProjectFolder> =
     [TemplateProject.RetailDashboard]: TemplateProjectFolder.RetailDashboard,
     [TemplateProject.TabSSOApimProxy]: TemplateProjectFolder.TabSSOApimProxy,
     [TemplateProject.LargeScaleBot]: TemplateProjectFolder.LargeScaleBot,
+    [TemplateProject.BotSSODocker]: TemplateProjectFolder.BotSSODocker,
   };
 
 export enum Resource {
@@ -380,6 +382,7 @@ export enum LocalDebugTaskLabel {
   Azurite = "Start Azurite emulator",
   Compile = "Compile typescript",
   StartWebServer = "Start web server",
+  DockerRun = "docker-run: debug",
 }
 
 export class LocalDebugTaskResult {
@@ -394,6 +397,7 @@ export class LocalDebugTaskResult {
   static readonly Error = "error";
   static readonly DebuggerAttached = "Debugger attached";
   static readonly WebServerSuccess = "press h to show help";
+  static readonly DockerRunFinish = "press any key to close it";
 }
 
 export enum LocalDebugTaskLabel2 {

diff --git a/packages/tests/src/utils/executor.ts b/packages/tests/src/utils/executor.ts
@@ -197,7 +197,8 @@ export class Executor {
     v3 = true,
     processEnv: NodeJS.ProcessEnv = process.env,
     onData?: (data: string) => void,
-    onError?: (data: string) => void
+    onError?: (data: string) => void,
+    openOnly?: boolean
   ) {
     console.log(`[start] ${env} debug ... `);
     const childProcess = spawn(
@@ -208,7 +209,12 @@ export class Executor {
         : v3
         ? "teamsapp"
         : "teamsfx",
-      ["preview", v3 ? "--env" : "", v3 ? `${env}` : `--${env}`],
+      [
+        "preview",
+        v3 ? "--env" : "",
+        v3 ? `${env}` : `--${env}`,
+        openOnly ? "--open-only" : "",
+      ],
       {
         cwd: projectPath,
         env: processEnv ? processEnv : process.env,
@@ -594,6 +600,8 @@ export class Executor {
       } catch (error) {
         console.log(error);
       }
+    } else {
+      console.log(childProcess);
     }
   }
 }