bun.sh/test/docker/index.ts

import { spawn } from "bun";
import { join, dirname } from "path";
import { fileURLToPath } from "url";
import * as net from "net";

const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);

export type ServiceName =
  | "postgres_plain"
  | "postgres_tls"
  | "postgres_auth"
  | "mysql_plain"
  | "mysql_native_password"
  | "mysql_tls"
  | "redis_plain"
  | "redis_unified"
  | "minio"
  | "autobahn";

export interface ServiceInfo {
  host: string;
  ports: Record<number, number>;
  tls?: {
    ca?: string;
    cert?: string;
    key?: string;
  };
  socketPath?: string;
  users?: Record<string, string>;
}

interface DockerComposeOptions {
  projectName?: string;
  composeFile?: string;
}

class DockerComposeHelper {
  private projectName: string;
  private composeFile: string;
  private runningServices: Set<ServiceName> = new Set();

  constructor(options: DockerComposeOptions = {}) {
    this.projectName = options.projectName ||
      process.env.BUN_DOCKER_PROJECT_NAME ||
      process.env.COMPOSE_PROJECT_NAME ||
      "bun-test-services";  // Default project name for all test services

    this.composeFile = options.composeFile ||
      process.env.BUN_DOCKER_COMPOSE_FILE ||
      join(__dirname, "docker-compose.yml");

    // Verify the compose file exists
    const fs = require("fs");
    if (!fs.existsSync(this.composeFile)) {
      console.error(`Docker Compose file not found at: ${this.composeFile}`);
      console.error(`Current directory: ${process.cwd()}`);
      console.error(`__dirname: ${__dirname}`);
      throw new Error(`Docker Compose file not found: ${this.composeFile}`);
    }
  }

  private async exec(args: string[]): Promise<{ stdout: string; stderr: string; exitCode: number }> {
    // Only support docker compose v2
    const cmd = ["docker", "compose", "-p", this.projectName, "-f", this.composeFile, ...args];

    const proc = spawn({
      cmd,
      stdout: "pipe",
      stderr: "pipe",
    });

    const [stdout, stderr] = await Promise.all([
      proc.stdout.text(),
      proc.stderr.text(),
    ]);

    const exitCode = await proc.exited;

    return { stdout, stderr, exitCode };
  }

  async ensureDocker(): Promise<void> {
    // Check Docker is available
    const dockerCheck = spawn({
      cmd: ["docker", "version"],
      stdout: "pipe",
      stderr: "pipe",
    });

    const exitCode = await dockerCheck.exited;
    if (exitCode !== 0) {
      throw new Error("Docker is not available. Please ensure Docker is installed and running.");
    }

    // Check docker compose v2 is available
    const composeCheck = spawn({
      cmd: ["docker", "compose", "version"],
      stdout: "pipe",
      stderr: "pipe",
    });

    const composeExitCode = await composeCheck.exited;
    if (composeExitCode !== 0) {
      throw new Error("Docker Compose v2 is not available. Please ensure Docker Compose v2 is installed.");
    }
  }

  async up(service: ServiceName): Promise<void> {
    if (this.runningServices.has(service)) {
      return;
    }

    // Build the service if needed (for services like mysql_tls that need building)
    if (service === "mysql_tls" || service === "redis_unified") {
      const buildResult = await this.exec(["build", service]);
      if (buildResult.exitCode !== 0) {
        throw new Error(`Failed to build service ${service}: ${buildResult.stderr}`);
      }
    }

    // Start the service and wait for it to be healthy
    // Remove --quiet-pull to see pull progress and avoid confusion
    const { exitCode, stderr } = await this.exec(["up", "-d", "--wait", service]);

    if (exitCode !== 0) {
      throw new Error(`Failed to start service ${service}: ${stderr}`);
    }

    this.runningServices.add(service);
  }

  async port(service: ServiceName, targetPort: number): Promise<number> {
    const { stdout, exitCode } = await this.exec(["port", service, targetPort.toString()]);

    if (exitCode !== 0) {
      throw new Error(`Failed to get port for ${service}:${targetPort}`);
    }

    const match = stdout.trim().match(/:(\d+)$/);
    if (!match) {
      throw new Error(`Invalid port output: ${stdout}`);
    }

    return parseInt(match[1], 10);
  }

  async waitForPort(port: number, timeout: number = 10000): Promise<void> {
    const deadline = Date.now() + timeout;
    while (Date.now() < deadline) {
      try {
        const socket = new net.Socket();
        await new Promise<void>((resolve, reject) => {
          socket.once('connect', () => {
            socket.destroy();
            resolve();
          });
          socket.once('error', reject);
          socket.connect(port, '127.0.0.1');
        });
        return;
      } catch {
        // Wait 100ms before retrying
        await new Promise(resolve => setTimeout(resolve, 100));
      }
    }
    throw new Error(`Port ${port} did not become ready within ${timeout}ms`);
  }

