testcontainers-mysql 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6cb938c40f21035fe967d0ac06a0a09dc6d3f976d94e51cadd5363721ad11bb
-  data.tar.gz: 236c54c790761d62ad9c87b427ac60be26ed5cb99b60d73e554096d7b7f302eb
+  metadata.gz: 321c7acc969cd09e9abb47ad22be5146f1ced8f11024778b29efc2e06a9a74a6
+  data.tar.gz: d86b26751a25a110d19f35df5359773fcb09bcfbf9dd97782cd99cf38db5ba8e
 SHA512:
-  metadata.gz: e51a9a3e5e4333eef7f9c092f6092f787eabb154300340ecf1b0b98a2e12fe97b62daa33b399bd9b5fab91fa0d2cddb7526ac14bf05af144b0933b99dee03fc9
-  data.tar.gz: 306ce8bb8cf32455ec2fb0bc50abfbf25aaff041b356349ed328270e2860008185d0c710e78148312e328b41d38185b7ad57e3bc63e97518e11cc98385a7f006
+  metadata.gz: 246f7ccb0eb529035ff205becfb14ad1c72103239dc2b7349a6ac51b33c45709d0f2f89e3402e99b1cd54217049755340184aad1cb71608910a2b478db3d6a42
+  data.tar.gz: 9e4872a00506ff9518ee49a9bf8272eedd2c645dfe5f8bea7402c1c78c2f777dacdc7096dde92faae2578a06886f591878f7821f690634f527cc320d0289bdd9

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.1.1] - 2023-06-10
+
+### Added
+
+- Add healthcheck support on start
+
+### Fixed
+
+- Remove support for custom ports, it is not supported by underlying
+  images.
+
 ## [0.1.0] - 2023-05-13
 
 ### Added

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../core
   specs:
-    testcontainers-core (0.1.1)
+    testcontainers-core (0.1.3)
       docker-api (~> 2.2)
 
 PATH
   remote: .
   specs:
-    testcontainers-mysql (0.1.0)
-      testcontainers-core (~> 0.1.1)
+    testcontainers-mysql (0.1.1)
+      testcontainers-core (~> 0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -79,7 +79,6 @@ port = container.first_mapped_port
 ```
 
 
-
 Or, you can generate a full database URL:
 
 ```ruby
@@ -122,11 +121,30 @@ container.stop
 
 This example creates a MySQL container, connects to it using the `mysql2` gem, runs a simple `SELECT 1` query, and then stops the container.
 
-### Example with RSpec
+### 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.mysql_container` without using global variables.
+  config.add_setting :mysql, default: nil
+
+  config.before(:suite) do
+    config.mysql_container = Testcontainers::MysqlContainer.new.start
+    ENV["DATABASE_URL"] = config.mysql_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.mysql_container&.stop
+    config.mysql_container&.remove
+  end
+end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/guilleiguaran/testcontainers. 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/guilleiguaran/testcontainers/blob/main/CODE_OF_CONDUCT.md).
+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
 
@@ -134,4 +152,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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/guilleiguaran/testcontainers/blob/main/CODE_OF_CONDUCT.md).
+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/lib/testcontainers/mysql/version.rb

@@ -2,6 +2,6 @@
 
 module Testcontainers
   module Mysql
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/testcontainers/mysql.rb

@@ -5,7 +5,6 @@ require "uri"
 module Testcontainers
   # MysqlContainer class is used to manage containers that runs a MySQL database
   #
-  # @attr_reader [String] port used by the container
   # @attr_reader [String] username used by the container
   # @attr_reader [String] password used by the container
   # @attr_reader [String] database used by the container
@@ -21,7 +20,7 @@ module Testcontainers
     MYSQL_DEFAULT_ROOT_USERNAME = "root"
     MYSQL_DEFAULT_DATABASE = "test"
 
-    attr_reader :port, :username, :password, :database
+    attr_reader :username, :password, :database
 
     # Initializes a new instance of MysqlContainer
     #
@@ -34,17 +33,18 @@ module Testcontainers
     # @return [MysqlContainer] a new instance of MysqlContainer
     def initialize(image = MYSQL_DEFAULT_IMAGE, username: nil, password: nil, database: nil, port: nil, **kwargs)
       super(image, **kwargs)
-      @port = port || ENV.fetch("MYSQL_PORT", MYSQL_DEFAULT_PORT)
       @username = username || ENV.fetch("MYSQL_USER", MYSQL_DEFAULT_USERNAME)
       @password = password || ENV.fetch("MYSQL_PASSWORD", MYSQL_DEFAULT_PASSWORD)
       @database = database || ENV.fetch("MYSQL_DATABASE", MYSQL_DEFAULT_DATABASE)
+      @healthcheck ||= add_healthcheck(_default_healthcheck_options)
+      @wait_for ||= add_wait_for(:healthcheck)
     end
 
     # Starts the container
     #
     # @return [MysqlContainer] self
     def start
-      with_exposed_ports(@port)
+      with_exposed_ports(port)
       _configure
       super
     end
@@ -59,6 +59,13 @@ module Testcontainers
       (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
+      MYSQL_DEFAULT_PORT
+    end
+
     # Returns the database url (e.g. mysql://user:password@host:port/database)
     #
     # @param protocol [String] the protocol to use in the string (default: "mysql")
@@ -118,5 +125,9 @@ module Testcontainers
         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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcontainers-mysql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Guillermo Iguaran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: testcontainers-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -110,13 +110,13 @@ files:
 - Rakefile
 - lib/testcontainers/mysql.rb
 - lib/testcontainers/mysql/version.rb
-homepage: https://github.com/guilleiguaran/testcontainers-ruby
+homepage: https://github.com/testcontainers/testcontainers-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/mysql
-  source_code_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/mysql
-  changelog_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/mysql/CHANGELOG.md
+  homepage_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mysql
+  source_code_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mysql
+  changelog_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/mysql/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: