Merge pull request #780 from ydb-platform/credentials

Added String method to credentials types

Author: asmyasnikov

connection.go

@@ -465,8 +465,7 @@ func connect(ctx context.Context, c *Driver) error {
 		c.config = c.config.With(config.WithCredentials(
 			credentials.NewStaticCredentials(
 				c.userInfo.User, c.userInfo.Password,
-				c.config.Endpoint(),
-				c.config.GrpcDialOptions()...,
+				c.config,
 			),
 		))
 	}

credentials/credentials.go

@@ -6,6 +6,7 @@ import (
 	"google.golang.org/grpc"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/credentials"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
 )
 
 // Credentials is an interface of YDB credentials required for connect with YDB
@@ -29,33 +30,52 @@ func WithSourceInfo(sourceInfo string) option {
 
 // NewAccessTokenCredentials makes access token credentials object
 // Passed options redefines default values of credentials object internal fields
-func NewAccessTokenCredentials(accessToken string, opts ...option) Credentials {
+func NewAccessTokenCredentials(accessToken string, opts ...option) *credentials.AccessToken {
 	h := &optionsHolder{
-		sourceInfo: "credentials.NewAccessTokenCredentials(token)",
+		sourceInfo: stack.Record(1),
 	}
 	for _, o := range opts {
 		if o != nil {
 			o(h)
 		}
 	}
-	return credentials.NewAccessTokenCredentials(accessToken, h.sourceInfo)
+	return credentials.NewAccessTokenCredentials(accessToken, credentials.WithSourceInfo(h.sourceInfo))
 }
 
 // NewAnonymousCredentials makes anonymous credentials object
 // Passed options redefines default values of credentials object internal fields
-func NewAnonymousCredentials(opts ...option) Credentials {
+func NewAnonymousCredentials(opts ...option) *credentials.Anonymous {
 	h := &optionsHolder{
-		sourceInfo: "credentials.NewAnonymousCredentials()",
+		sourceInfo: stack.Record(1),
 	}
 	for _, o := range opts {
 		if o != nil {
 			o(h)
 		}
 	}
-	return credentials.NewAnonymousCredentials(h.sourceInfo)
+	return credentials.NewAnonymousCredentials(credentials.WithSourceInfo(h.sourceInfo))
+}
+
+type staticCredentialsConfig struct {
+	authEndpoint string
+	opts         []grpc.DialOption
+}
+
+func (s staticCredentialsConfig) Endpoint() string {
+	return s.authEndpoint
+}
+
+func (s staticCredentialsConfig) GrpcDialOptions() []grpc.DialOption {
+	return s.opts
 }
 
 // NewStaticCredentials makes static credentials object
-func NewStaticCredentials(user, password, authEndpoint string, opts ...grpc.DialOption) Credentials {
-	return credentials.NewStaticCredentials(user, password, authEndpoint, opts...)
+func NewStaticCredentials(user, password, authEndpoint string, opts ...grpc.DialOption) *credentials.Static {
+	return credentials.NewStaticCredentials(user, password,
+		staticCredentialsConfig{
+			authEndpoint: authEndpoint,
+			opts:         opts,
+		},
+		credentials.WithSourceInfo(stack.Record(1)),
+	)
 }

internal/credentials/access_token.go

@@ -2,23 +2,43 @@ package credentials
 
 import (
 	"context"
+	"fmt"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/secret"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
+)
+
+var (
+	_ Credentials  = (*AccessToken)(nil)
+	_ fmt.Stringer = (*AccessToken)(nil)
 )
 
-// accessTokenCredentials implements Credentials interface with static
+// AccessToken implements Credentials interface with static
 // authorization parameters.
-type accessTokenCredentials struct {
+type AccessToken struct {
 	token      string
 	sourceInfo string
 }
 
-func NewAccessTokenCredentials(token, sourceInfo string) Credentials {
-	return &accessTokenCredentials{
+func NewAccessTokenCredentials(token string, opts ...Option) *AccessToken {
+	options := optionsHolder{
+		sourceInfo: stack.Record(1),
+	}
+	for _, opt := range opts {
+		opt(&options)
+	}
+	return &AccessToken{
 		token:      token,
-		sourceInfo: sourceInfo,
+		sourceInfo: options.sourceInfo,
 	}
 }
 
 // Token implements Credentials.
-func (a accessTokenCredentials) Token(_ context.Context) (string, error) {
-	return a.token, nil
+func (c AccessToken) Token(_ context.Context) (string, error) {
+	return c.token, nil
+}
+
+// Token implements Credentials.
+func (c AccessToken) String() string {
+	return fmt.Sprintf("AccessToken(token:%q,from:%q)", secret.Token(c.token), c.sourceInfo)
 }

internal/credentials/anonymous.go

@@ -2,20 +2,39 @@ package credentials
 
 import (
 	"context"
+	"fmt"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
+)
+
+var (
+	_ Credentials  = (*Anonymous)(nil)
+	_ fmt.Stringer = (*Anonymous)(nil)
 )
 
-// anonymousCredentials implements Credentials interface with anonymousCredentials access
-type anonymousCredentials struct {
+// Anonymous implements Credentials interface with Anonymous access
+type Anonymous struct {
 	sourceInfo string
 }
 
-func NewAnonymousCredentials(sourceInfo string) Credentials {
-	return &anonymousCredentials{
-		sourceInfo: sourceInfo,
+func NewAnonymousCredentials(opts ...Option) *Anonymous {
+	options := optionsHolder{
+		sourceInfo: stack.Record(1),
+	}
+	for _, opt := range opts {
+		opt(&options)
+	}
+	return &Anonymous{
+		sourceInfo: options.sourceInfo,
 	}
 }
 
 // Token implements Credentials.
-func (a anonymousCredentials) Token(_ context.Context) (string, error) {
+func (c Anonymous) Token(_ context.Context) (string, error) {
 	return "", nil
 }
+
+// Token implements Credentials.
+func (c Anonymous) String() string {
+	return fmt.Sprintf("Anonymous(from:%q)", c.sourceInfo)
+}

internal/credentials/credentials.go

@@ -2,16 +2,8 @@ package credentials
 
 import (
 	"context"
-	"fmt"
-
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
 )
 
-// errNoCredentials may be returned by Credentials implementations to
-// make driver act as if there are no Credentials at all. That is, driver will
-// not send any token meta information during request.
-var errNoCredentials = xerrors.Wrap(fmt.Errorf("ydb: credentials: no credentials"))
-
 // Credentials is an interface of YDB credentials required for connect with YDB
 type Credentials interface {
 	// Token must return actual token or error

internal/credentials/credentials_test.go

@@ -0,0 +1,38 @@
+package credentials
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestCredentialsString(t *testing.T) {
+	for _, test := range []struct {
+		c Credentials
+		s string
+	}{
+		{
+			NewAnonymousCredentials(),
+			"Anonymous(from:\"github.com/ydb-platform/ydb-go-sdk/v3/internal/credentials.TestCredentialsString(credentials_test.go:16)\")", //nolint:lll
+		},
+		{
+			NewAnonymousCredentials(WithSourceInfo("test")),
+			"Anonymous(from:\"test\")",
+		},
+		{
+			NewAccessTokenCredentials("123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"),
+			"AccessToken(token:\"1234****WXYZ(CRC-32c: 81993EA5)\",from:\"github.com/ydb-platform/ydb-go-sdk/v3/internal/credentials.TestCredentialsString(credentials_test.go:24)\")", //nolint:lll
+		},
+		{
+			NewAccessTokenCredentials("123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ", WithSourceInfo("test")),
+			"AccessToken(token:\"1234****WXYZ(CRC-32c: 81993EA5)\",from:\"test\")",
+		},
+	} {
+		t.Run(test.s, func(t *testing.T) {
+			if stringer, ok := test.c.(fmt.Stringer); ok {
+				require.Equal(t, test.s, stringer.String())
+			}
+		})
+	}
+}

internal/credentials/multi.go

@@ -0,0 +1,13 @@
+package credentials
+
+type optionsHolder struct {
+	sourceInfo string
+}
+
+type Option func(opts *optionsHolder)
+
+func WithSourceInfo(sourceInfo string) Option {
+	return func(opts *optionsHolder) {
+		opts.sourceInfo = sourceInfo
+	}
+}

internal/credentials/options.go

@@ -13,31 +13,51 @@ import (
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Operations"
 	"google.golang.org/grpc"
 
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/secret"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
 )
 
-func NewStaticCredentials(user, password, authEndpoint string, opts ...grpc.DialOption) Credentials {
-	return &staticCredentials{
-		user:     user,
-		password: password,
-		endpoint: authEndpoint,
-		opts:     opts,
+type staticCredentialsConfig interface {
+	Endpoint() string
+	GrpcDialOptions() []grpc.DialOption
+}
+
+func NewStaticCredentials(user, password string, config staticCredentialsConfig, opts ...Option) *Static {
+	options := optionsHolder{
+		sourceInfo: stack.Record(1),
+	}
+	for _, opt := range opts {
+		opt(&options)
+	}
+	return &Static{
+		user:       user,
+		password:   password,
+		endpoint:   config.Endpoint(),
+		sourceInfo: options.sourceInfo,
+		opts:       config.GrpcDialOptions(),
 	}
 }
 
-// staticCredentials implements Credentials interface with static
+var (
+	_ Credentials  = (*Static)(nil)
+	_ fmt.Stringer = (*Static)(nil)
+)
+
+// Static implements Credentials interface with static
 // authorization parameters.
-type staticCredentials struct {
-	user      string
-	password  string
-	endpoint  string
-	opts      []grpc.DialOption
-	token     string
-	requestAt time.Time
-	mu        sync.Mutex
+type Static struct {
+	user       string
+	password   string
+	endpoint   string
+	opts       []grpc.DialOption
+	token      string
+	requestAt  time.Time
+	mu         sync.Mutex
+	sourceInfo string
 }
 
-func (c *staticCredentials) Token(ctx context.Context) (token string, err error) {
+func (c *Static) Token(ctx context.Context) (token string, err error) {
 	c.mu.Lock()
 	defer c.mu.Unlock()
 	if time.Until(c.requestAt) > 0 {
@@ -110,3 +130,13 @@ func parseExpiresAt(raw string) (expiresAt time.Time, err error) {
 	}
 	return claims.ExpiresAt.Time, nil
 }
+
+func (c *Static) String() string {
+	return fmt.Sprintf(
+		"Static(user:%q,password:%q,token:%q,from:%q)",
+		c.user,
+		secret.Password(c.password),
+		secret.Token(c.token),
+		c.sourceInfo,
+	)
+}