feat(cassandra): add ssl option cassandra #3151
There are no files selected for viewing
This file contains hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,10 +2,12 @@ package cassandra | |||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "crypto/tls" | ||||||
| "fmt" | ||||||
| "io" | ||||||
| "path/filepath" | ||||||
| "strings" | ||||||
| "time" | ||||||
|
|
||||||
| "github.com/docker/go-connections/nat" | ||||||
|
|
||||||
|
|
@@ -14,28 +16,35 @@ import ( | |||||
| ) | ||||||
|
|
||||||
| const ( | ||||||
| port = nat.Port("9042/tcp") | ||||||
| securePort = nat.Port("9142/tcp") // Common port for SSL/TLS connections | ||||||
| ) | ||||||
|
|
||||||
| // CassandraContainer represents the Cassandra container type used in the module | ||||||
| type CassandraContainer struct { | ||||||
| testcontainers.Container | ||||||
| settings Options | ||||||
| } | ||||||
|
|
||||||
| // ConnectionHost returns the host and port of the cassandra container, using the default, native port, | ||||||
| // obtaining the host and exposed port from the container | ||||||
| func (c *CassandraContainer) ConnectionHost(ctx context.Context) (string, error) { | ||||||
| host, err := c.Host(ctx) | ||||||
| if err != nil { | ||||||
| return "", err | ||||||
| } | ||||||
|
|
||||||
| // Use the secure port if TLS is enabled | ||||||
| portToUse := port | ||||||
| if c.settings.tlsConfig != nil { | ||||||
| portToUse = securePort | ||||||
| } | ||||||
|
|
||||||
| mappedPort, err := c.MappedPort(ctx, portToUse) | ||||||
| if err != nil { | ||||||
| return "", err | ||||||
| } | ||||||
| return host + ":" + mappedPort.Port(), nil | ||||||
| } | ||||||
|
|
||||||
| // WithConfigFile sets the YAML config file to be used for the cassandra container | ||||||
|
|
@@ -49,7 +58,6 @@ func WithConfigFile(configFile string) testcontainers.CustomizeRequestOption { | |||||
| FileMode: 0o755, | ||||||
| } | ||||||
| req.Files = append(req.Files, cf) | ||||||
| return nil | ||||||
| } | ||||||
| } | ||||||
|
|
@@ -66,10 +74,8 @@ func WithInitScripts(scripts ...string) testcontainers.CustomizeRequestOption { | |||||
| FileMode: 0o755, | ||||||
| } | ||||||
| initScripts = append(initScripts, cf) | ||||||
| execs = append(execs, initScript{File: cf.ContainerFilePath}) | ||||||
| } | ||||||
| req.Files = append(req.Files, initScripts...) | ||||||
| return testcontainers.WithAfterReadyCommand(execs...)(req) | ||||||
| } | ||||||
|
|
@@ -84,8 +90,7 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize | |||||
| // Run creates an instance of the Cassandra container type | ||||||
| func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*CassandraContainer, error) { | ||||||
| req := testcontainers.ContainerRequest{ | ||||||
| Image: img, | ||||||
| Env: map[string]string{ | ||||||
| "CASSANDRA_SNITCH": "GossipingPropertyFileSnitch", | ||||||
| "JVM_OPTS": "-Dcassandra.skip_wait_for_gossip_to_settle=0 -Dcassandra.initial_token=0", | ||||||
|
|
@@ -94,30 +99,44 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom | |||||
| "CASSANDRA_ENDPOINT_SNITCH": "GossipingPropertyFileSnitch", | ||||||
| "CASSANDRA_DC": "datacenter1", | ||||||
| }, | ||||||
| ExposedPorts: []string{string(port)}, | ||||||
| } | ||||||
|
|
||||||
| genericContainerReq := testcontainers.GenericContainerRequest{ | ||||||
| ContainerRequest: req, | ||||||
| Started: true, | ||||||
| } | ||||||
|
|
||||||
| var settings Options | ||||||
|
There was a problem hiding this comment. bug: settings is never set, you still need to check if you have an Option in the for loop and process it to ensure it set correctly. If your tests are passing they shouldn't so might need a fix there too. |
||||||
| for _, opt := range opts { | ||||||
| if err := opt.Customize(&genericContainerReq); err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // Set up wait strategies | ||||||
| waitStrategies := []wait.Strategy{ | ||||||
| wait.ForListeningPort(port), | ||||||
| wait.ForExec([]string{"cqlsh", "-e", "SELECT bootstrapped FROM system.local"}).WithResponseMatcher(func(body io.Reader) bool { | ||||||
| data, _ := io.ReadAll(body) | ||||||
| return strings.Contains(string(data), "COMPLETED") | ||||||
| }).WithStartupTimeout(1 * time.Minute), | ||||||
| } | ||||||
|
Comment on lines
+118
to
+124
There was a problem hiding this comment. @mdelapenya looks like we have an issue with WithWaitStrategy, it sets vs appending to WaitFor preventing easy initialisation here. There was a problem hiding this comment. Indeed. I think the use case here would be appending. I can submit a fix now |
||||||
|
|
||||||
| // Add TLS wait strategy if TLS config exists | ||||||
| if settings.tlsConfig != nil { | ||||||
| waitStrategies = append(waitStrategies, wait.ForListeningPort(securePort).WithStartupTimeout(1*time.Minute)) | ||||||
| } | ||||||
|
|
||||||
| // Apply wait strategy using the correct method | ||||||
| if err := testcontainers.WithWaitStrategy(wait.ForAll(waitStrategies...)).Customize(&genericContainerReq); err != nil { | ||||||
| return nil, err | ||||||
|
There was a problem hiding this comment. suggestion: wrap the error here
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| container, err := testcontainers.GenericContainer(ctx, genericContainerReq) | ||||||
| var c *CassandraContainer | ||||||
| if container != nil { | ||||||
| c = &CassandraContainer{Container: container, settings: settings} | ||||||
| } | ||||||
|
|
||||||
| if err != nil { | ||||||
|
|
@@ -126,3 +145,11 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom | |||||
|
|
||||||
| return c, nil | ||||||
| } | ||||||
|
|
||||||
| // TLSConfig returns the TLS configuration for the Cassandra container, nil if TLS is not enabled. | ||||||
| func (c *CassandraContainer) TLSConfig() *tls.Config { | ||||||
|
Comment on lines
+149
to
+150
There was a problem hiding this comment. @mdelapenya quite a common pattern in modules, we should consider returning an error instead. There was a problem hiding this comment. You mean the pointer to the config and the error, right? I think we changed the tlscert library precisely for that, so good to me to change it There was a problem hiding this comment. Nope, these container methods, have them return an error if the config is nil vs just returning nil as the caller should know if they enabled TLS or not. func (c *CassandraContainer) TLSConfig() (*tls.Config, error) {
if c.settings.tlsConfig == nil {
return nil, errors.New("tls not enabled")
}
return c.settings.tlsConfig.Config, nil
}There was a problem hiding this comment. Oh I see, the recently added methods for Redis and Valkey. For Valkey, we are in the same release cycle, we can change it without BC, for Redis, it's a BC |
||||||
| if c.settings.tlsConfig == nil { | ||||||
| return nil | ||||||
| } | ||||||
| return c.settings.tlsConfig.Config | ||||||
| } | ||||||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
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.
question: do we need to two ports or can it just be one which is either SSL or not?