Beginning of recorder

Author: kalverra

parrot/errors.go

@@ -0,0 +1,38 @@
+package parrot
+
+import (
+	"errors"
+	"fmt"
+)
+
+var (
+	ErrNilRoute         = errors.New("route is nil")
+	ErrNoMethod         = errors.New("no method specified")
+	ErrInvalidPath      = errors.New("invalid path")
+	ErrNoResponse       = errors.New("route must have a handler or some response")
+	ErrOnlyOneResponse  = errors.New("route can only have one response type")
+	ErrResponseMarshal  = errors.New("unable to marshal response body to JSON")
+	ErrRouteNotFound    = errors.New("route not found")
+	ErrRecorderNotFound = errors.New("recorder not found")
+)
+
+// Custom error type to help add more detail to base errors
+type dynamicError struct {
+	Base  error  // Base error for comparison
+	Extra string // Dynamic context (e.g., method name)
+}
+
+func (e *dynamicError) Error() string {
+	return fmt.Sprintf("%s: %s", e.Base.Error(), e.Extra)
+}
+
+func (e *dynamicError) Unwrap() error {
+	return e.Base
+}
+
+func newDynamicError(base error, detail string) error {
+	return &dynamicError{
+		Base:  base,
+		Extra: detail,
+	}
+}

parrot/parrot_examples_test.go parrot/examples_test.goparrot/parrot_examples_test.go renamed to parrot/examples_test.go

@@ -5,15 +5,18 @@ import (
 	"io"
 	"net/http"
 
+	"github.com/rs/zerolog"
 	"github.com/smartcontractkit/chainlink-testing-framework/parrot"
 )
 
 func ExampleServer() {
-	p, err := parrot.Wake()
+	// Create a new parrot instance with no logging
+	p, err := parrot.Wake(parrot.WithLogLevel(zerolog.NoLevel))
 	if err != nil {
 		panic(err)
 	}
 
+	// Create a new route /test that will return a 200 status code with a text/plain response body of "Squawk"
 	route := &parrot.Route{
 		Method:              http.MethodGet,
 		Path:                "/test",
@@ -22,11 +25,13 @@ func ExampleServer() {
 		ResponseContentType: "text/plain",
 	}
 
+	// Register the route with the parrot instance
 	err = p.Register(route)
 	if err != nil {
 		panic(err)
 	}
 
+	// Call the route
 	resp, err := p.Call(http.MethodGet, "/test")
 	if err != nil {
 		panic(err)
@@ -37,7 +42,6 @@ func ExampleServer() {
 	fmt.Println(resp.Header.Get("Content-Type"))
 	body, _ := io.ReadAll(resp.Body)
 	fmt.Println(string(body))
-
 	// Output:
 	// 200
 	// text/plain