Merge branch 'fix-wait-for'

guilleiguaran · guilleiguaran · commit 931f767df902 · 2025-10-19T18:33:48.000-05:00
diff --git a/core/Gemfile.lock b/core/Gemfile.lock
@@ -25,6 +25,7 @@ GEM
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     multi_json (1.17.0)
+    mutex_m (0.3.0)
     parallel (1.27.0)
     parser (3.3.9.0)
       ast (~> 2.4.1)
@@ -77,6 +78,7 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 5.0)
   minitest-hooks (~> 1.5)
+  mutex_m (~> 0.3)
   rake (~> 13.0)
   standard (~> 1.3)
   testcontainers-core!
diff --git a/core/lib/testcontainers/docker_container.rb b/core/lib/testcontainers/docker_container.rb
@@ -55,6 +55,7 @@ def initialize(image, name: nil, command: nil, entrypoint: nil, exposed_ports: n
       add_labels(labels) if labels
       @working_dir = working_dir
       @healthcheck = add_healthcheck(healthcheck) if healthcheck
+      @wait_for_user_defined = false
       @wait_for = add_wait_for(wait_for)
       @logger = logger
       @_container = nil
@@ -263,16 +264,19 @@ def add_wait_for(method = nil, *args, **kwargs, &block)
         if block
           if block.arity == 1
             @wait_for = block
+            @wait_for_user_defined = true
           else
             raise ArgumentError, "Invalid wait_for block: #{block}"
           end
         elsif @exposed_ports && !@exposed_ports.empty?
           port = @exposed_ports.keys.first.split("/").first
           @wait_for = ->(container) { container.wait_for_tcp_port(port) }
+          @wait_for_user_defined ||= false
         end
       elsif method.is_a?(Proc)
         if method.arity == 1
           @wait_for = method
+          @wait_for_user_defined = true
         else
           raise ArgumentError, "Invalid wait_for method: #{method}"
         end
@@ -282,20 +286,26 @@ def add_wait_for(method = nil, *args, **kwargs, &block)
         kwargs = method[2] || {}
         if respond_to?(method_name)
           @wait_for = ->(container) { container.send(method_name, *args, **kwargs) }
+          @wait_for_user_defined = true
         else
           raise ArgumentError, "Invalid wait_for method: #{method_name}"
         end
       else
         method_name = :"wait_for_#{method}"
         if respond_to?(method_name)
           @wait_for = ->(container) { container.send(method_name, *args, **kwargs) }
+          @wait_for_user_defined = true
         else
           raise ArgumentError, "Invalid wait_for method: #{method_name}"
         end
       end
       @wait_for
     end
 
+    def wait_for_user_defined?
+      @wait_for_user_defined
+    end
+
     # Set options for the container configuration using "with_" methods.
     #
     # @param options [Hash] A hash of options where keys correspond to "with_" methods and values are the arguments for those methods.
diff --git a/core/test/docker_container_test.rb b/core/test/docker_container_test.rb
@@ -281,6 +281,25 @@ def test_it_adds_a_wait_for_with_default
     assert_kind_of(Proc, container.wait_for)
   end
 
+  def test_wait_for_default_from_port_bindings_is_not_user_defined
+    container = Testcontainers::DockerContainer.new("hello-world", port_bindings: {80 => 8080})
+
+    refute container.wait_for_user_defined?
+  end
+
+  def test_wait_for_option_marks_user_defined
+    container = Testcontainers::DockerContainer.new("hello-world", wait_for: [:logs, /Hello from Docker!/])
+
+    assert container.wait_for_user_defined?
+  end
+
+  def test_add_wait_for_healthcheck_marks_user_defined
+    container = Testcontainers::DockerContainer.new("hello-world")
+    container.add_wait_for(:healthcheck)
+
+    assert container.wait_for_user_defined?
+  end
+
   def test_it_adds_a_wait_for_with_proc
     container = Testcontainers::DockerContainer.new("hello-world")
     container.add_wait_for(proc { |c| sleep 1 })
diff --git a/elasticsearch/lib/testcontainers/elasticsearch.rb b/elasticsearch/lib/testcontainers/elasticsearch.rb
@@ -30,7 +30,7 @@ def initialize(image = ELASTICSEARCH_DEFAULT_IMAGE, http_port: nil, tcp_port: ni
       @username = username || ELASTICSEARCH_DEFAULT_USERNAME
       @password = password || ELASTICSEARCH_DEFAULT_PASSWORD
       @healthcheck ||= add_healthcheck(_default_healthcheck_options)
-      @wait_for ||= add_wait_for(:healthcheck)
+      add_wait_for(:healthcheck) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/mariadb/Gemfile.lock b/mariadb/Gemfile.lock
@@ -5,6 +5,7 @@ PATH
       base64 (~> 0.3)
       docker-api (~> 2.4)
       java-properties (~> 0.3.0)
+      mutex_m (~> 0.3)
 
 PATH
   remote: .
@@ -18,8 +19,8 @@ GEM
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (3.3.1)
-    docker-api (2.2.0)
-      excon (>= 0.47.0)
+    docker-api (2.4.0)
+      excon (>= 0.64.0)
       multi_json
     excon (0.99.0)
     java-properties (0.3.0)
@@ -30,6 +31,7 @@ GEM
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     multi_json (1.15.0)
+    mutex_m (0.3.0)
     mysql2 (0.5.7)
       bigdecimal
     parallel (1.27.0)
diff --git a/mariadb/lib/testcontainers/mariadb.rb b/mariadb/lib/testcontainers/mariadb.rb
@@ -36,7 +36,7 @@ def initialize(image = MARIADB_DEFAULT_IMAGE, username: nil, password: nil, data
       @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)
+      add_wait_for(:healthcheck) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/mongo/lib/testcontainers/mongo.rb b/mongo/lib/testcontainers/mongo.rb
@@ -35,7 +35,7 @@ def initialize(image = MONGO_DEFAULT_IMAGE, username: nil, password: nil, databa
       @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)
+      add_wait_for(:healthcheck) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/mongo/testcontainers-mongo.gemspec b/mongo/testcontainers-mongo.gemspec
@@ -37,7 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest-hooks", "~> 1.5"
   spec.add_development_dependency "standard", "~> 1.3"
   spec.add_development_dependency "mongo", "~> 2.2"
-  spec.add_development_dependency "bigdecimal", "~> 3.1"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
diff --git a/mysql/Gemfile.lock b/mysql/Gemfile.lock
@@ -5,6 +5,7 @@ PATH
       base64 (~> 0.3)
       docker-api (~> 2.4)
       java-properties (~> 0.3.0)
+      mutex_m (~> 0.3)
 
 PATH
   remote: .
@@ -18,8 +19,8 @@ GEM
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (3.3.1)
-    docker-api (2.2.0)
-      excon (>= 0.47.0)
+    docker-api (2.4.0)
+      excon (>= 0.64.0)
       multi_json
     excon (0.99.0)
     java-properties (0.3.0)
@@ -30,6 +31,7 @@ GEM
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     multi_json (1.15.0)
+    mutex_m (0.3.0)
     mysql2 (0.5.7)
       bigdecimal
     parallel (1.27.0)
diff --git a/mysql/lib/testcontainers/mysql.rb b/mysql/lib/testcontainers/mysql.rb
@@ -37,7 +37,7 @@ def initialize(image = MYSQL_DEFAULT_IMAGE, username: nil, password: nil, databa
       @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)
+      add_wait_for(:healthcheck) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/nginx/lib/testcontainers/nginx.rb b/nginx/lib/testcontainers/nginx.rb
@@ -18,7 +18,7 @@ class NginxContainer < ::Testcontainers::DockerContainer
     # @return [NginxContainer] a new instance of NginxContainer
     def initialize(image = NGINX_DEFAULT_IMAGE, port: nil, **kwargs)
       super(image, **kwargs)
-      @wait_for ||= add_wait_for(:logs, /start worker process/)
+      add_wait_for(:logs, /start worker process/) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/postgres/Gemfile.lock b/postgres/Gemfile.lock
@@ -3,7 +3,7 @@ PATH
   specs:
     testcontainers-core (0.2.0)
       base64 (~> 0.3)
-      docker-api (~> 2.2)
+      docker-api (~> 2.4)
       java-properties (~> 0.3.0)
 
 PATH
@@ -17,8 +17,8 @@ GEM
   specs:
     ast (2.4.3)
     base64 (0.3.0)
-    docker-api (2.2.0)
-      excon (>= 0.47.0)
+    docker-api (2.4.0)
+      excon (>= 0.64.0)
       multi_json
     excon (0.99.0)
     java-properties (0.3.0)
@@ -29,6 +29,7 @@ GEM
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     multi_json (1.15.0)
+    mutex_m (0.3.0)
     parallel (1.27.0)
     parser (3.3.9.0)
       ast (~> 2.4.1)
@@ -82,6 +83,7 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 5.0)
   minitest-hooks (~> 1.5)
+  mutex_m (~> 0.3)
   pg (~> 1.5)
   rake (~> 13.0)
   standard (~> 1.3)
diff --git a/postgres/lib/testcontainers/postgres.rb b/postgres/lib/testcontainers/postgres.rb
@@ -36,7 +36,7 @@ def initialize(image = POSTGRES_DEFAULT_IMAGE, username: nil, password: nil, dat
       @password = password || ENV.fetch("POSTGRES_PASSWORD", POSTGRES_DEFAULT_PASSWORD)
       @database = database || ENV.fetch("POSTGRES_DATABASE", POSTGRES_DEFAULT_DATABASE)
       @healthcheck ||= add_healthcheck(_default_healthcheck_options)
-      @wait_for ||= add_wait_for(:healthcheck)
+      add_wait_for(:healthcheck) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/postgres/test/postgres_container_test.rb b/postgres/test/postgres_container_test.rb
@@ -80,4 +80,18 @@ def test_it_is_reachable
     client = PG.connect(host: @host, user: "test", password: "test", port: @port, dbname: "test")
     assert_equal({"number" => "1"}, client.exec("SELECT 1 AS number").first)
   end
+
+  def test_default_wait_for_is_healthcheck
+    expected = Testcontainers::PostgresContainer.new(wait_for: :healthcheck).wait_for
+    actual = Testcontainers::PostgresContainer.new.wait_for
+
+    assert_equal expected.source_location, actual.source_location
+  end
+
+  def test_default_wait_for_is_healthcheck_when_port_bindings_specified
+    expected = Testcontainers::PostgresContainer.new(wait_for: :healthcheck).wait_for
+    actual = Testcontainers::PostgresContainer.new(port_bindings: {5432 => 15432}).wait_for
+
+    assert_equal expected.source_location, actual.source_location
+  end
 end
diff --git a/redis/lib/testcontainers/redis.rb b/redis/lib/testcontainers/redis.rb
@@ -18,7 +18,7 @@ class RedisContainer < ::Testcontainers::DockerContainer
     # @return [RedisContainer] a new instance of RedisContainer
     def initialize(image = REDIS_DEFAULT_IMAGE, **kwargs)
       super
-      @wait_for ||= add_wait_for(:logs, /Ready to accept connections/)
+      add_wait_for(:logs, /Ready to accept connections/) unless wait_for_user_defined?
     end
 
     # Starts the container
diff --git a/selenium/lib/testcontainers/selenium.rb b/selenium/lib/testcontainers/selenium.rb
@@ -29,7 +29,7 @@ def initialize(image = nil, capabilities: :firefox, headless: false, vnc_no_pass
       @vnc_password = vnc_password
       @vnc_no_password = vnc_no_password
       @headless = headless
-      @wait_for ||= add_wait_for(:logs, /Started Selenium/)
+      add_wait_for(:logs, /Started Selenium/) unless wait_for_user_defined?
     end
 
     # Starts the container
