httpmock

package

v0.4.0 Latest Latest Go to latest Published: Oct 23, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/github/gh-actions-lock

Links

Open Source Insights

Documentation ¶

Overview ¶

Package httpmock provides HTTP test fakes for the ghapi client.

Index ¶

func BranchListResponse(pairs ...string) any
func BranchListResponseProtected(triples ...any) any
func CompareAncestorResponse(mergeBaseSHA string) any
func GitRefResponse(qualified, sha string) any
func NoTagsNamed(reg *Registry, owner, repo string)
func TagListResponse(pairs ...string) any
type Matcher
type Registry
type Responder

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BranchListResponse ¶

func BranchListResponse(pairs ...string) any

BranchListResponse builds a REST list-branches response body. pairs are (name, sha) alternating, e.g. BranchListResponse("main", "abc", "dev", "def"). All entries are marked protected:true so tests model trusted-upstream branches by default; use BranchListResponseProtected to mix protected and unprotected entries.

func BranchListResponseProtected ¶

func BranchListResponseProtected(triples ...any) any

BranchListResponseProtected builds a REST list-branches response body where each entry is a (name, sha, protected) triple.

func CompareAncestorResponse ¶

func CompareAncestorResponse(mergeBaseSHA string) any

CompareAncestorResponse builds a REST compare response indicating the requested sha is an ancestor of the head, with the given merge-base sha.

func GitRefResponse ¶ added in v0.3.0

func GitRefResponse(qualified, sha string) any

GitRefResponse is a git/ref body for the exact ref qualified (refs/tags/x or refs/heads/x) pointing at a commit.

func NoTagsNamed ¶ added in v0.3.0

func NoTagsNamed(reg *Registry, owner, repo string)

NoTagsNamed answers every exact tag lookup in owner/repo with 404, for tests whose branches have no same-named tag.

func TagListResponse ¶

func TagListResponse(pairs ...string) any

TagListResponse builds a REST list-tags response body. pairs are (name, sha) alternating.

Types ¶

type Matcher ¶

type Matcher func(req *http.Request) bool

Matcher determines whether a stub matches an outbound request.

func GraphQL ¶

func GraphQL(q string) Matcher

GraphQL matches a POST GraphQL request whose query matches q.

func GraphQLForRepo ¶

func GraphQLForRepo(owner, repo string) Matcher

GraphQLForRepo matches any GraphQL request whose query or variables reference the given repository owner/name. This is the preferred matcher for queries that pass owner/name through GraphQL `$variables` rather than interpolating them as string literals.

func REST ¶

func REST(method, pathPattern string) Matcher

REST matches a request by method and URL path pattern (regex).

func RESTWithQuery ¶

func RESTWithQuery(method, pathPattern, querySubstring string) Matcher

RESTWithQuery is like REST but also requires querySubstring to appear in the request's raw query string. Use this to distinguish calls that share a URL path but differ by query parameter (e.g. branches?protected=true vs branches?per_page=100).

type Registry ¶

type Registry struct {
	Requests []*http.Request
	// contains filtered or unexported fields
}

Registry records requests and serves stubbed responses. It mirrors the cli/cli pkg/httpmock usage pattern for deterministic API tests.

func (*Registry) Register ¶

func (r *Registry) Register(m Matcher, resp Responder)

Register adds a matcher/response pair to the registry.

func (*Registry) RegisterReusable ¶ added in v0.3.0

func (r *Registry) RegisterReusable(m Matcher, resp Responder)

RegisterReusable adds a matcher/response pair that serves every matching request rather than just the first. Verify doesn't require it to match.

func (*Registry) RoundTrip ¶

func (r *Registry) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip satisfies http.RoundTripper.

func (*Registry) Verify ¶

func (r *Registry) Verify(t *testing.T)

Verify fails the test if any registered stubs were never exercised.

type Responder ¶

type Responder func(req *http.Request) (*http.Response, error)

Responder builds an HTTP response for a matched request.

func GraphQLQuery ¶

func GraphQLQuery(body string, cb func(query string, variables map[string]any)) Responder

GraphQLQuery inspects the outbound GraphQL request before returning a body.

func JSONResponse ¶

func JSONResponse(body any) Responder

JSONResponse turns a value into a 200 JSON response.

func StatusResponse ¶

func StatusResponse(code int) Responder

StatusResponse returns a response with the given status code and empty body.

func StatusResponseWithHeaders ¶

func StatusResponseWithHeaders(code int, headers map[string]string) Responder

StatusResponseWithHeaders is StatusResponse with response headers — used by tests that exercise rate-limit fallbacks keyed off Retry-After or X-RateLimit-Reset / X-RateLimit-Remaining.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL