feat: add recover pattern (#130)

Signed-off-by: Tronje Krop <[email protected]>

Author: tkrop

.github/workflows/build.yaml

@@ -25,24 +25,24 @@ jobs:
         path-to-profile: ./build/test-all.cover
 
 
-  macos:
-    runs-on: macos-latest
-    steps:
-    - name: Set up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: 1.25
-        cache: false
+  # macos:
+  #   runs-on: macos-latest
+  #   steps:
+  #   - name: Set up Go
+  #     uses: actions/setup-go@v5
+  #     with:
+  #       go-version: 1.25
+  #       cache: false
 
-    - name: Checkout code
-      uses: actions/checkout@v4
+  #   - name: Checkout code
+  #     uses: actions/checkout@v4
 
-    - name: Build and tests
-      env:
-        BASH_COMPAT: 3.2
-        CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
-        LANG: en_US.UTF-8
-      run: make all
+  #   - name: Build and tests
+  #     env:
+  #       BASH_COMPAT: 3.2
+  #       CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+  #       LANG: en_US.UTF-8
+  #     run: make all
 
 
   release:

VERSION

@@ -1 +1 @@
-0.0.43
+0.0.44

go.mod

@@ -15,8 +15,8 @@ require (
 
 require (
 	github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
-	golang.org/x/mod v0.29.0 // indirect
-	golang.org/x/sync v0.17.0 // indirect
+	golang.org/x/mod v0.30.0 // indirect
+	golang.org/x/sync v0.18.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -28,10 +28,10 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y=
 go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU=
-golang.org/x/mod v0.29.0 h1:HV8lRxZC4l2cr3Zq1LvtOsi/ThTgWnUk/y64QSs8GwA=
-golang.org/x/mod v0.29.0/go.mod h1:NyhrlYXJ2H4eJiRy/WDBO6HMqZQ6q9nk4JzS3NuCK+w=
-golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
-golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
+golang.org/x/mod v0.30.0 h1:fDEXFVZ/fmCKProc/yAXXUijritrDzahmwwefnjoPFk=
+golang.org/x/mod v0.30.0/go.mod h1:lAsf5O2EvJeSFMiBxXDki7sCgAxEUcZHXoXMKT4GJKc=
+golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I=
+golang.org/x/sync v0.18.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
 golang.org/x/text v0.30.0 h1:yznKA/E9zq54KzlzBEAWn1NXSQ8DIp/NYMy88xJjl4k=
 golang.org/x/text v0.30.0/go.mod h1:yDdHFIX9t+tORqspjENWgzaCVXgk0yYnYuSZ8UzzBVM=
 golang.org/x/tools v0.38.0 h1:Hx2Xv8hISq8Lm16jvBZ2VQf+RLmbd7wVUsALibYI/IQ=

test/pattern.go

@@ -46,6 +46,17 @@ func Ptr[T any](v T) *T {
 // others arguments. The method allows to write concise test setup code.
 func First[T any](arg T, _ ...any) T { return arg }
 
+// Recover is a convenience method to be used in deferred calls to verify that
+// a panic occurred with the expected error value.
+func Recover(t Test, expect error) {
+	// revive:disable-next-line:defer // caller is expected to use defer.
+	if actual := recover(); actual != nil {
+		assert.Equal(t, expect, actual)
+	} else {
+		assert.Fail(t, "expected panic: %#v", expect)
+	}
+}
+
 // TODO: consider following convenience methods:
 //
 // // Check is a convenience method that returns the second argument and swallows

test/pattern_test.go

@@ -2,6 +2,7 @@ package test_test
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"os"
 	"reflect"
@@ -394,6 +395,58 @@ func TestPtr(t *testing.T) {
 	})
 }
 
+type RecoverParams struct {
+	setup  error
+	expect test.Expect
+	panic  any
+}
+
+var recoverTestCases = map[string]RecoverParams{
+	// No panic cases.
+	"no panic with nil": {},
+	"no panic with error": {
+		setup: assert.AnError,
+	},
+	"no panic with custom error": {
+		setup: errors.New("custom error"),
+	},
+
+	// Successful recovery.
+	"panic with error": {
+		panic:  assert.AnError,
+		setup:  assert.AnError,
+		expect: test.Success,
+	},
+	"panic with custom error": {
+		panic:  fmt.Errorf("custom error: %s", "details"),
+		setup:  fmt.Errorf("custom error: %s", "details"),
+		expect: test.Success,
+	},
+	"panic with formatted error": {
+		panic:  fmt.Errorf("error code: %d", 500),
+		setup:  fmt.Errorf("error code: %d", 500),
+		expect: test.Success,
+	},
+	"panic with same error pointer": {
+		panic:  assert.AnError,
+		setup:  assert.AnError,
+		expect: test.Success,
+	},
+}
+
+func TestRecover(t *testing.T) {
+	test.Map(t, recoverTestCases).
+		Run(func(t test.Test, param RecoverParams) {
+			// Given
+			defer test.Recover(t, param.setup)
+
+			// When
+			if param.panic != nil {
+				panic(param.panic)
+			}
+		})
+}
+
 // ctx returns the current time formatted as RFC3339Nano truncated to 26
 // characters to avoid excessive precision in test output.
 func ctx() string {