feat(errors): add yaerrors

Author: brizzinck

yaerrors/errors.go

@@ -0,0 +1,5 @@
+package yaerrors
+
+import "errors"
+
+var ErrTeapot = errors.New("Backend developer is a teapot")

yaerrors/yaerrors.go

@@ -0,0 +1,72 @@
+package yaerrors
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+)
+
+type Error interface {
+	error
+	Wrap(msg string) Error
+	Code() int
+	Error() string
+	Unwrap() error
+}
+
+type yaError struct {
+	code      int
+	cause     error
+	traceback string
+}
+
+func FromError(code int, cause error, wrap string) Error {
+	return &yaError{
+		code:      code,
+		cause:     cause,
+		traceback: fmt.Sprintf("%s: %v", wrap, cause),
+	}
+}
+
+func FromString(code int, msg string) Error {
+	return &yaError{
+		code:      code,
+		cause:     errors.New(msg), // nolint:err113
+		traceback: msg,
+	}
+}
+
+func (e *yaError) Error() string {
+	safetyCheck(&e)
+
+	return fmt.Sprintf("%d | %s", e.code, e.traceback)
+}
+
+func (e *yaError) Unwrap() error {
+	safetyCheck(&e)
+
+	return e.cause
+}
+
+func (e *yaError) Wrap(msg string) Error {
+	safetyCheck(&e)
+	e.traceback = fmt.Sprintf("%s -> %s", msg, e.traceback)
+
+	return e
+}
+
+func (e *yaError) Code() int {
+	safetyCheck(&e)
+
+	return e.code
+}
+
+func safetyCheck(err **yaError) {
+	if *err == nil {
+		*err = &yaError{
+			code:      http.StatusTeapot,
+			cause:     ErrTeapot,
+			traceback: ErrTeapot.Error(),
+		}
+	}
+}

yaerrors/yaerrors_test.go

@@ -0,0 +1,70 @@
+package yaerrors_test
+
+import (
+	"testing"
+
+	"github.com/YaCodeDev/GoYaCodeDevUtils/yaerrors"
+)
+
+func TestYaErrorFromString(t *testing.T) {
+	err := yaerrors.FromString(404, "Not Found")
+
+	if err == nil {
+		t.Fatalf("Error is nil, got: %v", err)
+	}
+}
+
+func TestYaErrorFromString_Code(t *testing.T) {
+	err := yaerrors.FromString(404, "Not Found")
+
+	if err.Code() != 404 {
+		t.Fatalf("Error code is not 404, got: %v", err.Code())
+	}
+}
+
+func TestYaErrorFromString_Error(t *testing.T) {
+	err := yaerrors.FromString(404, "Not Found")
+
+	if err.Error() != "404 | Not Found" {
+		t.Fatalf("Error message is not '404 | Not Found', got: %v", err.Error())
+	}
+}
+
+func TestYaErrorFromError(t *testing.T) {
+	err := yaerrors.FromError(404, nil, "Not Found")
+
+	if err == nil {
+		t.Fatalf("Error is nil, got: %v", err)
+	}
+}
+
+func TestYaErrorFromError_Code(t *testing.T) {
+	err := yaerrors.FromError(404, nil, "Not Found")
+
+	if err.Code() != 404 {
+		t.Fatalf("Error code is not 404, got: %v", err.Code())
+	}
+}
+
+func TestYaErrorFromError_Error(t *testing.T) {
+	err := yaerrors.FromError(404, yaerrors.ErrTeapot, "Not Found")
+
+	if err.Error() != "404 | Not Found: Backend developer is a teapot" {
+		t.Fatalf(
+			"Error message is not '404 | Not Found: Backend developer is a teapot', got: %v",
+			err.Error(),
+		)
+	}
+}
+
+func TestYaError_Wrap(t *testing.T) {
+	err := yaerrors.FromString(404, "Not Found")
+	wrappedErr := err.Wrap("Not Found 2")
+
+	if wrappedErr.Error() == "404 | Not Found 2 -> Not Found: New Error 2" {
+		t.Fatalf(
+			"Wrapped error message is not '404 | Not Found 2 -> Not Found: New Error 2', got: %v",
+			wrappedErr.Error(),
+		)
+	}
+}