testcontainers-core 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e441d19cef355259e7534abac5b40cadb36f3eba448bc278347ef4ca538d5504
-  data.tar.gz: ebc882a7769376f0750b3d41a38789edeca15e097a76f77bd7930ddc7c422cfe
+  metadata.gz: 584f5aabce655fd2f113af37af6ce59cc8b3e0f6aa4b276bff52378e1d3c5e9d
+  data.tar.gz: 0a3c73c6a6ba495c61b3ded68092d4a58a06099e1ff543d7ac2a45e9503082a6
 SHA512:
-  metadata.gz: 5da561414803d9c460e90d3568f1d77567e9c0c23cdda6c81365baebded160a8be7e1edef7a48ac336ab7fcf5b9fe08316106ad5abc33311617af73f70e179a7
-  data.tar.gz: 74341dba25a2be881e8015b91bd206bc37948bd2bd844509553bfe60320e789684b197d1f2bc0f0008cd0342228144573aefda77b1af46ea30fc8f27ce8a62aa
+  metadata.gz: 18f526847480a5cec71aa4abf2b10393fa7a08ccf5c4f70a07c18667624a8fb49ca3f0d9d241f0f5dd9e32404f3e0e06fc2cb67465059703d5e9eec143c04f4e
+  data.tar.gz: fcc6793d0bbdf773de7e0cb5933364f45840c034c8821dd12ab99c17d08a05c23967d2b992d4152b2c7298eae12d75d751eaff8e83e21563a060647cdcbd1b67

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## [0.1.2] - 2023-05-13
+
+## Added
+
+- DockerContainer#first_mapped_port method returns the first of the
+  mapped ports for convenience.
+
+- DockerContainer#get_env(key) method to gets the value of a single
+  env variable in the container
+
+- Support custom healthchecks set with the new and
+  DockerContainer#add_/with_healthcheck methods. Example:
+
+  redis_container.with_healthcheck(test: ["redis-cli ping"], interval: 30, timeout: 30, retries: 3)
+
+## Changed
+
+- DockerContainer#mapped_port(port) method now returns an Integer instead of a String.
+
+## Fixed
+
+- Links to the GitHub project on the README.md file are fixed.
+
+- Healtchecks handling have been fixed
+
+## [0.1.1] - 2023-05-04
+
+### Added
+
+- Add .yardopts file to set the project ready for RubyDoc.info.
+
+## [0.1.0] - 2023-05-04
+
+### Added
+
+- Initial release of the project with the Testcontainer::DockerContainer working.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    testcontainers-core (0.1.0)
+    testcontainers-core (0.1.1)
       docker-api (~> 2.2)
 
 GEM

data/lib/testcontainers/docker_container.rb

@@ -13,11 +13,12 @@ module Testcontainers
   # @attr env [Array<String>, nil] an array of environment variables for the container in the format KEY=VALUE
   # @attr labels [Hash, nil] a hash of labels to be applied to the container
   # @attr working_dir [String, nil] the working directory for the container
+  # @attr healthcheck [Hash, nil] a hash of healthcheck options for the container
   # @attr logger [Logger] a logger instance for the container
   # @attr_reader _container [Docker::Container, nil] the underlying Docker::Container object
   # @attr_reader _id [String, nil] the container's ID
   class DockerContainer
-    attr_accessor :name, :image, :command, :exposed_ports, :port_bindings, :volumes, :filesystem_binds, :env, :labels, :working_dir
+    attr_accessor :name, :image, :command, :exposed_ports, :port_bindings, :volumes, :filesystem_binds, :env, :labels, :working_dir, :healthcheck
     attr_accessor :logger
     attr_reader :_container, :_id
 
@@ -35,7 +36,7 @@ module Testcontainers
     # @param working_dir [String, nil] the working directory for the container
     # @param logger [Logger] a logger instance for the container
     def initialize(image, command: nil, name: nil, exposed_ports: nil, port_bindings: nil, volumes: nil, filesystem_binds: nil, env: nil,
-      labels: nil, working_dir: nil, logger: Testcontainers.logger)
+      labels: nil, working_dir: nil, healthcheck: nil, logger: Testcontainers.logger)
 
       @image = image
       @command = command
@@ -47,6 +48,7 @@ module Testcontainers
       @filesystem_binds = add_filesystem_binds(filesystem_binds) if filesystem_binds
       @labels = add_labels(labels) if labels
       @working_dir = working_dir
+      @healthcheck = add_healthcheck(healthcheck) if healthcheck
       @logger = logger
       @_container = nil
       @_id = nil
@@ -206,6 +208,40 @@ module Testcontainers
       @labels
     end
 
