testcontainers-compose 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2ea689b10ff1396275d2395062aff23e77feb3edffc83ab7cecd7eb0a097d04
+  data.tar.gz: c995e21fa6fe265632fb397ad3b8fba2e8c50ecc6c9d667a7f0ac560aee43b3f
+SHA512:
+  metadata.gz: 8e97904d1097e1d11ffb9d6436a107e664e826fdf150cd2eb8325478eacebbb41b066b70ab3d26c2cb736481aec95dfe830598769304ff72564d6f3caff47792
+  data.tar.gz: f121dfbea69d3e89f26c3593e73b30f85d82a56442b68befe7e148ddd74abbfea0080f1dda3189e5a84b08b7f956430ba6f85ba63d3d96c920dfc75ff02274d3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.2.0] - 2024-02-08
+
+### Added
+
+- Initial release of the Docker Compose module

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.2.0)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-compose (0.2.0)
+      testcontainers-core (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.100.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)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      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.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-compose!
+  testcontainers-core!
+
+BUNDLED WITH
+   2.4.13

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,117 @@
+# Testcontainers module for Docker Compose
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'testcontainers-compose'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-compose
+```
+
+## Usage
+To use the library, you first need to require it:
+
+```ruby
+require "testcontainers/compose"
+```
+
+### Creating a Compose Container
+Create a new instance of the `Testcontainers::ComposeContainer` class:
+
+``` ruby
+compose = Testcontainer::ComposeContainer.new(filepath: Dir.getwd)
+```	
+
+The instance creates a set of containers defined on the .yml file, the 'compose.start' wakes up all containers as service
+
+Start the services on the compose file.
+
+```ruby
+compose.start
+```
+
+Stop the services:
+
+```ruby
+compose.stop
+```
+
+### Connecting to services
+
+Once the service is running, you can obtain the mapped port to connect to it: 
+
+```ruby
+compose.service_port(service: "hub", port: 4444)
+```
+
+You can inspect the logs of for the services also:
+
+```ruby
+puts compose.logs
+```
+
+You can use `wait_for_logs`, `wait_for_http` and `wait_for_tcp_port` to wait for the services to start:
+
+```ruby
+compose.wait_for_logs(/Service started/)
+compose.wait_for_http(url: "http://localhost:4444/hub")
+compose.wait_for_tcp_port(host: "localhost", port: 3306)
+```
+
+### Configuration of services
+
+This example initialize docker compose with two services described in the YML file located in the current directory:
+
+```ruby
+services = ["hub","firefox"]
+compose = Testcontainers::ComposeContainer.new(filepath: Dir.getwd, services: services)
+```
+
+You can specify the name of different docker-compose files also:
+
+```ruby
+compose_filenames = ["docker-compose.dbs.yml", "docker-compose.web.yml"]
+compose = Testcontainer::ComposeContainer.new(filepath: Dir.getwd, compose_filenames: compose_filenames)
+compose.start
+```
+
+An env file can be specified when starting the services:
+
+```ruby
+compose_filename = ["docker-compose.test.yml"]
+compose = Testcontainers::ComposeContainer.new(filepath: Dir.getwd, env_file: ".env.test")
+```
+
+### Executing commands in the container for a service
+
+```ruby
+compose.exec(service_name: "hub", command: "echo test")
+```
+
+
+## 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/compose/version.rb

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

data/lib/testcontainers/compose.rb

@@ -0,0 +1,242 @@
+require_relative "compose/version"
+require "testcontainers"
+require "open3"
+
+module Testcontainers
+  # ComposeContainer class is used to manage a large number of containers in a synchronous environment
+  #
+  # @attr_accesor [String] filepath used by the container
+  # @attr_accesor [String,List] compose_filename used by the container
+  # @attr_accesor [Boolean] pull used by the container
+  # @attr_accesor [Boolean] build used by the container
+  # @attr_accesor [List] services used by the container
+  class ComposeContainer
+    # Default image used by the container
+
+    attr_accessor :filepath, :compose_filenames, :pull, :build, :env_file, :services
+
+    # Initializes a new instance of ComposeContainer
+    #
+    # @param image [String] the image to use
+    # @param filepath [String] the filepath of the configuration files for the configuration of docker compose
+    # @param compose_filename [String, List] the names of the files with yml extencion for custom configuration
+    # @param pull [Boolean] is the option for decide if there should be a pull request to generate the image for the containers
+    # @param build [Boolean] is the option for decide if there have to use a build command for the images used for the containers
+    # @param env_file [String] is the name of the envieroment configuration
+    # @param services [List] are the names of the services that gonna use in the images of the containers
+    def initialize(command: ["docker compose"], filepath: ".", compose_filenames: ["docker-compose.yml"],
+      pull: false, build: false, env_file: nil, services: nil)
+
+      @command = command
+      @filepath = filepath
+      @compose_filenames = compose_filenames
+      @pull = pull
+      @build = build
+      @services = services
+      @env_file = env_file
+      @_container_started = false
+    end
+
+    # Run the containers using the `docker-compose up` command
+    #
+    # @return [ComposeContainer] self
+    def start
+      return self if @_container_started
+
+      if @pull
+        pull_cmd = compose_command("pull")
+        exec_command(pull_cmd)
+      end
+
+      args = ["up", "-d"]
+      args << "--build" if @build
+      args << @services.join(" ") if @services
+      up_cmd = compose_command(args)
+      _, _, status = exec_command(up_cmd)
+      @_container_started = true if status.success?
+
+      self
+    end
+
+    # Stop the containers using the `docker-compose down` command
+    #
+    # @return [ComposeContainer] self
+    def stop
+      raise ContainerNotStartedError unless @_container_started
+
+      down_cmd = compose_command("down -v")
+      _, _, status = exec_command(down_cmd)
+      @_container_started = false if status.success?
+
+      self
+    end
+
+    def running?
+      @_container_started
+    end
+
+    def exited?
+      !running?
+    end
+
+    # Return the logs of the containers using the `docker-compose logs` command
+    #
+    # @return [String] logs
+    def logs
+      raise ContainerNotStartedError unless @_container_started
+
+      logs_command = compose_command("logs")
+      stdout, _, _ = exec_command(logs_command)
+      stdout
+    end
+
+    # Execute a command in the given service using the `docker-compose exec` command
+    #
+    # @param service_name [String]
+    # @param command [String]
+    def exec(service_name:, command:)
+      raise ContainerNotStartedError unless @_container_started
+
+      exec_cmd = compose_command(["exec", "-T", service_name, command])
+      exec_command(exec_cmd)
+    end
+
+    # Return the mapped port for a given service and port using the `docker-compose port` command
+    #
+    # @param service [String]
+    # @return port [int]
+    def service_port(service: nil, port: 0)
+      raise ContainerNotStartedError unless @_container_started
+
+      _service_info(service: service, port: port)["port"]
+    end
+
+    # Return the host for a given service and port using the `docker-compose port` command
+    #
+    # @param service [String]
+    # @return host  [String]
+    def service_host(service: nil, port: 0)
+      raise ContainerNotStartedError unless @_container_started
+
+      _service_info(service: service, port: port)["host"]
+    end
+
+    # Waits for the container logs to match the given regex.
+    #
+    # @param matcher [Regexp] The regex to match.
+    # @param timeout [Integer] The number of seconds to wait for the logs to match.
+    # @param interval [Float] The number of seconds to wait between checks.
+    # @return [Boolean] Whether the logs matched the regex.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    # @raise [TimeoutError] If the timeout is reached.
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    def wait_for_logs(matcher:, timeout: 60, interval: 0.1)
+      raise ContainerNotStartedError unless @_container_started
+
+      Timeout.timeout(timeout) do
+        loop do
+          return true if logs&.match?(matcher)
+
+          sleep interval
+        end
+      end
+    rescue Timeout::Error
+      raise TimeoutError, "Timed out waiting for logs to match #{matcher}"
+    end
+
+    # Waits for the container to open the given port.
+    #
+    # @param port [Integer] The port to wait for.
+    # @param timeout [Integer] The number of seconds to wait for the port to open.
+    # @param interval [Float] The number of seconds to wait between checks.
+    # @return [Boolean] Whether the port is open.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    # @raise [TimeoutError] If the timeout is reached.
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [PortNotMappedError] If the port is not mapped.
+    def wait_for_tcp_port(host:, port:, timeout: 60, interval: 0.1)
+      raise ContainerNotStartedError unless @_container_started
+
+      Timeout.timeout(timeout) do
+        loop do
+          Timeout.timeout(interval) do
+            TCPSocket.new(host, port).close
+            return true
+          end
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Timeout::Error
+          sleep interval
+        end
+      end
+    rescue Timeout::Error
+      raise TimeoutError, "Timed out waiting for port #{port} to open"
+    end
+
+    # Waits for the container to respond to HTTP requests.
+    #
+    # @param service [String] The name of the service.
+    # @param timeout [Integer] The number of seconds to wait for the TCP connection to be established.
+    # @param interval [Float] The number of seconds to wait between checks.
+    # @param path [String] The path to request.
+    # @param container_port [Integer] The container port to request.
+    # @param https [Boolean] Whether to use TLS.
+    # @param status [Integer] The expected HTTP status code.
+    # @return [Boolean] Whether the container is responding to HTTP requests.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    # @raise [TimeoutError] If the timeout is reached.
+    # @raise [PortNotMappedError] If the port is not mapped.
+    def wait_for_http(url:, timeout: 60, interval: 0.1, status: 200)
+      raise ContainerNotStartedError unless @_container_started
+
+      Timeout.timeout(timeout) do
+        loop do
+          begin
+            response = Excon.get(url)
+            return true if response.status == status
+          rescue Excon::Error::Socket
+            # The container may not be ready to accept connections yet
+          end
+
+          sleep interval
+        end
+      end
+    rescue Timeout::Error
+      raise TimeoutError, "Timed out waiting for HTTP status #{status} on #{path}"
+    end
+
+    private
+
+    def exec_command(cmd)
+      stdout, stderr, status = Open3.capture3(cmd, chdir: @filepath)
+
+      [stdout, stderr, status]
+    end
+
+    def compose_command(args)
+      # Prepare the args and command
+      args = args.split(" ") if args.is_a?(String)
+      compose_command = @command.dup
+      compose_command = compose_comand.split(" ") if compose_command.is_a?(String)
+
+      # Add the compose files
+      file_args = @compose_filenames.map { |filename| "-f #{filename}" }
+      compose_command += file_args
+
+      # Add the env file
+      compose_command.push("--env-file #{env_file}") if env_file
+
+      # Add the args
+      compose_command += args
+
+      # Return the command
+      compose_command.join(" ")
+    end
+
+    # Return the host and the mapped port for the given service and port
+    def _service_info(service: nil, port: 0)
+      port_command = compose_command(["port", service, port])
+      stdout, _, _ = exec_command(port_command)
+      host, port = stdout.strip.split(":")
+      {"host" => host, "port" => port}
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-compose
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Guillermo Iguaran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-09 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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'
+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/compose.rb
+- lib/testcontainers/compose/version.rb
+homepage: https://github.com/testcontainers/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/compose
+  source_code_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/compose
+  changelog_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/compose/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.14
+signing_key:
+specification_version: 4
+summary: 'Testcontainers for Ruby: Compose module'
+test_files: []