telemetry/consumer/consumererror/error_test.go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package consumererror

import (
	"errors"
	"net/http"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

var errTest = errors.New("consumererror testing error")

func Test_NewOTLPHTTPError(t *testing.T) {
	httpStatus := 500
	wantErr := &Error{
		error:      errTest,
		httpStatus: httpStatus,
	}

	newErr := NewOTLPHTTPError(errTest, httpStatus)

	require.Equal(t, wantErr, newErr)
}

func Test_NewOTLPGRPCError(t *testing.T) {
	grpcStatus := status.New(codes.Aborted, "aborted")
	wantErr := &Error{
		error:       errTest,
		grpcStatus:  grpcStatus,
		isRetryable: true,
	}

	newErr := NewOTLPGRPCError(errTest, grpcStatus)

	require.Equal(t, wantErr, newErr)
}

func Test_NewRetryableError(t *testing.T) {
	wantErr := &Error{
		error:       errTest,
		isRetryable: true,
	}

	newErr := NewRetryableError(errTest)

	require.Equal(t, wantErr, newErr)
}

func Test_Error(t *testing.T) {
	newErr := Error{error: errTest}

	require.Equal(t, errTest.Error(), newErr.Error())
}

func TestUnwrap(t *testing.T) {
	grpcErr := status.New(codes.InvalidArgument, "not allowed")
	testCases := []struct {
		name     string
		err      *Error
		expected error
	}{
		{
			name: "Error object",
			err: &Error{
				error:      errTest,
				grpcStatus: grpcErr,
			},
			expected: errTest,
		},
		{
			name: "gRPC error",
			err: &Error{
				grpcStatus: grpcErr,
			},
			expected: grpcErr.Err(),
		},
		{
			name:     "zero value struct",
			err:      &Error{},
			expected: nil,
		},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			require.Equal(t, tt.expected, tt.err.Unwrap())
		})
	}
}

func TestAs(t *testing.T) {
	err := &Error{
		error: errTest,
	}

	secondError := errors.Join(errors.New("test"), err)

	var e *Error
	require.ErrorAs(t, secondError, &e)
	assert.Equal(t, errTest.Error(), e.Error())
}

func TestError_Error(t *testing.T) {
	testCases := []struct {
		name     string
		err      *Error
		expected string
	}{
		{
			name: "Error object",
			err: &Error{
				error:      errTest,
				grpcStatus: status.New(codes.InvalidArgument, "not allowed"),
				httpStatus: 400,
			},
			expected: errTest.Error(),
		},
		{
			name: "gRPC error",
			err: &Error{
				grpcStatus: status.New(codes.InvalidArgument, "not allowed"),
			},
			expected: "rpc error: code = InvalidArgument desc = not allowed",
		},
		{
			name: "HTTP error",
			err: &Error{
				httpStatus: 400,
			},
			expected: "network error: received HTTP status 400",
		},
		{
			name:     "zero value struct",
			err:      &Error{},
			expected: "uninitialized consumererror.Error",
		},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			require.Equal(t, tt.expected, tt.err.Error())
		})
	}
}

func TestError_Unwrap(t *testing.T) {
	err := &Error{
		error: errTest,
	}

	require.Equal(t, errTest, err.Unwrap())
}

func TestError_ToHTTPStatus(t *testing.T) {
	serverErr := http.StatusTooManyRequests
	testCases := []struct {
		name       string
		httpStatus int
		grpcStatus *status.Status
		retryable  bool
		want       int
		hasCode    bool
	}{
		{
			name:       "Passes through HTTP status",
			httpStatus: serverErr,
			want:       serverErr,
			hasCode:    true,
		},
		{
			name:       "Converts gRPC status",
			grpcStatus: status.New(codes.ResourceExhausted, errTest.Error()),
			want:       serverErr,
			hasCode:    true,
		},
		{
			name:       "Passes through HTTP status when gRPC status also present",
			httpStatus: serverErr,
			grpcStatus: status.New(codes.OK, errTest.Error()),
			want:       serverErr,
			hasCode:    true,
		},
		{
			name:       "Passes through HTTP status when retryable also present",
			httpStatus: serverErr,
			retryable:  true,
			want:       serverErr,
		},
		{
			name:      "No statuses set with retryable",
			retryable: true,
			want:      http.StatusServiceUnavailable,
		},
		{
			name: "No statuses set",
			want: http.StatusInternalServerError,
		},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			err := &Error{
				error:       errTest,
				httpStatus:  tt.httpStatus,
				grpcStatus:  tt.grpcStatus,
				isRetryable: tt.retryable,
			}

			s := ToHTTPStatus(err)

			require.Equal(t, tt.want, s)
		})
	}
}