+    # Adds a healthcheck to the container.
+    #
+    # @param options [Hash] the healthcheck options.
+    # @option options [Array|String] :test the command to run to check the health of the container.
+    # @option options [Float] :interval the time in seconds between health checks. (default: 30)
+    # @option options [Float] :timeout the time in seconds to wait for a health check to complete. (default: 30)
+    # @option options [Integer] :retries the number of times to retry a failed health check before giving up. (default: 3)
+    # @option options [Boolean] :shell whether or not to run the health check in a shell. (default: false)
+    # @return [Hash] the healthcheck options for Docker.
+    def add_healthcheck(options = {})
+      test = options[:test]
+
+      if test.nil?
+        @healthcheck = {"Test" => ["NONE"]}
+        return @healthcheck
+      end
+
+      interval = options[:interval]&.to_f || 30.0
+      timeout = options[:timeout]&.to_f || 30.0
+      retries = options[:retries]&.to_i || 3
+      shell = options[:shell] || false
+
+      test = test.split(" ") if test.is_a?(String)
+      test = shell ? test.unshift("CMD-SHELL") : test.unshift("CMD")
+
+      @healthcheck = {
+        "Test" => test,
+        "Interval" => (interval * 1_000_000_000).to_i,
+        "Timeout" => (timeout * 1_000_000_000).to_i,
+        "Retries" => retries,
+        "StartPeriod" => 0
+      }
+    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.
@@ -323,6 +359,20 @@ module Testcontainers
       self
     end
 
+    # Adds a healthcheck to the container.
+    #
+    # @param options [Hash] the healthcheck options.
+    # @option options [Array|String] :test the command to run to check the health of the container.
+    # @option options [Float] :interval the time in seconds between health checks. (default: 30)
+    # @option options [Float] :timeout the time in seconds to wait for a health check to complete. (default: 30)
+    # @option options [Integer] :retries the number of times to retry a failed health check before giving up. (default: 3)
+    # @option options [Boolean] :shell whether or not to run the health check in a shell. (default: false)
+    # @return [DockerContainer] The updated DockerContainer instance.
+    def with_healthcheck(options = {})
+      add_healthcheck(options)
+      self
+    end
+
     # Starts the container, yields the container instance to the block, and stops the container.
     #
     # @yield [DockerContainer] The container instance.
@@ -492,7 +542,7 @@ module Testcontainers
     # @raise [ConnectionError] If the connection to the Docker daemon fails.
     # @raise [HealthcheckNotSupportedError] If the container does not support healthchecks.
     def healthy?
-      if supports_healtcheck?
+      if supports_healthcheck?
         @_container&.json&.dig("State", "Health", "Status") == "healthy"
       else
         raise HealthcheckNotSupportedError
@@ -508,9 +558,9 @@ module Testcontainers
     #
     # @return [Boolean] Whether the container supports healthchecks.
     # @raise [ContainerNotStartedError] If the container has not been started.
-    def supports_healtcheck?
+    def supports_healthcheck?
       raise ContainerNotStartedError unless @_container
-      @_container.json["Config"]["Healthcheck"].present?
+      @_container.json["Config"]["Healthcheck"] != nil
     end
 
     # Returns whether the container exists.
@@ -573,8 +623,8 @@ module Testcontainers
 
     # Returns the mapped host port for the given container port.
     #
-    # @param port [Integer] The container port.
-    # @return [String] The mapped host port.
+    # @param port [Integer | String] The container port.
+    # @return [Integer] The mapped host port.
     # @raise [ConnectionError] If the connection to the Docker daemon fails.
     # @raise [ContainerNotStartedError] If the container has not been started.
     def mapped_port(port)
@@ -585,13 +635,32 @@ module Testcontainers
         gateway_ip = container_gateway_ip
         host = docker_host
 
-        return port if gateway_ip == host
+        return port.to_i if gateway_ip == host
       end
-      mapped_port
+      mapped_port.to_i
     rescue Excon::Error::Socket => e
       raise ConnectionError, e.message
     end
 
+    # Returns the container's first mapped port.
+    #
+    # @return [Integer] The container's first mapped port.
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    def first_mapped_port
+      raise ContainerNotStartedError unless @_container
+      container_ports.map { |port| mapped_port(port) }.first
+    end
+
+    # Returns the value for the given environment variable.
+    #
+    # @param key [String] The environment variable's key.
+    # @return [String] The environment variable's value.
+    # @return [nil] If the environment variable does not exist.
+    def get_env(key)
+      env_entry = env.find { |entry| entry.start_with?("#{key}=") }
+      env_entry&.split("=")&.last
+    end
+
     # Returns the container's logs.
     #
     # @param stdout [Boolean] Whether to return stdout.
@@ -830,6 +899,11 @@ module Testcontainers
       @_container&.json&.dig("NetworkSettings", "Ports", normalize_port(port))&.first&.dig("HostPort")
     end
 
+    def container_ports
+      ports = @_container&.json&.dig("NetworkSettings", "Ports")&.keys || []
+      ports&.map { |port| port.split("/").first }
+    end
+
     def default_gateway_ip
       cmd = "ip route | awk '/default/ { print $3 }'"
 
@@ -868,6 +942,7 @@ module Testcontainers
         "Env" => @env,
         "Labels" => @labels,
         "WorkingDir" => @working_dir,
+        "Healthcheck" => @healthcheck,
         "HostConfig" => {
           "PortBindings" => @port_bindings,
           "Binds" => @filesystem_binds

data/lib/testcontainers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Testcontainers
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/testcontainers.rb

@@ -20,6 +20,8 @@ module Testcontainers
 
   class PortNotMappedError < Error; end
 
+  class ContainerLaunchException < Error; end
+
   class << self
     attr_writer :logger
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcontainers-core
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Guillermo Iguaran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -88,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt