brokerclient

type BrokerError ¶

type BrokerError struct {
	Status  int
	Code    string
	Message string
}

BrokerError is the typed error returned for any non-2xx broker response. Code is brokerapi.ErrorResponse.Code (or HTTP%d if the envelope was missing). Status is the HTTP status code.

func (e *BrokerError) Error() string

type Client ¶

type Client struct {
	Endpoint     string
	TokenReader  TokenReader
	RunName      string
	RunNamespace string
	// contains filtered or unexported fields
}

Client is the shared HTTPS broker client. Operation-specific methods live in caller packages (controller's Issue, proxy's ValidateEgress / SubstituteAuth) — this struct only owns the plumbing.

Zero value not usable; construct via New.

Concurrency: Client itself is not safe for concurrent use. RunName and RunNamespace may be updated between calls when the same Client instance is reused across multiple runs (the controller reconcile loop does this); the surrounding call site must serialise such mutations. The proxy holds a Client per run and does not mutate these fields.

func New(opts Options) (*Client, error)

func NewForTest(opts Options, hc *http.Client) *Client

func (c *Client) Do(ctx context.Context, path string, body []byte) (*http.Response, error)

type Options ¶

type Options struct {
	// Endpoint is the broker's HTTPS base URL (no trailing slash
	// required; New trims it).
	Endpoint string

	// CABundlePath is the file holding the CA the broker's serving
	// cert chains to. Empty falls back to the system trust store —
	// only correct when the broker presents a publicly trusted cert,
	// which is not Paddock's default.
	CABundlePath string

	// TokenReader returns the SA bearer for every call. Required.
	TokenReader TokenReader

	// RunName / RunNamespace are attached as X-Paddock-Run /
	// X-Paddock-Run-Namespace on every outbound request. RunNamespace
	// may be empty (the broker then infers from the caller's SA).
	RunName      string
	RunNamespace string

	// Timeout caps each Do call (TLS handshake + request + response
	// read). Required — callers pick the budget appropriate to their
	// path.
	Timeout time.Duration
}

Options configures New.

type TokenReader ¶

type TokenReader func() ([]byte, error)

TokenReader returns the SA bearer token to attach to every outbound request. The default produced by FileTokenReader re-reads from disk on every call (the projected ServiceAccountToken file rotates on disk; an in-memory cache would invite expired-token failures after Pod lifetime ≥ the token's 1h TTL). Tests inject inline byte slices.

func FileTokenReader(path string) TokenReader