testcontainers-mongo simplifies the creation and management of MongoDB containers for testing purposes using the Testcontainers library.

Add the library to the test section in your application's Gemfile:

group :test do
  gem "testcontainers-mongo"
end

And then execute:

$ bundle install

Or install it yourself as:

$ gem install testcontainers-mongo

To use the library, you first need to require it:

require "testcontainers/mongo"

Create a new instance of the Testcontainers::MongoContainer class:

container = Testcontainers::MongoContainer.new

This creates a new container with the default MongoL image, user, password, and database. You can customize these by passing arguments to the constructor:

container = Testcontainers::MongoContainer.new("mongo:5.7", username: "custom_user", password: "custom_pass", database: "custom_db")

Start the container:

container.start

Stop the container when you're done:

container.stop

Once the container is running, you can obtain the connection details using the following methods:

host = container.host
port = container.first_mapped_port

Or, you can generate a full database URL:

database_url = container.database_url

Use this URL to connect to the MongoDB container using your preferred MongoDB client library.

You can also customize the container using the following methods:

container.with_database("custom_db")
container.with_username("custom_user")
container.with_password("custom_pass")

Here's a complete example of how to use testcontainers-mongo to create a container, connect to it, and run a simple query:

require "testcontainers/mongo"
require "mongo"

container = Testcontainers::MongoContainer.new
container.start

client = Mongo::Client.new(container.database_url, auth_source: "admin")

client[:artists].insert_one({:name => "FKA Twigs"})
client[:artists].find(:name => "FKA Twigs").each do |document|
  document.inspect
end

client.close
container.stop

This example creates a MongoDB container, connects to it using the mongo gem, inserts a a document, runs a query with find, and then stops the container.

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.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Testcontainers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.