fix(mongodb): replica set initialization & connection handling #2984

ttruongatl · 2025-02-15T01:25:17Z

What does this PR do?

This PR addresses critical issues in the MongoDB container module regarding replica set initialization, host IP detection, and connection string formation. In addition, it expands test coverage by verifying change stream functionality when a replica set is configured.

Replica Set Initialization Reliability:
The previous implementation initialized the replica set using the container’s internal IP and a hardcoded port (27017). This approach caused issues when custom host port mappings were applied (e.g., mapping container port 27017 to host port 52120) because the advertised address was incorrect. Furthermore, the old code did not reliably wait for MongoDB to be fully ready before issuing the rs.initiate command, leading to intermittent failures that went undetected by tests.
This PR introduces a waitForMongoReady helper, which waits for MongoDB’s readiness (using a ping command) before retrieving the host and mapped port and issuing the replica set initialization command with the correct values.
Accurate Host IP Detection:
Previously, using Unix sockets defaulted to "localhost," which often broke replica set functionality since that address isn't externally reachable. This PR introduces a helper, getLocalNonLoopbackIP, to obtain a non-loopback IPv4 address—and if that fails, it falls back to "host.docker.internal"—ensuring the connection string advertises an externally accessible IP.
Enhanced Connection String Formation:
The ConnectionString method has been updated to dynamically build the connection URI. When a replica set is configured, it now appends the appropriate query parameter (e.g., ?replicaSet=rs0) so that clients can connect properly. Previously, the tests did not verify this because the connection string did not accurately reflect the replica set configuration.
Expanded Testing with Change Streams:
The test suite has been extended to include change stream tests for containers configured with a replica set. If the connection string contains a replica set parameter, the tests now create a change stream on a collection, insert a document, and verify that the change event reflects an insert operation. This ensures that the replica set functionality is not only initialized correctly but also operational in terms of change stream processing.

Why is it important?

Without these enhancements, the replica set configuration might not work correctly—especially in CI or Docker host environments where custom port mappings are common. The shortcomings of the old code meant that, even though tests passed, the replica set functionality (and thus features like change streams) was not truly exercised. This PR improves reliability and test coverage, ensuring that integration tests can now fully validate replica set behavior.

How to test this PR:

git clone [email protected]:ttruongatl/testcontainers-go.git
cd modules/mongodb
make test

netlify · 2025-02-15T01:25:49Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`d4adb4d`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/67ed203c4288b30008a53a9a
😎 Deploy Preview	https://deploy-preview-2984--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

stevenh

Thanks for the PR, here's some initial feedback.

modules/mongodb/mongodb.go

modules/mongodb/mongodb_test.go

stevenh

Thanks for the updates, just done another quick pass.

modules/mongodb/mongodb.go

modules/mongodb/mongodb_test.go

mdelapenya

I just left a few non-blocking comments. Will approve once discussed, thanks!

modules/mongodb/mongodb_test.go

stevenh

Sorry a little miss-understanding on a previous suggestion, should be good to go after this.

modules/mongodb/mongodb.go

Co-authored-by: Steven Hartland <[email protected]>

Co-authored-by: Manuel de la Peña <[email protected]>

Co-authored-by: Steven Hartland <[email protected]>

stevenh

Looks good to me

stevenh · 2025-02-17T21:28:21Z

@ttruongatl looks like the file needs a format, likely just a spacing change from one of my suggestions.

ttruongatl · 2025-02-17T22:40:32Z

@stevenh I've fixed the lint check issues. PTAL! Thank you.

modules/mongodb/mongodb.go

…pbackIP function

…ialization-and-connection-handling

modules/mongodb/mongodb.go

mdelapenya

LGTM, thanks!