  async ensure(service: ServiceName): Promise<ServiceInfo> {
    try {
      await this.ensureDocker();
    } catch (error) {
      console.error(`Failed to ensure Docker is available: ${error}`);
      throw error;
    }

    try {
      await this.up(service);
    } catch (error) {
      console.error(`Failed to start service ${service}: ${error}`);
      throw error;
    }

    const info: ServiceInfo = {
      host: "127.0.0.1",
      ports: {},
    };

    // Get ports based on service type
    switch (service) {
      case "postgres_plain":
      case "postgres_tls":
      case "postgres_auth":
        info.ports[5432] = await this.port(service, 5432);

        if (service === "postgres_tls") {
          info.tls = {
            cert: join(__dirname, "../js/sql/docker-tls/server.crt"),
            key: join(__dirname, "../js/sql/docker-tls/server.key"),
          };
        }

        if (service === "postgres_auth") {
          info.users = {
            bun_sql_test: "",
            bun_sql_test_md5: "bun_sql_test_md5",
            bun_sql_test_scram: "bun_sql_test_scram",
          };
        }
        break;

      case "mysql_plain":
      case "mysql_native_password":
      case "mysql_tls":
        info.ports[3306] = await this.port(service, 3306);

        if (service === "mysql_tls") {
          info.tls = {
            ca: join(__dirname, "../js/sql/mysql-tls/ssl/ca.pem"),
            cert: join(__dirname, "../js/sql/mysql-tls/ssl/server-cert.pem"),
            key: join(__dirname, "../js/sql/mysql-tls/ssl/server-key.pem"),
          };
        }
        break;

      case "redis_plain":
        info.ports[6379] = await this.port(service, 6379);
        break;

      case "redis_unified":
        info.ports[6379] = await this.port(service, 6379);
        info.ports[6380] = await this.port(service, 6380);
        // For Redis unix socket, we need to use docker volume mapping
        // This won't work as expected without additional configuration
        // info.socketPath = "/tmp/redis/redis.sock";
        info.tls = {
          cert: join(__dirname, "../js/valkey/docker-unified/server.crt"),
          key: join(__dirname, "../js/valkey/docker-unified/server.key"),
        };
        info.users = {
          default: "",
          testuser: "test123",
          readonly: "readonly",
          writeonly: "writeonly",
        };
        break;

      case "minio":
        info.ports[9000] = await this.port(service, 9000);
        info.ports[9001] = await this.port(service, 9001);
        break;

      case "autobahn":
        info.ports[9002] = await this.port(service, 9002);
        // Docker compose --wait should handle readiness
        break;
    }

    return info;
  }

  async envFor(service: ServiceName): Promise<Record<string, string>> {
    const info = await this.ensure(service);
    const env: Record<string, string> = {};

    switch (service) {
      case "postgres_plain":
      case "postgres_tls":
      case "postgres_auth":
        env.PGHOST = info.host;
        env.PGPORT = info.ports[5432].toString();
        env.PGUSER = "bun_sql_test";
        env.PGDATABASE = "bun_sql_test";

        if (info.tls) {
          env.PGSSLMODE = "require";
          env.PGSSLCERT = info.tls.cert!;
          env.PGSSLKEY = info.tls.key!;
        }
        break;

      case "mysql_plain":
      case "mysql_native_password":
      case "mysql_tls":
        env.MYSQL_HOST = info.host;
        env.MYSQL_PORT = info.ports[3306].toString();
        env.MYSQL_USER = "root";
        env.MYSQL_PASSWORD = service === "mysql_plain" ? "" : "bun";
        env.MYSQL_DATABASE = "bun_sql_test";

        if (info.tls) {
          env.MYSQL_SSL_CA = info.tls.ca!;
        }
        break;

      case "redis_plain":
      case "redis_unified":
        env.REDIS_HOST = info.host;
        env.REDIS_PORT = info.ports[6379].toString();
        env.REDIS_URL = `redis://${info.host}:${info.ports[6379]}`;

        if (info.ports[6380]) {
          env.REDIS_TLS_PORT = info.ports[6380].toString();
          env.REDIS_TLS_URL = `rediss://${info.host}:${info.ports[6380]}`;
        }

        if (info.socketPath) {
          env.REDIS_SOCKET = info.socketPath;
        }
        break;

      case "minio":
        env.S3_ENDPOINT = `http://${info.host}:${info.ports[9000]}`;
        env.S3_ACCESS_KEY_ID = "minioadmin";
        env.S3_SECRET_ACCESS_KEY = "minioadmin";
        env.AWS_ACCESS_KEY_ID = "minioadmin";
        env.AWS_SECRET_ACCESS_KEY = "minioadmin";
        env.AWS_ENDPOINT_URL_S3 = `http://${info.host}:${info.ports[9000]}`;
        break;

      case "autobahn":
        env.AUTOBAHN_URL = `ws://${info.host}:${info.ports[9002]}`;
        break;
    }

    return env;
  }

  async down(): Promise<void> {
    if (process.env.BUN_KEEP_DOCKER === "1") {
      return;
    }

    const { exitCode } = await this.exec(["down", "-v"]);
    if (exitCode !== 0) {
      console.warn("Failed to tear down Docker services");
    }

    this.runningServices.clear();
  }

