More tests on recorders

Author: kalverra

.gitignore

@@ -80,4 +80,6 @@ import_keys_test.go
 tag.py
 
 parrot/*.json
-parrot/*.log
+parrot/*.log
+# Executable
+parrot/parrot

parrot/Makefile

@@ -26,4 +26,8 @@ test_unit:
 
 .PHONY: bench
 bench:
-	go test $(TEST_ARGS) -bench=. -run=^$$ ./...
+	go test $(TEST_ARGS) -bench=. -run=^$$ ./...
+
+.PHONY: build
+build:
+	go build -o ./parrot ./cmd

parrot/cmd/main.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"os/signal"
 	"syscall"
+	"time"
 
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
@@ -42,7 +43,7 @@ func main() {
 				options = append(options, parrot.WithJSONLogs())
 			}
 
-			ctx, cancel := context.WithCancel(context.Background())
+			ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
 			defer cancel()
 
 			p, err := parrot.Wake(options...)
@@ -62,7 +63,7 @@ func main() {
 			<-c
 			err = p.Shutdown(ctx)
 			if err != nil {
-				log.Error().Err(err).Msg("error shutting down server")
+				log.Error().Err(err).Msg("Error putting parrot to sleep")
 			}
 			return nil
 		},

parrot/errors.go

@@ -18,7 +18,7 @@ var (
 	ErrInvalidRecorderURL = errors.New("invalid recorder URL")
 	ErrRecorderNotFound   = errors.New("recorder not found")
 
-	ErrParrotAsleep = errors.New("parrot is asleep")
+	ErrServerShutdown = errors.New("parrot is already asleep")
 )
 
 // Custom error type to help add more detail to base errors

parrot/examples_test.go

@@ -3,33 +3,36 @@ package parrot_test
 import (
 	"context"
 	"fmt"
-	"io"
 	"net/http"
+	"os"
 
 	"github.com/go-resty/resty/v2"
 	"github.com/rs/zerolog"
 	"github.com/smartcontractkit/chainlink-testing-framework/parrot"
 )
 
 func ExampleRegister() {
-	// Create a new parrot instance with no logging
-	p, err := parrot.Wake(parrot.WithLogLevel(zerolog.NoLevel))
+	// Create a new parrot instance with no logging and a custom save file
+	saveFile := "register_example.json"
+	p, err := parrot.Wake(parrot.WithLogLevel(zerolog.NoLevel), parrot.WithSaveFile(saveFile))
 	if err != nil {
 		panic(err)
 	}
-	defer func() {
-		err = p.Shutdown(context.Background())
+	defer func() { // Cleanup the parrot instance
+		err = p.Shutdown(context.Background()) // Gracefully shutdown the parrot instance
 		if err != nil {
 			panic(err)
 		}
+		p.WaitShutdown()    // Wait for the parrot instance to shutdown. Usually unnecessary, but we want to clean up the save file
+		os.Remove(saveFile) // Cleanup the save file for the example
 	}()
 
 	// 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",
 		RawResponseBody:    "Squawk",
-		ResponseStatusCode: 200,
+		ResponseStatusCode: http.StatusOK,
 	}
 
 	// Register the route with the parrot instance
@@ -43,27 +46,27 @@ func ExampleRegister() {
 	if err != nil {
 		panic(err)
 	}
-	defer resp.Body.Close()
-
-	fmt.Println(resp.StatusCode)
-	body, _ := io.ReadAll(resp.Body)
-	fmt.Println(string(body))
+	fmt.Println(resp.StatusCode())
+	fmt.Println(string(resp.Body()))
 	// Output:
 	// 200
 	// Squawk
 }
 
 func ExampleRoute() {
 	// Run the parrot server as a separate instance, like in a Docker container
-	p, err := parrot.Wake(parrot.WithPort(9090), parrot.WithLogLevel(zerolog.NoLevel))
+	saveFile := "route_example.json"
+	p, err := parrot.Wake(parrot.WithPort(9090), parrot.WithLogLevel(zerolog.NoLevel), parrot.WithSaveFile(saveFile))
 	if err != nil {
 		panic(err)
 	}
-	defer func() {
-		err = p.Shutdown(context.Background())
+	defer func() { // Cleanup the parrot instance
+		err = p.Shutdown(context.Background()) // Gracefully shutdown the parrot instance
 		if err != nil {
 			panic(err)
 		}
+		p.WaitShutdown()    // Wait for the parrot instance to shutdown. Usually unnecessary, but we want to clean up the save file
+		os.Remove(saveFile) // Cleanup the save file for the example
 	}()
 
 	// Code that calls the parrot server from another service
@@ -75,7 +78,7 @@ func ExampleRoute() {
 		Method:             http.MethodGet,
 		Path:               "/test",
 		RawResponseBody:    "Squawk",
-		ResponseStatusCode: 200,
+		ResponseStatusCode: http.StatusOK,
 	}
 	resp, err := client.R().SetBody(route).Post("http://localhost:9090/routes")
 	if err != nil {
@@ -123,15 +126,18 @@ func ExampleRoute() {
 }
 
 func ExampleRecorder() {
-	p, err := parrot.Wake(parrot.WithLogLevel(zerolog.NoLevel))
+	saveFile := "recorder_example.json"
+	p, err := parrot.Wake(parrot.WithLogLevel(zerolog.NoLevel), parrot.WithSaveFile(saveFile))
 	if err != nil {
 		panic(err)
 	}
-	defer func() {
-		err = p.Shutdown(context.Background())
+	defer func() { // Cleanup the parrot instance
+		err = p.Shutdown(context.Background()) // Gracefully shutdown the parrot instance
 		if err != nil {
 			panic(err)
 		}
+		p.WaitShutdown()    // Wait for the parrot instance to shutdown. Usually unnecessary, but we want to clean up the save file
+		os.Remove(saveFile) // Cleanup the save file for the example
 	}()
 
 	// Create a new recorder
@@ -161,11 +167,10 @@ func ExampleRecorder() {
 
 	// Call the route
 	go func() {
-		resp, err := p.Call(http.MethodGet, "/test")
+		_, err := p.Call(http.MethodGet, "/test")
 		if err != nil {
 			panic(err)
 		}
-		defer resp.Body.Close()
 	}()
 
 	// Record the route call