test: unify deadline error checking into testing.AssertIsTimeoutError

Author: GeorgeMac

conn_test.go

@@ -2,7 +2,6 @@ package clickhouse
 
 import (
 	"context"
-	"errors"
 	"log/slog"
 	"os"
 	"testing"
@@ -118,20 +117,6 @@ func TestConn_Query_ReadTimeout(t *testing.T) {
 
 	t.Run("second row timeout", func(t *testing.T) {
 		assert.False(t, rows.Next())
-		err := rows.Err()
-		assert.True(t, isDeadlineExceededError(err), "error is not a timeout error: %#v", err)
+		chtesting.AssertIsDeadlineError(t, rows.Err())
 	})
 }
-
-type timeout interface {
-	Timeout() bool
-}
-
-func isDeadlineExceededError(err error) bool {
-	nerr, ok := errors.Unwrap(err).(timeout)
-	if !ok {
-		return false
-	}
-
-	return nerr.Timeout()
-}

lib/testing/errors.go

@@ -0,0 +1,38 @@
+package testing
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// AssertIsTimeoutError ensures that the error provided is a timeout error
+// It recursively unwraps the provided error and ensures the core error
+// implements the Timeout() method and it returns true.
+// context deadline error, os deadline error and and poll deadline error each
+// implement this and return true.
+func AssertIsTimeoutError(t *testing.T, err error) {
+	assert.True(t, isDeadlineExceededError(err), "error is not a timeout error: %#v", err)
+}
+
+type timeout interface {
+	Timeout() bool
+}
+
+func isDeadlineExceededError(err error) bool {
+	nerr, ok := unwrap(err).(timeout)
+	if !ok {
+		return false
+	}
+
+	return nerr.Timeout()
+}
+
+// unwrap recursively unwraps the error until it gets the core error
+func unwrap(err error) error {
+	if uerr := errors.Unwrap(err); uerr != nil {
+		return unwrap(uerr)
+	}
+	return err
+}

lib/testing/server.go

@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package proto
+package testing
 
 import (
 	"errors"

tests/std/context_timeout_test.go

@@ -20,15 +20,15 @@ package std
 import (
 	"context"
 	"fmt"
-	"github.com/ClickHouse/clickhouse-go/v2"
-	clickhouse_tests "github.com/ClickHouse/clickhouse-go/v2/tests"
-	"github.com/stretchr/testify/require"
-	"net"
-	"net/url"
 	"strconv"
 	"testing"
 	"time"
 
+	"github.com/ClickHouse/clickhouse-go/v2"
+	chtesting "github.com/ClickHouse/clickhouse-go/v2/lib/testing"
+	clickhouse_tests "github.com/ClickHouse/clickhouse-go/v2/tests"
+	"github.com/stretchr/testify/require"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -46,14 +46,7 @@ func TestStdContextStdTimeout(t *testing.T) {
 				if row := connect.QueryRowContext(ctx, "SELECT 1, sleep(3)"); assert.NotNil(t, row) {
 					var a, b int
 					if err := row.Scan(&a, &b); assert.Error(t, err) {
-						switch err := err.(type) {
-						case *net.OpError:
-							assert.Equal(t, "read", err.Op)
-						case *url.Error:
-							assert.Equal(t, context.DeadlineExceeded, err.Err)
-						default:
-							assert.ErrorIs(t, err, context.DeadlineExceeded)
-						}
+						chtesting.AssertIsDeadlineError(t, err)
 					}
 				}
 			}
@@ -67,7 +60,6 @@ func TestStdContextStdTimeout(t *testing.T) {
 					}
 				}
 			}
-
 		})
 	}
 }