pubsublite/internal/wire/rpc_test.go

// Copyright 2020 Google LLC
//
// 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
//
//     https://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

package wire

import (
	"encoding/base64"
	"errors"
	"log"
	"testing"

	"cloud.google.com/go/internal/testutil"
	"google.golang.org/genproto/googleapis/rpc/errdetails"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/anypb"
	"google.golang.org/protobuf/types/known/structpb"

	spb "google.golang.org/genproto/googleapis/rpc/status"
)

func makeAny(msg proto.Message) *anypb.Any {
	any, err := anypb.New(msg)
	if err != nil {
		log.Fatalf("Failed to make Any: %v", err)
	}
	return any
}

func makeStreamResetSignal() error {
	statuspb := &spb.Status{
		Code: int32(codes.Aborted),
		Details: []*anypb.Any{makeAny(&errdetails.ErrorInfo{
			Reason: "RESET", Domain: "pubsublite.googleapis.com",
		})},
	}
	return status.ErrorProto(statuspb)
}

func TestIsStreamResetSignal(t *testing.T) {
	for _, tc := range []struct {
		desc string
		err  error
		want bool
	}{
		{
			desc: "reset signal",
			err:  makeStreamResetSignal(),
			want: true,
		},
		{
			desc: "non-retryable code",
			err: status.ErrorProto(&spb.Status{
				Code:    int32(codes.FailedPrecondition),
				Details: []*anypb.Any{makeAny(&errdetails.ErrorInfo{Reason: "RESET", Domain: "pubsublite.googleapis.com"})},
			}),
			want: false,
		},
		{
			desc: "wrong domain",
			err: status.ErrorProto(&spb.Status{
				Code:    int32(codes.Aborted),
				Details: []*anypb.Any{makeAny(&errdetails.ErrorInfo{Reason: "RESET"})},
			}),
			want: false,
		},
		{
			desc: "wrong reason",
			err: status.ErrorProto(&spb.Status{
				Code:    int32(codes.Aborted),
				Details: []*anypb.Any{makeAny(&errdetails.ErrorInfo{Domain: "pubsublite.googleapis.com"})},
			}),
			want: false,
		},
		{
			desc: "missing details",
			err:  status.ErrorProto(&spb.Status{Code: int32(codes.Aborted)}),
			want: false,
		},
		{
			desc: "nil error",
			err:  nil,
			want: false,
		},
		{
			desc: "generic error",
			err:  errors.New(""),
			want: false,
		},
	} {
		t.Run(tc.desc, func(t *testing.T) {
			if got := isStreamResetSignal(tc.err); got != tc.want {
				t.Errorf("isStreamResetSignal() got: %v, want %v", got, tc.want)
			}
		})
	}
}

func TestPubsubMetadataAddClientInfo(t *testing.T) {
	for _, tc := range []struct {
		desc           string
		framework      FrameworkType
		libraryVersion func() (version, bool)
		wantClientInfo *structpb.Struct
	}{
		{
			desc: "minimal",
			libraryVersion: func() (version, bool) {
				return version{}, false
			},
			wantClientInfo: &structpb.Struct{
				Fields: map[string]*structpb.Value{
					"language": stringValue("GOLANG"),
				},
			},
		},
		{
			desc:      "cps shim",
			framework: FrameworkCloudPubSubShim,
			libraryVersion: func() (version, bool) {
				return version{}, false
			},
			wantClientInfo: &structpb.Struct{
				Fields: map[string]*structpb.Value{
					"language":  stringValue("GOLANG"),
					"framework": stringValue("CLOUD_PUBSUB_SHIM"),
				},
			},
		},
		{
			desc:      "version valid",
			framework: FrameworkCloudPubSubShim,
			libraryVersion: func() (version, bool) {
				return version{Major: "1", Minor: "2"}, true
			},
			wantClientInfo: &structpb.Struct{
				Fields: map[string]*structpb.Value{
					"language":      stringValue("GOLANG"),
					"framework":     stringValue("CLOUD_PUBSUB_SHIM"),
					"major_version": stringValue("1"),
					"minor_version": stringValue("2"),
				},
			},
		},
	} {
		t.Run(tc.desc, func(t *testing.T) {
			metadata := newPubsubMetadata()
			metadata.doAddClientInfo(tc.framework, tc.libraryVersion)

			b, err := base64.StdEncoding.DecodeString(metadata["x-goog-pubsub-context"])
			if err != nil {
				t.Errorf("Failed to decode base64 pubsub context header: %v", err)
				return
			}
			gotClientInfo := new(structpb.Struct)
			if err := proto.Unmarshal(b, gotClientInfo); err != nil {
				t.Errorf("Failed to unmarshal pubsub context structpb: %v", err)
				return
			}
			if diff := testutil.Diff(gotClientInfo, tc.wantClientInfo); diff != "" {
				t.Errorf("Pubsub context structpb: got: -, want: +\n%s", diff)
			}
		})
	}
}