Skip to content

test/docker: BUN_TEST_SERVICE_<name> env override for ensure() #32139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alii merged 2 commits into from
Jun 12, 2026
Merged

test/docker: BUN_TEST_SERVICE_<name> env override for ensure() #32139

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4a3d6f
test/docker: BUN_TEST_SERVICE_<name> env override for ensure()
alii Jun 11, 2026
00a63f5
harness: drop the Bun 1.2.22 describe.concurrent guard
alii Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 106 additions & 73 deletions test/docker/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,98 @@ export interface ServiceInfo {
users?: Record<string, string>;
}

const serviceMeta: Record<ServiceName, { ports: number[]; tls?: ServiceInfo["tls"]; users?: ServiceInfo["users"] }> = {
postgres_plain: { ports: [5432] },
postgres_tls: {
ports: [5432],
tls: {
cert: join(__dirname, "../js/sql/docker-tls/server.crt"),
key: join(__dirname, "../js/sql/docker-tls/server.key"),
},
},
postgres_auth: {
ports: [5432],
users: {
bun_sql_test: "",
bun_sql_test_md5: "bun_sql_test_md5",
bun_sql_test_scram: "bun_sql_test_scram",
},
},
mysql_plain: { ports: [3306] },
mysql_native_password: { ports: [3306] },
mysql_tls: {
ports: [3306],
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"),
},
},
redis_plain: { ports: [6379] },
redis_unified: {
ports: [6379, 6380],
tls: {
cert: join(__dirname, "../js/valkey/docker-unified/server.crt"),
key: join(__dirname, "../js/valkey/docker-unified/server.key"),
},
users: {
default: "",
testuser: "test123",
readonly: "readonly",
writeonly: "writeonly",
},
},
minio: { ports: [9000, 9001] },
autobahn: { ports: [9002] },
squid: { ports: [3128] },
};

function serviceFromEnv(service: ServiceName): ServiceInfo | null {
const raw = process.env["BUN_TEST_SERVICE_" + service];
if (!raw) return null;

const meta = serviceMeta[service];
const ports: Record<number, number> = {};
const colon = raw.indexOf(":");
let host: string;

if (colon === -1) {
host = raw;
for (const p of meta.ports) ports[p] = p;
} else {
host = raw.slice(0, colon);
if (!host) {
throw new Error(`BUN_TEST_SERVICE_${service}: missing host in "${raw}"`);
}
const spec = raw.slice(colon + 1);
if (spec.includes("=")) {
for (const pair of spec.split(",")) {
const m = /^(\d+)=(\d+)$/.exec(pair);
if (!m) {
throw new Error(`BUN_TEST_SERVICE_${service}: malformed port mapping "${pair}" in "${raw}"`);
}
ports[Number(m[1])] = Number(m[2]);
}
for (const p of meta.ports) if (!(p in ports)) ports[p] = p;
} else {
if (!/^\d+$/.test(spec)) {
throw new Error(`BUN_TEST_SERVICE_${service}: malformed port spec "${spec}" in "${raw}"`);
}
if (meta.ports.length !== 1) {
throw new Error(
`BUN_TEST_SERVICE_${service}: single port in "${raw}" is ambiguous for a ${meta.ports.length}-port service; use cport=hport pairs`,
);
}
ports[meta.ports[0]] = Number(spec);
}
}

const info: ServiceInfo = { host, ports };
if (meta.tls) info.tls = meta.tls;
if (meta.users) info.users = meta.users;
return info;
}

