Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiremock/wiremock-testcontainers-go
WireMock module for Testcontainers Go
https://github.com/wiremock/wiremock-testcontainers-go
api go golang hacktoberfest testcontainer testcontainers wiremock
Last synced: 5 days ago
JSON representation
WireMock module for Testcontainers Go
- Host: GitHub
- URL: https://github.com/wiremock/wiremock-testcontainers-go
- Owner: wiremock
- License: apache-2.0
- Created: 2023-06-29T11:49:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-09T21:25:47.000Z (3 months ago)
- Last Synced: 2024-08-09T22:35:18.289Z (3 months ago)
- Topics: api, go, golang, hacktoberfest, testcontainer, testcontainers, wiremock
- Language: Go
- Homepage: https://wiremock.org/docs/solutions/testcontainers/
- Size: 246 KB
- Stars: 10
- Watchers: 2
- Forks: 11
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# WireMock Module for Testcontainers Go
[](http://godoc.org/github.com/wiremock/wiremock-testcontainers-go)
[](https://github.com/wiremock/wiremock-testcontainers-go/releases)
[](https://slack.wiremock.org/)
[](https://github.com/wiremock/wiremock-testcontainers-go/graphs/contributors)
This module allows provisioning the [WireMock API mock server](https://wiremock.org/?utm_medium=referral&utm_campaign=wiremock-testcontainers) as a standalone container within your unit tests,
based on the official [WireMock Docker](https://github.com/wiremock/wiremock-docker) images (`2.35.0-1` or above) or compatible custom images.
You can learn more about WireMock and Golang on this [WireMock solutions page](https://wiremock.org/docs/solutions/golang/?utm_medium=referral&utm_campaign=wiremock-testcontainers).
## Supported features
The following features are now explicitly included in the module's API:
- Passing API Mapping and Resource files
- Sending HTTP requests to the mocked container
- Embedded [Go WireMock](https://github.com/wiremock/go-wiremock/) client
for interacting with the WireMock container REST API
More features will be added over time.
## Quick Start
See the [Quick Start Guide](./docs/quickstart.md).
Just a teaser of how it feels at the real speed!
## Requirements
- Golang version 1.17 or above, so all modern Golang projects should be compatible with it.
- The module supports the official [WireMock Docker](https://github.com/wiremock/wiremock-docker) images 2.35.0-1 or above.
- Custom images are supported too as long as they follow the same CLI and API structure.
## Usage
```golang
import (
"context"
. "github.com/wiremock/wiremock-testcontainers-go"
"testing"
)
func TestWireMock(t *testing.T) {
// Create Container
ctx := context.Background()
container, err := RunContainerAndStopOnCleanup(ctx,
WithMappingFile("hello", "hello-world.json"),
)
if err != nil {
t.Fatal(err)
}
// Send the HTTP GET request to the mocked API
statusCode, out, err := SendHttpGet(container, "/hello", nil)
if err != nil {
t.Fatal(err, "Failed to get a response")
}
// Verify the response
if statusCode != 200 {
t.Fatalf("expected HTTP-200 but got %d", statusCode)
}
if string(out) != "Hello, world!" {
t.Fatalf("expected 'Hello, world!' but got %v", string(out))
}
}
```
## Examples
- [Quick Start Guide](./docs/quickstart.md) - [sources](./examples/quickstart/)
- [Using the REST API Client](./examples/using_api_client/)
## License
The module is licensed under [Apache License v.2](./LICENSE)
## References
- [WireMock Website](https://wiremock.org/?utm_medium=referral&utm_campaign=wiremock-testcontainers)
- [WireMock and Golang Solutions page](https://wiremock.org/docs/solutions/golang/?utm_medium=referral&utm_campaign=wiremock-testcontainers)
- [Testcontainers for Go](https://golang.testcontainers.org/)
- [WireMock Module page on the Testcontainers marketplace](https://testcontainers.com/modules/wiremock/)