diff --git a/docs/features/containers.md b/docs/features/containers.md index 704a65187..a5e07b546 100644 --- a/docs/features/containers.md +++ b/docs/features/containers.md @@ -316,7 +316,7 @@ import { } from "testcontainers"; class CustomContainer extends GenericContainer { - protected override async beforeContainerStarted(): Promise { + protected override async beforeContainerCreated(): Promise { // ... } diff --git a/src/generic-container/generic-container-lifecycle.test.ts b/src/generic-container/generic-container-lifecycle.test.ts index 2abf73a80..be29ac2b7 100644 --- a/src/generic-container/generic-container-lifecycle.test.ts +++ b/src/generic-container/generic-container-lifecycle.test.ts @@ -3,7 +3,7 @@ import { GenericContainer, AbstractStartedContainer, StartedTestContainer, Inspe describe("GenericContainer lifecycle", () => { jest.setTimeout(180_000); - let beforeContainerStarted: jest.Func; + let beforeContainerCreated: jest.Func; let containerCreated: jest.Func; let containerStarting: jest.Func; let containerStarted: jest.Func; @@ -11,7 +11,7 @@ describe("GenericContainer lifecycle", () => { let containerStopped: jest.Func; beforeEach(() => { - beforeContainerStarted = jest.fn(); + beforeContainerCreated = jest.fn(); containerCreated = jest.fn(); containerStarting = jest.fn(); containerStarted = jest.fn(); @@ -24,7 +24,7 @@ describe("GenericContainer lifecycle", () => { .withExposedPorts(8080) .start(); - expect(beforeContainerStarted).toHaveBeenCalled(); + expect(beforeContainerCreated).toHaveBeenCalled(); expect(containerCreated).toHaveBeenCalledWith(container.getId()); expect(containerStarting).toHaveBeenCalledWith(false); expect(containerStarted).toHaveBeenCalledWith(false); @@ -45,7 +45,7 @@ describe("GenericContainer lifecycle", () => { .start(); expect(container1.getId()).toEqual(container2.getId()); - expect(beforeContainerStarted).toHaveBeenCalled(); + expect(beforeContainerCreated).toHaveBeenCalled(); expect(containerCreated).not.toHaveBeenCalled(); expect(containerStarting).toHaveBeenCalledWith(true); expect(containerStarted).toHaveBeenCalledWith(true); @@ -54,8 +54,8 @@ describe("GenericContainer lifecycle", () => { }); class CustomContainer extends GenericContainer { - protected override async beforeContainerStarted(): Promise { - beforeContainerStarted(); + protected override async beforeContainerCreated(): Promise { + beforeContainerCreated(); } protected override async containerCreated(containerId: string): Promise { diff --git a/src/generic-container/generic-container.ts b/src/generic-container/generic-container.ts index 91587aed3..cd719bdfb 100644 --- a/src/generic-container/generic-container.ts +++ b/src/generic-container/generic-container.ts @@ -60,12 +60,7 @@ export class GenericContainer implements TestContainer { this.opts = initCreateContainerOptions(imageName, imageName.isReaper()); } - /** - * @deprecated Since version 9.4.0. Will be removed in version 10.0.0. Use `beforeContainerStarted` instead. - */ - protected preStart?(): Promise; - - protected beforeContainerStarted?(): Promise; + protected beforeContainerCreated?(): Promise; protected containerCreated?(containerId: string): Promise; @@ -83,10 +78,8 @@ export class GenericContainer implements TestContainer { await ReaperInstance.getInstance(); } - if (this.beforeContainerStarted) { - await this.beforeContainerStarted(); - } else if (this.preStart) { - await this.preStart(); + if (this.beforeContainerCreated) { + await this.beforeContainerCreated(); } if (!this.opts.imageName.isHelperContainer() && PortForwarderInstance.isRunning()) { @@ -152,8 +145,6 @@ export class GenericContainer implements TestContainer { if (this.containerStarted) { await this.containerStarted(startedContainer, inspectResult, true); - } else if (this.postStart) { - await this.postStart(startedContainer, inspectResult, boundPorts); } return startedContainer; @@ -226,22 +217,11 @@ export class GenericContainer implements TestContainer { if (this.containerStarted) { await this.containerStarted(startedContainer, inspectResult, false); - } else if (this.postStart) { - await this.postStart(startedContainer, inspectResult, boundPorts); } return startedContainer; } - /** - * @deprecated Since version 9.4.0. Will be removed in version 10.0.0. Use `containerStarted` instead. - */ - protected postStart?( - container: StartedTestContainer, - inspectResult: InspectResult, - boundPorts: BoundPorts - ): Promise; - protected containerStarted?( container: StartedTestContainer, inspectResult: InspectResult, diff --git a/src/modules/kafka/kafka-container.ts b/src/modules/kafka/kafka-container.ts index d19c46779..e28ff563f 100644 --- a/src/modules/kafka/kafka-container.ts +++ b/src/modules/kafka/kafka-container.ts @@ -70,7 +70,7 @@ export class KafkaContainer extends GenericContainer { return this; } - protected override async beforeContainerStarted(): Promise { + protected override async beforeContainerCreated(): Promise { const network = this.networkMode && this.networkAliases.length > 0 ? this.networkAliases[0] : "localhost"; this.withEnvironment({ KAFKA_ADVERTISED_LISTENERS: `BROKER://${network}:${KAFKA_BROKER_PORT}` });