|
| 1 | +package service_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "errors" |
| 5 | + "fmt" |
| 6 | + "testing" |
| 7 | + |
| 8 | + "stellarbill-backend/internal/errcode" |
| 9 | + "stellarbill-backend/internal/middleware" |
| 10 | + "stellarbill-backend/internal/pagination" |
| 11 | + "stellarbill-backend/internal/service" |
| 12 | +) |
| 13 | + |
| 14 | +// registeredSentinelErrors is the canonical list of every service-layer |
| 15 | +// sentinel error that surfaces to API clients. Every entry must have a |
| 16 | +// corresponding errcode.Register call in its package's init() function. |
| 17 | +// |
| 18 | +// ADDING A NEW ERROR WITHOUT ADDING IT HERE AND REGISTERING IT WILL FAIL CI. |
| 19 | +// |
| 20 | +// To add a new error code: |
| 21 | +// 1. Define the var ErrXxx = errors.New(...) in the appropriate package. |
| 22 | +// 2. Add errcode.Register(...) in that package's init(). |
| 23 | +// 3. Add the code constant to internal/errcode/registry.go. |
| 24 | +// 4. Add the sentinel to the list below. |
| 25 | +// 5. Document the new code in docs/error-codes.md. |
| 26 | +var registeredSentinelErrors = []struct { |
| 27 | + name string |
| 28 | + err error |
| 29 | + code errcode.Code |
| 30 | +}{ |
| 31 | + // service/errors.go |
| 32 | + {"ErrNotFound", service.ErrNotFound, errcode.CodeNotFound}, |
| 33 | + {"ErrDeleted", service.ErrDeleted, errcode.CodeSubscriptionDeleted}, |
| 34 | + {"ErrForbidden", service.ErrForbidden, errcode.CodeForbidden}, |
| 35 | + {"ErrBillingParse", service.ErrBillingParse, errcode.CodeSubscriptionBillingParse}, |
| 36 | + {"ErrExportInProgress", service.ErrExportInProgress, errcode.CodeExportInProgress}, |
| 37 | + {"ErrInvalidTransition", service.ErrInvalidTransition, errcode.CodeSubscriptionInvalidTransition}, |
| 38 | + {"ErrUnknownCurrentState", service.ErrUnknownCurrentState, errcode.CodeSubscriptionUnknownState}, |
| 39 | + {"ErrInvalidStatus", service.ErrInvalidStatus, errcode.CodeSubscriptionInvalidStatus}, |
| 40 | + |
| 41 | + // service/fees_service.go |
| 42 | + {"ErrInvalidAmount", service.ErrInvalidAmount, errcode.CodeFeeInvalidAmount}, |
| 43 | + {"ErrInvalidTaxRate", service.ErrInvalidTaxRate, errcode.CodeFeeInvalidTaxRate}, |
| 44 | + {"ErrInvalidParts", service.ErrInvalidParts, errcode.CodeFeeInvalidParts}, |
| 45 | + |
| 46 | + // service/swap_service.go |
| 47 | + {"ErrInsufficientLiquidity", service.ErrInsufficientLiquidity, errcode.CodeSwapInsufficientLiquidity}, |
| 48 | + |
| 49 | + // pagination/limit.go |
| 50 | + {"ErrInvalidLimit", pagination.ErrInvalidLimit, errcode.CodeInvalidLimit}, |
| 51 | + |
| 52 | + // middleware/idempotency_store.go |
| 53 | + {"ErrRequestMismatch", middleware.ErrRequestMismatch, errcode.CodeIdempotencyRequestMismatch}, |
| 54 | +} |
| 55 | + |
| 56 | +// TestEverySentinelErrorIsRegistered ensures that every service-level |
| 57 | +// sentinel error added to registeredSentinelErrors has a matching entry in |
| 58 | +// the errcode registry. This test must be updated whenever a new sentinel |
| 59 | +// error is introduced — CI will fail otherwise. |
| 60 | +func TestEverySentinelErrorIsRegistered(t *testing.T) { |
| 61 | + for _, entry := range registeredSentinelErrors { |
| 62 | + t.Run(entry.name, func(t *testing.T) { |
| 63 | + code, found := errcode.MustLookup(entry.err) |
| 64 | + if !found { |
| 65 | + t.Errorf("sentinel error %q (%v) is NOT registered in errcode — "+ |
| 66 | + "add errcode.Register(...) in the package's init() and update registeredSentinelErrors", |
| 67 | + entry.name, entry.err) |
| 68 | + return |
| 69 | + } |
| 70 | + if code != entry.code { |
| 71 | + t.Errorf("sentinel error %q has code %q, want %q", |
| 72 | + entry.name, code, entry.code) |
| 73 | + } |
| 74 | + }) |
| 75 | + } |
| 76 | +} |
| 77 | + |
| 78 | +// TestAllRegisteredCodesAreUsed ensures no stale codes remain in the |
| 79 | +// registry without a matching sentinel error in the enforcement list. |
| 80 | +// This catches the case where a code is added but the error definition |
| 81 | +// is later removed. |
| 82 | +func TestAllRegisteredCodesAreUsed(t *testing.T) { |
| 83 | + allCodes := errcode.AllCodes() |
| 84 | + if len(allCodes) == 0 { |
| 85 | + t.Fatal("expected non-empty code list from AllCodes()") |
| 86 | + } |
| 87 | + |
| 88 | + // Build a set of expected codes from the enforcement list. |
| 89 | + expected := make(map[errcode.Code]bool) |
| 90 | + for _, entry := range registeredSentinelErrors { |
| 91 | + expected[entry.code] = true |
| 92 | + } |
| 93 | + // Plus: the general-purpose codes that aren't tied to specific sentinel errors. |
| 94 | + expected[errcode.CodeBadRequest] = true |
| 95 | + expected[errcode.CodeUnauthorized] = true |
| 96 | + expected[errcode.CodeForbidden] = true |
| 97 | + expected[errcode.CodeNotFound] = true |
| 98 | + expected[errcode.CodeConflict] = true |
| 99 | + expected[errcode.CodeValidationFailed] = true |
| 100 | + expected[errcode.CodeUnknownField] = true |
| 101 | + expected[errcode.CodeInternalError] = true |
| 102 | + expected[errcode.CodeServiceUnavailable] = true |
| 103 | + |
| 104 | + for _, code := range allCodes { |
| 105 | + if !expected[code] { |
| 106 | + t.Errorf("code %q is registered in errcode but not accounted for in registeredSentinelErrors or general-purpose codes", code) |
| 107 | + } |
| 108 | + } |
| 109 | +} |
| 110 | + |
| 111 | +// TestAllSentinelErrorsHaveNonEmptyCode verifies every sentinel resolves |
| 112 | +// to a non-empty code string. |
| 113 | +func TestAllSentinelErrorsHaveNonEmptyCode(t *testing.T) { |
| 114 | + for _, entry := range registeredSentinelErrors { |
| 115 | + if entry.code == "" { |
| 116 | + t.Errorf("sentinel error %q has an empty code", entry.name) |
| 117 | + } |
| 118 | + } |
| 119 | +} |
| 120 | + |
| 121 | +// TestSentinelErrorsWrapCorrectly verifies that each sentinel can be |
| 122 | +// resolved even when wrapped with fmt.Errorf("...: %w", sentinel). |
| 123 | +func TestSentinelErrorsWrapCorrectly(t *testing.T) { |
| 124 | + type wrapCase struct { |
| 125 | + name string |
| 126 | + sentinel error |
| 127 | + wantCode errcode.Code |
| 128 | + } |
| 129 | + cases := []wrapCase{ |
| 130 | + {"ErrNotFound", service.ErrNotFound, errcode.CodeNotFound}, |
| 131 | + {"ErrInvalidTransition", service.ErrInvalidTransition, errcode.CodeSubscriptionInvalidTransition}, |
| 132 | + {"ErrInvalidAmount", service.ErrInvalidAmount, errcode.CodeFeeInvalidAmount}, |
| 133 | + {"ErrInvalidLimit", pagination.ErrInvalidLimit, errcode.CodeInvalidLimit}, |
| 134 | + {"ErrRequestMismatch", middleware.ErrRequestMismatch, errcode.CodeIdempotencyRequestMismatch}, |
| 135 | + } |
| 136 | + |
| 137 | + for _, tc := range cases { |
| 138 | + t.Run(tc.name, func(t *testing.T) { |
| 139 | + wrapped := fmt.Errorf("wrapped: %w", tc.sentinel) |
| 140 | + code := errcode.Lookup(wrapped) |
| 141 | + if code != tc.wantCode { |
| 142 | + t.Errorf("wrapped %s: got code %q, want %q", tc.name, code, tc.wantCode) |
| 143 | + } |
| 144 | + }) |
| 145 | + } |
| 146 | +} |
0 commit comments