testcontainers-mariadb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ddda1e688d370cee4be396c175b28c4943ffcc29e9bc9279826c5dafb29f5013
+  data.tar.gz: 35acaa90e1cbbdbd0bdbc68b77d0e60e5d0fe09f6c8f266b4a6421b1526e65eb
+SHA512:
+  metadata.gz: 84f999615a260a04a663eee1e0f1ecab3ab22d60a65211565fd0c98bd93ff76bbd422d77749b5f972e6567c67a074b13ccedc5f8c89cb6416416ea8b5f74fa71
+  data.tar.gz: d890faef3913f657a509442b0a5147a28358ca14265d46c8510ea0d2d011dbfd0806a73e332801bd79fea32eb82b026ab1a135d0795cc0a47369ef1732888917

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.0] - 2023-05-13
+
+### Added
+
+- Initial release of the MariaDB module

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.3)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-mariadb (0.1.0)
+      testcontainers-core (~> 0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    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)
+    multi_json (1.15.0)
+    mysql2 (0.5.5)
+    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
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  mysql2 (~> 0.5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-mariadb!
+
+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,147 @@
+# Testcontainers module for MariaDB
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem "testcontainers-mariadb"
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-mariadb
+```
+
+## Usage
+
+To use the library, you first need to require it:
+
+```ruby
+require "testcontainers/mariadb"
+```
+
+### Creating a MariaDB container
+
+Create a new instance of the `Testcontainers::MariadbContainer` class:
+
+```ruby
+container = Testcontainers::MariadbContainer.new
+```
+
+
+This creates a new container with the default MariaDB image, user, password, and database. You can customize these by passing arguments to the constructor:
+
+```ruby
+container = Testcontainers::MariadbContainer.new("mariadb:10.10", 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 MariaDB 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 MariaDB container using your preferred MySQL 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-mysdql to create a container, connect to it, and run a simple query:
+
+```ruby
+require "testcontainers/mariadb"
+require "mysql2"
+
+container = Testcontainers::MariadbContainer.new
+container.start
+
+client = Mysql2::Client.new(url: container.database_url)
+
+result = client.query("SELECT 1")
+result.each do |row|
+  puts row.inspect
+end
+
+client.close
+container.stop
+```
+
+This example creates a MariaDB container, connects to it using the `mysql2` gem, runs a simple `SELECT 1` query, and then stops the container.
+
+### Using with RSpec
+
+You can manage the container in the `before(:suite)` / `after(:suite)` blocks in your `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  # This helps us to have access to the `RSpec.configuration.mariadb_container` without using global variables.
+  config.add_setting :mariadb_container, default: nil
+
+  config.before(:suite) do
+    config.mariadb_container = Testcontainers::MariadbContainer.new.start
+    ENV["DATABASE_URL"] = config.mariadb_container.database_url(protocol: "mysql2") # or you can expose it to a fixed port and use database.yml for configuration
+  end
+
+  config.after(:suite) do
+    config.mariadb_container&.stop
+    config.mariadb_container&.remove
+  end
+end
+```
+
+## 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/mariadb/version.rb

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

data/lib/testcontainers/mariadb.rb

@@ -0,0 +1,132 @@
+require_relative "mariadb/version"
+require "testcontainers"
+
+module Testcontainers
+  # MariadbContainer class is used to manage containers that runs a MariaDB database
+  #
+  # @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 MariadbContainer < ::Testcontainers::DockerContainer
+    # Default port used by the container
+    MARIADB_DEFAULT_PORT = 3306
+
+    # Default image used by the container
+    MARIADB_DEFAULT_IMAGE = "mariadb:latest"
+
+    MARIADB_DEFAULT_USERNAME = "test"
+    MARIADB_DEFAULT_PASSWORD = "test"
+    MARIADB_DEFAULT_ROOT_USERNAME = "root"
+    MARIADB_DEFAULT_DATABASE = "test"
+
+    attr_reader :username, :password, :database
+
+    # Initializes a new instance of MariadbContainer
+    #
+    # @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 [MariadbContainer] a new instance of MariadbContainer
+    def initialize(image = MARIADB_DEFAULT_IMAGE, username: nil, password: nil, database: nil, port: nil, **kwargs)
+      super(image, **kwargs)
+      @username = username || ENV.fetch("MARIADB_USER", MARIADB_DEFAULT_USERNAME)
+      @password = password || ENV.fetch("MARIADB_PASSWORD", MARIADB_DEFAULT_PASSWORD)
+      @database = database || ENV.fetch("MARIADB_DATABASE", MARIADB_DEFAULT_DATABASE)
+      @healthcheck ||= add_healthcheck(_default_healthcheck_options)
+      @wait_for ||= add_wait_for(:healthcheck)
+    end
+
+    # Starts the container
+    #
+    # @return [MariadbContainer] self
+    def start
+      with_exposed_ports(port)
+      _configure
+      super
+    end
+
+    # Returns the host used to connect to the container
+    # If the host is "localhost", it is replaced by "127.0.0.1" since MariaDB fallbacks
+    # to a socket connection with "localhost"
+    #
+    # @return [String] the host used to connect to the container
+    def host
+      host = super
+      (host == "localhost") ? "127.0.0.1" : host
+    end
+
+    # Returns the port used by the container
+    #
+    # @return [Integer] the port used by the container
+    def port
+      MARIADB_DEFAULT_PORT
+    end
+
+    # Returns the database url (e.g. mariadb://user:password@host:port/database)
+    #
+    # @param protocol [String] the protocol to use in the string (default: "mariadb")
+    # @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 database_url(protocol: "mariadb", 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
+
+    # Sets the database to use
+    #
+    # @param database [String] the database to use
+    # @return [MariadbContainer] self
+    def with_database(database)
+      @database = database
+      self
+    end
+
+    # Sets the username to use
+    #
+    # @param username [String] the username to use
+    # @return [MariadbContainer] self
+    def with_username(username)
+      @username = username
+      self
+    end
+
+    # Sets the password to use
+    #
+    # @param password [String] the password to use
+    # @return [MariadbContainer] self
+    def with_password(password)
+      @password = password
+      self
+    end
+
+    private
+
+    def _configure
+      add_env("MARIADB_DATABASE", @database)
+      add_env("MARIADB_USER", @username) if @username != MARIADB_DEFAULT_ROOT_USERNAME
+
+      if !@password.nil? && !@password.empty?
+        add_env("MARIADB_PASSWORD", @password)
+        add_env("MARIADB_ROOT_PASSWORD", @password)
+      elsif @username == MARIADB_DEFAULT_ROOT_USERNAME
+        add_env("MARIADB_ALLOW_EMPTY_PASSWORD", "yes")
+      else
+        raise ContainerLaunchException, "Password is required for non-root users"
+      end
+    end
+
+    def _default_healthcheck_options
+      {test: ["/usr/bin/mysql", "--protocol=TCP", "--port=#{port}", "--user=#{username}", "--password=#{password}", database, "--silent", "--execute=SELECT 1;"], interval: 1, timeout: 5, retries: 5}
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-mariadb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 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: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Testcontainers makes it easy to create and clean up container-based dependencies
+  for automated tests.
+email:
+- guilleiguaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testcontainers/mariadb.rb
+- lib/testcontainers/mariadb/version.rb
+homepage: https://github.com/testcontainers/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mariadb
+  source_code_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mariadb
+  changelog_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mariadb/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: Mariadb module'
+test_files: []