planfake

type ExpectedTarget ¶

type ExpectedTarget struct {
	Prefix    string
	Namespace string
	Table     string
}

ExpectedTarget is the decoded REST planning target accepted by a Scenario. Namespace uses the REST namespace path representation (components joined by the unit separator), while Prefix and Table are decoded path values.

type Request ¶

type Request struct {
	Method    string
	Path      string
	RawQuery  string
	Header    http.Header
	Body      []byte
	Prefix    string
	Namespace string
	Table     string
	PlanID    string
	PlanTask  string
}

Request is one request captured by the fake server. Path is the escaped wire path, which preserves opaque plan IDs containing slashes or dot segments. RawQuery is captured separately without decoding. Prefix, Namespace, Table, PlanID, and PlanTask are decoded routing values when applicable.

type Response ¶

type Response struct {
	Status int
	Header http.Header
	Body   json.RawMessage
	Gate   <-chan struct{}
}

Response is one HTTP response in a scenario. A zero Status means 200 OK. Header and Body are cloned when the server is created and again before a response is written, so callers may safely reuse or mutate their fixtures. When Gate is non-nil, the server waits for it to close or receive a value before writing the response. Cancelling the request releases the waiter; closing the Server aborts the gated connection without manufacturing a successful response.

func ConfigResponse(endpoints ...string) Response

type ResponseSequence ¶

type ResponseSequence struct {
	Responses  []Response
	RepeatLast bool
}

ResponseSequence is an ordered sequence of responses for one scenario key. Each request consumes the next response. Once exhausted, a sequence returns a non-retryable scenario error unless RepeatLast is true, in which case its final response is returned for every later request.

type Scenario ¶

type Scenario struct {
	ExpectedTarget  *ExpectedTarget
	ConfigResponse  Response
	PlanResponse    Response
	PollResponses   map[string]ResponseSequence
	TaskResponses   map[string]ResponseSequence
	CancelResponses map[string]ResponseSequence
}

Scenario declares the responses returned by a Server. ExpectedTarget is required for every planning operation; requests for another target, or a planning request made without an expected target, receive a non-retryable scenario error.

Poll responses are keyed by decoded plan ID, task responses by the plan-task value in the request body, and cancel responses by decoded plan ID. A missing key, empty sequence, or exhausted non-repeating sequence returns a clear, non-retryable scenario error.

An all-zero ConfigResponse or PlanResponse means that response was not configured. Use Response{Status: http.StatusOK} to model an intentional empty 200 response. Scenario errors fail the owning test during cleanup unless a test explicitly acknowledges their exact values with Server.AcknowledgeScenarioErrors.

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

Server is a concurrency-safe in-process REST scan-planning server.

func New(t testing.TB, scenario Scenario) *Server

func (s *Server) AcknowledgeScenarioErrors(want ...string) error

func (s *Server) CancelCount(planID string) int

func (s *Server) Close()

func (s *Server) PollCount(planID string) int

func (s *Server) Requests() []Request

func (s *Server) ScenarioErrors() []string

func (s *Server) TaskCount(planTask string) int

func (s *Server) URL() string

func (s *Server) WaitForPollCount(ctx context.Context, planID string, atLeast int) error