fix(cockroachdb): Fixes cockroachdb wait strategy handling #2456

bearrito · 2024-03-30T15:29:00Z

What does this PR do?

Fixes wait strategy handling. Previously cockroachdb was overwriting wait strategies.

Why is it important?

Custom wait strategies were not being respected

Related issues

Closes [Bug]: CockroachDB module does not support overriding of wait strategy deadline #2453

How to test this PR

I added tests.
There looks to be some form of connection logic in the SQL strategy. This has to be merged into the user provided strategy otherwise you will timeout.

netlify · 2024-03-30T15:29:20Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`0c35c64`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/66680369e868c20008a78c9c
😎 Deploy Preview	https://deploy-preview-2456--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.

modules/cockroachdb/cockroachdb_test.go

modules/cockroachdb/cockroachdb.go

mdelapenya

LGTM thank you for taking the time to fix this!

@bearrito I added a few minor comments regarding consistency around blank lines as separation for different code blocks, so once they are addressed, this is ready to be merged.

🚀

modules/cockroachdb/cockroachdb_test.go

mdelapenya

LGTM, there are a few non-blocking cosmetic comments here, but I think the PR can be merged if everybody agree.

I'll wait for you @bearrito and @AhmedNSidd for the open discussions, so at the moment they are closed, I'll merge this one.

Thank you both for your patience and for contributing to testcontainers-go!

AhmedNSidd

Changes look good to me. Please feel free to merge this one in @mdelapenya

My pleasure re: contributing to testcontainers-go :)
Thank you for maintaining this library.

mdelapenya · 2024-04-04T13:12:00Z

modules/cockroachdb/cockroachdb.go

+	if req.WaitingFor == nil {
+		req.WaitingFor = defaultStrategy
+	} else {
+		req.WaitingFor = wait.ForAll(req.WaitingFor, sqlWait)


Do we want to exclude the wait.ForHTTP here? IIUC, if there is a waitingFor, we are adding the SQL wait plus the defined one. If there is no waitingFor, we are adding the default wait (http + sql). Is it intended to remove the http one in the case the user provides a waitingFor? I think we should append the user-defined one to the default. Wdyt?

Are you suggesting we do this ?

defaultStrategy := wait.ForSQL( ... elided ...) if req.WaitingFor == nil { req.WaitingFor = wait.ForAll(wait.ForHTTP("/health").WithPort(defaultAdminPort),defaultStrategy) } else { req.WaitingFor = wait.ForAll(req.WaitingFor, defaultStrategy) }

I think you end up with the same thing.

Case 1: No Waiting for defined -> You get HTTP and SQL Waits
Case 2: A Wait is defined -> You get whatever the user passes in and SQL.

If that approach reads better I'm good with it.

Also, I can look in the source, but I might as well ask is wait.ForAll linear-ish eg if is FIFO or LIFO or in parallel ?

They are not run in parallel, so FIFO

Case 2: A Wait is defined -> You get whatever the user passes in and SQL.

That's exactly my point: we lose here the original waitFor.HTTP, right? Is this intended?

That's what I originally had, but removed it. I have no problem switching it back.

Two arguments for/against:

If as a user I pass in a wait strategy I would expect that wait strategy to be exclusively used. However, the SQL is different as it has to be awaited for connection functionality.

Alternatively, we should always wait with predetermined strategies until we have a usable container to provide the user. But then why allow the user to override at all?

It almost seems like what would be better would something like

testcontainers.WithDeadline(time.Millisecond*20))

Where we could just add the deadline to the existing wait strategy (assuming it exists).

WDYT?

Hey @bearrito sorry for the radio silence, May was a month in which I combined PTO and full-focus on an eventual v1 release of testcontainers-go. My apologies.

The wait.ForAll strategy comes with a deadline to be applied to all its children, so you could leverage that.

bearrito · 2024-04-13T15:51:49Z

@mdelapenya Is this good to go, the last failing test were unrelated

bearrito · 2024-05-23T13:19:59Z

@mdelapenya Anything else on this?

bearrito · 2024-06-10T18:41:59Z

@mdelapenya I reverted to always honor the default strategy. I don't think can do much more with cockroach, namely because how it's doing it's own thing with the addWaitingFor and addingEnvs

