Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/testcontainers/testcontainers-ruby
Testcontainers for Ruby
https://github.com/testcontainers/testcontainers-ruby
Last synced: 6 days ago
JSON representation
Testcontainers for Ruby
- Host: GitHub
- URL: https://github.com/testcontainers/testcontainers-ruby
- Owner: testcontainers
- License: mit
- Created: 2023-05-03T10:17:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-03T00:28:07.000Z (about 1 month ago)
- Last Synced: 2025-02-05T23:22:17.127Z (9 days ago)
- Language: Ruby
- Size: 268 KB
- Stars: 138
- Watchers: 5
- Forks: 19
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-testcontainers - Repository
- awesome-testcontainers - Repository
README
# Testcontainers
Testcontainers is a Ruby library that provides a convenient way to run Docker containers for your tests. It is inspired by the popular Testcontainers library for Java.
This library simplifies the process of managing Docker containers during testing, making it easier to ensure a consistent and isolated environment for each test. It supports a wide range of containers, including databases, message queues, and web servers.
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add testcontainers
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install testcontainers
## Usage
To use Testcontainers in your tests, first create and start a container in your test setup. For example, to run a Redis container:
```ruby
container = Testcontainers::DockerContainer.new("redis:6.2-alpine").with_exposed_port(6379)
container.start
```
In your tests, you can now access the container's host and mapped port:
```ruby
host = container.host
port = container.mapped_port(6379)
```
This allows you to connect to the containerized service and perform your tests. After running your tests, you can stop and delete the container:
```ruby
container.stop
container.delete
```
For a more detailed example, please refer to the Quickstart Guide under the docs folder.
### Included modules
Tescontainers contains modules that can be used instead of the generic
DockerContainer for common databases and services, providing
pre-configured setups and reducing the amount of boilerplate code:
- [ComposeContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/compose)
- [ElasticsearchContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/elasticsearch)
- [MariadbContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/mariadb)
- [MongoContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/mongo)
- [MysqlContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/mysql)
- [NginxContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/nginx)
- [PostgresContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/postgres)
- [RabbitmqContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/rabbitmq)
- [RedisContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/redis)
- [RedpandaContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/redpanda)
- [SeleniumContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/selenium)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/testcontainers/testcontainers-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/testcontainers/testcontainers-ruby/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Testcontainers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/testcontainers/testcontainers-ruby/blob/main/CODE_OF_CONDUCT.md).