  async waitTcp(host: string, port: number, timeout = 30000): Promise<void> {
    const start = Date.now();

    while (Date.now() - start < timeout) {
      try {
        const socket = await Bun.connect({
          hostname: host,
          port,
        });
        socket.end();
        return;
      } catch {
        await Bun.sleep(500);
      }
    }

    throw new Error(`TCP connection to ${host}:${port} timed out`);
  }

  /**
   * Pull all Docker images explicitly - useful for CI
   */
  async pullImages(): Promise<void> {
    console.log("Pulling Docker images...");
    const { exitCode, stderr } = await this.exec(["pull", "--ignore-pull-failures"]);

    if (exitCode !== 0) {
      // Don't fail on pull errors since some services need building
      console.warn(`Warning during image pull: ${stderr}`);
    }
  }

  /**
   * Build all services that need building - useful for CI
   */
  async buildServices(): Promise<void> {
    console.log("Building Docker services...");
    // Services that need building
    const servicesToBuild = ["mysql_tls", "redis_unified"];

    for (const service of servicesToBuild) {
      console.log(`Building ${service}...`);
      const { exitCode, stderr } = await this.exec(["build", service]);

      if (exitCode !== 0) {
        throw new Error(`Failed to build ${service}: ${stderr}`);
      }
    }
  }

  /**
   * Prepare all images (pull and build) - useful for CI
   */
  async prepareImages(): Promise<void> {
    await this.pullImages();
    await this.buildServices();
  }
}

// Global instance
let globalHelper: DockerComposeHelper | null = null;

function getHelper(): DockerComposeHelper {
  if (!globalHelper) {
    globalHelper = new DockerComposeHelper();
  }
  return globalHelper;
}

// Exported functions
export async function ensureDocker(): Promise<void> {
  return getHelper().ensureDocker();
}

export async function ensure(service: ServiceName): Promise<ServiceInfo> {
  return getHelper().ensure(service);
}

export async function port(service: ServiceName, targetPort: number): Promise<number> {
  return getHelper().port(service, targetPort);
}

export async function envFor(service: ServiceName): Promise<Record<string, string>> {
  return getHelper().envFor(service);
}

export async function down(): Promise<void> {
  return getHelper().down();
}

export async function waitTcp(host: string, port: number, timeout?: number): Promise<void> {
  return getHelper().waitTcp(host, port, timeout);
}

export async function pullImages(): Promise<void> {
  return getHelper().pullImages();
}

export async function buildServices(): Promise<void> {
  return getHelper().buildServices();
}

export async function prepareImages(): Promise<void> {
  return getHelper().prepareImages();
}

// Higher-level wrappers for tests
export async function withPostgres(
  opts: { variant?: "plain" | "tls" | "auth" },
  fn: (info: ServiceInfo & { url: string }) => Promise<void>
): Promise<void> {
  const variant = opts.variant || "plain";
  const serviceName = `postgres_${variant}` as ServiceName;
  const info = await ensure(serviceName);

  const user = variant === "auth" ? "bun_sql_test" : "postgres";
  const url = `postgres://${user}@${info.host}:${info.ports[5432]}/bun_sql_test`;

  try {
    await fn({ ...info, url });
  } finally {
    // Services persist - no teardown
  }
}

export async function withMySQL(
  opts: { variant?: "plain" | "native_password" | "tls" },
  fn: (info: ServiceInfo & { url: string }) => Promise<void>
): Promise<void> {
  const variant = opts.variant || "plain";
  const serviceName = `mysql_${variant}` as ServiceName;
  const info = await ensure(serviceName);

  const password = variant === "plain" ? "" : ":bun";
  const url = `mysql://root${password}@${info.host}:${info.ports[3306]}/bun_sql_test`;

  try {
    await fn({ ...info, url });
  } finally {
    // Services persist - no teardown
  }
}

export async function withRedis(
  opts: { variant?: "plain" | "unified" },
  fn: (info: ServiceInfo & { url: string; tlsUrl?: string }) => Promise<void>
): Promise<void> {
  const variant = opts.variant || "plain";
  const serviceName = `redis_${variant}` as ServiceName;
  const info = await ensure(serviceName);

  const url = `redis://${info.host}:${info.ports[6379]}`;
  const tlsUrl = info.ports[6380] ? `rediss://${info.host}:${info.ports[6380]}` : undefined;

  try {
    await fn({ ...info, url, tlsUrl });
  } finally {
    // Services persist - no teardown
  }
}

export async function withMinio(
  fn: (info: ServiceInfo & { endpoint: string; accessKeyId: string; secretAccessKey: string }) => Promise<void>
): Promise<void> {
  const info = await ensure("minio");

  try {
    await fn({
      ...info,
      endpoint: `http://${info.host}:${info.ports[9000]}`,
      accessKeyId: "minioadmin",
      secretAccessKey: "minioadmin",
    });
  } finally {
    // Services persist - no teardown
  }
}

export async function withAutobahn(
  fn: (info: ServiceInfo & { url: string }) => Promise<void>
): Promise<void> {
  const info = await ensure("autobahn");

  try {
    await fn({
      ...info,
      url: `ws://${info.host}:${info.ports[9002]}`,
    });
  } finally {
    // Services persist - no teardown
  }
}