refactor: add SKIP_SUBMODULE_DEPS to postinstall

Author: jsjoeio

ci/dev/postinstall.sh

@@ -29,7 +29,11 @@ main() {
 
   install-deps test
   install-deps test/e2e/extensions/test-extension
-  install-deps lib/vscode
+  # We don't need these when running the integration tests
+  # so you can pass SKIP_SUBMODULE_DEPS
+  if [[ ! ${SKIP_SUBMODULE_DEPS-} ]]; then
+    install-deps lib/vscode
+  fi
 }
 
 main "$@"

package.json

@@ -19,7 +19,7 @@
     "release:prep": "./ci/build/release-prep.sh",
     "test:e2e": "VSCODE_IPC_HOOK_CLI= ./ci/dev/test-e2e.sh",
     "test:unit": "./ci/dev/test-unit.sh --forceExit --detectOpenHandles",
-    "test:integration": "./ci/dev/test-integration.sh",
+    "test:integration": "SKIP_SUBMODULE_DEPS=1 ./ci/dev/test-integration.sh",
     "test:scripts": "./ci/dev/test-scripts.sh",
     "package": "./ci/build/build-packages.sh",
     "postinstall": "./ci/dev/postinstall.sh",

test/integration/installExtension.test.ts

@@ -1,5 +1,5 @@
 import { clean, tmpdir } from "../utils/helpers"
-import { runCodeServerCommand } from "../utils/integration"
+import { runCodeServerCommand } from "../utils/runCodeServerCommand"
 
 describe("--install-extension", () => {
   const testName = "installExtension"

test/utils/integration.ts

@@ -1,4 +1,3 @@
-import { spawn } from "child_process"
 import { promises as fs } from "fs"
 import * as path from "path"
 import { parse, parseConfigFile, setDefaults } from "../../src/node/cli"
@@ -30,87 +29,3 @@ 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)
-    })
-  })
-}