Documentation
¶
Overview ¶
Package httpreplay provides an API for recording and replaying traffic from HTTP-based clients.
To record:
- Call NewRecorder to get a Recorder.
- Use its Client method to obtain an HTTP client to use when making API calls.
- Close the Recorder when you're done. That will save the log of interactions to the file you provided to NewRecorder.
To replay:
- Call NewReplayer with the same filename you used to record to get a Replayer.
- Call its Client method and use the client to make the same API calls. You will get back the recorded responses.
- Close the Replayer when you're done.
Although it has some features specific to Google HTTP APIs, this package can be used more generally.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DebugHeaders ¶
func DebugHeaders()
DebugHeaders helps to determine whether a header should be ignored. When true, if requests have the same method, URL and body but differ in a header, the first mismatched header is logged.
Types ¶
type Recorder ¶
type Recorder struct {
// contains filtered or unexported fields
}
A Recorder records HTTP interactions.
func NewRecorder ¶
NewRecorder creates a recorder that writes to filename. The file will also store initial state that can be retrieved to configure replay.
You must call Close on the Recorder to ensure that all data is written.
func (*Recorder) ClearHeaders ¶
ClearHeaders will replace the value of request and response headers that match any of the patterns with CLEARED, on both recording and replay. Use ClearHeaders when the header information is secret or may change from run to run, but you still want to verify that the headers are being sent and received.
Pattern is taken literally except for *, which matches any sequence of characters.
func (*Recorder) ClearQueryParams ¶
ClearQueryParams will replace the value of URL query parametrs that match any of the patterns with CLEARED, on both recording and replay. Use ClearQueryParams when the parameter information is secret or may change from run to run, but you still want to verify that it are being sent.
Pattern is taken literally except for *, which matches any sequence of characters.
func (*Recorder) Close ¶
Close closes the Recorder and saves the log file.
Since Close writes a file, you should always check that it returns a non-nil error.
func (*Recorder) RemoveQueryParams ¶
RemoveQueryParams will remove URL query parameters matching patterns from the log, and skip matching them during replay.
Pattern is taken literally except for *, which matches any sequence of characters.
func (*Recorder) RemoveRequestHeaders ¶
RemoveRequestHeaders will remove request headers matching patterns from the log, and skip matching them during replay.
Pattern is taken literally except for *, which matches any sequence of characters.
type Replayer ¶
type Replayer struct {
// contains filtered or unexported fields
}
A Replayer replays previously recorded HTTP interactions.
func NewReplayer ¶
NewReplayer creates a replayer that reads from filename.
func (*Replayer) Client ¶
Client returns an HTTP client for replaying.
The client does not need to be configured with credentials for authenticating to a server, since it never contacts a real backend.
func (*Replayer) IgnoreHeader ¶
IgnoreHeader will not use h when matching requests.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package google provides a way to obtain an http.Client for Google Cloud Platform APIs.
|
Package google provides a way to obtain an http.Client for Google Cloud Platform APIs. |
|
internal
|
|
|
proxy
Package proxy provides a record/replay HTTP proxy.
|
Package proxy provides a record/replay HTTP proxy. |