fix: Rename test container. (#204)

Author: goloroden

README.md

@@ -403,12 +403,12 @@ controller.abort();
 
 ### Using Testcontainers
 
-Import the `EventSourcingDbContainer` class, create an instance, call the `start` function to run a test container, get a client, run your test code, and finally call the `stop` function to stop the test container:
+Import the `Container` class, create an instance, call the `start` function to run a test container, get a client, run your test code, and finally call the `stop` function to stop the test container:
 
 ```typescript
-import { EventSourcingDbContainer } from 'eventsourcingdb';
+import { Container } from 'eventsourcingdb';
 
-const container = new EventSourcingDbContainer();
+const container = new Container();
 await container.start();
 
 const client = container.getClient();
@@ -426,17 +426,17 @@ const isRunning = container.isRunning();
 
 #### Configuring the Container Instance
 
-By default, `EventSourcingDbContainer` uses the `latest` tag of the official EventSourcingDB Docker image. To change that, call the `withImageTag` function:
+By default, `Container` uses the `latest` tag of the official EventSourcingDB Docker image. To change that, call the `withImageTag` function:
 
 ```typescript
-const container = new EventSourcingDbContainer()
+const container = new Container()
   .withImageTag('1.0.0');
 ```
 
 Similarly, you can configure the port to use and the API token. Call the `withPort` or the `withApiToken` function respectively:
 
 ```typescript
-const container = new EventSourcingDbContainer()
+const container = new Container()
   .withPort(4000)
   .withApiToken('secret');
 ```

src/EventSourcingDbContainer.ts src/Container.tssrc/EventSourcingDbContainer.ts renamed to src/Container.ts

@@ -2,7 +2,7 @@ import type { StartedTestContainer } from 'testcontainers';
 import { GenericContainer, Wait } from 'testcontainers';
 import { Client } from './Client.js';
 
-class EventSourcingDbContainer {
+class Container {
 	#imageName = 'thenativeweb/eventsourcingdb';
 	#imageTag = 'latest';
 	#internalPort = 3000;
@@ -88,4 +88,4 @@ class EventSourcingDbContainer {
 	}
 }
 
-export { EventSourcingDbContainer };
+export { Container };

src/index.ts

@@ -1,12 +1,12 @@
 import { Client } from './Client.js';
+import { Container } from './Container.js';
 import type { Event } from './Event.js';
 import type { EventCandidate } from './EventCandidate.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
 import type { EventType } from './EventType.js';
 import type { ObserveEventsOptions } from './ObserveEventsOptions.js';
 import type { ReadEventsOptions } from './ReadEventsOptions.js';
 import { isSubjectOnEventId } from './isSubjectOnEventId.js';
 import { isSubjectPristine } from './isSubjectPristine.js';
 
-export { Client, EventSourcingDbContainer, isSubjectPristine, isSubjectOnEventId };
+export { Client, Container, isSubjectPristine, isSubjectOnEventId };
 export type { Event, EventCandidate, EventType, ReadEventsOptions, ObserveEventsOptions };

src/observeEvents.test.ts

@@ -1,16 +1,16 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
+import { Container } from './Container.js';
 import type { Event } from './Event.js';
 import type { EventCandidate } from './EventCandidate.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('observeEvents', { timeout: 30_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});
 

src/ping.test.ts

@@ -1,15 +1,15 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
 import { Client } from './Client.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
+import { Container } from './Container.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('ping', { timeout: 30_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});
 

src/readEventTypes.test.ts

@@ -1,16 +1,16 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
+import { Container } from './Container.js';
 import type { EventCandidate } from './EventCandidate.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
 import type { EventType } from './EventType.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('readEventTypes', { timeout: 20_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});
 

src/readEvents.test.ts

@@ -1,16 +1,16 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
+import { Container } from './Container.js';
 import type { Event } from './Event.js';
 import type { EventCandidate } from './EventCandidate.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('readEvents', { timeout: 30_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});
 

src/readSubjects.test.ts

@@ -1,15 +1,15 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
+import { Container } from './Container.js';
 import type { EventCandidate } from './EventCandidate.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('readSubjects', { timeout: 30_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});
 

src/registerEventSchema.test.ts

@@ -1,14 +1,14 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
+import { Container } from './Container.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('registerEventSchema', { timeout: 30_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});
 

src/runEventQlQuery.test.ts

@@ -1,15 +1,15 @@
 import assert from 'node:assert/strict';
 import { afterEach, beforeEach, suite, test } from 'node:test';
+import { Container } from './Container.js';
 import type { EventCandidate } from './EventCandidate.js';
-import { EventSourcingDbContainer } from './EventSourcingDbContainer.js';
 import { getImageVersionFromDockerfile } from './getImageVersionFromDockerfile.js';
 
 suite('runEventQlQuery', { timeout: 30_000 }, () => {
-	let container: EventSourcingDbContainer;
+	let container: Container;
 
 	beforeEach(async () => {
 		const imageVersion = getImageVersionFromDockerfile();
-		container = new EventSourcingDbContainer().withImageTag(imageVersion);
+		container = new Container().withImageTag(imageVersion);
 		await container.start();
 	});