Make parrot route setting more flexible

Author: kalverra

lib/client/mockserver.go

@@ -15,20 +15,24 @@ import (
 )
 
 // MockserverClient mockserver client
+//
 // Deprecated: Use Parrot instead
 type MockserverClient struct {
 	APIClient *resty.Client
 	Config    *MockserverConfig
 }
 
 // MockserverConfig holds config information for MockserverClient
+//
+// Deprecated: Use Parrot instead
 type MockserverConfig struct {
 	LocalURL   string
 	ClusterURL string
 	Headers    map[string]string
 }
 
 // ConnectMockServer creates a connection to a deployed mockserver in the environment
+//
 // Deprecated: Use Parrot instead
 func ConnectMockServer(e *environment.Environment) *MockserverClient {
 	c := NewMockserverClient(&MockserverConfig{
@@ -39,6 +43,7 @@ func ConnectMockServer(e *environment.Environment) *MockserverClient {
 }
 
 // ConnectMockServerURL creates a connection to a mockserver at a given url, should only be used for inside K8s tests
+//
 // Deprecated: Use Parrot instead
 func ConnectMockServerURL(url string) *MockserverClient {
 	c := NewMockserverClient(&MockserverConfig{
@@ -49,6 +54,7 @@ func ConnectMockServerURL(url string) *MockserverClient {
 }
 
 // NewMockserverClient returns a mockserver client
+//
 // Deprecated: Use Parrot instead
 func NewMockserverClient(cfg *MockserverConfig) *MockserverClient {
 	log.Debug().Str("Local URL", cfg.LocalURL).Str("Remote URL", cfg.ClusterURL).Msg("Connected to MockServer")
@@ -217,39 +223,53 @@ func (em *MockserverClient) SetStringValuePath(path string, stringValue string)
 }
 
 // LocalURL returns the local url of the mockserver
+//
+// Deprecated: Use Parrot instead
 func (em *MockserverClient) LocalURL() string {
 	return em.Config.LocalURL
 }
 
 // PathSelector represents the json object used to find expectations by path
+//
+// Deprecated: Use Parrot instead
 type PathSelector struct {
 	Path string `json:"path"`
 }
 
 // HttpRequest represents the httpRequest json object used in the mockserver initializer
+//
+// Deprecated: Use Parrot instead
 type HttpRequest struct {
 	Path string `json:"path"`
 }
 
 // HttpResponse represents the httpResponse json object used in the mockserver initializer
+//
+// Deprecated: Use Parrot instead
 type HttpResponse struct {
 	Body interface{} `json:"body"`
 }
 
 // HttpInitializer represents an element of the initializer array used in the mockserver initializer
+//
+// Deprecated: Use Parrot instead
 type HttpInitializer struct {
 	Id       string       `json:"id"`
 	Request  HttpRequest  `json:"httpRequest"`
 	Response HttpResponse `json:"httpResponse"`
 }
 
 // HttpResponse represents the httpResponse json object used in the mockserver initializer
+//
+// Deprecated: Use Parrot instead
 type HttpResponseTemplate struct {
 	Template     string `json:"template"`
 	TemplateType string `json:"templateType"`
 }
 
 // HttpInitializer represents an element of the initializer array used in the mockserver initializer
+//
+// Deprecated: Use Parrot instead
 type HttpInitializerTemplate struct {
 	Id       string               `json:"id"`
 	Request  HttpRequest          `json:"httpRequest"`
@@ -259,12 +279,16 @@ type HttpInitializerTemplate struct {
 // For OTPE - weiwatchers
 
 // NodeInfoJSON represents an element of the nodes array used to deliver configs to otpe
+//
+// Deprecated: Use Parrot instead
 type NodeInfoJSON struct {
 	ID          string   `json:"id"`
 	NodeAddress []string `json:"nodeAddress"`
 }
 
 // ContractInfoJSON represents an element of the contracts array used to deliver configs to otpe
+//
+// Deprecated: Use Parrot instead
 type ContractInfoJSON struct {
 	ContractAddress string `json:"contractAddress"`
 	ContractVersion int    `json:"contractVersion"`
@@ -275,11 +299,15 @@ type ContractInfoJSON struct {
 // For Adapter endpoints
 
 // AdapterResult represents an int result for an adapter
+//
+// Deprecated: Use Parrot instead
 type AdapterResult struct {
 	Result interface{} `json:"result"`
 }
 
 // AdapterResponse represents a response from an adapter
+//
+// Deprecated: Use Parrot instead
 type AdapterResponse struct {
 	Id    string        `json:"id"`
 	Data  AdapterResult `json:"data"`

lib/docker/test_env/parrot.go

@@ -149,6 +149,7 @@ func (p *Parrot) getContainerRequest() (tc.ContainerRequest, error) {
 }
 
 // SetAdapterRoute sets a new route for the mock external adapter, wrapping the provided response in a standard adapter response.
+// If you don't want to wrap the response, use Client.RegisterRoute directly.
 func (p *Parrot) SetAdapterRoute(route *parrot.Route) error {
 	var result any
 	if route.RawResponseBody != "" {

parrot/parrot.go

@@ -335,6 +335,9 @@ func (p *Server) Register(route *Route) error {
 	if route == nil {
 		return ErrNilRoute
 	}
+	if !strings.HasPrefix(route.Path, "/") {
+		route.Path = "/" + route.Path
+	}
 	if !isValidPath(route.Path) {
 		return newDynamicError(ErrInvalidPath, fmt.Sprintf("'%s'", route.Path))
 	}