Improve Cassandra errors for schema check (uber#5038)

common/persistence/nosql/nosqlplugin/cassandra/tests/cassandra_tool_version_test.go

@@ -28,8 +28,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/uber/cadence/testflags"
-
 	log "github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
@@ -39,6 +37,7 @@ import (
 	"github.com/uber/cadence/common/dynamicconfig"
 	cassandra_db "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra"
 	"github.com/uber/cadence/environment"
+	"github.com/uber/cadence/testflags"
 	"github.com/uber/cadence/tools/cassandra"
 )
 
@@ -106,7 +105,7 @@ func (s *VersionTestSuite) TestCheckCompatibleVersion() {
 		{"2.0", "1.0", "version mismatch", false},
 		{"1.0", "1.0", "", false},
 		{"1.0", "2.0", "", false},
-		{"1.0", "abc", "unable to read schema version keyspace/database", false},
+		{"1.0", "abc", "reading schema version: unconfigured table schema_version", false},
 	}
 	for _, flag := range flags {
 		s.runCheckCompatibleVersion(flag.expectedVersion, flag.actualVersion, flag.errStr, flag.expectedFail)

tools/cassandra/cqlclient.go

@@ -21,7 +21,6 @@
 package cassandra
 
 import (
-	"errors"
 	"fmt"
 	"log"
 	"time"
@@ -54,8 +53,6 @@ type (
 	}
 )
 
-var errGetSchemaVersion = errors.New("failed to get current schema version from cassandra")
-
 const (
 	DefaultTimeout        = 30 // Timeout in seconds
 	DefaultConnectTimeout = 2  // Connect timeout in seconds
@@ -128,12 +125,12 @@ func (client *CqlClient) DropDatabase(name string) error {
 	return client.DropKeyspace(name)
 }
 
-// createKeyspace creates a cassandra Keyspace if it doesn't exist
+// CreateKeyspace creates a cassandra Keyspace if it doesn't exist
 func (client *CqlClient) CreateKeyspace(name string) error {
 	return client.ExecDDLQuery(fmt.Sprintf(createKeyspaceCQL, name, client.nReplicas))
 }
 
-// createNTSKeyspace creates a cassandra Keyspace if it doesn't exist using network topology strategy
+// CreateNTSKeyspace creates a cassandra Keyspace if it doesn't exist using network topology strategy
 func (client *CqlClient) CreateNTSKeyspace(name string, datacenter string) error {
 	return client.ExecDDLQuery(fmt.Sprintf(createNTSKeyspaceCQL, name, datacenter, client.nReplicas))
 }
@@ -161,16 +158,16 @@ func (client *CqlClient) ReadSchemaVersion() (string, error) {
 	iter := query.Iter()
 	var version string
 	if !iter.Scan(&version) {
-		iter.Close()
-		return "", errGetSchemaVersion
+		err := iter.Close()
+		return "", fmt.Errorf("reading schema version: %w", err)
 	}
 	if err := iter.Close(); err != nil {
 		return "", err
 	}
 	return version, nil
 }
 
-// UpdateShemaVersion updates the schema version for the Keyspace
+// UpdateSchemaVersion updates the schema version for the Keyspace
 func (client *CqlClient) UpdateSchemaVersion(newVersion string, minCompatibleVersion string) error {
 	query := client.session.Query(writeSchemaVersionCQL, client.cfg.Keyspace, time.Now(), newVersion, minCompatibleVersion)
 	return query.Exec()

tools/cassandra/handler.go

@@ -75,7 +75,7 @@ func verifyCompatibleVersion(
 	// However, this file will be refactor to support NoSQL soon. After the refactoring, cycle dependency issue
 	// should be gone and we can use constant at that time
 	if ds.NoSQL.PluginName != "cassandra" {
-		return fmt.Errorf("unknown NoSQL plugin name: %v", ds.NoSQL.PluginName)
+		return fmt.Errorf("unknown NoSQL plugin name: %q", ds.NoSQL.PluginName)
 	}
 
 	return CheckCompatibleVersion(*ds.NoSQL, expectedCassandraVersion)
@@ -100,7 +100,7 @@ func CheckCompatibleVersion(
 		ProtoVersion:          cfg.ProtoVersion,
 	})
 	if err != nil {
-		return fmt.Errorf("unable to create CQL Client: %v", err.Error())
+		return fmt.Errorf("creating CQL client: %w", err)
 	}
 	defer client.Close()
 

tools/common/schema/handler.go

@@ -35,7 +35,7 @@ func VerifyCompatibleVersion(
 
 	version, err := db.ReadSchemaVersion()
 	if err != nil {
-		return fmt.Errorf("unable to read schema version keyspace/database: %s error: %v", dbName, err.Error())
+		return fmt.Errorf("reading schema version keyspace/database: %q, error: %w", dbName, err)
 	}
 	// In most cases, the versions should match. However if after a schema upgrade there is a code
 	// rollback, the code version (expected version) would fall lower than the actual version in

tools/sql/clitest/versionTest.go

@@ -139,7 +139,7 @@ func (s *VersionTestSuite) TestCheckCompatibleVersion() {
 		{"2.0", "1.0", "version mismatch", false},
 		{"1.0", "1.0", "", false},
 		{"1.0", "2.0", "", false},
-		{"1.0", "abc", "unable to read schema version keyspace/database", false},
+		{"1.0", "abc", "schema_version' doesn't exist", false},
 	}
 	for _, flag := range flags {
 		s.runCheckCompatibleVersion(flag.expectedVersion, flag.actualVersion, flag.errStr, flag.expectedFail)