Skip to content
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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Jun 11, 2024
Merged

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

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
85e5e70
Fixes cockroachdb wait strategy handling
Mar 30, 2024
4663d37
Clarify test intent
Mar 30, 2024
c12cb33
Merge in default strategy to get connection
Mar 30, 2024
d131370
Use subtests
Mar 30, 2024
9789f92
Separate out Connection logic
Apr 2, 2024
9b66353
Feedback from PR
Apr 2, 2024
5150d9d
Merge branch 'main' into bug/withwaitstrategydeadline
Apr 13, 2024
2992689
Honor default settings
Jun 10, 2024
c1851a0
fix: make lint
mdelapenya Jun 11, 2024
0c35c64
Merge branch 'main' into bug/withwaitstrategydeadline
mdelapenya Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 23 additions & 16 deletions modules/cockroachdb/cockroachdb.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,25 +167,32 @@ func addWaitingFor(req *testcontainers.GenericContainerRequest, opts options) er
tlsConfig = cfg
}

req.WaitingFor = wait.ForAll(
sqlWait := wait.ForSQL(defaultSQLPort, "pgx/v5", func(host string, port nat.Port) string {
connStr := connString(opts, host, port)
if tlsConfig == nil {
return connStr
}

// register TLS config with pgx driver
connCfg, err := pgx.ParseConfig(connStr)
if err != nil {
panic(err)
}
connCfg.TLSConfig = tlsConfig

return stdlib.RegisterConnConfig(connCfg)
})
defaultStrategy := wait.ForAll(
wait.ForHTTP("/health").WithPort(defaultAdminPort),
wait.ForSQL(defaultSQLPort, "pgx/v5", func(host string, port nat.Port) string {
connStr := connString(opts, host, port)
if tlsConfig == nil {
return connStr
}

// register TLS config with pgx driver
connCfg, err := pgx.ParseConfig(connStr)
if err != nil {
panic(err)
}
connCfg.TLSConfig = tlsConfig

return stdlib.RegisterConnConfig(connCfg)
}),
sqlWait,
)

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

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?

Copy link
Contributor Author

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 ?



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.

Copy link
Contributor Author

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 ?

Copy link
Member

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

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:

  1. 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.
  2. 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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

}

return nil
}

Expand Down
85 changes: 85 additions & 0 deletions modules/cockroachdb/cockroachdb_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -144,6 +147,88 @@ 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() {
contextDeadlineExceeded := fmt.Errorf("failed to start container: context deadline exceeded")
nodeStartUpCompleted := "node startup completed"

mdelapenya marked this conversation as resolved.
Show resolved Hide resolved
suite.Run("Expected Failure To Run", func() {
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)
}
})

bearrito marked this conversation as resolved.
Show resolved Hide resolved
})

suite.Run("Expected Failure To Run But Would Succeed ", func() {
ctx := context.Background()

// 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)
}
})

bearrito marked this conversation as resolved.
Show resolved Hide resolved
})

suite.Run("Succeeds And Executes Commands", func() {
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)
}
})
})

suite.Run("Succeeds And Executes Commands Waiting on HTTP Endpoint", func() {
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)
}
})
})
}

func conn(ctx context.Context, container *cockroachdb.CockroachDBContainer) (*pgx.Conn, error) {
cfg, err := pgx.ParseConfig(container.MustConnectionString(ctx))
if err != nil {
Expand Down
Loading