Port bindings can be undefined

Author: cristianrgreco

packages/testcontainers/src/generic-container/inspect-container-util-ports-exposed.test.ts

@@ -11,54 +11,66 @@ function mockInspectResult(
     },
     NetworkSettings: {
       Ports: ports,
-      Networks: {},
     },
-  } as unknown as ContainerInspectInfo;
+  } as ContainerInspectInfo;
 }
 
-test("returns the inspect result when all ports are exposed", async () => {
-  const data = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [{ HostIp: "0.0.0.0", HostPort: "45000" }] });
-  const inspectFn = vi.fn().mockResolvedValueOnce(data);
+describe.sequential("inspectContainerUntilPortsExposed", () => {
+  it("returns the inspect result when all ports are exposed", async () => {
+    const data = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [{ HostIp: "0.0.0.0", HostPort: "45000" }] });
+    const inspectFn = vi.fn().mockResolvedValueOnce(data);
 
-  const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
+    const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
 
-  expect(result).toEqual(data);
-});
+    expect(result).toEqual(data);
+  });
 
-test("returns the inspect result when no ports are exposed", async () => {
-  const data = mockInspectResult({}, {});
-  const inspectFn = vi.fn().mockResolvedValueOnce(data);
+  it("returns the inspect result when no ports are exposed", async () => {
+    const data = mockInspectResult({}, {});
+    const inspectFn = vi.fn().mockResolvedValueOnce(data);
 
-  const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
+    const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
 
-  expect(result).toEqual(data);
-});
+    expect(result).toEqual(data);
+  });
 
-test("retries the inspect if ports are not yet exposed", async () => {
-  const data1 = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [] });
-  const data2 = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [{ HostIp: "0.0.0.0", HostPort: "45000" }] });
-  const inspectFn = vi.fn().mockResolvedValueOnce(data1).mockResolvedValueOnce(data1).mockResolvedValueOnce(data2);
+  it("retries the inspect if ports are not yet exposed", async () => {
+    const data1 = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [] });
+    const data2 = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [{ HostIp: "0.0.0.0", HostPort: "45000" }] });
+    const inspectFn = vi.fn().mockResolvedValueOnce(data1).mockResolvedValueOnce(data1).mockResolvedValueOnce(data2);
 
-  const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
+    const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
 
-  expect(result).toEqual(data2);
-  expect(inspectFn).toHaveBeenCalledTimes(3);
-});
+    expect(result).toEqual(data2);
+    expect(inspectFn).toHaveBeenCalledTimes(3);
+  });
 
-test("throws an error when host ports are not exposed within timeout", async () => {
-  const data = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [] });
-  const inspectFn = vi.fn().mockResolvedValue(data);
+  it("retries the inspect if port bindings are undefined", async () => {
+    const data1 = mockInspectResult(undefined, { "8080/tcp": [{ HostIp: "0.0.0.0", HostPort: "45000" }] });
+    const data2 = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [{ HostIp: "0.0.0.0", HostPort: "45000" }] });
+    const inspectFn = vi.fn().mockResolvedValueOnce(data1).mockResolvedValueOnce(data1).mockResolvedValueOnce(data2);
 
-  await expect(inspectContainerUntilPortsExposed(inspectFn, "container-id", 0)).rejects.toThrow(
-    "Container did not expose all ports after starting"
-  );
-});
+    const result = await inspectContainerUntilPortsExposed(inspectFn, "container-id");
+
+    expect(result).toEqual(data2);
+    expect(inspectFn).toHaveBeenCalledTimes(3);
+  });
+
+  it("throws an error when host ports are not exposed within timeout", async () => {
+    const data = mockInspectResult({ "8080/tcp": [] }, { "8080/tcp": [] });
+    const inspectFn = vi.fn().mockResolvedValue(data);
+
+    await expect(inspectContainerUntilPortsExposed(inspectFn, "container-id", 0)).rejects.toThrow(
+      "Container did not expose all ports after starting"
+    );
+  });
 
-test("throws an error when container ports not exposed within timeout", async () => {
-  const data = mockInspectResult({ "8080/tcp": [] }, {});
-  const inspectFn = vi.fn().mockResolvedValue(data);
+  it("throws an error when container ports not exposed within timeout", async () => {
+    const data = mockInspectResult({ "8080/tcp": [] }, {});
+    const inspectFn = vi.fn().mockResolvedValue(data);
 
-  await expect(inspectContainerUntilPortsExposed(inspectFn, "container-id", 0)).rejects.toThrow(
-    "Container did not expose all ports after starting"
-  );
+    await expect(inspectContainerUntilPortsExposed(inspectFn, "container-id", 0)).rejects.toThrow(
+      "Container did not expose all ports after starting"
+    );
+  });
 });

packages/testcontainers/src/generic-container/inspect-container-util-ports-exposed.ts

@@ -9,8 +9,10 @@ export async function inspectContainerUntilPortsExposed(
   const result = await new IntervalRetry<ContainerInspectInfo, Error>(250).retryUntil(
     () => inspectFn(),
     (inspectResult) => {
-      const exposedPorts = Object.keys(inspectResult.HostConfig.PortBindings);
-      return exposedPorts.every((exposedPort) => inspectResult.NetworkSettings.Ports[exposedPort]?.length > 0);
+      const portBindings = inspectResult?.HostConfig?.PortBindings;
+      if (!portBindings) return false;
+      const expectedlyBoundPorts = Object.keys(portBindings);
+      return expectedlyBoundPorts.every((exposedPort) => inspectResult.NetworkSettings.Ports[exposedPort]?.length > 0);
     },
     () => {
       const message = `Container did not expose all ports after starting`;