Adds Parrot EA method

Author: kalverra

lib/docker/test_env/killgrave.go

@@ -57,6 +57,8 @@ type KillgraveRequest struct {
 }
 
 // Response represent the structure of real response
+//
+// Deprecated: Use Parrot instead
 type KillgraveResponse struct {
 	Status   int                     `json:"status"`
 	Body     string                  `json:"body,omitempty"`
@@ -66,19 +68,25 @@ type KillgraveResponse struct {
 }
 
 // ResponseDelay represent time delay before server responds.
+//
+// Deprecated: Use Parrot instead
 type KillgraveResponseDelay struct {
 	Delay  int64 `json:"delay,omitempty"`
 	Offset int64 `json:"offset,omitempty"`
 }
 
 // AdapterResponse represents a response from an adapter
+//
+// Deprecated: Use Parrot instead
 type KillgraveAdapterResponse struct {
 	Id    string                 `json:"id"`
 	Data  KillgraveAdapterResult `json:"data"`
 	Error interface{}            `json:"error"`
 }
 
 // AdapterResult represents an int result for an adapter
+//
+// Deprecated: Use Parrot instead
 type KillgraveAdapterResult struct {
 	Result interface{} `json:"result"`
 }
@@ -108,8 +116,6 @@ func NewKillgrave(networks []string, impostersDirectoryPath string, opts ...EnvC
 
 // WithTestInstance sets up a Killgrave instance for testing by assigning a test logger and the testing context.
 // This allows for better logging during tests and facilitates easier debugging.
-//
-// Deprecated: Use Parrot instead
 func (k *Killgrave) WithTestInstance(t *testing.T) *Killgrave {
 	k.l = logging.GetTestLogger(t)
 	k.t = t
@@ -118,8 +124,6 @@ func (k *Killgrave) WithTestInstance(t *testing.T) *Killgrave {
 
 // StartContainer initializes and starts the Killgrave container, setting up imposters and request dumping.
 // It also configures cleanup for the container and logs the external and internal endpoints for access.
-//
-// Deprecated: Use Parrot instead
 func (k *Killgrave) StartContainer() error {
 	err := k.setupImposters()
 	if err != nil {

lib/docker/test_env/parrot.go

@@ -5,6 +5,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/google/uuid"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	tc "github.com/testcontainers/testcontainers-go"
@@ -29,6 +30,18 @@ type Parrot struct {
 	l                zerolog.Logger
 }
 
+// ParrotAdapterResponse imitates the standard response from a Chainlink external adapter.
+type ParrotAdapterResponse struct {
+	ID    string              `json:"id"`
+	Data  ParrotAdapterResult `json:"data"`
+	Error any                 `json:"error"`
+}
+
+// ParrotAdapterResult is the data field of the ParrotAdapterResponse.
+type ParrotAdapterResult struct {
+	Result any `json:"result"`
+}
+
 // NewParrot creates a new instance of ParrotServer with specified networks and options.
 // It initializes the server with a unique container name and a default startup timeout.
 // This function is useful for testing decentralized applications in a controlled environment.
@@ -134,3 +147,27 @@ func (p *Parrot) getContainerRequest() (tc.ContainerRequest, error) {
 		},
 	}, nil
 }
+
+// SetAdapterRoute sets a new route for the mock external adapter, wrapping the provided response in a standard adapter response.
+func (p *Parrot) SetAdapterRoute(route *parrot.Route) error {
+	var result any
+	if route.RawResponseBody != "" {
+		result = route.RawResponseBody
+	} else {
+		result = route.ResponseBody
+	}
+	ar := ParrotAdapterResponse{
+		ID: uuid.NewString(),
+		Data: ParrotAdapterResult{
+			Result: result,
+		},
+		Error: nil,
+	}
+
+	return p.Client.RegisterRoute(&parrot.Route{
+		Method:             route.Method,
+		Path:               route.Path,
+		ResponseBody:       ar,
+		ResponseStatusCode: route.ResponseStatusCode,
+	})
+}