Separate testcontainers and modules into workspaces and publish as distinct packages into the testcontainers NPM organisation

.eslintignore

@@ -0,0 +1 @@
+**/build/**

.eslintrc.js

@@ -5,5 +5,6 @@ module.exports = {
   extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
   rules: {
     "prettier/prettier": "error",
+    "@typescript-eslint/no-empty-function": "off",
   },
 };

.github/workflows/npm-publish.yml

@@ -1,43 +1,48 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
 name: Node.js Package
 
 on:
   release:
     types: [published]
 
 jobs:
-  commit-version:
+  publish:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
         with:
           ref: main
+
       - uses: actions/setup-node@v3
         with:
           node-version: 18
-      - run: |
+
+      - name: Configure Git
+        run: |
           git config user.name github-actions
           git config user.email [email protected]
-          npm --no-git-tag-version version ${{ github.event.release.tag_name }}
+
+      - name: Update versions
+        run: |
+          npm version ${{ github.event.release.tag_name }} -ws
+          for module in src/modules/*; do npm install testcontainers@${{ github.event.release.tag_name }} --save -w $module; done
           sed -i -E "s/(sonar.projectVersion)=.+/\1=${{ github.event.release.tag_name }}/" sonar-project.properties
-          git add package.json package-lock.json sonar-project.properties
+
+      - name: Build packages
+        run: |
+          npm ci --no-optional
+          npm run build -ws
+
+      - name: Git commit and push
+        run: |
+          git add \
+            package-lock.json \
+            src/**/package.json \
+            src/testcontainers/src/version.ts \
+            sonar-project.properties
           git commit -m "${{ github.event.release.tag_name }}"
           git push
 
-  publish-npm:
-    needs: commit-version
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          ref: main
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci --no-optional
-      - run: npm publish
+      - name: Publish packages to NPM
+        run: npm publish -ws
         env:
           NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

.github/workflows/test-main.yml

@@ -126,6 +126,7 @@ jobs:
         run: npm run test:ci -- generic-container.test.ts
 
   rancher-desktop:
+    if: false # https://github.com/rancher-sandbox/rancher-desktop/issues/5285
     runs-on: ${{ matrix.os-version }}
     strategy:
       fail-fast: false
@@ -220,9 +221,11 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm ci --omit=optional
+      - name: Build workspaces
+        run: npm run build -ws
       - name: Remove dev dependencies
         run: npm prune --omit=dev
       - name: Run CommonJS module smoke test
-        run: node smoke-test.js
+        run: node src/testcontainers/smoke-test.js
       - name: Run ES module smoke test
-        run: node smoke-test.mjs
+        run: node src/testcontainers/smoke-test.mjs

.github/workflows/test.yml

@@ -120,6 +120,7 @@ jobs:
         run: npm run test:ci -- generic-container.test.ts
 
   rancher-desktop:
+    if: false # https://github.com/rancher-sandbox/rancher-desktop/issues/5285
     runs-on: ${{ matrix.os-version }}
     strategy:
       fail-fast: false
@@ -214,9 +215,11 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm ci --omit=optional
+      - name: Build workspaces
+        run: npm run build -ws
       - name: Remove dev dependencies
         run: npm prune --omit=dev
       - name: Run CommonJS module smoke test
-        run: node smoke-test.js
+        run: node src/testcontainers/smoke-test.js
       - name: Run ES module smoke test
-        run: node smoke-test.mjs
+        run: node src/testcontainers/smoke-test.mjs

.gitignore

@@ -1,4 +1,5 @@
-dist/
+build/
+*.tsbuildinfo
 node_modules/
 coverage/
 

.prettierignore

