go.uber.org/yarpc@v1.72.1/encoding/thrift/thriftrw-plugin-yarpc/exception_test.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package main
    22  
    23  import (
    24  	"testing"
    25  
    26  	"github.com/stretchr/testify/assert"
    27  	"github.com/stretchr/testify/require"
    28  	"go.uber.org/thriftrw/compile"
    29  	noservices "go.uber.org/yarpc/encoding/thrift/thriftrw-plugin-yarpc/internal/tests/NOSERVICES"
    30  	"go.uber.org/yarpc/yarpcerrors"
    31  )
    32  
    33  func TestGetYARPCErrorCode(t *testing.T) {
    34  	const exName = "MyException"
    35  
    36  	t.Run("success", func(t *testing.T) {
    37  		spec := &compile.StructSpec{
    38  			Name:        exName,
    39  			Annotations: map[string]string{_errorCodeAnnotationKey: "ABORTED"},
    40  		}
    41  		assert.NotPanics(t, func() {
    42  			want := "yarpcerrors.CodeAborted"
    43  			got := getYARPCErrorCode(spec)
    44  			assert.Equal(t, want, got)
    45  		}, "unexpected panic")
    46  	})
    47  
    48  	t.Run("panic fail", func(t *testing.T) {
    49  		spec := &compile.StructSpec{
    50  			Name:        exName,
    51  			Annotations: map[string]string{_errorCodeAnnotationKey: "foo"},
    52  		}
    53  		assert.PanicsWithValue(t,
    54  			"invalid rpc.code annotation for \"MyException\": \"foo\"\nAvailable codes: CANCELLED,UNKNOWN,INVALID_ARGUMENT,DEADLINE_EXCEEDED,NOT_FOUND,ALREADY_EXISTS,PERMISSION_DENIED,RESOURCE_EXHAUSTED,FAILED_PRECONDITION,ABORTED,OUT_OF_RANGE,UNIMPLEMENTED,INTERNAL,UNAVAILABLE,DATA_LOSS,UNAUTHENTICATED",
    55  			func() { getYARPCErrorCode(spec) },
    56  			"unexpected panic")
    57  	})
    58  }
    59  
    60  func TestGeneratedExceptionAnnotations(t *testing.T) {
    61  	// If we have complier errors within this test, it likely
    62  	// means that the generated types file is not being generated.
    63  
    64  	t.Run("exception without annotation", func(t *testing.T) {
    65  		ex := noservices.ExWithoutAnnotation{}
    66  		assert.Nil(t, ex.YARPCErrorCode(), "unexpected code")
    67  		assert.Equal(t, ex.YARPCErrorName(), "ExWithoutAnnotation")
    68  	})
    69  
    70  	t.Run("exception with annotation", func(t *testing.T) {
    71  		ex := noservices.ExWithAnnotation{}
    72  		require.NotNil(t, ex.YARPCErrorCode())
    73  		assert.Equal(t, yarpcerrors.CodeOutOfRange.String(), ex.YARPCErrorCode().String())
    74  		assert.Equal(t, ex.YARPCErrorName(), "ExWithAnnotation")
    75  	})
    76  }