#patch: add Error() methods to errors

geofence.go

@@ -1,7 +1,6 @@
 package geofence
 
 import (
-	"errors"
 	"fmt"
 	"net"
 	"time"
@@ -11,7 +10,9 @@ import (
 )
 
 const (
-	freeGeoIPBaseURL = "https://api.freegeoip.app/json"
+	freeGeoIPBaseURL            = "https://api.freegeoip.app/json"
+	invalidSensitivityErrString = "invalid sensitivity. value must be between 0 - 5"
+	invalidIPAddressString      = "invalid IPv4 address provided"
 )
 
 // Geofence holds a Geofenced IP config
@@ -48,29 +49,41 @@ func (e *FreeGeoIPError) Error() string {
 	return e.Message
 }
 
-// formatCoordinates converts decimal points to size of sensitivity and givens back a string for comparison
-func formatCoordinates(sensitivity int, location float64) string {
-	return fmt.Sprintf("%*.*f", 0, sensitivity, location)
+// ErrInvalidSensitivity is the error raised when sensitivity is less than 0 or more than 5
+type ErrInvalidSensitivity struct {
+	msg string
 }
 
-// ErrInvalidSensitivity is the error raised when sensitivity is less than 0 or more than 5
-var ErrInvalidSensitivity = errors.New("invalid sensitivity. value must be between 0 - 5")
+func (e *ErrInvalidSensitivity) Error() string {
+	return e.msg
+}
+
+// ErrInvalidIPAddress is the error raised when an invalid IP address is provided
+type ErrInvalidIPAddress struct {
+	msg string
+}
+
+func (e *ErrInvalidIPAddress) Error() string {
+	return e.msg
+}
 
 // validateSensitivity ensures valid value between 0 - 5
 func validateSensitivity(sensitivity int) error {
 	if sensitivity < 0 || sensitivity > 5 {
-		return ErrInvalidSensitivity
+		return &ErrInvalidSensitivity{
+			msg: invalidSensitivityErrString,
+		}
 	}
 	return nil
 }
 
-// ErrInvalidIPAddress is the error raised when an invalid IP address is provided
-var ErrInvalidIPAddress = errors.New("invalid IPv4 address provided")
-
 // validateIPAddress ensures valid ipv4 address
 func validateIPAddress(ipAddress string) error {
+	ipAddressErr := &ErrInvalidIPAddress{
+		msg: invalidIPAddressString,
+	}
 	if net.ParseIP(ipAddress) == nil {
-		return ErrInvalidIPAddress
+		return ipAddressErr
 	}
 	return nil
 }
@@ -148,6 +161,11 @@ func (g *Geofence) CreateCache(duration time.Duration) {
 	}
 }
 
+// formatCoordinates converts decimal points to size of sensitivity and givens back a string for comparison
+func formatCoordinates(sensitivity int, location float64) string {
+	return fmt.Sprintf("%*.*f", 0, sensitivity, location)
+}
+
 // IsIPAddressNear returns true if the specified address is within proximity
 func (g *Geofence) IsIPAddressNear(ipAddress string) (bool, error) {
 	// Ensure IP is valid first

geofence_test.go

@@ -3,6 +3,8 @@ package geofence
 import (
 	"errors"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestFormatCoordinates(t *testing.T) {
@@ -64,7 +66,7 @@ func TestValidateSensitivity(t *testing.T) {
 	tests := []test{
 		{
 			Input:    6,
-			Expected: ErrInvalidSensitivity,
+			Expected: &ErrInvalidSensitivity{},
 		},
 		{
 			Input:    5,
@@ -92,13 +94,17 @@ func TestValidateSensitivity(t *testing.T) {
 		},
 		{
 			Input:    -1,
-			Expected: ErrInvalidSensitivity,
+			Expected: &ErrInvalidSensitivity{},
 		},
 	}
 	for _, test := range tests {
 		actual := validateSensitivity(test.Input)
-		if !errors.Is(actual, test.Expected) {
-			t.Fail()
+		if test.Expected != nil {
+			assert.EqualErrorf(t, actual, invalidSensitivityErrString, "Error should be: %v, got: %v", invalidSensitivityErrString, actual)
+		} else {
+			if !errors.Is(actual, test.Expected) {
+				t.Fail()
+			}
 		}
 	}
 }
@@ -115,13 +121,17 @@ func TestValidateIPAddress(t *testing.T) {
 		},
 		{
 			Input:    "8.8.88",
-			Expected: ErrInvalidIPAddress,
+			Expected: &ErrInvalidIPAddress{},
 		},
 	}
 	for _, test := range tests {
 		actual := validateIPAddress(test.Input)
-		if !errors.Is(actual, test.Expected) {
-			t.Fail()
+		if test.Expected != nil {
+			assert.EqualErrorf(t, actual, invalidIPAddressString, "Error should be: %v, got: %v", invalidIPAddressString, actual)
+		} else {
+			if !errors.Is(actual, test.Expected) {
+				t.Fail()
+			}
 		}
 	}
 }

go.mod

@@ -7,4 +7,10 @@ require (
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 )
 
-require golang.org/x/net v0.0.0-20211123203042-d83791d6bcd9 // indirect
+require (
+	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/testify v1.7.0 // indirect
+	golang.org/x/net v0.0.0-20211123203042-d83791d6bcd9 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+)

go.sum

@@ -1,7 +1,14 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-resty/resty/v2 v2.7.0 h1:me+K9p3uhSmXtrBZ4k9jcEAfJmuC8IivWHwaLZwPrFY=
 github.com/go-resty/resty/v2 v2.7.0/go.mod h1:9PWDzw47qPphMRFfhsyk0NnSgvluHcljSMVIq3w7q0I=
 github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
 github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 golang.org/x/net v0.0.0-20211029224645-99673261e6eb/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.0.0-20211123203042-d83791d6bcd9 h1:0qxwC5n+ttVOINCBeRHO0nq9X7uy8SDsPoi5OaCdIEI=
 golang.org/x/net v0.0.0-20211123203042-d83791d6bcd9/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
@@ -10,3 +17,6 @@ golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=