Add test extension

This will let us test extension-related features (like the proxy URI).

I removed the environment variables in the script because they override
the ones you set yourself. We still set defaults in constants.ts.

Author: code-asher

.eslintrc.yaml

@@ -36,8 +36,8 @@ rules:
   import/order:
     [error, { alphabetize: { order: "asc" }, groups: [["builtin", "external", "internal"], "parent", "sibling"] }]
   no-async-promise-executor: off
-  # This isn't a real module, just types, which apparently doesn't resolve.
-  import/no-unresolved: [error, { ignore: ["express-serve-static-core"] }]
+  # These aren't real modules, just types, which apparently don't resolve.
+  import/no-unresolved: [error, { ignore: ["express-serve-static-core", "vscode"] }]
 
 settings:
   # Does not work with CommonJS unfortunately.

.github/workflows/ci.yaml

@@ -381,7 +381,7 @@ jobs:
 
       - name: Run end-to-end tests
         run: |
-          ./release-packages/code-server*-linux-amd64/bin/code-server --log trace &
+          ./release-packages/code-server*-linux-amd64/bin/code-server --log trace --extensions-dir ./test/e2e/extensions &
           yarn test:e2e
 
       - name: Upload test artifacts

ci/dev/postinstall.sh

@@ -5,15 +5,21 @@ main() {
   cd "$(dirname "$0")/../.."
   source ./ci/lib.sh
 
-  # This installs the dependencies needed for testing
-  cd test
+  pushd test
+  echo "Installing dependencies for $PWD"
   yarn
-  cd ..
+  popd
 
-  cd lib/vscode
-  yarn ${CI+--frozen-lockfile}
+  pushd test/e2e/extensions/test-extension
+  echo "Installing dependencies for $PWD"
+  yarn
+  popd
 
+  pushd lib/vscode
+  echo "Installing dependencies for $PWD"
+  yarn ${CI+--frozen-lockfile}
   symlink_asar
+  popd
 }
 
 main "$@"

ci/dev/test-e2e.sh

@@ -3,10 +3,17 @@ set -euo pipefail
 
 main() {
   cd "$(dirname "$0")/../.."
-  cd test
-  # We set these environment variables because they're used in the e2e tests
-  # they don't have to be these values, but these are the defaults
-  PASSWORD=e45432jklfdsab CODE_SERVER_ADDRESS=http://localhost:8080 yarn playwright test "$@"
+  source ./ci/lib.sh
+
+  pushd test/e2e/extensions/test-extension
+  echo "Building test extension"
+  yarn build
+  popd
+
+  pushd test
+  echo "Running e2e tests"
+  yarn playwright test "$@"
+  popd
 }
 
 main "$@"

ci/dev/test-unit.sh

@@ -5,6 +5,7 @@ main() {
   cd "$(dirname "$0")/../.."
   cd test/unit/test-plugin
   make -s out/index.js
+
   # We must keep jest in a sub-directory. See ../../test/package.json for more
   # information. We must also run it from the root otherwise coverage will not
   # include our source files.

test/e2e/extensions.test.ts

@@ -0,0 +1,15 @@
+import { CODE_SERVER_ADDRESS, storageState } from "../utils/constants"
+import { test } from "./baseFixture"
+
+test.describe("Extensions", () => {
+  test.use({
+    storageState,
+  })
+
+  // This will only work if the test extension is loaded into code-server.
+  test("should have access to VSCODE_PROXY_URI", async ({ codeServerPage }) => {
+    await codeServerPage.runCommandFromPalette("code-server: Get proxy URI")
+
+    await codeServerPage.page.isVisible(`text=${CODE_SERVER_ADDRESS}/proxy/{port}`)
+  })
+})

test/e2e/extensions/test-extension/.gitignore

@@ -0,0 +1 @@
+/extension.js

test/e2e/extensions/test-extension/extension.ts

@@ -0,0 +1,13 @@
+import * as vscode from "vscode"
+
+export function activate(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.commands.registerCommand("codeServerTest.proxyUri", () => {
+      if (process.env.VSCODE_PROXY_URI) {
+        vscode.window.showInformationMessage(process.env.VSCODE_PROXY_URI)
+      } else {
+        vscode.window.showErrorMessage("No proxy URI was set")
+      }
+    }),
+  )
+}

