testcontainers-rabbitmq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d97a9dd11ccfa2cdf0306fee0ce355a1ae6ae7d9cc242c62e0f450734d3afd1
+  data.tar.gz: eb2f0e776019538d07c04e2bc5b434fecb7fb387868b23040bce4d27e13ca674
+SHA512:
+  metadata.gz: b1ee3ea2117c31d37ce6ea6cb52924b9614c97577166442b69eb3c0a59b766bd5f4b35bf008fa38b64e195f45f6c91bcf93db46ef01370ac27ebb3df210f6fa1
+  data.tar.gz: c127eb5be4b1f6ee4f758ef2476e7b820185e93f7f23b6f7f88010de2caf594304530d3456802a573f8ab22bd4fda96226b9c183fc2ec8c444936b875a567e92

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [Unreleased]
+
+### Added

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.3)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-rabbitmq (0.1.0)
+      testcontainers-core (~> 0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.3.2)
+    ast (2.4.2)
+    bunny (2.20.3)
+      amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.99.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.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbtree (0.4.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      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.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    set (1.0.3)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    standard (1.28.4)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bunny (~> 2.19)
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-rabbitmq!
+
+BUNDLED WITH
+   2.4.1

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,139 @@
+# Testcontainers module for RabbitMQ
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'testcontainers-rabbitmq'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-rabbitmq
+```
+
+## Usage
+
+To use the library, you first need to require it:
+
+```ruby
+require "testcontainers/rabbitmq"
+```
+
+### Creating a RabbitMQ container
+
+Create a new instance of the `Testcontainers::RabbitmqContainer` class:
+
+```ruby
+container = Testcontainers::RabbitmqContainer.new
+```
+
+This creates a new container with the default RabbitMQ image, user, password, and vhost. You can customize these by passing arguments to the constructor:
+
+```ruby
+container = Testcontainers::RabbitmqContainer.new("rabbitmq:latest", username: "custom_user", password: "custom_pass", vhost: "custom_vhost")
+```
+
+### Starting and stopping the container
+
+Start the container:
+
+```ruby
+container.start
+```
+
+Stop the container when you're done:
+
+```ruby
+container.stop
+```
+
+### Connecting to the RabbitMQ container
+
+Once the container is running, you can obtain the connection details using the following methods:
+
+```ruby
+host = container.host
+port = container.first_mapped_port
+```
+
+Or, you can generate a full RabbitMQ URL:
+
+```ruby
+broker_url = container.rabbitmq_url
+```
+
+### Customizing the container
+
+```ruby
+container.with_vhost("custom_vhost")
+container.with_username("custom_user")
+container.with_password("custom_pass")
+```
+
+### Example
+
+There are complete examples of how to use testcontainers-rabbitmq to create containers, connects to it, publish and consume simple message:
+
+```ruby
+require "testcontainers/rabbitmq"
+require "bunny"
+
+container = Testcontainers::RabbitmqContainer.new
+container.start
+
+connection = Bunny.new(container.rabbitmq_url)
+connection.start
+
+channel = connection.create_channel
+queue = channel.queue('hello')
+channel.default_exchange.publish('Hello World!', routing_key: queue.name)
+
+connection.close
+```
+
+The previous example creates a RabbitMQ container, connects to it using `bunny` gem, then publish a message to a queue named `hello`
+
+```ruby
+require "testcontainers/rabbitmq"
+require "bunny"
+
+container = Testcontainers::RabbitmqContainer.new
+container.start
+
+connection = Bunny.new(container.rabbitmq_url)
+connection.start
+
+channel = connection.create_channel
+queue = channel.queue('hello')
+
+queue.subscribe(block: true) do |_delivery_info, _properties, body|
+  puts " [x] Received #{body}"
+end
+
+connection.close
+```
+
+The previous example creates a RabbitMQ container, connects to it using `bunny` gem, then reads messages from a queue named `hello`
+
+## 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/rabbitmq/version.rb

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

data/lib/testcontainers/rabbitmq.rb

@@ -0,0 +1,150 @@
+require_relative "rabbitmq/version"
+require "testcontainers"
+require "uri"
+
+module Testcontainers
+  # RabbitmqContainer class is used to manage containers that runs a RabbitMQ message broker
+  #
+  # @attr_reader [String] username used by the container
+  # @attr_reader [String] password used by the container
+  # @attr_reader [String] database used by the container
+  class RabbitmqContainer < ::Testcontainers::DockerContainer
+    # Default ports used by the container
+    RABBITMQ_QUEUE_DEFAULT_PORT = 5672
+    RABBITMQ_MGMT_UI_DEFAULT_PORT = 15672
+
+    # Default image used by the container
+    # To have the management plugin enabled, use the image with the tag "management"
+    RABBITMQ_DEFAULT_IMAGE = "rabbitmq:latest"
+
+    # Default credentials used by the container
+    RABBITMQ_DEFAULT_USER = "rabbitmq"
+    RABBITMQ_DEFAULT_PASS = "rabbitmq"
+
+    # Default vhost used by the container
+    RABBITMQ_DEFAULT_VHOST = "/"
+
+    attr_reader :username, :password, :vhost
+
+    # Initializes a new instance of RabbitMQContainer
+    #
+    #  @param image [String] the image to use
+    #  @param username [String] the username to use
+    #  @param password [String] the password to use
+    #  @param port [String] the port to use
+    #  @param kwargs [Hash] the options to pass to the container. See {DockerContainer#initialize}
+    #  @return [RabbitmqContainer] a new instance of RabbitmqContainer
+    def initialize(image = RABBITMQ_DEFAULT_IMAGE, username: nil, password: nil, vhost: nil, **kwargs)
+      super(image, **kwargs)
+      @username = username || ENV.fetch("RABBITMQ_USER", RABBITMQ_DEFAULT_USER)
+      @password = password || ENV.fetch("RABBITMQ_PASSWORD", RABBITMQ_DEFAULT_PASS)
+      @vhost = vhost || ENV.fetch("RABBITMQ_VHOST", RABBITMQ_DEFAULT_VHOST)
+      @healthcheck ||= add_healthcheck(_default_healthcheck_options)
+      @wait_for ||= add_wait_for(:healthcheck)
+    end
+
+    # Starts the container
+    #
+    # @return [RabbitmqContainer] self
+    def start
+      with_exposed_ports([port, management_ui_port])
+      _configure
+      super
+    end
+
+    # Returns the port used to connect to the container queue
+    #
+    # @return [Integer] the port used by the container
+    def port
+      RABBITMQ_QUEUE_DEFAULT_PORT
+    end
+
+    # Returns the port used to connect to the container management UI
+    # This is available only if an image with the management plugin enabled is used
+    #
+    # @return [Integer] the port used by the container
+    def management_ui_port
+      RABBITMQ_MGMT_UI_DEFAULT_PORT
+    end
+
+    # Returns the rabbitmq connection url (e.g. amqp://user:password@host:port/vhost)
+    #
+    # @param protocol [String] the protocol to use in the string (default: "mysql")
+    # @param database [String] the database to use in the string (default: @database)
+    # @param options [Hash] the options to use in the query string (default: {})
+    # @return [String] the rabbitmq url
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def rabbitmq_url(protocol: "amqp://", username: nil, password: nil, vhost: nil)
+      username ||= @username
+      password ||= @password
+      vhost ||= @vhost
+      vhost = "/#{vhost}" unless vhost.start_with?("/")
+      vhost = "" if vhost == "/"
+
+      # amqp://user:pass@host:10000/vhost
+      "#{protocol}#{username}:#{password}@#{host}:#{mapped_port(port)}#{vhost}"
+    end
+
+    alias_method :connection_url, :rabbitmq_url
+
+    # Returns the rabbitmq management UI url (e.g. http://user:password@host:port)
+    #
+    # @param protocol [String] the protocol to use in the string (default: "http")
+    # @return [String] the url for the management UI. Returns nil if the management UI is not available.
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def management_ui_url(protocol: "http")
+      port = mapped_port(management_ui_port)
+      port.nil? ? nil : "#{protocol}://#{host}:#{port}"
+    end
+
+    # Sets the vhost to use
+    #
+    # @param vhost [String] the vhost to use
+    # @return [RabbitmqContainer] self
+    def with_vhost(vhost)
+      @vhost = vhost
+      self
+    end
+
+    # Sets the username to use
+    #
+    # @param username [String] the username to use
+    # @return [RabbitmqContainer] self
+    def with_username(username)
+      @username = username
+      self
+    end
+
+    # Sets the password to use
+    #
+    # @param password [String] the password to use
+    # @return [RabbitmqContainer] self
+    def with_password(password)
+      @password = password
+      self
+    end
+
+    # Returns the container's first mapped port (the one used by the queue)
+    #
+    # @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
+      mapped_port(port)
+    end
+
+    private
+
+    def _configure
+      add_env("RABBITMQ_DEFAULT_USER", @username)
+      add_env("RABBITMQ_DEFAULT_PASS", @password)
+      add_env("RABBITMQ_DEFAULT_VHOST", @vhost) if @vhost
+    end
+
+    def _default_healthcheck_options
+      {test: %w[rabbitmqctl node_health_check], interval: 10, timeout: 10, retries: 5}
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-rabbitmq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Piza
+- Guillermo Iguaran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-10 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.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+description: Testcontainers makes it easy to create and clean up container-based dependencies
+  for automated tests.
+email:
+- pedro920224@gmail.com
+- guilleiguaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testcontainers/rabbitmq.rb
+- lib/testcontainers/rabbitmq/version.rb
+homepage: https://github.com/testcontainers/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/rabbitmq
+  source_code_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/rabbitmq
+  changelog_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/rabbitmq/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.1
+signing_key:
+specification_version: 4
+summary: 'Testcontainers for Ruby: Rabbitmq module'
+test_files: []