testcontainers-mongo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d719fe2e9a9aa14dd44903272285ec6446d2c9ec06ae96ec0d359aa4b0bbb17
+  data.tar.gz: 89c3e5567a55ff21d9c5a9df4a5ad31e44d022e7643ffd50e71b747d0fbe1f5b
+SHA512:
+  metadata.gz: ad814ad4f2f4846fd938bb6a7eb59aad6d5b041ccf1594c66d8bc73524c19ad10521e2daadd41353da1822a5150c7cec8f5efb6051df26e303feac5ea5b254fe
+  data.tar.gz: 7722a2ab869d1b49047228ed7ac2f3c3efc81fd583044acf290d93abfdcdc253847cfc82d9bcc3bf27423f927590a6a0a1c1df602bc91740281c1e97d78cd0fd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.0] - 2023-06-10
+
+### Added
+
+- Initial release of the Mongo module

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in testcontainers-mongo.gemspec
+gemspec
+
+# Use the latest version of testcontainers-core from the local path
+gem "testcontainers-core", path: "../core"

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.3)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-mongo (0.1.0)
+      testcontainers-core (~> 0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bson (4.15.0)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.99.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    minitest (5.18.0)
+    minitest-hooks (1.5.0)
+      minitest (> 5.3)
+    mongo (2.18.2)
+      bson (>= 4.14.1, < 5.0.0)
+    multi_json (1.15.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  mongo (~> 2.2)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-mongo!
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Guillermo Iguaran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# Testcontainers module for MongoDB
+
+testcontainers-mongo simplifies the creation and management of MongoDB containers for testing purposes using the Testcontainers library.
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem "testcontainers-mongo"
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-mongo
+```
+
+## Usage
+
+To use the library, you first need to require it:
+
+```ruby
+require "testcontainers/mongo"
+```
+
+### Creating a MongoDB container
+
+Create a new instance of the `Testcontainers::MongoContainer` class:
+
+```ruby
+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:
+
+```ruby
+container = Testcontainers::MongoContainer.new("mongo:5.7", username: "custom_user", password: "custom_pass", database: "custom_db")
+```
+
+### Starting and stopping the container
+
+Start the container:
+
+```ruby
+container.start
+```
+
+Stop the container when you're done:
+
+```ruby
+container.stop
+```
+
+### Connecting to the MongoDB container
+
+Once the container is running, you can obtain the connection details using the following methods:
+
+```ruby
+host = container.host
+port = container.first_mapped_port
+```
+
+Or, you can generate a full database URL:
+
+```ruby
+database_url = container.database_url
+```
+
+Use this URL to connect to the MongoDB container using your preferred MongoDB client library.
+
+### Customizing the container
+
+You can also customize the container using the following methods:
+
+```ruby
+container.with_database("custom_db")
+container.with_username("custom_user")
+container.with_password("custom_pass")
+```
+
+### Example
+
+Here's a complete example of how to use testcontainers-mongo to create a container, connect to it, and run a simple query:
+
+```ruby
+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.
+
+## 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).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/testcontainers/mongo/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Testcontainers
+  module Mongo
+    VERSION = "0.1.0"
+  end
+end

data/lib/testcontainers/mongo.rb

@@ -0,0 +1,115 @@
+require_relative "mongo/version"
+require "testcontainers"
+
+module Testcontainers
+  # MongoContainer class is used to manage containers that runs a Mongo databese
+  #
+  # @attr_reader [String] username used by the container
+  # @attr_reader [String] password used by the container
+  # @attr_reader [String] database used by the container
+  class MongoContainer < ::Testcontainers::DockerContainer
+    # Default port used by the container
+    MONGO_DEFAULT_PORT = 27017
+
+    # Default image used by the container
+    MONGO_DEFAULT_IMAGE = "mongo:latest"
+
+    MONGO_DEFAULT_USERNAME = "test"
+    MONGO_DEFAULT_PASSWORD = "test"
+    MONGO_DEFAULT_DATABASE = "test"
+
+    attr_reader :username, :password, :database
+
+    # Initializes a new instance of MongoContainer
+    #
+    # @param image [String] the image to use
+    # @param username [String] the username to use
+    # @param password [String] the password to use
+    # @param database [String] the database to use
+    # @param port [String] the port to use
+    # @param kwargs [Hash] the options to pass to the container. See {DockerContainer#initialize}
+    # @return [MongoContainer] a new instance of MongoContainer
+    def initialize(image = MONGO_DEFAULT_IMAGE, username: nil, password: nil, database: nil, **kwargs)
+      super(image, **kwargs)
+      @username = username || ENV.fetch("MONGO_USERNAME", MONGO_DEFAULT_USERNAME)
+      @password = password || ENV.fetch("MONGO_PASSWORD", MONGO_DEFAULT_PASSWORD)
+      @database = database || ENV.fetch("MONGO_DATABASE", MONGO_DEFAULT_DATABASE)
+      @healthcheck ||= add_healthcheck(_default_healthcheck_options)
+      @wait_for ||= add_wait_for(:healthcheck)
+    end
+
+    # Starts the container
+    #
+    # @return [MongoContainer] self
+    def start
+      with_exposed_ports(port)
+      _configure
+      super
+    end
+
+    # Returns the port used by the container
+    #
+    # @return [Integer] the port used by the container
+    def port
+      MONGO_DEFAULT_PORT
+    end
+
+    # Returns the database url (e.g. mongodb://user:password@host:port/database)
+    #
+    # @param protocol [String] the protocol to use in the string (default: "mongodb")
+    # @param database [String] the database to use in the string (default: @database)
+    # @param options [Hash] the options to use in the query string (default: {})
+    # @return [String] the database url
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def mongo_url(protocol: "mongodb", username: nil, password: nil, database: nil, options: {})
+      database ||= @database
+      username ||= @username
+      password ||= @password
+      query_string = options.empty? ? "" : "?#{URI.encode_www_form(options)}"
+
+      "#{protocol}://#{username}:#{password}@#{host}:#{mapped_port(port)}/#{database}#{query_string}"
+    end
+
+    alias_method :database_url, :mongo_url
+
+    # Sets the database to use
+    #
+    # @param database [String] the database to use
+    # @return [MongoContainer] self
+    def with_database(database)
+      @database = database
+      self
+    end
+
+    # Sets the username to use
+    #
+    # @param username [String] the password to use
+    # @return [MongoContainer] self
+    def with_username(username)
+      @password = password
+      self
+    end
+
+    # Sets the password to use
+    #
+    # @param password [String] the password to use
+    # @return [MongoContainer] self
+    def with_password(password)
+      @password = password
+      self
+    end
+
+    private
+
+    def _configure
+      add_env("MONGO_INITDB_DATABASE", @database)
+      add_env("MONGO_INITDB_ROOT_USERNAME", @username)
+      add_env("MONGO_INITDB_ROOT_PASSWORD", @password)
+    end
+
+    def _default_healthcheck_options
+      {test: ["mongosh", "--eval", "db.adminCommand('ping')"], interval: 5, timeout: 5, retries: 3}
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-mongo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Piza
+- Guillermo Iguaran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: testcontainers-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Testcontainers makes it easy to create and clean up container-based dependencies
+  for automated tests.
+email:
+- pedro920224@gmail.com
+- guilleiguaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testcontainers/mongo.rb
+- lib/testcontainers/mongo/version.rb
+homepage: https://github.com/testcontainers/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mongo
+  source_code_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mongo
+  changelog_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mongo/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: 'Testcontainers for Ruby: Mongo module'
+test_files: []