test/e2e/extensions/test-extension/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "code-server-extension",
+  "description": "code-server test extension",
+  "version": "0.0.1",
+  "publisher": "cdr",
+  "activationEvents": [
+    "onCommand:codeServerTest.proxyUri"
+  ],
+  "engines": {
+    "vscode": "^1.56.0"
+  },
+  "main": "./extension.js",
+  "contributes": {
+    "commands": [
+      {
+        "command": "codeServerTest.proxyUri",
+        "title": "Get proxy URI",
+        "category": "code-server"
+      }
+    ]
+  },
+  "devDependencies": {
+    "@types/vscode": "^1.56.0",
+    "typescript": "^4.0.5"
+  },
+  "scripts": {
+    "build": "tsc extension.ts"
+  }
+}

test/e2e/extensions/test-extension/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "outDir": ".",
+    "strict": true,
+    "baseUrl": "./"
+  },
+  "include": ["./extension.ts"]
+}

test/e2e/extensions/test-extension/yarn.lock

@@ -0,0 +1,13 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@types/vscode@^1.56.0":
+  version "1.57.0"
+  resolved "https://registry.yarnpkg.com/@types/vscode/-/vscode-1.57.0.tgz#cc648e0573b92f725cd1baf2621f8da9f8bc689f"
+  integrity sha512-FeznBFtIDCWRluojTsi9c3LLcCHOXP5etQfBK42+ixo1CoEAchkw39tuui9zomjZuKfUVL33KZUDIwHZ/xvOkQ==
+
+typescript@^4.0.5:
+  version "4.3.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.3.2.tgz#399ab18aac45802d6f2498de5054fcbbe716a805"
+  integrity sha512-zZ4hShnmnoVnAHpVHWpTcxdv7dWP60S2FsydQLV8V5PbS3FifjWFFRiHSWpDJahly88PRyV5teTSLoq4eG7mKw==

test/e2e/models/CodeServer.ts

@@ -81,25 +81,10 @@ export class CodeServer {
    * visible already.
    */
   async focusTerminal() {
-    // Click [aria-label="Application Menu"] div[role="none"]
-    await this.page.click('[aria-label="Application Menu"] div[role="none"]')
-
-    // Click text=View
-    await this.page.hover("text=View")
-    await this.page.click("text=View")
-
-    // Click text=Command Palette
-    await this.page.hover("text=Command Palette")
-    await this.page.click("text=Command Palette")
-
-    // Type Terminal: Focus Terminal
-    await this.page.keyboard.type("Terminal: Focus Terminal")
-
-    // Click Terminal: Focus Terminal
-    await this.page.hover("text=Terminal: Focus Terminal")
-    await this.page.click("text=Terminal: Focus Terminal")
+    // Execute the focus terminal command via the command palette.
+    await this.runCommandFromPalette("Terminal: Focus Terminal")
 
-    // Wait for terminal textarea to show up
+    // Wait for terminal textarea to show up.
     await this.page.waitForSelector("textarea.xterm-helper-textarea")
   }
 
@@ -113,4 +98,32 @@ export class CodeServer {
     await this.navigate()
     await this.reloadUntilEditorIsReady()
   }
+
+  /**
+   * Run a command via the command palette.
+   */
+  async runCommandFromPalette(command: string) {
+    await this.runCommandFromMenu(["View", "Command Palette"])
+
+    // Type the command we want.
+    await this.page.keyboard.type(command)
+
+    // Click on the matching command.
+    await this.page.hover(`text=${command}`)
+    await this.page.click(`text=${command}`)
+  }
+
+  /**
+   * Run a command from the application menu.
+   */
+  async runCommandFromMenu(menus: string[]) {
+    // Open the application menu.
+    await this.page.click('[aria-label="Application Menu"] div[role="none"]')
+
+    // Open each sub-menu in turn.
+    for (const menu in menus) {
+      await this.page.hover(`text=${menu}`)
+      await this.page.click(`text=${menu}`)
+    }
+  }
 }