Add support for initialization scripts by taole33 · Pull Request #11331 · testcontainers/testcontainers-java

taole33 · 2025-12-06T01:22:41Z

Description

This PR adds support for initialization scripts in MongoDBContainer.

When an initialization script is placed in /docker-entrypoint-initdb.d/, the official MongoDB image restarts the container process after executing the script. This behavior previously caused WaitStrategy timeouts because the container would stop and start again.

Changes

Added withInitScript(String scriptPath) method to MongoDBContainer.
The method copies the script to /docker-entrypoint-initdb.d/init.js.
It automatically configures the WaitStrategy to expect two "waiting for connections" log messages, ensuring the container is fully ready after the restart.

Verification

Added MongoDBInitScriptTest to verify that the container starts successfully with an init script.

Running initialization scripts in MongoDB causes the container to restart, which previously required manual WaitStrategy adjustment. This commit adds 'withInitScript(String)' to automatically handle the script copy and adjust the WaitStrategy to expect two startup log messages. Fixes testcontainers#3066

eddumelendez · 2025-12-09T20:24:40Z

modules/mongodb/src/main/java/org/testcontainers/containers/MongoDBContainer.java

+     * @param scriptPath the path to the init script file on the classpath
+     * @return this container instance
+     */
+    public MongoDBContainer withInitScript(String scriptPath) {


org.testcontainers.containers.MongoDBContainer is deprecated. can you moved to org.testcontainers.mongodb.MongoDBContainer?

I moved to org.testcontainers.mongodb.MongoDBContainer.
Also, For the tests, instead of creating a new file named MongoDBInitScriptTest.java, I added the test cases directly to MongoDBContainerTest.java.

eddumelendez · 2025-12-10T15:46:38Z

does this work with ReplicaSet and Sharded mode? New MongoDBContainer implementation has withReplicaSet() and withSharding() methods. It would be nice we can make sure this work with all implementations

taole33 · 2025-12-11T12:57:28Z

I updated withInitScript to support ReplicaSet and Sharding modes.

In these modes, the default entrypoint mechanism conflicts with the cluster initialization scripts or is ignored. To fix this, I modified the logic to isolate the init script from the default directory when running in Cluster mode, and instead execute it manually after the container has started.

Reason

In Cluster modes (ReplicaSet/Sharding), relying on the default /docker-entrypoint-initdb.d/ mechanism causes issues:

ReplicaSet: The default entrypoint triggers a restart, causing a race condition with rs.initiate().
Sharding: The entrypoint is overridden, so the script is ignored.

Changes

Added logic to detect Cluster mode.
If Cluster mode is enabled, the script is mounted to a temporary location (isolating it from the default entrypoint) and executed manually after the cluster is fully initialized.
This ensures data consistency and avoids startup conflicts.

Fixes #3066

eddumelendez · 2025-12-15T16:00:38Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+                .withEnv("LANG", "C.UTF-8")
+                .withEnv("LC_ALL", "C.UTF-8")
+                .withStartupTimeout(Duration.ofSeconds(30))


is this required?

eddumelendez · 2025-12-15T16:01:03Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+        try (
+            MongoDBContainer mongoDB = new MongoDBContainer("mongo:4.0.10")
+                .withInitScript("init.js")
+                .withStartupTimeout(Duration.ofSeconds(30))


is this required?

eddumelendez · 2025-12-15T16:01:39Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+                    .isEqualTo("{ } [ ] : ,");
+
+                assertThat(doc.getString("description"))
+                    .as("Japanese text should be preserved correctly")


remove as

eddumelendez · 2025-12-15T16:01:53Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+
+                assertThat(doc.getString("description"))
+                    .as("Japanese text should be preserved correctly")
+                    .isEqualTo("特殊記号を含むコレクションへの挿入テスト");


Can we use plain english, please?

eddumelendez · 2025-12-15T16:03:06Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+    @Test
+    void shouldExecuteInitScriptWithShardingConfiguredFirst() {
+        try (MongoDBContainer mongo = new MongoDBContainer("mongo:7.0.0").withSharding().withInitScript("init.js")) {
+            mongo.start();
+            assertInitScriptExecuted(mongo);
+        }
+    }


let's remove it. There is no difference with the previous test

eddumelendez · 2025-12-15T16:03:16Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+    @Test
+    void shouldExecuteInitScriptWithReplicaSetConfiguredFirst() {
+        try (MongoDBContainer mongo = new MongoDBContainer("mongo:7.0.0").withReplicaSet().withInitScript("init.js")) {
+            mongo.start();
+            assertInitScriptExecuted(mongo);
+        }
+    }


let's remove it. There is no difference with the previous test

taole33 · 2025-12-16T02:29:10Z

@eddumelendez
Thank you for the review. I have updated the implementation to address your feedback.

In this update, I also addressed an edge case regarding filenames containing special characters (e.g., # or spaces) which wasn't handled in the previous version.
Since standard resource loading can sometimes misinterpret these characters as URL fragments, I implemented the file transfer logic to explicitly handle raw bytes. This ensures robustness for any filename.

I believe this covers all cases. Let me know if you have any further questions.

Copilot

Pull request overview

Adds first-class init-script support to org.testcontainers.mongodb.MongoDBContainer, addressing MongoDB’s entrypoint behavior of restarting mongod after running /docker-entrypoint-initdb.d/* scripts (which previously could cause readiness timing issues).

Changes:

Added MongoDBContainer.withInitScript(String) to copy an init script into the container and adjust readiness behavior.
Implemented special-character-tolerant init script transfer using Transferable-based byte copying.
Added tests and resources to verify init script execution across standalone, replica set, and sharding modes.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File	Description
modules/mongodb/src/main/java/org/testcontainers/mongodb/MongoDBContainer.java	Adds init-script plumbing, classpath resolution + copy, wait strategy adjustments, and manual execution for cluster modes.
modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java	Adds test coverage for init scripts in standalone, replica set, sharding, and edge-case filenames.
modules/mongodb/src/test/resources/init.js	Provides a simple init script used by the new tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-12T22:53:57Z

modules/mongodb/src/main/java/org/testcontainers/mongodb/MongoDBContainer.java

+                Path scriptPath = Paths.get(this.initScriptPath);
+                String fileName = scriptPath.getFileName().toString();
+                Path parentDir = scriptPath.getParent();
+                String resourceDir = (parentDir == null) ? "" : parentDir.toString();


configure() derives resourceDir via Paths.get(initScriptPath) / parentDir.toString(), which uses platform-specific separators (e.g., \ on Windows). Classpath resource lookup expects / separators, so scripts located under nested directories can fail to resolve on Windows. Consider treating scriptPath as a classpath resource name (string with /) rather than a filesystem Path, or normalize resourceDir to / separators before calling getResources.

Suggested change

Path scriptPath = Paths.get(this.initScriptPath);

String fileName = scriptPath.getFileName().toString();

Path parentDir = scriptPath.getParent();

String resourceDir = (parentDir == null) ? "" : parentDir.toString();

// Treat initScriptPath as a classpath resource name, not a filesystem path

String normalizedScriptPath = this.initScriptPath.replace('\\', '/');

int lastSlash = normalizedScriptPath.lastIndexOf('/');

String fileName = (lastSlash == -1) ? normalizedScriptPath : normalizedScriptPath.substring(lastSlash + 1);

String resourceDir = (lastSlash == -1) ? "" : normalizedScriptPath.substring(0, lastSlash);

Copilot · 2026-03-12T22:53:57Z

modules/mongodb/src/main/java/org/testcontainers/mongodb/MongoDBContainer.java

+                Enumeration<URL> resources = this.getClass().getClassLoader().getResources(resourceDir);
+                byte[] fileContent = null;
+
+                while (resources.hasMoreElements()) {
+                    URL dirUrl = resources.nextElement();
+
+                    if ("file".equals(dirUrl.getProtocol())) {
+                        Path dirPath = Paths.get(dirUrl.toURI());
+                        Path candidatePath = dirPath.resolve(fileName);
+
+                        if (Files.exists(candidatePath) && !Files.isDirectory(candidatePath)) {
+                            fileContent = Files.readAllBytes(candidatePath);
+                            break;
+                        }
+                    }


The init script resolution only considers classpath resources with the file: protocol. If the init script is packaged in a JAR (common in some test setups/build tools), dirUrl.getProtocol() will be jar and the script will never be found, resulting in a runtime failure. Consider loading the resource bytes via ClassLoader.getResourceAsStream (or similar) so both file: and jar: classpath resources work.

Copilot · 2026-03-12T22:53:58Z

modules/mongodb/src/main/java/org/testcontainers/mongodb/MongoDBContainer.java

+                }
+
+                String destination = isClusterMode ? SCRIPT_DESTINATION_MANUAL : SCRIPT_DESTINATION_DEFAULT;
+                withCopyToContainer(Transferable.of(fileContent, 0777), destination);


The init script is copied into the container with mode 0777. For a .js init script, execute permissions are not required and 0777 is overly permissive; it’s safer to use a read-only mode like 0644 (or 0444) unless execution is needed.

Suggested change

withCopyToContainer(Transferable.of(fileContent, 0777), destination);

withCopyToContainer(Transferable.of(fileContent, 0644), destination);

Copilot · 2026-03-12T22:53:58Z

modules/mongodb/src/main/java/org/testcontainers/mongodb/MongoDBContainer.java

+            }
+        }
+
+        if (this.initScriptPath != null && !isClusterMode) {


configure() unconditionally overwrites the container’s waitStrategy when initScriptPath is set in standalone mode. This prevents users from supplying a custom waitingFor(...) strategy (it will be silently replaced at startup). Consider only adjusting the wait strategy if it is still the default (GenericContainer.DEFAULT_WAIT_STRATEGY) or offering an opt-out.

Suggested change

if (this.initScriptPath != null && !isClusterMode) {

if (this.initScriptPath != null

&& !isClusterMode

&& (this.waitStrategy == null || this.waitStrategy == GenericContainer.DEFAULT_WAIT_STRATEGY)) {

Copilot · 2026-03-12T22:53:58Z

modules/mongodb/src/main/java/org/testcontainers/mongodb/MongoDBContainer.java

+
+        boolean isClusterMode = this.shardingEnabled || this.rsEnabled;
+
+        if (isClusterMode && this.initScriptPath != null) {


In cluster mode (replica set/sharding), the init script is executed unconditionally in containerIsStarted(...), even when reused == true. This differs from the official entrypoint behavior (init scripts run only on first initialization) and can break non-idempotent scripts when container reuse is enabled. Consider skipping init-script execution on reuse, or documenting/controlling this behavior explicitly.

Suggested change

if (isClusterMode && this.initScriptPath != null) {

if (isClusterMode && !reused && this.initScriptPath != null) {

Copilot · 2026-03-12T22:53:58Z

modules/mongodb/src/test/java/org/testcontainers/mongodb/MongoDBContainerTest.java

+    @Test
+    void shouldExecuteInitScriptWithEdgeCases() {
+        try (
+            MongoDBContainer mongoDB = new MongoDBContainer("mongo:4.0.10").withInitScript("initEdgeCase!@#%^& *'().js")


The init script resource name used here contains * ("initEdgeCase!@#%^& *'().js"). * is not a valid filename character on Windows filesystems, which can make the test resources impossible to check out/build on Windows and cause CI failures. Consider using a cross-platform-safe filename (still including tricky URL characters like # and spaces if needed) to validate the edge case.

Suggested change

MongoDBContainer mongoDB = new MongoDBContainer("mongo:4.0.10").withInitScript("initEdgeCase!@#%^& *'().js")

MongoDBContainer mongoDB = new MongoDBContainer("mongo:4.0.10").withInitScript("initEdgeCase!@#%^& '().js")

taole33 added 2 commits December 6, 2025 10:10

style: Apply code formatting

e2adfb1

taole33 requested a review from a team as a code owner December 6, 2025 01:22

github-actions bot added the modules/mongodb label Dec 6, 2025

eddumelendez changed the title ~~feat(module/mongodb): Add support for initialization scripts~~ Add support for initialization scripts Dec 9, 2025

eddumelendez requested changes Dec 9, 2025

View reviewed changes

taole33 force-pushed the feature/issue-3066-mongodb-init-script branch 2 times, most recently from 6665ad7 to 67088da Compare December 9, 2025 23:28

fix(module/mongodb):move to org.testcontainers.mongodb.MongoDBContainer

e81a2ac

taole33 force-pushed the feature/issue-3066-mongodb-init-script branch from 67088da to e81a2ac Compare December 9, 2025 23:32

taole33 added 2 commits December 11, 2025 21:39

Fix withInitScript compatibility with ReplicaSet and Sharding modes

35b753b

Fix edgecases test

488b5fa

eddumelendez requested changes Dec 15, 2025

View reviewed changes

taole33 added 2 commits December 16, 2025 10:59

fix: Address review comments

b7ca531

fix: Address review comments

d868b95

taole33 requested a review from eddumelendez December 16, 2025 02:29

Merge branch 'main' into feature/issue-3066-mongodb-init-script

4c3c477

eddumelendez mentioned this pull request Mar 12, 2026

MongoDBContainer: simplify loading and executing java script files to init DB #3869

Closed

eddumelendez requested a review from Copilot March 12, 2026 22:49

Copilot started reviewing on behalf of eddumelendez March 12, 2026 22:50 View session

Copilot AI reviewed Mar 12, 2026

View reviewed changes

-                Path scriptPath = Paths.get(this.initScriptPath);
-                String fileName = scriptPath.getFileName().toString();
-                Path parentDir = scriptPath.getParent();
-                String resourceDir = (parentDir == null) ? "" : parentDir.toString();
+                // Treat initScriptPath as a classpath resource name, not a filesystem path
+                String normalizedScriptPath = this.initScriptPath.replace('\\', '/');
+                int lastSlash = normalizedScriptPath.lastIndexOf('/');
+                String fileName = (lastSlash == -1) ? normalizedScriptPath : normalizedScriptPath.substring(lastSlash + 1);
+                String resourceDir = (lastSlash == -1) ? "" : normalizedScriptPath.substring(0, lastSlash);

	withCopyToContainer(Transferable.of(fileContent, 0777), destination);
	withCopyToContainer(Transferable.of(fileContent, 0644), destination);


		boolean isClusterMode = this.shardingEnabled \|\| this.rsEnabled;

		if (isClusterMode && this.initScriptPath != null) {

	if (isClusterMode && this.initScriptPath != null) {
	if (isClusterMode && !reused && this.initScriptPath != null) {

	MongoDBContainer mongoDB = new MongoDBContainer("mongo:4.0.10").withInitScript("initEdgeCase!@#%^& *'().js")
	MongoDBContainer mongoDB = new MongoDBContainer("mongo:4.0.10").withInitScript("initEdgeCase!@#%^& '().js")

Uh oh!

Conversation

taole33 commented Dec 6, 2025

Description

Changes

Verification

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eddumelendez commented Dec 10, 2025

Uh oh!

taole33 commented Dec 11, 2025

Reason

Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

taole33 commented Dec 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants