https://github.com/wiremock/go-wiremock
Golang WireMock admin API client
https://github.com/wiremock/go-wiremock
golang hacktoberfest wiremock wiremock-admin
Last synced: 6 months ago
JSON representation
Golang WireMock admin API client
- Host: GitHub
- URL: https://github.com/wiremock/go-wiremock
- Owner: wiremock
- License: mit
- Created: 2020-10-18T13:33:30.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T20:55:55.000Z (12 months ago)
- Last Synced: 2025-04-02T06:07:34.961Z (6 months ago)
- Topics: golang, hacktoberfest, wiremock, wiremock-admin
- Language: Go
- Homepage: https://pkg.go.dev/github.com/wiremock/go-wiremock?utm_source=godoc
- Size: 295 KB
- Stars: 51
- Watchers: 3
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-wiremock
[](http://godoc.org/github.com/wiremock/go-wiremock)
[](https://github.com/wiremock/go-wiremock/actions?query=workflow%3Abuild)
[](https://slack.wiremock.org/)
[](https://goreportcard.com/report/github.com/wiremock/go-wiremock)
The Golang client library to stub API resources in [WireMock](https://wiremock.org) using its
[REST API](https://wiremock.org/docs/api/).
The project connects to the instance and allows
setting up stubs and response templating,
or using administrative API to extract observability data.
Learn more: [Golang & WireMock Solutions page]( https://wiremock.org/docs/solutions/golang/)
## Documentation
[](http://godoc.org/github.com/wiremock/go-wiremock)
## Compatibility
The library was tested with the following distributions
of WireMock:
- WireMock 2.x - standalone deployments, including but not limited to official Docker images, Helm charts and the Java executable
- WireMock 3.x Beta - partial support, some features are
yet to be implemented. Contributions are welcome!
- [WireMock Cloud](https://www.wiremock.io/product) -
proprietary SaaS edition by WireMock Inc.
Note that the CI pipelines run only against the official community distributions of WireMock.
It may work for custom builds and other distributions.
Should there be any issues, contact their vendors/maintainers.
## Usage
Launch a standalone Docker instance:
```shell
docker run -it --rm -p 8080:8080 wiremock/wiremock
```
Connect to it using the client library:
```go
package main
import (
"net/http"
"testing"
"github.com/wiremock/go-wiremock"
)
func TestSome(t *testing.T) {
wiremockClient := wiremock.NewClient("http://0.0.0.0:8080")
defer wiremockClient.Reset()
// stubbing POST http://0.0.0.0:8080/example
wiremockClient.StubFor(wiremock.Post(wiremock.URLPathEqualTo("/example")).
WithQueryParam("firstName", wiremock.EqualTo("John")).
WithQueryParam("lastName", wiremock.NotMatching("Black")).
WithBodyPattern(wiremock.EqualToJson(`{"meta": "information"}`)).
WithHeader("x-session", wiremock.Matching("^\\S+fingerprint\\S+$")).
WithBearerToken(wiremock.StartsWith("token")).
WillReturnResponse(
wiremock.NewResponse().
WithJSONBody(map[string]interface{}{
"code": 400,
"detail": "detail",
}).
WithHeader("Content-Type", "application/json").
WithStatus(http.StatusBadRequest),
).
AtPriority(1))
// scenario
defer wiremockClient.ResetAllScenarios()
wiremockClient.StubFor(wiremock.Get(wiremock.URLPathEqualTo("/status")).
WillReturnResponse(
wiremock.NewResponse().
WithJSONBody(map[string]interface{}{
"status": nil,
}).
WithHeader("Content-Type", "application/json").
WithStatus(http.StatusOK),
).
InScenario("Set status").
WhenScenarioStateIs(wiremock.ScenarioStateStarted))
wiremockClient.StubFor(wiremock.Post(wiremock.URLPathEqualTo("/state")).
WithBodyPattern(wiremock.EqualToJson(`{"status": "started"}`)).
InScenario("Set status").
WillSetStateTo("Status started"))
statusStub := wiremock.Get(wiremock.URLPathEqualTo("/status")).
WillReturnResponse(
wiremock.NewResponse().
WithJSONBody(map[string]interface{}{
"status": "started",
}).
WithHeader("Content-Type", "application/json").
WithStatus(http.StatusOK),
).
InScenario("Set status").
WhenScenarioStateIs("Status started")
wiremockClient.StubFor(statusStub)
//testing code...
verifyResult, _ := wiremockClient.Verify(statusStub.Request(), 1)
if !verifyResult {
//...
}
wiremockClient.DeleteStub(statusStub)
}
```
## Support for Authentication Schemes
The library provides support for common authentication schemes, i.e.: Basic Authentication, API Token Authentication, Bearer Authentication, Digest Access Authentication.
All of them are equivalent to manually specifying the "Authorization" header value with the appropriate prefix.
E.g. `WithBearerToken(wiremock.EqualTo("token123")).` works the same as `WithHeader("Authorization", wiremock.EqualTo("Bearer token123")).`.
### Example of usage
```go
basicAuthStub := wiremock.Get(wiremock.URLPathEqualTo("/basic")).
WithBasicAuth("username", "password"). // same as: WithHeader("Authorization", wiremock.EqualTo("Basic dXNlcm5hbWU6cGFzc3dvcmQ=")).
WillReturnResponse(wiremock.NewResponse().WithStatus(http.StatusOK))
bearerTokenStub := wiremock.Get(wiremock.URLPathEqualTo("/bearer")).
WithBearerToken(wiremock.Matching("^\\S+abc\\S+$")). // same as: WithHeader("Authorization", wiremock.Matching("^Bearer \\S+abc\\S+$")).
WillReturnResponse(wiremock.NewResponse().WithStatus(http.StatusOK))
apiTokenStub := wiremock.Get(wiremock.URLPathEqualTo("/token")).
WithAuthToken(wiremock.StartsWith("myToken123")). // same as: WithHeader("Authorization", wiremock.StartsWith("Token myToken123")).
WillReturnResponse(wiremock.NewResponse().WithStatus(http.StatusOK))
digestAuthStub := wiremock.Get(wiremock.URLPathEqualTo("/digest")).
WithDigestAuth(wiremock.Contains("realm")). // same as: WithHeader("Authorization", wiremock.StartsWith("Digest ").And(Contains("realm"))).
WillReturnResponse(wiremock.NewResponse().WithStatus(http.StatusOK))
```
## License
[MIT License](./LICENSE)
## See also
- [Golang & WireMock Solutions page]( https://wiremock.org/docs/solutions/golang/)
- [WireMock module for Testcontainers Go](https://wiremock.org/docs/solutions/testcontainers/)