func TestError_ToGRPCStatus(t *testing.T) {
	httpStatus := http.StatusTooManyRequests
	otherOTLPHTTPStatus := http.StatusOK
	serverErr := status.New(codes.ResourceExhausted, errTest.Error())
	testCases := []struct {
		name       string
		httpStatus int
		grpcStatus *status.Status
		retryable  bool
		want       *status.Status
		hasCode    bool
	}{
		{
			name:       "Converts HTTP status",
			httpStatus: httpStatus,
			want:       serverErr,
			hasCode:    true,
		},
		{
			name:       "Passes through gRPC status",
			grpcStatus: serverErr,
			want:       serverErr,
			hasCode:    true,
		},
		{
			name:       "Passes through gRPC status when HTTP status also present",
			httpStatus: otherOTLPHTTPStatus,
			grpcStatus: serverErr,
			want:       serverErr,
			hasCode:    true,
		},
		{
			name:       "Passes through gRPC status when retryable also present",
			grpcStatus: serverErr,
			retryable:  true,
			want:       serverErr,
		},
		{
			name:      "No statuses set with retryable",
			retryable: true,
			want:      status.New(codes.Unavailable, errTest.Error()),
		},
		{
			name: "No statuses set",
			want: status.New(codes.Unknown, errTest.Error()),
		},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			err := &Error{
				error:       errTest,
				httpStatus:  tt.httpStatus,
				grpcStatus:  tt.grpcStatus,
				isRetryable: tt.retryable,
			}

			s := ToGRPCStatus(err)

			require.Equal(t, tt.want, s)
		})
	}
}

func TestStatus_ToGRPCStatus(t *testing.T) {
	st := status.New(codes.ResourceExhausted, errTest.Error())
	require.Equal(t, st, ToGRPCStatus(st.Err()))
}

func TestError_Retryable(t *testing.T) {
	retryableCodes := []codes.Code{codes.Canceled, codes.DeadlineExceeded, codes.Aborted, codes.OutOfRange, codes.Unavailable, codes.DataLoss}
	retryableStatuses := []*status.Status{}

	for _, code := range retryableCodes {
		retryableStatuses = append(retryableStatuses, status.New(code, errTest.Error()))
	}

	nonretryableCodes := []codes.Code{codes.Unauthenticated, codes.Unknown, codes.NotFound, codes.InvalidArgument}
	nonretryableStatuses := []*status.Status{}

	for _, code := range nonretryableCodes {
		nonretryableStatuses = append(nonretryableStatuses, status.New(code, errTest.Error()))
	}

	testCases := []struct {
		name         string
		httpStatuses []int
		grpcStatuses []*status.Status
		want         bool
	}{
		{
			name:         "HTTP statuses: retryable",
			httpStatuses: []int{http.StatusTooManyRequests, http.StatusBadGateway, http.StatusServiceUnavailable, http.StatusGatewayTimeout},
			want:         true,
		},
		{
			name:         "HTTP statuses: non-retryable",
			httpStatuses: []int{0, http.StatusInternalServerError, http.StatusNotFound, http.StatusUnauthorized},
			want:         false,
		},
		{
			name:         "gRPC statuses: retryable",
			grpcStatuses: retryableStatuses,
			want:         true,
		},
		{
			name:         "gRPC statuses: non-retryable",
			grpcStatuses: nonretryableStatuses,
			want:         false,
		},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			for _, httpStatus := range tt.httpStatuses {
				err := NewOTLPHTTPError(errTest, httpStatus)
				var httpErr *Error
				if errors.As(err, &httpErr) {
					require.Equal(t, tt.want, httpErr.IsRetryable(), "Expected %d to be retryable=%t", httpStatus, tt.want)
				} else {
					require.Fail(t, "NewOTLPHTTPError didn't return an *Error")
				}
			}

			for _, grpcStatus := range tt.grpcStatuses {
				err := NewOTLPGRPCError(errTest, grpcStatus)
				var grpcErr *Error

				if errors.As(err, &grpcErr) {
					require.Equal(t, tt.want, grpcErr.IsRetryable(), "Expected %q to be retryable=%t", grpcStatus.Code().String(), tt.want)
				} else {
					require.Fail(t, "NewOTLPGRPCError didn't return an *Error")
				}
			}
		})
	}
}

func TestSuccessCodes(t *testing.T) {
	require.Panics(t, func() {
		_ = NewOTLPHTTPError(nil, 200)
	})
	require.Panics(t, func() {
		_ = NewOTLPHTTPError(nil, 299)
	})
	require.NotPanics(t, func() {
		require.Error(t, NewOTLPHTTPError(nil, 199))
	})
	require.NotPanics(t, func() {
		require.Error(t, NewOTLPHTTPError(nil, 300))
	})
	require.Panics(t, func() {
		_ = NewOTLPGRPCError(nil, status.New(codes.OK, ""))
	})
	require.NotPanics(t, func() {
		require.Error(t, NewOTLPGRPCError(nil, status.New(codes.AlreadyExists, "")))
	})
}