Files
tasks/tools/cassandra/version_tests.go
Vladyslav SimonenkoandGitHub cacba8f347 Log errors when doing version compatibility check for Cassandra and SQL (#8100)
## What changed?
Changes version compability checks to pass the real logger, so that the
error messages would be seeing in the log

## Why?

Before, the error was generic and there were no logs indicating the real
error (see https://github.com/temporalio/temporal/issues/7939):
```
sql schema version compatibility check failed: unable to read DB schema version keyspace/database: temporal error: no usable database connection found
```

With this change, the log would contain the actual error:
```
{"level":"error","ts":"2025-07-25T15:30:49.660-0700","msg":"sql handle: unable to refresh database connection pool","error":"pq: no pg_hba.conf entry for host \"127.0.0.1\", ...
```

The alternative solution would be to return the error, but the design of
common/persistence/sql/sqlplugin/db_handle.go suggests we hold the
abstraction boundaries, by returning generic errors and logging specific
errors.

## How did you test it?
- [X] built
- [X] run locally and tested manually
- [X] covered by existing tests
2025-07-28 11:47:14 -07:00

78 lines
2.3 KiB
Go

package cassandra
import (
"path"
"runtime"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/persistence/cassandra"
"go.temporal.io/server/common/primitives"
"go.temporal.io/server/common/resolver"
"go.temporal.io/server/temporal/environment"
)
type (
VersionTestSuite struct {
*require.Assertions // override suite.Suite.Assertions with require.Assertions; this means that s.NotNil(nil) will stop the test, not merely log an error
suite.Suite
}
)
func (s *VersionTestSuite) SetupTest() {
s.Assertions = require.New(s.T()) // Have to define our overridden assertions in the test setup. If we did it earlier, s.T() will return nil
}
func (s *VersionTestSuite) TestVerifyCompatibleVersion() {
keyspace := "temporal_ver_test_"
_, filename, _, ok := runtime.Caller(0)
s.True(ok)
root := path.Dir(path.Dir(path.Dir(filename)))
cqlFile := path.Join(root, "schema/cassandra/temporal/schema.cql")
defer s.createKeyspace(keyspace)()
s.Nil(RunTool([]string{
"./tool", "-k", keyspace, "-q", "setup-schema", "-f", cqlFile, "-version", "10.0", "-o",
}))
defaultCfg := config.Cassandra{
Hosts: environment.GetCassandraAddress(),
Port: environment.GetCassandraPort(),
User: "",
Password: "",
Keyspace: keyspace,
}
cfg := config.Persistence{
DefaultStore: "default",
DataStores: map[string]config.DataStore{
"default": {Cassandra: &defaultCfg},
},
TransactionSizeLimit: dynamicconfig.GetIntPropertyFn(primitives.DefaultTransactionSizeLimit),
}
s.NoError(cassandra.VerifyCompatibleVersion(cfg, resolver.NewNoopResolver(), log.NewNoopLogger()))
}
func (s *VersionTestSuite) createKeyspace(keyspace string) func() {
cfg := &CQLClientConfig{
Hosts: environment.GetCassandraAddress(),
Port: environment.GetCassandraPort(),
Keyspace: "system",
Timeout: defaultTimeout,
numReplicas: 1,
}
client, err := newCQLClient(cfg, log.NewNoopLogger())
s.NoError(err)
err = client.createKeyspace(keyspace)
if err != nil {
s.Fail("error creating keyspace, err=%v", err)
}
return func() {
s.NoError(client.dropKeyspace(keyspace))
client.Close()
}
}