New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(cockroachdb): Fixes cockroachdb wait strategy handling #2456
Open
bearrito
wants to merge
7
commits into
testcontainers:main
Choose a base branch
from
bearrito:bug/withwaitstrategydeadline
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+108
−16
Open
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
85e5e70
Fixes cockroachdb wait strategy handling
4663d37
Clarify test intent
c12cb33
Merge in default strategy to get connection
d131370
Use subtests
9789f92
Separate out Connection logic
9b66353
Feedback from PR
5150d9d
Merge branch 'main' into bug/withwaitstrategydeadline
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -3,16 +3,19 @@ package cockroachdb_test | |||
import ( | ||||
"context" | ||||
"errors" | ||||
"fmt" | ||||
"net/url" | ||||
"strings" | ||||
"testing" | ||||
"time" | ||||
|
||||
"github.com/jackc/pgx/v5" | ||||
"github.com/stretchr/testify/require" | ||||
"github.com/stretchr/testify/suite" | ||||
|
||||
"github.com/testcontainers/testcontainers-go" | ||||
"github.com/testcontainers/testcontainers-go/modules/cockroachdb" | ||||
"github.com/testcontainers/testcontainers-go/wait" | ||||
) | ||||
|
||||
func TestCockroach_Insecure(t *testing.T) { | ||||
|
@@ -144,6 +147,95 @@ func (suite *AuthNSuite) TestQuery() { | |||
suite.Equal(523123, id) | ||||
} | ||||
|
||||
// TestWithWaitStrategyAndDeadline covers a previous regression, container creation needs to fail to cover that path. | ||||
func (suite *AuthNSuite) TestWithWaitStrategyAndDeadline() { | ||||
|
||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
contextDeadlineExceeded := fmt.Errorf("failed to start container: context deadline exceeded") | ||||
nodeStartUpCompleted := "node startup completed" | ||||
suite.Run("Expected Failure To Run", func() { | ||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto
Suggested change
|
||||
ctx := context.Background() | ||||
|
||||
// This will never match a log statement | ||||
suite.opts = append(suite.opts, testcontainers.WithWaitStrategyAndDeadline(time.Millisecond*250, wait.ForLog("Won't Exist In Logs"))) | ||||
container, err := cockroachdb.RunContainer(ctx, suite.opts...) | ||||
suite.Require().Error(err, contextDeadlineExceeded) | ||||
suite.T().Cleanup(func() { | ||||
if container != nil { | ||||
err := container.Terminate(ctx) | ||||
suite.Require().NoError(err) | ||||
} | ||||
}) | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||
}) | ||||
|
||||
suite.Run("Expected Failure To Run But Would Succeed ", func() { | ||||
|
||||
ctx := context.Background() | ||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
||||
// This will timeout as we didn't give enough time for intialization, but would have succeeded otherwise | ||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
suite.opts = append(suite.opts, testcontainers.WithWaitStrategyAndDeadline(time.Millisecond*20, wait.ForLog(nodeStartUpCompleted))) | ||||
container, err := cockroachdb.RunContainer(ctx, suite.opts...) | ||||
suite.Require().Error(err, contextDeadlineExceeded) | ||||
suite.T().Cleanup(func() { | ||||
if container != nil { | ||||
err := container.Terminate(ctx) | ||||
suite.Require().NoError(err) | ||||
} | ||||
}) | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||
}) | ||||
|
||||
suite.Run("Succeeds And Executes Commands", func() { | ||||
|
||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
ctx := context.Background() | ||||
|
||||
// This will succeed | ||||
suite.opts = append(suite.opts, testcontainers.WithWaitStrategyAndDeadline(time.Second*60, wait.ForLog(nodeStartUpCompleted))) | ||||
container, err := cockroachdb.RunContainer(ctx, suite.opts...) | ||||
suite.Require().NoError(err) | ||||
|
||||
conn, err := conn(ctx, container) | ||||
suite.Require().NoError(err) | ||||
defer conn.Close(ctx) | ||||
bearrito marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
||||
_, err = conn.Exec(ctx, "CREATE TABLE test (id INT PRIMARY KEY)") | ||||
suite.Require().NoError(err) | ||||
suite.T().Cleanup(func() { | ||||
if container != nil { | ||||
err := container.Terminate(ctx) | ||||
suite.Require().NoError(err) | ||||
} | ||||
}) | ||||
|
||||
}) | ||||
bearrito marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
||||
suite.Run("Succeeds And Executes Commands Waiting on HTTP Endpoint", func() { | ||||
|
||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
ctx := context.Background() | ||||
|
||||
// This will succeed | ||||
suite.opts = append(suite.opts, testcontainers.WithWaitStrategyAndDeadline(time.Second*60, wait.ForHTTP("/health").WithPort("8080/tcp"))) | ||||
container, err := cockroachdb.RunContainer(ctx, suite.opts...) | ||||
suite.Require().NoError(err) | ||||
|
||||
conn, err := conn(ctx, container) | ||||
suite.Require().NoError(err) | ||||
defer conn.Close(ctx) | ||||
|
||||
_, err = conn.Exec(ctx, "CREATE TABLE test (id INT PRIMARY KEY)") | ||||
suite.Require().NoError(err) | ||||
suite.T().Cleanup(func() { | ||||
if container != nil { | ||||
err := container.Terminate(ctx) | ||||
suite.Require().NoError(err) | ||||
} | ||||
}) | ||||
|
||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
}) | ||||
|
||||
mdelapenya marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
} | ||||
|
||||
func conn(ctx context.Context, container *cockroachdb.CockroachDBContainer) (*pgx.Conn, error) { | ||||
cfg, err := pgx.ParseConfig(container.MustConnectionString(ctx)) | ||||
if err != nil { | ||||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you suggesting we do this ?
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 ?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are not run in parallel, so FIFO
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's exactly my point: we lose here the original waitFor.HTTP, right? Is this intended?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's what I originally had, but removed it. I have no problem switching it back.
Two arguments for/against:
It almost seems like what would be better would something like
Where we could just add the deadline to the existing wait strategy (assuming it exists).
WDYT?