feat: add installExtension integration test

This adds a new helper function called `runCodeServerCommand` along with
a test for `--install-extension`. We can use this approach for writing
integration tests (i.e. testing a real code-server build, CLI commands,
etc).

Author: jsjoeio

ci/build/test-standalone-release.sh

@@ -0,0 +1,22 @@
+import { clean, tmpdir } from "../utils/helpers"
+import { runCodeServerCommand } from "../utils/integration"
+
+describe("--install-extension", () => {
+  const testName = "installExtension"
+  let tempDir: string
+  let setupFlags: string[]
+
+  beforeEach(async () => {
+    await clean(testName)
+    tempDir = await tmpdir(testName)
+    setupFlags = ["--extensions-dir", tempDir]
+  })
+  it("should install an extension", async () => {
+    const extName = "wesbos.theme-cobalt2"
+    await runCodeServerCommand([...setupFlags, "--install-extension", extName], {})
+    const { stdout } = await runCodeServerCommand([...setupFlags, "--list-extensions"], {
+      stdout: "log",
+    })
+    expect(stdout).toContain(extName)
+  })
+})

test/integration/installExtension.test.ts

@@ -1,3 +1,4 @@
+import { spawn } from "child_process"
 import { promises as fs } from "fs"
 import * as path from "path"
 import { parse, parseConfigFile, setDefaults } from "../../src/node/cli"
@@ -29,3 +30,87 @@ export async function setup(argv: string[], configFile?: string): Promise<httpse
 
   return new httpserver.HttpServer(server)
 }
+
+type RunCodeServerCommandOptions = {
+  stderr?: "log"
+  stdout?: "log"
+  ignoreFail?: boolean
+}
+interface ErrorWithMoreInfo extends Error {
+  stderr: string
+  stdout: string
+}
+
+type CSCmd =
+  | {
+      code: number | null
+      signal: NodeJS.Signals | null
+      stdout: string
+      stderr: string
+    }
+  | ErrorWithMoreInfo
+
+/**
+ *
+ * A helper function for integration tests to run code-server commands.
+ */
+export async function runCodeServerCommand(argv: string[], options: RunCodeServerCommandOptions = {}): Promise<CSCmd> {
+  const CODE_SERVER_COMMAND = process.env.CODE_SERVER_PATH || "/var/tmp/coder/code-server/bin/code-server"
+  // Credit: https://github.com/vercel/next.js/blob/canary/test/lib/next-test-utils.js#L139
+  return new Promise((resolve, reject) => {
+    console.log(`Running command "${CODE_SERVER_COMMAND} ${argv.join(" ")}"`)
+    const instance = spawn(CODE_SERVER_COMMAND, [...argv])
+    let mergedStdio = ""
+
+    let stderrOutput = ""
+    if (options.stderr) {
+      instance.stderr.on("data", function (chunk) {
+        mergedStdio += chunk
+        stderrOutput += chunk
+
+        if (options.stderr === "log") {
+          console.log(chunk.toString())
+        }
+      })
+    } else {
+      instance.stderr.on("data", function (chunk) {
+        mergedStdio += chunk
+      })
+    }
+
+    let stdoutOutput = ""
+    if (options.stdout) {
+      instance.stdout.on("data", function (chunk) {
+        mergedStdio += chunk
+        stdoutOutput += chunk
+
+        if (options.stdout === "log") {
+          console.log(chunk.toString())
+        }
+      })
+    } else {
+      instance.stdout.on("data", function (chunk) {
+        mergedStdio += chunk
+      })
+    }
+
+    instance.on("close", (code, signal) => {
+      if (!options.stderr && !options.stdout && !options.ignoreFail && code !== 0) {
+        return reject(new Error(`command failed with code ${code}\n${mergedStdio}`))
+      }
+
+      resolve({
+        code,
+        signal,
+        stdout: stdoutOutput,
+        stderr: stderrOutput,
+      })
+    })
+
+    instance.on("error", (err: ErrorWithMoreInfo) => {
+      err.stdout = stdoutOutput
+      err.stderr = stderrOutput
+      reject(err)
+    })
+  })
+}