* main: (48 commits) Fix race condition when looking up reaper (ryuk) container (testcontainers#2508) chore: bring golangci-lint back (testcontainers#2571) docs(compose): Fix typo docker compose docs (testcontainers#2565) Handle error properly during port forwarding initialization. (testcontainers#2550) chore: pin vearch version (testcontainers#2568) feat: add vearch module (testcontainers#2560) chore: run tests against latest Docker engine, nightly (testcontainers#2566) chore(deps): bump mkdocs-include-markdown-plugin from 6.0.4 to 6.0.7 (testcontainers#2562) Fix network accessor for port-forwarding feature (testcontainers#2551) --- (testcontainers#2549) fix: update search bar eval in mkdocs (testcontainers#2547) docs: improve contributing docs for code snippets (testcontainers#2546) chore: use a virtualenv for working with the docs site (testcontainers#2545) docs: document test session semantics (testcontainers#2544) feat(ryuk): allow to configure ryuk timeouts using env variables (testcontainers#2541) docs: fix CircleCI docs (testcontainers#2539) fix: add import to module generation (testcontainers#2537) chore: prepare for next minor development cycle (0.32.0) chore: use new version (v0.31.0) in modules and examples feat(mongodb): add replica set support via opts (testcontainers#2469) ...

mdelapenya

LGTM, thanks!

* Fixes cockroachdb wait strategy handling * Clarify test intent * Merge in default strategy to get connection * Use subtests * Separate out Connection logic * Feedback from PR * Honor default settings * fix: make lint --------- Co-authored-by: bstrausser <bstrausser@locusrobotics.com> Co-authored-by: Manuel de la Peña <mdelapenya@gmail.com>

* main: docs: document disabling ryuk with properties (testcontainers#2603) fix: allow compose files and readers to be used together (testcontainers#2598) chore(deps): bump urllib3 from 2.2.1 to 2.2.2 (testcontainers#2590) docs: example for NATS cluster (testcontainers#2591) docs: fix deprecation for material extensions emoji (testcontainers#2592) gha: update golangci-lint to v1.59.1 (testcontainers#2588) network: WithCheckDuplicate: don't set CheckDuplicate value (testcontainers#2589) fix: proper synchronisation for start/stop log production (testcontainers#2576) chore(deps): bump github.com/docker/docker from v25.0.5 to v26.1.4 (testcontainers#2584) docs: update contributing guide (testcontainers#2586) feat: add testcontainers labels to the built images (testcontainers#2579) feat(mongodb): Make the replica set name configurable (testcontainers#2538) chore: skip reaper tests if ryuk is disabled (testcontainers#2582) chore: increase check time to 60 secs instead of 20 (testcontainers#2581) fix: prepend substitutors for built images (testcontainers#2577) docs: update colima docs (testcontainers#2578) fix(cockroachdb): Fixes cockroachdb wait strategy handling (testcontainers#2456) Fix race condition when looking up reaper (ryuk) container (testcontainers#2508) chore: bring golangci-lint back (testcontainers#2571) docs(compose): Fix typo docker compose docs (testcontainers#2565)

Fixes cockroachdb wait strategy handling

85e5e70

bearrito requested a review from a team as a code owner March 30, 2024 15:29

bstrausser added 3 commits March 30, 2024 11:30

Clarify test intent

4663d37

Merge in default strategy to get connection

c12cb33

Use subtests

d131370

AhmedNSidd reviewed Apr 2, 2024

View reviewed changes

modules/cockroachdb/cockroachdb_test.go Show resolved Hide resolved

modules/cockroachdb/cockroachdb_test.go Outdated Show resolved Hide resolved

modules/cockroachdb/cockroachdb.go Show resolved Hide resolved

Separate out Connection logic

9789f92

mdelapenya previously approved these changes Apr 2, 2024

View reviewed changes

Feedback from PR

9b66353

bearrito dismissed mdelapenya’s stale review via 9b66353 April 2, 2024 15:47

mdelapenya previously approved these changes Apr 3, 2024

View reviewed changes

AhmedNSidd approved these changes Apr 3, 2024

View reviewed changes

mdelapenya reviewed Apr 4, 2024

View reviewed changes

Merge branch 'main' into bug/withwaitstrategydeadline

5150d9d

Honor default settings

2992689

bearrito dismissed mdelapenya’s stale review via 2992689 June 10, 2024 18:28

mdelapenya added 2 commits June 11, 2024 09:57

fix: make lint

c1851a0

mdelapenya approved these changes Jun 11, 2024

View reviewed changes

mdelapenya self-assigned this Jun 11, 2024

mdelapenya added the bug An issue with the library label Jun 11, 2024

mdelapenya merged commit d483772 into testcontainers:main Jun 11, 2024
106 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(cockroachdb): Fixes cockroachdb wait strategy handling #2456

fix(cockroachdb): Fixes cockroachdb wait strategy handling #2456

bearrito commented Mar 30, 2024 •

edited

Loading

netlify bot commented Mar 30, 2024 •

edited

Loading

mdelapenya left a comment

mdelapenya left a comment

AhmedNSidd left a comment

mdelapenya Apr 4, 2024

bearrito Apr 4, 2024

bearrito Apr 4, 2024

mdelapenya Apr 10, 2024

mdelapenya Apr 10, 2024

bearrito Apr 10, 2024

mdelapenya Jun 10, 2024

bearrito commented Apr 13, 2024

bearrito commented May 23, 2024

bearrito commented Jun 10, 2024

mdelapenya left a comment

fix(cockroachdb): Fixes cockroachdb wait strategy handling #2456

fix(cockroachdb): Fixes cockroachdb wait strategy handling #2456

Conversation

bearrito commented Mar 30, 2024 • edited Loading

What does this PR do?

Why is it important?

Related issues

How to test this PR

netlify bot commented Mar 30, 2024 • edited Loading

✅ Deploy Preview for testcontainers-go ready!

mdelapenya left a comment

Choose a reason for hiding this comment

mdelapenya left a comment

Choose a reason for hiding this comment

AhmedNSidd left a comment

Choose a reason for hiding this comment

mdelapenya Apr 4, 2024

Choose a reason for hiding this comment

bearrito Apr 4, 2024

Choose a reason for hiding this comment

bearrito Apr 4, 2024

Choose a reason for hiding this comment

mdelapenya Apr 10, 2024

Choose a reason for hiding this comment

mdelapenya Apr 10, 2024

Choose a reason for hiding this comment

bearrito Apr 10, 2024

Choose a reason for hiding this comment

mdelapenya Jun 10, 2024

Choose a reason for hiding this comment

bearrito commented Apr 13, 2024

bearrito commented May 23, 2024

bearrito commented Jun 10, 2024

mdelapenya left a comment

Choose a reason for hiding this comment

bearrito commented Mar 30, 2024 •

edited

Loading

netlify bot commented Mar 30, 2024 •

edited

Loading