@@ -0,0 +1 @@
+**/build/**

docs/features/compose.md

@@ -43,11 +43,29 @@ const environment = await new DockerComposeEnvironment(composeFilePath, composeF
 
 ### With a pull policy
 
+Testcontainers will automatically pull an image if it doesn't exist. This is configurable:
+
 ```javascript
-const { DockerComposeEnvironment, AlwaysPullPolicy } = require("testcontainers");
+const { DockerComposeEnvironment, PullPolicy } = require("testcontainers");
+
+const environment = await new DockerComposeEnvironment(composeFilePath, composeFile)
+  .withPullPolicy(PullPolicy.alwaysPull())
+  .up();
+```
+
+Create a custom pull policy:
+
+```typescript
+const { GenericContainer, ImagePullPolicy } = require("testcontainers");
+
+class CustomPullPolicy implements ImagePullPolicy {
+  public shouldPull(): boolean {
+    return true;
+  }
+}
 
 const environment = await new DockerComposeEnvironment(composeFilePath, composeFile)
-  .withPullPolicy(new AlwaysPullPolicy())
+  .withPullPolicy(new CustomPullPolicy())
   .up();
 ```
 

docs/features/containers.md

@@ -21,10 +21,26 @@ const container = await new GenericContainer("alpine:3.10").start();
 Testcontainers will automatically pull an image if it doesn't exist. This is configurable:
 
 ```javascript
-const { GenericContainer, AlwaysPullPolicy } = require("testcontainers");
+const { GenericContainer, PullPolicy } = require("testcontainers");
 
 const container = await new GenericContainer("alpine")
-  .withPullPolicy(new AlwaysPullPolicy())
+  .withPullPolicy(PullPolicy.alwaysPull())
+  .start();
+```
+
+Create a custom pull policy:
+
+```typescript
+const { GenericContainer, ImagePullPolicy } = require("testcontainers");
+
+class CustomPullPolicy implements ImagePullPolicy {
+  public shouldPull(): boolean {
+    return true;
+  }
+}
+
+const container = await new GenericContainer("alpine")
+  .withPullPolicy(new CustomPullPolicy())
   .start();
 ```
 
@@ -395,7 +411,7 @@ import {
 } from "testcontainers";
 
 class CustomContainer extends GenericContainer {
-  protected override async beforeContainerStarted(): Promise<void> {
+  protected override async beforeContainerCreated(): Promise<void> {
     // ...
   }
 

docs/features/images.md

@@ -24,16 +24,33 @@ const container = await GenericContainer
   .build("my-custom-image", { deleteOnExit: false });
 ```
 
-### With pull policy
+### With a pull policy
 
 Testcontainers will automatically pull an image if it doesn't exist. This is configurable:
 
 ```javascript
-const { GenericContainer, AlwaysPullPolicy } = require("testcontainers");
+const { GenericContainer, PullPolicy } = require("testcontainers");
 
 const container = await GenericContainer
   .fromDockerfile("/path/to/build-context")
-  .withPullPolicy(new AlwaysPullPolicy())
+  .withPullPolicy(PullPolicy.alwaysPull())
+  .build();
+```
+
+Create a custom pull policy:
+
+```typescript
+const { GenericContainer, ImagePullPolicy } = require("testcontainers");
+
+class CustomPullPolicy implements ImagePullPolicy {
+  public shouldPull(): boolean {
+    return true;
+  }
+}
+
+const container = await GenericContainer
+  .fromDockerfile("/path/to/build-context")
+  .withPullPolicy(new CustomPullPolicy())
   .build();
 ```
 

docs/modules/arangodb.md

@@ -2,9 +2,15 @@
 
 [ArangoDB](https://www.arangodb.com/) is an open source friendly multi-model database. You can find the documentation of the [ArangoDB JavaScript](https://www.arangodb.com/docs/stable/drivers/js.html) driver here.
 
+## Install
+
+```bash
+npm install @testcontainers/arangodb --save-dev
+```
+
 ## Example
 
 <!--codeinclude-->
-[](../../src/modules/arangodb/arangodb-container.test.ts) inside_block:connect
+[](../../src/modules/arangodb/src/arangodb-container.test.ts) inside_block:connect
 <!--/codeinclude-->
 

docs/modules/elastic-search.md → docs/modules/elasticsearch.md

@@ -2,12 +2,18 @@
 
 [Elasticsearch](https://www.elastic.co/elasticsearch/) is a search engine based on the Lucene library. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.
 
+## Install
+
+```bash
+npm install @testcontainers/elasticsearch --save-dev
+```
+
 ## Examples
 
 <!--codeinclude-->
-[Create an index:](../../src/modules/elasticsearch/elasticsearch-container.test.ts) inside_block:createIndex
+[Create an index:](../../src/modules/elasticsearch/src/elasticsearch-container.test.ts) inside_block:createIndex
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Index a document:](../../src/modules/elasticsearch/elasticsearch-container.test.ts) inside_block:indexDocument
+[Index a document:](../../src/modules/elasticsearch/src/elasticsearch-container.test.ts) inside_block:indexDocument
 <!--/codeinclude-->

docs/modules/hivemq.md

@@ -3,6 +3,12 @@
 This module allows automatic start up of [HiveMQ's](https://www.hivemq.com/) docker container within
 Jest suites, to enable programmatic testing of JavaScript based MQTT client applications.
 
+## Install
+
+```bash
+npm install @testcontainers/hivemq --save-dev
+```
+
 ## Resources
 
 * [Community forum](https://community.hivemq.com/)
@@ -18,5 +24,5 @@ Please make sure to check out the hivemq-docs for the [Community Edition](https:
 ## Examples
 
 <!--codeinclude-->
-[Connect with a mqtt.js client to HiveMQ](../../src/modules/hivemq/hivemq-container.test.ts) inside_block:connect
+[Connect with a mqtt.js client to HiveMQ](../../src/modules/hivemq/src/hivemq-container.test.ts) inside_block:connect
 <!--/codeinclude-->

docs/modules/kafka.md

@@ -2,16 +2,22 @@
 
 [Kafka](https://kafka.apache.org/) is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.
 
+## Install
+
+```bash
+npm install @testcontainers/kafka --save-dev
+```
+
 ## Examples
 
 <!--codeinclude-->
-[Connect to Kafka using in-built ZooKeeper:](../../src/modules/kafka/kafka-container.test.ts) inside_block:connectBuiltInZK
+[Connect to Kafka using in-built ZooKeeper:](../../src/modules/kafka/src/kafka-container.test.ts) inside_block:connectBuiltInZK
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Connect to Kafka using your own ZooKeeper:](../../src/modules/kafka/kafka-container.test.ts) inside_block:connectProvidedZK
+[Connect to Kafka using your own ZooKeeper:](../../src/modules/kafka/src/kafka-container.test.ts) inside_block:connectProvidedZK
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Connect to Kafka using SSL:](../../src/modules/kafka/kafka-container.test.ts) inside_block:ssl
+[Connect to Kafka using SSL:](../../src/modules/kafka/src/kafka-container.test.ts) inside_block:ssl
 <!--/codeinclude-->

docs/modules/mongodb.md

@@ -2,12 +2,18 @@
 
 [MongoDB](https://www.mongodb.com/) is an open source NoSQL database management program. NoSQL is used as an alternative to traditional relational databases. NoSQL databases are quite useful for working with large sets of distributed data. MongoDB is a tool that can manage document-oriented information, store or retrieve information.
 
+## Install
+
+```bash
+npm install @testcontainers/mongodb --save-dev
+```
+
 ## Examples
 
 <!--codeinclude-->
-[Mongo 4.0.x:](../../src/modules/mongodb/mongodb-container.test.ts) inside_block:connect4
+[Mongo 4.0.x:](../../src/modules/mongodb/src/mongodb-container.test.ts) inside_block:connect4
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[MongoDB 6.0.x:](../../src/modules/mongodb/mongodb-container.test.ts) inside_block:connect6
+[MongoDB 6.0.x:](../../src/modules/mongodb/src/mongodb-container.test.ts) inside_block:connect6
 <!--/codeinclude-->

docs/modules/mysql.md

@@ -2,20 +2,26 @@
 
 [MySQL](https://www.mysql.com/) is the world's most popular open source database. With its proven performance, reliability and ease-of-use, MySQL has become the leading database choice for web-based applications, covering the entire range from personal projects and websites, via e-commerce and information services, all the way to high profile web properties including Facebook, Twitter, YouTube, Yahoo! and many more.
 
+## Install
+
+```bash
+npm install @testcontainers/mysql --save-dev
+```
+
 ## Examples
 
 <!--codeinclude-->
-[Connect and execute query:](../../src/modules/mysql/mysql-container.test.ts) inside_block:connect
+[Connect and execute query:](../../src/modules/mysql/src/mysql-container.test.ts) inside_block:connect
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Connect and execute query using URI:](../../src/modules/mysql/mysql-container.test.ts) inside_block:uriConnect
+[Connect and execute query using URI:](../../src/modules/mysql/src/mysql-container.test.ts) inside_block:uriConnect
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Set username:](../../src/modules/mysql/mysql-container.test.ts) inside_block:setUsername
+[Set username:](../../src/modules/mysql/src/mysql-container.test.ts) inside_block:setUsername
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Execute a query inside the container:](../../src/modules/mysql/mysql-container.test.ts) inside_block:executeQuery
+[Execute a query inside the container:](../../src/modules/mysql/src/mysql-container.test.ts) inside_block:executeQuery
 <!--/codeinclude-->