refactor: move integration tests to Jest

[jsjoeio]

Description

This PR refactors our integration tests to be written in TypeScript and run with Jest instead of bash. It also adds a helper inspired by the Next.js team to make it easy to test code-server commands.

Motivation

We currently only have one integration test and it's not easy to write new ones because Bash and it's all in one file.

This should make it easier to write integration tests, specifically around the CLI. This is also prep work for #5031

Before

Here is what our integration tests looked like:

#!/usr/bin/env bash
set -euo pipefail

# Make sure a code-server release works. You can pass in the path otherwise it
# will use release-standalone in the current directory.
#
# This is to make sure we don't have Node version errors or any other
# compilation-related errors.
main() {
  cd "$(dirname "${0}")/../.."

  local EXTENSIONS_DIR
  EXTENSIONS_DIR="$(mktemp -d)"

  local path=${1:-./release-standalone/bin/code-server}

  echo "Testing standalone release in $path."

  # NOTE: using a basic theme extension because it doesn't update often and is more reliable for testing
  "$path" --extensions-dir "$EXTENSIONS_DIR" --install-extension wesbos.theme-cobalt2
  local installed_extensions
  installed_extensions="$("$path" --extensions-dir "$EXTENSIONS_DIR" --list-extensions 2>&1)"
  # We use grep as wesbos.theme-cobalt2 may have dependency extensions that change.
  if ! echo "$installed_extensions" | grep -q "wesbos.theme-cobalt2"; then
    echo "Unexpected output from listing extensions:"
    echo "$installed_extensions"
    exit 1
  fi

  echo "Standalone release works correctly."
}

main "$@"

After

This is what they'll look like moving forward:

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)
  })
})

Fixes N/A

[github-actions]

✨ code-server docs for PR #5275 is ready! It will be updated on every commit.

• Host: https://coder.com/docs/code-server/2d892d4
• Last deploy status: success
• Commit: 53e82a6
• Workflow status: https://github.com/coder/code-server/actions/runs/2556921028

[github-actions]

✨ code-server dev build published to npm for PR #5275!

• Last publish status: success
• Commit: 53e82a6

To install in a local project, run:

npm install @coder/code-server-pr@5275

To install globally, run:

npm install -g @coder/code-server-pr@5275

[codecov]

Codecov Report

Merging #5275 (2d892d4) into main (a879844) will not change coverage.
The diff coverage is n/a.

❗ Current head 2d892d4 differs from pull request most recent head 53e82a6. Consider uploading reports for the commit 53e82a6 to get more accurate results

@@           Coverage Diff           @@
##             main    #5275   +/-   ##
=======================================
  Coverage   72.47%   72.47%           
=======================================
  Files          30       30           
  Lines        1671     1671           
  Branches      367      367           
=======================================
  Hits         1211     1211           
  Misses        397      397           
  Partials       63       63           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a879844...53e82a6. Read the comment docs.

[jsjoeio]

possible workaround is to manually checkout submodules
actions/checkout#758 (comment)

[jsjoeio]

NOTE: I had to use --ignore-scripts because otherwise yarn install fails if you don't checkout the repo with submodules. On the Linux job that runs on CentOS7, it didn't have the latest git so this one-liner was the best alternative. It ensures we have the right TS/Jest dependencies to run the yarn test:integration step.

[jsjoeio]

Since we install code-server in these steps, we need to tell the integration tests to look at code-server and use the CLI/binary.

[code-asher]

Happy to see this move into our standard testing framework!