interface DockerComposeOptions {
projectName?: string;
composeFile?: string;
Expand All @@ -40,6 +132,7 @@ class DockerComposeHelper {
private projectName: string;
private composeFile: string;
private upPromises: Map<ServiceName, Promise<void>> = new Map();
private composeStarted = false;

constructor(options: DockerComposeOptions = {}) {
this.projectName =
Expand Down Expand Up @@ -158,6 +251,8 @@ class DockerComposeHelper {
`Failed to start service ${service}: ${stderr}\n` + `--- ps ---\n${ps.stdout}\n--- logs ---\n${logs.stdout}`,
);
}

this.composeStarted = true;
}

async port(service: ServiceName, targetPort: number): Promise<number> {
Expand Down Expand Up @@ -251,6 +346,9 @@ class DockerComposeHelper {
}

async ensure(service: ServiceName): Promise<ServiceInfo> {
const viaEnv = serviceFromEnv(service);
if (viaEnv) return viaEnv;

const viaCoordinator = await this.ensureViaCoordinator(service);
if (viaCoordinator !== null) {
return viaCoordinator;
Expand All @@ -270,84 +368,16 @@ class DockerComposeHelper {
throw error;
}

const meta = serviceMeta[service];
const info: ServiceInfo = {
host: this.testHost,
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;

case "squid":
info.ports[3128] = await this.port(service, 3128);
break;
for (const p of meta.ports) {
info.ports[p] = await this.port(service, p);
}
if (meta.tls) info.tls = meta.tls;
if (meta.users) info.users = meta.users;

return info;
}
Expand Down Expand Up @@ -429,6 +459,9 @@ class DockerComposeHelper {
if (process.env.BUN_KEEP_DOCKER === "1") {
return;
}
if (!this.composeStarted) {
return;
}

const { exitCode } = await this.exec(["down", "-v"]);
if (exitCode !== 0) {
Expand Down
157 changes: 81 additions & 76 deletions test/harness.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -959,91 +959,96 @@ export async function describeWithContainer(
},
fn: (container: { port: number; host: string; ready: Promise<void> }) => void,
) {
// Skip if Docker is not available
if (!isDockerEnabled()) {
describe.todo(label);
// Check if this is one of our docker-compose services
const services: Record<string, number> = {
"postgres_plain": 5432,
"postgres_tls": 5432,
"postgres_auth": 5432,
"mysql_plain": 3306,
"mysql_native_password": 3306,
"mysql_tls": 3306,
"mysql:8": 3306, // Map mysql:8 to mysql_plain
"mysql:9": 3306, // Map mysql:9 to mysql_native_password
"redis_plain": 6379,
"redis_unified": 6379,
"minio": 9000,
"autobahn": 9002,
};

const servicePort = services[image];
if (!servicePort) {
// No fallback - if the image isn't in docker-compose, it should fail
describe(label, () => {
throw new Error(
`Image "${image}" is not configured in docker-compose.yml. All test containers must use docker-compose.`,
);
});
return;
}

(concurrent && Bun.version !== "1.2.22" ? describe.concurrent : describe)(label, () => {
// Check if this is one of our docker-compose services
const services: Record<string, number> = {
"postgres_plain": 5432,
"postgres_tls": 5432,
"postgres_auth": 5432,
"mysql_plain": 3306,
"mysql_native_password": 3306,
"mysql_tls": 3306,
"mysql:8": 3306, // Map mysql:8 to mysql_plain
"mysql:9": 3306, // Map mysql:9 to mysql_native_password
"redis_plain": 6379,
"redis_unified": 6379,
"minio": 9000,
"autobahn": 9002,
};
// Map mysql:8 and mysql:9 based on environment variables
let actualService = image;
if (image === "mysql:8" || image === "mysql:9") {
if (env.MYSQL_ROOT_PASSWORD === "bun") {
actualService = "mysql_native_password"; // Has password "bun"
} else if (env.MYSQL_ALLOW_EMPTY_PASSWORD === "yes") {
actualService = "mysql_plain"; // No password
} else {
actualService = "mysql_plain"; // Default to no password
}
}

const servicePort = services[image];
if (servicePort) {
// Map mysql:8 and mysql:9 based on environment variables
let actualService = image;
if (image === "mysql:8" || image === "mysql:9") {
if (env.MYSQL_ROOT_PASSWORD === "bun") {
actualService = "mysql_native_password"; // Has password "bun"
} else if (env.MYSQL_ALLOW_EMPTY_PASSWORD === "yes") {
actualService = "mysql_plain"; // No password
} else {
actualService = "mysql_plain"; // Default to no password
}
}
// Skip only when no env override, no coordinator, and docker is unavailable.
// isDockerEnabled() may throw when docker is required but absent, so the
// env-override and coordinator checks must short-circuit before it.
if (!process.env["BUN_TEST_SERVICE_" + actualService] && !process.env.BUN_DOCKER_COORDINATOR && !isDockerEnabled()) {
describe.todo(label);
return;
}

// Create a container descriptor with stable references and a ready promise
let readyResolver: () => void;
let readyRejecter: (error: any) => void;
const readyPromise = new Promise<void>((resolve, reject) => {
readyResolver = resolve;
readyRejecter = reject;
});
(concurrent && Bun.version !== "1.2.22" ? describe.concurrent : describe)(label, () => {
Comment thread
alii marked this conversation as resolved.
Outdated
// Create a container descriptor with stable references and a ready promise
let readyResolver: () => void;
let readyRejecter: (error: any) => void;
const readyPromise = new Promise<void>((resolve, reject) => {
readyResolver = resolve;
readyRejecter = reject;
});

// Internal state that will be updated when container is ready
let _host = "127.0.0.1";
let _port = 0;
// Internal state that will be updated when container is ready
let _host = "127.0.0.1";
let _port = 0;

// Container descriptor with live getters and ready promise
const containerDescriptor = {
get host() {
return _host;
},
get port() {
return _port;
},
ready: readyPromise,
};
// Container descriptor with live getters and ready promise
const containerDescriptor = {
get host() {
return _host;
},
get port() {
return _port;
},
ready: readyPromise,
};

// Kick off `ensure()` at describe-define time so a file with multiple
// describeWithContainer blocks starts all of its containers in parallel.
// up() de-duplicates in-flight calls per service, so two describes for
// the same service share one `compose up`. beforeAll just awaits the
// result so test failures still surface there.
const startPromise = import("./docker/index.ts").then(h => h.ensure(actualService as any));
// Surface any rejection through `ready`; without a handler the runner
// would see an unhandled rejection before beforeAll re-throws it.
startPromise.catch(readyRejecter!);

beforeAll(async () => {
const info = await startPromise;
_host = info.host;
_port = info.ports[servicePort];
console.log(`Container ready via docker-compose: ${image} at ${_host}:${_port}`);
readyResolver!();
});
// Kick off `ensure()` at describe-define time so a file with multiple
// describeWithContainer blocks starts all of its containers in parallel.
// up() de-duplicates in-flight calls per service, so two describes for
// the same service share one `compose up`. beforeAll just awaits the
// result so test failures still surface there.
const startPromise = import("./docker/index.ts").then(h => h.ensure(actualService as any));
// Surface any rejection through `ready`; without a handler the runner
// would see an unhandled rejection before beforeAll re-throws it.
startPromise.catch(readyRejecter!);

beforeAll(async () => {
const info = await startPromise;
_host = info.host;
_port = info.ports[servicePort];
console.log(`Container ready via docker-compose: ${image} at ${_host}:${_port}`);
readyResolver!();
});

fn(containerDescriptor);
return;
}
// No fallback - if the image isn't in docker-compose, it should fail
throw new Error(
`Image "${image}" is not configured in docker-compose.yml. All test containers must use docker-compose.`,
);
fn(containerDescriptor);
});
}

Expand Down
Loading