added exposed types for GlideClient

edlng · edlng · commit c1cccbb6e2c2 · 2025-01-20T12:52:07.000-08:00
diff --git a/go/api/base_client.go b/go/api/base_client.go
@@ -22,7 +22,7 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
-// BaseClient defines an interface for methods common to both [GlideClient] and [GlideClusterClient].
+// BaseClient defines an interface for methods common to both [IGlideClient] and [GlideClusterClient].
 type BaseClient interface {
 	StringCommands
 	HashCommands
diff --git a/go/api/glide_client.go b/go/api/glide_client.go
@@ -11,55 +11,55 @@ import (
 )
 
 // GlideClient interface compliance check.
-var _ GlideClient = (*glideClient)(nil)
+var _ IGlideClient = (*GlideClient)(nil)
 
-// GlideClient is a client used for connection in Standalone mode.
-type GlideClient interface {
+// IGlideClient is a client used for connection in Standalone mode.
+type IGlideClient interface {
 	BaseClient
 	GenericCommands
 	ServerManagementCommands
 }
 
-// glideClient implements standalone mode operations by extending baseClient functionality.
-type glideClient struct {
+// GlideClient implements standalone mode operations by extending baseClient functionality.
+type GlideClient struct {
 	*baseClient
 }
 
-// NewGlideClient creates a [GlideClient] in standalone mode using the given [GlideClientConfiguration].
-func NewGlideClient(config *GlideClientConfiguration) (GlideClient, error) {
+// NewGlideClient creates a [IGlideClient] in standalone mode using the given [GlideClientConfiguration].
+func NewGlideClient(config *GlideClientConfiguration) (IGlideClient, error) {
 	client, err := createClient(config)
 	if err != nil {
 		return nil, err
 	}
 
-	return &glideClient{client}, nil
+	return &GlideClient{client}, nil
 }
 
-func (client *glideClient) CustomCommand(args []string) (interface{}, error) {
+func (client *GlideClient) CustomCommand(args []string) (interface{}, error) {
 	res, err := client.executeCommand(C.CustomCommand, args)
 	if err != nil {
 		return nil, err
 	}
 	return handleInterfaceResponse(res)
 }
 
-func (client *glideClient) ConfigSet(parameters map[string]string) (string, error) {
+func (client *GlideClient) ConfigSet(parameters map[string]string) (string, error) {
 	result, err := client.executeCommand(C.ConfigSet, utils.MapToString(parameters))
 	if err != nil {
 		return "", err
 	}
 	return handleStringResponse(result)
 }
 
-func (client *glideClient) ConfigGet(args []string) (map[string]string, error) {
+func (client *GlideClient) ConfigGet(args []string) (map[string]string, error) {
 	res, err := client.executeCommand(C.ConfigGet, args)
 	if err != nil {
 		return nil, err
 	}
 	return handleStringToStringMapResponse(res)
 }
 
-func (client *glideClient) Select(index int64) (string, error) {
+func (client *GlideClient) Select(index int64) (string, error) {
 	result, err := client.executeCommand(C.Select, []string{utils.IntToString(index)})
 	if err != nil {
 		return "", err
diff --git a/go/integTest/glide_test_suite_test.go b/go/integTest/glide_test_suite_test.go
@@ -24,7 +24,7 @@ type GlideTestSuite struct {
 	clusterHosts    []api.NodeAddress
 	tls             bool
 	serverVersion   string
-	clients         []api.GlideClient
+	clients         []api.IGlideClient
 	clusterClients  []api.GlideClusterClient
 }
 
@@ -227,15 +227,15 @@ func (suite *GlideTestSuite) getDefaultClients() []api.BaseClient {
 	return []api.BaseClient{suite.defaultClient(), suite.defaultClusterClient()}
 }
 
-func (suite *GlideTestSuite) defaultClient() api.GlideClient {
+func (suite *GlideTestSuite) defaultClient() api.IGlideClient {
 	config := api.NewGlideClientConfiguration().
 		WithAddress(&suite.standaloneHosts[0]).
 		WithUseTLS(suite.tls).
 		WithRequestTimeout(5000)
 	return suite.client(config)
 }
 
-func (suite *GlideTestSuite) client(config *api.GlideClientConfiguration) api.GlideClient {
+func (suite *GlideTestSuite) client(config *api.GlideClientConfiguration) api.IGlideClient {
 	client, err := api.NewGlideClient(config)
 
 	assert.Nil(suite.T(), err)
diff --git a/go/integTest/shared_commands_test.go b/go/integTest/shared_commands_test.go
@@ -4098,7 +4098,7 @@ func sendWithCustomCommand(suite *GlideTestSuite, client api.BaseClient, args []
 	var res any
 	var err error
 	switch c := client.(type) {
-	case api.GlideClient:
+	case api.IGlideClient:
 		res, err = c.CustomCommand(args)
 	case api.GlideClusterClient:
 		res, err = c.CustomCommand(args)
@@ -4396,7 +4396,7 @@ func (suite *GlideTestSuite) TestXRead() {
 
 		// ensure that commands doesn't time out even if timeout > request timeout
 		var testClient api.BaseClient
-		if _, ok := client.(api.GlideClient); ok {
+		if _, ok := client.(api.IGlideClient); ok {
 			testClient = suite.client(api.NewGlideClientConfiguration().
 				WithAddress(&suite.standaloneHosts[0]).
 				WithUseTLS(suite.tls))
@@ -5412,7 +5412,7 @@ func (suite *GlideTestSuite) TestXPending() {
 		// each use of CustomCommand would make the tests difficult to read and maintain. These tests can be
 		// collapsed once the native commands are added in a subsequent release.
 
-		execStandalone := func(client api.GlideClient) {
+		execStandalone := func(client api.IGlideClient) {
 			// 1. Arrange the data
 			key := uuid.New().String()
 			groupName := "group" + uuid.New().String()
@@ -5568,7 +5568,7 @@ func (suite *GlideTestSuite) TestXPending() {
 		// this is only needed in order to be able to use custom commands.
 		// Once the native commands are added, this logic will be refactored.
 		switch c := client.(type) {
-		case api.GlideClient:
+		case api.IGlideClient:
 			execStandalone(c)
 		case api.GlideClusterClient:
 			execCluster(c)
@@ -5586,7 +5586,7 @@ func (suite *GlideTestSuite) TestXPendingFailures() {
 		// each use of CustomCommand would make the tests difficult to read and maintain. These tests can be
 		// collapsed once the native commands are added in a subsequent release.
 
-		execStandalone := func(client api.GlideClient) {
+		execStandalone := func(client api.IGlideClient) {
 			// 1. Arrange the data
 			key := uuid.New().String()
 			missingKey := uuid.New().String()
@@ -5892,7 +5892,7 @@ func (suite *GlideTestSuite) TestXPendingFailures() {
 		// this is only needed in order to be able to use custom commands.
 		// Once the native commands are added, this logic will be refactored.
 		switch c := client.(type) {
-		case api.GlideClient:
+		case api.IGlideClient:
 			execStandalone(c)
 		case api.GlideClusterClient:
 			execCluster(c)

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ import (`
`22`	`22`	`"google.golang.org/protobuf/proto"`
`23`	`23`	`)`
`24`	`24`
`25`		`-// BaseClient defines an interface for methods common to both [GlideClient] and [GlideClusterClient].`
	`25`	`+// BaseClient defines an interface for methods common to both [IGlideClient] and [GlideClusterClient].`
`26`	`26`	`type BaseClient interface {`
`27`	`27`	`StringCommands`
`28`	`28`	`HashCommands`
Original file line number	Diff line number	Diff line change
`@@ -11,55 +11,55 @@ import (`
`11`	`11`	`)`
`12`	`12`
`13`	`13`	`// GlideClient interface compliance check.`
`14`		`-var _ GlideClient = (*glideClient)(nil)`
	`14`	`+var _ IGlideClient = (*GlideClient)(nil)`
`15`	`15`
`16`		`-// GlideClient is a client used for connection in Standalone mode.`
`17`		`-type GlideClient interface {`
	`16`	`+// IGlideClient is a client used for connection in Standalone mode.`
	`17`	`+type IGlideClient interface {`
`18`	`18`	`BaseClient`
`19`	`19`	`GenericCommands`
`20`	`20`	`ServerManagementCommands`
`21`	`21`	`}`
`22`	`22`
`23`		`-// glideClient implements standalone mode operations by extending baseClient functionality.`
`24`		`-type glideClient struct {`
	`23`	`+// GlideClient implements standalone mode operations by extending baseClient functionality.`
	`24`	`+type GlideClient struct {`
`25`	`25`	`*baseClient`
`26`	`26`	`}`
`27`	`27`
`28`		`-// NewGlideClient creates a [GlideClient] in standalone mode using the given [GlideClientConfiguration].`
`29`		`-func NewGlideClient(config *GlideClientConfiguration) (GlideClient, error) {`
	`28`	`+// NewGlideClient creates a [IGlideClient] in standalone mode using the given [GlideClientConfiguration].`
	`29`	`+func NewGlideClient(config *GlideClientConfiguration) (IGlideClient, error) {`
`30`	`30`	`client, err := createClient(config)`
`31`	`31`	`if err != nil {`
`32`	`32`	`return nil, err`
`33`	`33`	`}`
`34`	`34`
`35`		`- return &glideClient{client}, nil`
	`35`	`+ return &GlideClient{client}, nil`
`36`	`36`	`}`
`37`	`37`
`38`		`-func (client *glideClient) CustomCommand(args []string) (interface{}, error) {`
	`38`	`+func (client *GlideClient) CustomCommand(args []string) (interface{}, error) {`
`39`	`39`	`res, err := client.executeCommand(C.CustomCommand, args)`
`40`	`40`	`if err != nil {`
`41`	`41`	`return nil, err`
`42`	`42`	`}`
`43`	`43`	`return handleInterfaceResponse(res)`
`44`	`44`	`}`
`45`	`45`
`46`		`-func (client *glideClient) ConfigSet(parameters map[string]string) (string, error) {`
	`46`	`+func (client *GlideClient) ConfigSet(parameters map[string]string) (string, error) {`
`47`	`47`	`result, err := client.executeCommand(C.ConfigSet, utils.MapToString(parameters))`
`48`	`48`	`if err != nil {`
`49`	`49`	`return "", err`
`50`	`50`	`}`
`51`	`51`	`return handleStringResponse(result)`
`52`	`52`	`}`
`53`	`53`
`54`		`-func (client *glideClient) ConfigGet(args []string) (map[string]string, error) {`
	`54`	`+func (client *GlideClient) ConfigGet(args []string) (map[string]string, error) {`
`55`	`55`	`res, err := client.executeCommand(C.ConfigGet, args)`
`56`	`56`	`if err != nil {`
`57`	`57`	`return nil, err`
`58`	`58`	`}`
`59`	`59`	`return handleStringToStringMapResponse(res)`
`60`	`60`	`}`
`61`	`61`
`62`		`-func (client *glideClient) Select(index int64) (string, error) {`
	`62`	`+func (client *GlideClient) Select(index int64) (string, error) {`
`63`	`63`	`result, err := client.executeCommand(C.Select, []string{utils.IntToString(index)})`
`64`	`64`	`if err != nil {`
`65`	`65`	`return "", err`