parrot

Mar 11, 2025

Changes in this version

type RecorderOption

+ func WithRecorderHost(host string) RecorderOption

Feb 10, 2025

Changes in this version

+ type Client struct

+ func NewClient(url string) *Client

+ func (c *Client) CallRoute(method, path string) (*resty.Response, error)

+ func (c *Client) DeleteRoute(route *Route) error

+ func (c *Client) Healthy() (bool, error)

+ func (c *Client) Recorders() ([]string, error)

+ func (c *Client) RegisterRecorder(recorder *Recorder) error

+ func (c *Client) RegisterRoute(route *Route) error

+ func (c *Client) Routes() ([]*Route, error)

type Server

+ func NewServer(options ...ServerOption) (*Server, error)

Feb 10, 2025

Changes in this version

type Server

+ func (p *Server) Host() string

+ func (p *Server) Port() int

Jan 31, 2025

Changes in this version

+ const HealthRoute

+ const RecorderRoute

+ const RoutesRoute

+ var ErrInvalidMethod = errors.New("invalid method")

+ var ErrServerUnhealthy = errors.New("parrot is unhealthy")

+ var ErrWildcardPath = fmt.Errorf("path can only contain one wildcard '*' and it must be the final value")

type RouteCall

+ ID string

type Server

+ func (p *Server) Healthy() error

Jan 29, 2025

Changes in this version

+ const MethodAny

+ var ErrCageNotFound = errors.New("sub-route not found")

type Route

+ func (r *Route) Segment() string

type ServerOption

+ func WithRecorders(recorderURLs ...string) ServerOption

Jan 27, 2025

Changes in this version

type ServerOption

+ func DisableConsoleLogs() ServerOption

Jan 24, 2025

Changes in this version

+ var ErrInvalidPath = errors.New("invalid path")

+ var ErrInvalidRecorderURL = errors.New("invalid recorder URL")

+ var ErrNilRoute = errors.New("route is nil")

+ var ErrNoMethod = errors.New("no method specified")

+ var ErrNoRecorderURL = errors.New("no recorder URL specified")

+ var ErrNoResponse = errors.New("route must have a handler or some response")

+ var ErrOnlyOneResponse = errors.New("route can only have one response type")

+ var ErrRecorderNotFound = errors.New("recorder not found")

+ var ErrResponseMarshal = errors.New("unable to marshal response body to JSON")

+ var ErrRouteNotFound = errors.New("route not found")

+ var ErrServerShutdown = errors.New("parrot is already asleep")

+ type Recorder struct

+ Host string

+ Port string

+ func NewRecorder(opts ...RecorderOption) (*Recorder, error)

+ func (r *Recorder) Close() error

+ func (r *Recorder) Err() chan error

+ func (r *Recorder) Record() chan *RouteCall

+ func (r *Recorder) URL() string

+ type RecorderOption func(*Recorder)

+ func WithHost(host string) RecorderOption

+ type Route struct

+ Handler http.HandlerFunc

+ Method string

+ Path string

+ RawResponseBody string

+ ResponseBody any

+ ResponseStatusCode int

+ func (r *Route) ID() string

+ type RouteCall struct

+ Request *RouteCallRequest

+ Response *RouteCallResponse

+ RouteCallID string

+ RouteID string

+ type RouteCallRequest struct

+ Body []byte

+ Header http.Header

+ Method string

+ RemoteAddr string

+ URL *url.URL

+ type RouteCallResponse struct

+ Body []byte

+ Header http.Header

+ StatusCode int

+ type SaveFile struct

+ Recorders []string

+ Routes []*Route

+ type Server struct

+ func Wake(options ...ServerOption) (*Server, error)

+ func (p *Server) Address() string

+ func (p *Server) Call(method, path string) (*resty.Response, error)

+ func (p *Server) Delete(routeID string) error

+ func (p *Server) Record(recorderURL string) error

+ func (p *Server) Recorders() []string

+ func (p *Server) Register(route *Route) error

+ func (p *Server) Routes() []*Route

+ func (p *Server) Shutdown(ctx context.Context) error

+ func (p *Server) WaitShutdown()

+ type ServerOption func(*Server) error

+ func WithJSONLogs() ServerOption

+ func WithLogFile(logFile string) ServerOption

+ func WithLogLevel(level zerolog.Level) ServerOption

+ func WithLogger(l zerolog.Logger) ServerOption

+ func WithPort(port int) ServerOption

+ func WithRoutes(routes []*Route) ServerOption

+ func WithSaveFile(saveFile string) ServerOption