testcontainers-core 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1ecb046574448907ac650c801eda4e7dad34055c6a61fa06a0f066067e2b97
-  data.tar.gz: f9c49b86765f2166cf2460bef0899ba40a1b822bdf23451bbe1a3e68531606e4
+  metadata.gz: a5422789f7d26555fc9198f71b189ec3f75beba0dbaed0b66f541ef5513a9819
+  data.tar.gz: abd82854569df36e3581edc1eb6460af76f2cb3b570ec711131f24f351568f56
 SHA512:
-  metadata.gz: e6dfd296c157b51d3429f0c470e5ee1a46d15de6c47b1d417045260c55fed5482e8562a6bc8ac689254fc80a835dff36a0b2af26d6a5f11e75e162f546d15233
-  data.tar.gz: 77ed8e5fe3cc9df35744fdeccebb9cef54a3a359aa36afe90e0f9dcbd3375a16411db5132590746084c89c3f091b42eb021b033e9d4dce184a12de9499563b4f
+  metadata.gz: 7eebf9df18f1599e5a13928f163a5269b5b0e78297447ff04396db804bfe7f0ff2515b16da13180e504905bf81d533d9528d76bae8f52d2d55d4823d69aed209
+  data.tar.gz: 97461a668a41d5efb9c3c88cac46d2f4f308a5975bff34042bb78a7edf41b66a2f2a3426ffa8a39baa0efe6b70bc8949306e8372d40dc35a80e4ecd12b2e0574

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.2.0] - 2024-02-08
+
+### Added
+
+- DockerContainer#new now accepts optional keyword argument `image_create_options` which accepts a hash. Passes the options to `Docker::Image.create`. See the [Docker ImageCreate api](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageCreate) for available parameters.
+
+- DockerContainer#remove now accepts an optional options hash. See the [Docker ContainerDelete api](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerDelete) for available parameters.
+
 ## [0.1.3] - 2023-06-10
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    testcontainers-core (0.1.3)
+    testcontainers-core (0.2.0)
       docker-api (~> 2.2)
 
 GEM
@@ -57,6 +57,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/lib/testcontainers/docker_container.rb

@@ -30,6 +30,7 @@ module Testcontainers
     # @param command [Array<String>, nil] the command to run in the container
     # @param name [String, nil] the container's name
     # @param exposed_ports [Hash, Array<String>, nil] a hash or an array of exposed container ports
+    # @param image_create_options [Hash] a hash of options to pass to Docker::Image.create.
     # @param port_bindings [Hash, Array<String>, nil] a hash or an array of container ports to host port bindings
     # @param volumes [Hash, Array<String>, nil] a hash or an array of volume paths in the container
     # @param filesystem_binds [Array<String>, Hash, nil] an array of strings or a hash representing bind mounts from the host to the container
@@ -37,7 +38,7 @@ module Testcontainers
     # @param labels [Hash, nil] a hash of labels to be applied to the container
     # @param working_dir [String, nil] the working directory for the container
     # @param logger [Logger] a logger instance for the container
-    def initialize(image, name: nil, command: nil, entrypoint: nil, exposed_ports: nil, port_bindings: nil, volumes: nil, filesystem_binds: nil,
+    def initialize(image, name: nil, command: nil, entrypoint: nil, exposed_ports: nil, image_create_options: {}, port_bindings: nil, volumes: nil, filesystem_binds: nil,
       env: nil, labels: nil, working_dir: nil, healthcheck: nil, wait_for: nil, logger: Testcontainers.logger)
 
       @image = image
@@ -45,6 +46,7 @@ module Testcontainers
       @command = command
       @entrypoint = entrypoint
       @exposed_ports = add_exposed_ports(exposed_ports) if exposed_ports
+      @image_create_options = image_create_options
       @port_bindings = add_fixed_exposed_ports(port_bindings) if port_bindings
       @volumes = add_volumes(volumes) if volumes
       @env = add_env(env) if env
@@ -468,8 +470,9 @@ module Testcontainers
     #
     # @return [DockerContainer] The DockerContainer instance.
     # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [NotFoundError] If Docker is unable to find the image.
     def start
-      Docker::Image.create("fromImage" => @image)
+      Docker::Image.create({"fromImage" => @image}.merge(@image_create_options))
 
       @_container ||= Docker::Container.create(_container_create_options)
       @_container.start
@@ -482,6 +485,8 @@ module Testcontainers
       @wait_for&.call(self)
 
       self
+    rescue Docker::Error::NotFoundError => e
+      raise NotFoundError, e.message
     rescue Excon::Error::Socket => e
       raise ConnectionError, e.message
     end
@@ -530,11 +535,12 @@ module Testcontainers
 
     # Removes the container.
     #
+    # @param options [Hash] Additional options to send to the container remove command.
     # @return [DockerContainer] The DockerContainer instance.
     # @return [nil] If the container does not exist.
     # @raise [ConnectionError] If the connection to the Docker daemon fails.
-    def remove
-      @_container&.remove
+    def remove(options = {})
+      @_container&.remove(options)
       @_container = nil
       self
     rescue Excon::Error::Socket => e
@@ -732,6 +738,24 @@ module Testcontainers
       container_ports.map { |port| mapped_port(port) }.first
     end
 
+    # Returns the container's mounts.
+    #
+    # @return [Array<Hash>] An array of the container's mounts.
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def mounts
+      info["Mounts"]
+    end
+
+    # Returns the container's mount names.
+    #
+    # @return [Array<String>] The container's mount names.
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def mount_names
+      mounts.map { |mount| mount["Name"] }
+    end
+
     # Returns the value for the given environment variable.
     #
     # @param key [String] The environment variable's key.

data/lib/testcontainers/version.rb

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

data/lib/testcontainers.rb

@@ -12,6 +12,8 @@ module Testcontainers
 
   class ConnectionError < Error; end
 
+  class NotFoundError < Error; end
+
   class TimeoutError < Error; end
 
   class ContainerNotStartedError < Error; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcontainers-core
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Guillermo Iguaran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-10 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: Testcontainers for Ruby.