Remove jest testcontainers

.github/workflows/budibase_ci.yml

@@ -161,7 +161,7 @@ jobs:
           docker pull postgres:16.1-bullseye
           docker pull mongo:7.0-jammy
           docker pull mariadb:lts
-          docker pull testcontainers/ryuk:0.3.0
+          docker pull testcontainers/ryuk:0.5.1
           docker pull budibase/couchdb
 
       - run: yarn --frozen-lockfile

packages/backend-core/jest.config.ts

@@ -1,8 +1,9 @@
 import { Config } from "@jest/types"
 
 const baseConfig: Config.InitialProjectOptions = {
-  preset: "@trendyol/jest-testcontainers",
   setupFiles: ["./tests/jestEnv.ts"],
+  globalSetup: "./src/tests/globalSetup.ts",
+  globalTeardown: "./src/tests/globalTeardown.ts",
   setupFilesAfterEnv: ["./tests/jestSetup.ts"],
   transform: {
     "^.+\\.ts?$": "@swc/jest",

packages/backend-core/package.json

@@ -60,7 +60,6 @@
     "@shopify/jest-koa-mocks": "5.1.1",
     "@swc/core": "1.3.71",
     "@swc/jest": "0.2.27",
-    "@trendyol/jest-testcontainers": "^2.1.1",
     "@types/chance": "1.1.3",
     "@types/cookies": "0.7.8",
     "@types/jest": "29.5.5",

packages/backend-core/src/db/Replication.ts

@@ -27,7 +27,7 @@ class Replication {
           return resolve(info)
         })
         .on("error", function (err) {
-          throw new Error(`Replication Error: ${err}`)
+          throw err
         })
     })
   }

packages/backend-core/src/tests/globalSetup.ts

@@ -0,0 +1,26 @@
+import { GenericContainer, Wait } from "testcontainers"
+
+export default async function setup() {
+  const container = await new GenericContainer("budibase/couchdb")
+    .withExposedPorts(5984)
+    .withEnvironment({
+      COUCHDB_PASSWORD: "budibase",
+      COUCHDB_USER: "budibase",
+    })
+    .withCopyFilesToContainer([
+      {
+        source: "./src/tests/test-couchdb.ini",
+        target: "/opt/couchdb/etc/local.d/test-couchdb.ini",
+      },
+    ])
+    .withWaitStrategy(
+      Wait.forSuccessfulCommand(
+        "curl http://budibase:budibase@localhost:5984/_up"
+      ).withStartupTimeout(20000)
+    )
+    .start()
+
+  // @ts-expect-error
+  // eslint-disable-next-line no-undef
+  globalThis.__COUCHDB_CONTAINER_ID__ = container.getId()
+}

packages/backend-core/src/tests/globalTeardown.ts

@@ -0,0 +1,12 @@
+import { getContainerRuntimeClient } from "testcontainers"
+
+export default async function teardown() {
+  const client = await getContainerRuntimeClient()
+
+  // @ts-expect-error
+  // eslint-disable-next-line no-undef
+  const containerId = globalThis.__COUCHDB_CONTAINER_ID__
+  const container = client.container.getById(containerId)
+  await client.container.stop(container)
+  await client.container.remove(container)
+}

packages/backend-core/tests/core/utilities/testContainerUtils.ts

@@ -1,85 +1,66 @@
+import { DatabaseImpl } from "../../../src/db"
 import { execSync } from "child_process"
 
-let dockerPsResult: string | undefined
-
-function formatDockerPsResult(serverName: string, port: number) {
-  const lines = dockerPsResult?.split("\n")
-  let first = true
-  if (!lines) {
-    return null
-  }
-  for (let line of lines) {
-    if (first) {
-      first = false
-      continue
-    }
-    let toLookFor = serverName.split("-service")[0]
-    if (!line.includes(toLookFor)) {
-      continue
-    }
-    const regex = new RegExp(`0.0.0.0:([0-9]*)->${port}`, "g")
-    const found = line.match(regex)
-    if (found) {
-      return found[0].split(":")[1].split("->")[0]
-    }
-  }
-  return null
+interface ContainerInfo {
+  Command: string
+  CreatedAt: string
+  ID: string
+  Image: string
+  Labels: string
+  LocalVolumes: string
+  Mounts: string
+  Names: string
+  Networks: string
+  Ports: string
+  RunningFor: string
+  Size: string
+  State: string
+  Status: string
 }
 
-function getTestContainerSettings(
-  serverName: string,
-  key: string
-): string | null {
-  const entry = Object.entries(global).find(
-    ([k]) =>
-      k.includes(`${serverName.toUpperCase()}`) &&
-      k.includes(`${key.toUpperCase()}`)
-  )
-  if (!entry) {
-    return null
-  }
-  return entry[1]
+function getTestcontainers(): ContainerInfo[] {
+  return execSync("docker ps --format json")
+    .toString()
+    .split("\n")
+    .filter(x => x.length > 0)
+    .map(x => JSON.parse(x) as ContainerInfo)
+    .filter(x => x.Labels.includes("org.testcontainers=true"))
 }
 
-function getContainerInfo(containerName: string, port: number) {
-  let assignedPort = getTestContainerSettings(
-    containerName.toUpperCase(),
-    `PORT_${port}`
-  )
-  if (!dockerPsResult) {
-    try {
-      const outputBuffer = execSync("docker ps")
-      dockerPsResult = outputBuffer.toString("utf8")
-    } catch (err) {
-      //no-op
-    }
-  }
-  const possiblePort = formatDockerPsResult(containerName, port)
-  if (possiblePort) {
-    assignedPort = possiblePort
-  }
-  const host = getTestContainerSettings(containerName.toUpperCase(), "IP")
-  return {
-    port: assignedPort,
-    host,
-    url: host && assignedPort && `http://${host}:${assignedPort}`,
-  }
+function getContainerByImage(image: string) {
+  return getTestcontainers().find(x => x.Image.startsWith(image))
 }
 
-function getCouchConfig() {
-  return getContainerInfo("couchdb", 5984)
+function getExposedPort(container: ContainerInfo, port: number) {
+  const match = container.Ports.match(new RegExp(`0.0.0.0:(\\d+)->${port}/tcp`))
+  if (!match) {
+    return undefined
+  }
+  return parseInt(match[1])
 }
 
 export function setupEnv(...envs: any[]) {
-  const couch = getCouchConfig()
+  const couch = getContainerByImage("budibase/couchdb")
+  if (!couch) {
+    throw new Error("CouchDB container not found")
+  }
+
+  const couchPort = getExposedPort(couch, 5984)
+  if (!couchPort) {
+    throw new Error("CouchDB port not found")
+  }
+
   const configs = [
-    { key: "COUCH_DB_PORT", value: couch.port },
-    { key: "COUCH_DB_URL", value: couch.url },
+    { key: "COUCH_DB_PORT", value: `${couchPort}` },
+    { key: "COUCH_DB_URL", value: `http://localhost:${couchPort}` },
   ]
 
   for (const config of configs.filter(x => !!x.value)) {
     for (const env of envs) {
       env._set(config.key, config.value)
     }
   }
+
+  // @ts-expect-error
+  DatabaseImpl.nano = undefined
 }

packages/backend-core/tests/jestEnv.ts

@@ -4,3 +4,5 @@ process.env.NODE_ENV = "jest"
 process.env.MOCK_REDIS = "1"
 process.env.LOG_LEVEL = process.env.LOG_LEVEL || "error"
 process.env.REDIS_PASSWORD = "budibase"
+process.env.COUCH_DB_PASSWORD = "budibase"
+process.env.COUCH_DB_USER = "budibase"

packages/server/jest.config.ts

@@ -4,7 +4,6 @@ import * as fs from "fs"
 import { join } from "path"
 
 const baseConfig: Config.InitialProjectOptions = {
-  preset: "@trendyol/jest-testcontainers",
   setupFiles: ["./src/tests/jestEnv.ts"],
   moduleFileExtensions: [
     "js",
@@ -18,6 +17,8 @@ const baseConfig: Config.InitialProjectOptions = {
     "svelte",
   ],
   setupFilesAfterEnv: ["./src/tests/jestSetup.ts"],
+  globalSetup: "./src/tests/globalSetup.ts",
+  globalTeardown: "./src/tests/globalTeardown.ts",
   transform: {
     "^.+\\.ts?$": "@swc/jest",
     "^.+\\.js?$": "@swc/jest",

packages/server/package.json

@@ -122,7 +122,6 @@
     "@babel/preset-env": "7.16.11",
     "@swc/core": "1.3.71",
     "@swc/jest": "0.2.27",
-    "@trendyol/jest-testcontainers": "2.1.1",
     "@types/global-agent": "2.1.1",
     "@types/google-spreadsheet": "3.1.5",
     "@types/jest": "29.5.5",

packages/server/src/tests/globalSetup.ts

@@ -0,0 +1,26 @@
+import { GenericContainer, Wait } from "testcontainers"
+
+export default async function setup() {
+  const container = await new GenericContainer("budibase/couchdb")
+    .withExposedPorts(5984)
+    .withEnvironment({
+      COUCHDB_PASSWORD: "budibase",
+      COUCHDB_USER: "budibase",
+    })
+    .withCopyFilesToContainer([
+      {
+        source: "./src/tests/test-couchdb.ini",
+        target: "/opt/couchdb/etc/local.d/test-couchdb.ini",
+      },
+    ])
+    .withWaitStrategy(
+      Wait.forSuccessfulCommand(
+        "curl http://budibase:budibase@localhost:5984/_up"
+      ).withStartupTimeout(20000)
+    )
+    .start()
+
+  // @ts-expect-error
+  // eslint-disable-next-line no-undef
+  globalThis.__COUCHDB_CONTAINER_ID__ = container.getId()
+}

packages/server/src/tests/globalTeardown.ts

@@ -0,0 +1,12 @@
+import { getContainerRuntimeClient } from "testcontainers"
+
+export default async function teardown() {
+  const client = await getContainerRuntimeClient()
+
+  // @ts-expect-error
+  // eslint-disable-next-line no-undef
+  const containerId = globalThis.__COUCHDB_CONTAINER_ID__
+  const container = client.container.getById(containerId)
+  await client.container.stop(container)
+  await client.container.remove(container)
+}

packages/server/src/tests/jestEnv.ts

@@ -11,3 +11,6 @@ process.env.PLATFORM_URL = "http://localhost:10000"
 process.env.REDIS_PASSWORD = "budibase"
 process.env.BUDIBASE_VERSION = "0.0.0+jest"
 process.env.WORKER_URL = "http://localhost:10000"
+process.env.COUCH_DB_PASSWORD = "budibase"
+process.env.COUCH_DB_USER = "budibase"
+process.env.JWT_SECRET = "jwtsecret"

packages/server/src/tests/test-couchdb.ini

@@ -0,0 +1,2 @@
+[log]
+level = warn

packages/worker/jest.config.ts

@@ -2,7 +2,8 @@ import { Config } from "@jest/types"
 import * as fs from "fs"
 
 const config: Config.InitialOptions = {
-  preset: "@trendyol/jest-testcontainers",
+  globalSetup: "./src/tests/globalSetup.ts",
+  globalTeardown: "./src/tests/globalTeardown.ts",
   setupFiles: ["./src/tests/jestEnv.ts"],
   setupFilesAfterEnv: ["./src/tests/jestSetup.ts"],
   collectCoverageFrom: ["src/**/*.{js,ts}", "../backend-core/src/**/*.{js,ts}"],

packages/worker/package.json

@@ -75,7 +75,6 @@
   "devDependencies": {
     "@swc/core": "1.3.71",
     "@swc/jest": "0.2.27",
-    "@trendyol/jest-testcontainers": "2.1.1",
     "@types/jest": "29.5.5",
     "@types/jsonwebtoken": "9.0.3",
     "@types/koa": "2.13.4",

packages/worker/src/tests/globalSetup.ts

@@ -0,0 +1,26 @@
+import { GenericContainer, Wait } from "testcontainers"
+
+export default async function setup() {
+  const container = await new GenericContainer("budibase/couchdb")
+    .withExposedPorts(5984)
+    .withEnvironment({
+      COUCHDB_PASSWORD: "budibase",
+      COUCHDB_USER: "budibase",
+    })
+    .withCopyFilesToContainer([
+      {
+        source: "./src/tests/test-couchdb.ini",
+        target: "/opt/couchdb/etc/local.d/test-couchdb.ini",
+      },
+    ])
+    .withWaitStrategy(
+      Wait.forSuccessfulCommand(
+        "curl http://budibase:budibase@localhost:5984/_up"
+      ).withStartupTimeout(20000)
+    )
+    .start()
+
+  // @ts-expect-error
+  // eslint-disable-next-line no-undef
+  globalThis.__COUCHDB_CONTAINER_ID__ = container.getId()
+}

packages/worker/src/tests/globalTeardown.ts

@@ -0,0 +1,12 @@
+import { getContainerRuntimeClient } from "testcontainers"
+
+export default async function teardown() {
+  const client = await getContainerRuntimeClient()
+
+  // @ts-expect-error
+  // eslint-disable-next-line no-undef
+  const containerId = globalThis.__COUCHDB_CONTAINER_ID__
+  const container = client.container.getById(containerId)
+  await client.container.stop(container)
+  await client.container.remove(container)
+}