* main: fix(mongodb): replica set initialization & connection handling (testcontainers#2984)

* main: chore: bump golangci-lint to v2 (testcontainers#3082) chore(gcloud): deprecate old gcp containers, creating subpackages for them (testcontainers#3063) fix(mongodb): replica set initialization & connection handling (testcontainers#2984) chore(deps): bump docker/setup-docker-action from 4.2.0 to 4.3.0 (testcontainers#3077) chore(deps): bump github/codeql-action from 3.28.12 to 3.28.13 (testcontainers#3078) chore(deps): bump tj-actions/changed-files from 45.0.4 to 46.0.3 (testcontainers#3076) docs: add dependabot configuration (testcontainers#3074) chore(deps): replace `golang.org/x/exp/slices` with stdlib (testcontainers#3075) fix(dind): use docker image load (testcontainers#3073)

* main: fix(mssql): reduce flakiness in tests (testcontainers#3084) chore: bump golangci-lint to v2 (testcontainers#3082) chore(gcloud): deprecate old gcp containers, creating subpackages for them (testcontainers#3063) fix(mongodb): replica set initialization & connection handling (testcontainers#2984)

* main: (91 commits) chore(deps): bump github/codeql-action from 3.28.13 to 3.28.15 (testcontainers#3097) chore(deps): bump golang.org/x/crypto from 0.31.0 to 0.37.0 (testcontainers#3098) feat(aerospike): add Aerospike module (testcontainers#3094) security(compose): upgrade github.com/docker/compose/v2 to fix security vulnerability (testcontainers#3095) feat: add more functional options to the modules API (testcontainers#3070) chore(deps): bump golang.org/x/net in /modules/arangodb (testcontainers#3087) feat: add arangodb module (testcontainers#3083) chore(deps): bump actions/upload-artifact from 4.6.0 to 4.6.2 (testcontainers#3086) chore(deps): bump SonarSource/sonarqube-scan-action from 5.0.0 to 5.1.0 (testcontainers#3085) feat: add socat container (testcontainers#3071) fix(mssql): reduce flakiness in tests (testcontainers#3084) chore: bump golangci-lint to v2 (testcontainers#3082) chore(gcloud): deprecate old gcp containers, creating subpackages for them (testcontainers#3063) fix(mongodb): replica set initialization & connection handling (testcontainers#2984) chore(deps): bump docker/setup-docker-action from 4.2.0 to 4.3.0 (testcontainers#3077) chore(deps): bump github/codeql-action from 3.28.12 to 3.28.13 (testcontainers#3078) chore(deps): bump tj-actions/changed-files from 45.0.4 to 46.0.3 (testcontainers#3076) docs: add dependabot configuration (testcontainers#3074) chore(deps): replace `golang.org/x/exp/slices` with stdlib (testcontainers#3075) fix(dind): use docker image load (testcontainers#3073) ...

ttruongatl requested a review from a team as a code owner February 15, 2025 01:25

ttruongatl changed the title ~~[MongoDB] Improve Replica Set Initialization & Connection Handling~~ fix(replica): Mongodb Replica Set Initialization & Connection Handling Feb 15, 2025

ttruongatl changed the title ~~fix(replica): Mongodb Replica Set Initialization & Connection Handling~~ fix(replica): mongodb replica set initialization & connection handling Feb 15, 2025

stevenh requested changes Feb 15, 2025

View reviewed changes

ttruongatl requested a review from stevenh February 16, 2025 20:33

stevenh requested changes Feb 16, 2025

View reviewed changes

ttruongatl requested a review from stevenh February 17, 2025 02:29

mdelapenya reviewed Feb 17, 2025

View reviewed changes

ttruongatl requested a review from mdelapenya February 17, 2025 14:17

stevenh requested changes Feb 17, 2025

View reviewed changes

modules/mongodb/mongodb.go Show resolved Hide resolved

modules/mongodb/mongodb.go Outdated Show resolved Hide resolved

ttruongatl requested a review from stevenh February 17, 2025 16:36

ttruongatl and others added 18 commits February 17, 2025 14:34

[MongoDB] Improve Replica Set Initialization & Connection Handling

d29289a

Test helper function

605e859

Remove helper

2274323

Fix tests

7646ab0

Correct test

40fb27e

Address PR comments

9f81231

Fix bugs

9490718

Remove "failed" prefix

868260a

Apply suggestion.

209e8aa

Co-authored-by: Steven Hartland <[email protected]>

Apply suggestion

6fec976

Co-authored-by: Steven Hartland <[email protected]>

Remove duplicate comments

cc222bd

Co-authored-by: Steven Hartland <[email protected]>

address comments

69e3a25

Apply suggestion to remove hard code message

09610f3

Co-authored-by: Manuel de la Peña <[email protected]>

Apply coding style suggestion.

7618320

Co-authored-by: Manuel de la Peña <[email protected]>

Apply coding style suggestion

06754a9

Co-authored-by: Manuel de la Peña <[email protected]>

Apply coding style suggestion

3379725

Co-authored-by: Manuel de la Peña <[email protected]>

Apply suggestion

62d640d

Co-authored-by: Steven Hartland <[email protected]>

Apply suggestion

37cb2c5

Co-authored-by: Steven Hartland <[email protected]>

ttruongatl force-pushed the thanhtruong/improve-MongoDB-Replica-Set-Initialization-and-connection-handling branch from 7966110 to 37cb2c5 Compare February 17, 2025 19:34

stevenh previously approved these changes Feb 17, 2025

View reviewed changes

Fix lint

deb1fbd

ttruongatl dismissed stevenh’s stale review via deb1fbd February 17, 2025 22:39

ttruongatl requested a review from stevenh February 17, 2025 22:40

stevenh previously approved these changes Feb 18, 2025

View reviewed changes

mdelapenya reviewed Feb 25, 2025

View reviewed changes

modules/mongodb/mongodb.go Outdated Show resolved Hide resolved

Refactor MongoDB replica set initiation and remove unused localNonLoo…

6e93a1d

…pbackIP function

ttruongatl dismissed stevenh’s stale review via 6e93a1d March 29, 2025 12:10

Merge branch 'main' into thanhtruong/improve-MongoDB-Replica-Set-Init…

d85ad23

…ialization-and-connection-handling

mdelapenya reviewed Mar 31, 2025

View reviewed changes

modules/mongodb/mongodb.go Outdated Show resolved Hide resolved

refactor(mongodb): remove unused waitForMongoReady function

d4adb4d

mdelapenya changed the title ~~fix(replica): mongodb replica set initialization & connection handling~~ fix(mongodb): replica set initialization & connection handling Apr 2, 2025

mdelapenya approved these changes Apr 2, 2025

View reviewed changes

mdelapenya merged commit 675acc3 into testcontainers:main Apr 2, 2025
17 checks passed

mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Apr 2, 2025

Merge branch 'main' into bump-golangci-lint

db4a57b

* main: fix(mongodb): replica set initialization & connection handling (testcontainers#2984)

mdelapenya added the bug An issue with the library label Apr 3, 2025

Uh oh!

fix(mongodb): replica set initialization & connection handling #2984

fix(mongodb): replica set initialization & connection handling #2984

Uh oh!

Conversation

ttruongatl commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

How to test this PR:

Uh oh!

netlify bot commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for testcontainers-go ready!

Uh oh!

stevenh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevenh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdelapenya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevenh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stevenh left a comment

Choose a reason for hiding this comment

Uh oh!

stevenh commented Feb 17, 2025

Uh oh!

ttruongatl commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdelapenya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ttruongatl commented Feb 15, 2025 •

edited

Loading

netlify bot commented Feb 15, 2025 •

edited

Loading

ttruongatl commented Feb 17, 2025 •

edited

Loading