chore: add e2e test for backwards ssh compatibility

kylecarbs · kylecarbs · commit 9151a1f8401e · 2023-07-27T04:41:36.000Z
diff --git a/site/e2e/helpers.ts b/site/e2e/helpers.ts
@@ -1,4 +1,4 @@
-import { expect, Page } from "@playwright/test"
+import { expect, Page, TestInfo } from "@playwright/test"
 import { spawn } from "child_process"
 import { randomUUID } from "crypto"
 import path from "path"
@@ -71,7 +71,55 @@ export const startAgent = async (page: Page, token: string): Promise<void> => {
     "coder",
     "main.go",
   )
-  const cp = spawn("go", ["run", coderMain, "agent", "--no-reap"], {
+  return startAgentWithCommand(page, token, "go", "run", coderMain)
+}
+
+export const downloadCoderVersion = async (testInfo: TestInfo, version: string): Promise<string> => {
+  if (version.startsWith("v")) {
+    version = version.slice(1)
+  }
+
+  const binaryName = "coder-e2e-" + version
+  const tempDir = "/tmp"
+  // The install script adds `./bin` automatically to the path :shrug:
+  const binaryPath = path.join(tempDir, "bin", binaryName)
+
+  const exists = await new Promise<boolean>((resolve) => {
+    const cp = spawn(binaryPath, ["version"])
+    cp.on("close", (code) => {
+      resolve(code === 0)
+    })
+    cp.on("error", () => resolve(false))
+  })
+  if (exists) {
+    return binaryPath
+  }
+
+  await new Promise<void>((resolve, reject) => {
+    const cp = spawn("sh", ["-c", [
+      "curl", "-L", "https://coder.com/install.sh",
+      "|",
+      "sh", "-s", "--",
+      "--version", version,
+      "--method", "standalone",
+      "--prefix", tempDir,
+      "--binary-name", binaryName,
+    ].join(" ")])
+    cp.stderr.on("data", (data) => testInfo.stderr.push(data))
+    cp.stdout.on("data", (data) => testInfo.stdout.push(data))
+    cp.on("close", (code) => {
+      if (code === 0) {
+        resolve()
+      } else {
+        reject(new Error("curl failed with code " + code))
+      }
+    })
+  })
+  return binaryPath
+}
+
+export const startAgentWithCommand = async (page: Page, token: string, command: string, ...args: string[]): Promise<void> => {
+  const cp = spawn(command, [...args, "agent", "--no-reap"], {
     env: {
       ...process.env,
       CODER_AGENT_URL: "http://localhost:" + port,
@@ -93,10 +141,10 @@ export const startAgent = async (page: Page, token: string): Promise<void> => {
 // Allows users to more easily define properties they want for agents and resources!
 type RecursivePartial<T> = {
   [P in keyof T]?: T[P] extends (infer U)[]
-    ? RecursivePartial<U>[]
-    : T[P] extends object | undefined
-    ? RecursivePartial<T[P]>
-    : T[P]
+  ? RecursivePartial<U>[]
+  : T[P] extends object | undefined
+  ? RecursivePartial<T[P]>
+  : T[P]
 }
 
 interface EchoProvisionerResponses {
@@ -259,3 +307,12 @@ export const createServer = async (
   await new Promise<void>((r) => e.listen(port, r))
   return e
 }
+
+export const findSessionToken = async (page: Page): Promise<string> => {
+  const cookies = await page.context().cookies()
+  const sessionCookie = cookies.find((c) => c.name === "coder_session_token")
+  if (!sessionCookie) {
+    throw new Error("session token not found")
+  }
+  return sessionCookie.value
+}
diff --git a/site/e2e/tests/outdatedAgent.spec.ts b/site/e2e/tests/outdatedAgent.spec.ts
@@ -0,0 +1,65 @@
+import { test } from "@playwright/test"
+import { createTemplate, createWorkspace, downloadCoderVersion, findSessionToken, startAgentWithCommand } from "../helpers"
+import { randomUUID } from "crypto"
+import { spawn } from "child_process"
+import path from "path"
+
+test("create workspace with an outdated agent", async ({ page }, testInfo) => {
+  const token = randomUUID()
+  const template = await createTemplate(page, {
+    apply: [
+      {
+        complete: {
+          resources: [
+            {
+              agents: [
+                {
+                  token,
+                },
+              ],
+            },
+          ],
+        },
+      },
+    ],
+  })
+  const workspace = await createWorkspace(page, template)
+  const binaryPath = await downloadCoderVersion(testInfo, "v0.24.0")
+  await startAgentWithCommand(page, token, binaryPath)
+  const sessionToken = await findSessionToken(page)
+  const coderMain = path.join(
+    __dirname,
+    "..",
+    "..",
+    "..",
+    "enterprise",
+    "cmd",
+    "coder",
+    "main.go",
+  )
+  await new Promise<void>((resolve, reject) => {
+    const cp = spawn("ssh", [
+      "-o", "StrictHostKeyChecking=no",
+      "-o", "UserKnownHostsFile=/dev/null",
+      "-o", "ProxyCommand=/usr/local/go/bin/go run "+coderMain+" ssh --stdio " + workspace,
+      "localhost",
+      "exit",
+      "0",
+    ], {
+      env: {
+        ...process.env,
+        CODER_SESSION_TOKEN: sessionToken,
+        CODER_URL: "http://localhost:3000",
+      },
+    })
+    cp.stderr.on("data", (data) => console.log(data.toString()))
+    cp.stdout.on("data", (data) => console.log(data.toString()))
+    cp.on("close", (code) => {
+      if (code === 0) {
+        resolve()
+      } else {
+        reject(new Error("ssh failed with code " + code))
+      }
+    })
+  })
+})
