web: web tests in github CI (#4431)

Will run the web unit tests in github CI

Signed-off-by: nkomonen <[email protected]>

Author: nkomonen-amazon

.github/workflows/node.js.yml

@@ -53,6 +53,29 @@ jobs:
                   file: ./coverage/lcov.info
                   flags: codewhisperer
 
+    web:
+        name: test Web
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: true
+            matrix:
+                node-version: [16.x]
+                vscode-version: [stable, insiders]
+        env:
+            VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
+            NODE_OPTIONS: '--max-old-space-size=8192'
+        steps:
+            - uses: actions/checkout@v4
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - run: npm ci
+            - name: Tests
+              uses: coactions/setup-xvfb@v1
+              with:
+                  run: npm run testWeb
+
     windows:
         name: test Windows
         runs-on: windows-2019

package.json

@@ -26,6 +26,7 @@
         "compile": "npm run compile -w packages/",
         "testCompile": "npm run testCompile -w packages/",
         "test": "npm run test -w packages/",
+        "testWeb": "npm run testWeb -w packages/toolkit",
         "testE2E": "npm run testE2E -w packages/",
         "testInteg": "npm run testInteg -w packages/",
         "package": "npm run package -w packages/toolkit",

packages/toolkit/package.json

@@ -4247,11 +4247,13 @@
         "copyFiles": "ts-node ./scripts/build/copyFiles.ts",
         "buildScripts": "npm run generateClients && npm run generatePackage && npm run generateNonCodeFiles && npm run copyFiles",
         "browserWatch": "npm run clean && npm run buildScripts && webpack --config-name web --watch",
+        "browserCompile": "npm run clean && npm run buildScripts && webpack --config-name web",
         "browserRun": "npx @vscode/test-web --open-devtools --browserOption=--disable-web-security --waitForDebugger=9222 --extensionDevelopmentPath=. .",
         "compile": "npm run clean && npm run buildScripts && webpack --mode development && npm run copyFiles",
         "watch": "npm run clean && npm run buildScripts && tsc -watch -p ./",
         "testCompile": "npm run buildScripts && tsc -p ./",
         "test": "npm run testCompile && c8 ts-node ./scripts/test/test.ts",
+        "testWeb": "npm run browserCompile && c8 ts-node ./scripts/test/testWeb.ts",
         "testE2E": "npm run testCompile && c8 ts-node ./scripts/test/testE2E.ts",
         "testInteg": "npm run testCompile && c8 ts-node ./scripts/test/testInteg.ts",
         "format": "prettier --ignore-path ../../.prettierignore --check src scripts",

packages/toolkit/scripts/test/launchTestUtilities.ts

@@ -18,7 +18,7 @@ const minimum = 'minimum'
 
 const disableWorkspaceTrust = '--disable-workspace-trust'
 
-type SuiteName = 'integration' | 'e2e' | 'unit'
+type SuiteName = 'integration' | 'e2e' | 'unit' | 'web'
 
 /**
  * This is the generalized method that is used by different test suites (unit, integration, ...) in CI to
@@ -64,7 +64,7 @@ async function getVSCodeCliArgs(params: {
     let disableExtensionsArgs: string[] = []
     let disableWorkspaceTrustArg: string[] = []
 
-    if (params.suite !== 'unit') {
+    if (params.suite === 'integration' || params.suite === 'e2e') {
         disableExtensionsArgs = await getCliArgsToDisableExtensions(params.vsCodeExecutablePath, {
             except: [
                 VSCODE_EXTENSION_ID.python,
@@ -78,16 +78,21 @@ async function getVSCodeCliArgs(params: {
             ],
         })
         disableWorkspaceTrustArg = [disableWorkspaceTrust]
+    } else {
+        disableExtensionsArgs = ['--disable-extensions']
     }
 
     const workspacePath = join(projectRootDir, 'dist', 'src', 'testFixtures', 'workspaceFolder')
+    // This tells VS Code to run the extension in a web environment, which mimics vscode.dev
+    const webExtensionKind = params.suite === 'web' ? ['--extensionDevelopmentKind=web'] : []
 
     return {
         vscodeExecutablePath: params.vsCodeExecutablePath,
         extensionDevelopmentPath: projectRootDir,
+
         extensionTestsPath: resolve(projectRootDir, params.relativeTestEntryPoint),
         // For verbose VSCode logs, add "--verbose --log debug". c2165cf48e62c
-        launchArgs: [...disableExtensionsArgs, workspacePath, ...disableWorkspaceTrustArg],
+        launchArgs: [...disableExtensionsArgs, workspacePath, ...disableWorkspaceTrustArg, ...webExtensionKind],
         extensionTestsEnv: {
             ['DEVELOPMENT_PATH']: projectRootDir,
             ['AWS_TOOLKIT_AUTOMATION']: params.suite,
@@ -122,7 +127,7 @@ async function setupVSCodeTestInstance(suite: SuiteName): Promise<string> {
     console.log(await invokeVSCodeCli(vsCodeExecutablePath, ['--version']))
 
     // Only certain test suites require specific vscode extensions to be installed
-    if (suite !== 'unit') {
+    if (suite === 'e2e' || suite === 'integration') {
         await installVSCodeExtension(vsCodeExecutablePath, VSCODE_EXTENSION_ID.python)
         await installVSCodeExtension(vsCodeExecutablePath, VSCODE_EXTENSION_ID.yaml)
         await installVSCodeExtension(vsCodeExecutablePath, VSCODE_EXTENSION_ID.go)

packages/toolkit/scripts/test/testWeb.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { runToolkitTests } from './launchTestUtilities'
+void (async () => {
+    await runToolkitTests('web', 'dist/src/testBrowser/testRunner.js')
+})()