etcd/client/v3/retry_interceptor_test.go

// Copyright 2022 The etcd Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package clientv3

import (
	"testing"

	grpccredentials "google.golang.org/grpc/credentials"

	"go.etcd.io/etcd/api/v3/v3rpc/rpctypes"
	"go.etcd.io/etcd/client/v3/credentials"
)

type dummyAuthTokenBundle struct{}

func (d dummyAuthTokenBundle) TransportCredentials() grpccredentials.TransportCredentials {
	return nil
}

func (d dummyAuthTokenBundle) PerRPCCredentials() grpccredentials.PerRPCCredentials {
	return nil
}

func (d dummyAuthTokenBundle) NewWithMode(mode string) (grpccredentials.Bundle, error) {
	return nil, nil
}

func (d dummyAuthTokenBundle) UpdateAuthToken(token string) {
}

func TestClientShouldRefreshToken(t *testing.T) {
	type fields struct {
		authTokenBundle credentials.Bundle
	}
	type args struct {
		err      error
		callOpts *options
	}

	optsWithTrue := &options{
		retryAuth: true,
	}
	optsWithFalse := &options{
		retryAuth: false,
	}

	tests := []struct {
		name   string
		fields fields
		args   args
		want   bool
	}{
		{
			name: "ErrUserEmpty and non nil authTokenBundle",
			fields: fields{
				authTokenBundle: &dummyAuthTokenBundle{},
			},
			args: args{rpctypes.ErrGRPCUserEmpty, optsWithTrue},
			want: true,
		},
		{
			name: "ErrUserEmpty and nil authTokenBundle",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCUserEmpty, optsWithTrue},
			want: false,
		},
		{
			name: "ErrGRPCInvalidAuthToken and retryAuth",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCInvalidAuthToken, optsWithTrue},
			want: true,
		},
		{
			name: "ErrGRPCInvalidAuthToken and !retryAuth",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCInvalidAuthToken, optsWithFalse},
			want: false,
		},
		{
			name: "ErrGRPCAuthOldRevision and retryAuth",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCAuthOldRevision, optsWithTrue},
			want: true,
		},
		{
			name: "ErrGRPCAuthOldRevision and !retryAuth",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCAuthOldRevision, optsWithFalse},
			want: false,
		},
		{
			name: "Other error and retryAuth",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCAuthFailed, optsWithTrue},
			want: false,
		},
		{
			name: "Other error and !retryAuth",
			fields: fields{
				authTokenBundle: nil,
			},
			args: args{rpctypes.ErrGRPCAuthFailed, optsWithFalse},
			want: false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			c := &Client{
				authTokenBundle: tt.fields.authTokenBundle,
			}
			if got := c.shouldRefreshToken(tt.args.err, tt.args.callOpts); got != tt.want {
				t.Errorf("shouldRefreshToken() = %v, want %v", got, tt.want)
			}
		})
	}
}