Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romnn/testcontainers
pre-configured testcontainers for your golang integration tests.
https://github.com/romnn/testcontainers
containers docker golang integration-testing kafka minio rabbitmq redis test-driven-development testcontainers testing-tools zookeeper
Last synced: about 2 months ago
JSON representation
pre-configured testcontainers for your golang integration tests.
- Host: GitHub
- URL: https://github.com/romnn/testcontainers
- Owner: romnn
- License: mit
- Created: 2020-04-24T18:00:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-17T15:42:58.000Z (over 1 year ago)
- Last Synced: 2024-11-17T03:12:56.813Z (about 2 months ago)
- Topics: containers, docker, golang, integration-testing, kafka, minio, rabbitmq, redis, test-driven-development, testcontainers, testing-tools, zookeeper
- Language: Go
- Homepage:
- Size: 225 KB
- Stars: 20
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## testcontainers, pre-configured
[](https://github.com/romnn/testcontainers)
[](https://godoc.org/github.com/romnn/testcontainers)
[](https://codecov.io/gh/romnn/testcontainers)
A collection of pre-configured [testcontainers](https://github.com/testcontainers/testcontainers-go) for your golang integration tests.
Available containers (feel free to contribute):
- MongoDB (based on [mongo](https://hub.docker.com/_/mongo))
- Kafka (based on [confluentinc/cp-kafka](https://hub.docker.com/r/confluentinc/cp-kafka) and [bitnami/zookeeper](https://hub.docker.com/r/bitnami/zookeeper))
- RabbitMQ (based on [rabbitmq](https://hub.docker.com/_/rabbitmq))
- Redis (based on [redis](https://hub.docker.com/_/redis/))
- Minio (based on [minio/minio](https://hub.docker.com/r/minio/minio))
### Usage
##### Redis
```go
// examples/redis/redis.go
package main
import (
"context"
"log"
"github.com/go-redis/redis"
tc "github.com/romnn/testcontainers"
tcredis "github.com/romnn/testcontainers/redis"
)
func main() {
container, err := tcredis.Start(context.Background(), tcredis.Options{
ImageTag: "7.0.5", // you could use latest here
})
if err != nil {
log.Fatalf("failed to start container: %v", err)
}
defer container.Terminate(context.Background())
// start logger
logger, err := tc.StartLogger(context.Background(), container.Container)
if err != nil {
log.Printf("failed to start logger: %v", err)
} else {
defer logger.Stop()
go logger.LogToStdout()
}
// connect to redis
db := redis.NewClient(&redis.Options{
Addr: container.ConnectionURI(),
Password: container.Password,
DB: 1,
})
// set some data
db.HSet("my-hash-key", "key", "Hello World!")
// get the data back
value, err := db.HGet("my-hash-key", "key").Result()
if err != nil {
log.Fatalf("failed to get value: %v", err)
}
if value != "Hello World!" {
log.Fatalf(`received %q instead of "Hello World!"`, value)
}
log.Printf("received %q from redis", value)
}
```
##### MongoDB
```go
// examples/mongo/mongo.go
package main
import (
"context"
"log"
"time"
tcmongo "github.com/romnn/testcontainers/mongo"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
)
func main() {
container, err := tcmongo.Start(context.Background(), tcmongo.Options{
ImageTag: "6.0.2", // you could use latest here
})
if err != nil {
log.Fatalf("failed to start container: %v", err)
}
defer container.Terminate(context.Background())
// connect to the container
uri := container.ConnectionURI()
client, err := mongo.NewClient(options.Client().ApplyURI(uri))
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
client.Connect(ctx)
// count documents in collection
collection := client.Database("testdatabase").Collection("my-collection")
opts := options.Count().SetMaxTime(2 * time.Second)
count, err := collection.CountDocuments(
context.TODO(),
bson.D{},
opts,
)
if err != nil {
log.Fatalf("failed to count docs in collection %q: %v", collection.Name(), err)
}
log.Printf("collection %q contains %d documents", collection.Name(), count)
}
```
For more examples, see `examples/`.
### Development
Before you get started, make sure you have installed the following tools:
$ python3 -m pip install pre-commit bump2version invoke
$ go install golang.org/x/tools/cmd/goimports@latest
$ go install golang.org/x/lint/golint@latest
$ go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
**Remember**: To be able to excecute the tools installed with `go install`,
make sure to include `$GOPATH/bin` in your `$PATH`.
If `echo $GOPATH` does not give you a path make sure to run
(`export GOPATH="$HOME/go"` to set it). In order for your changes to persist,
do not forget to add these to your shells `.bashrc`.
With the tools in place, it is strongly advised to install the git commit hooks to make sure checks are passing in CI:
```bash
invoke install-hooks
```
You can check if all checks pass at any time:
```bash
invoke pre-commit
```