testcontainers-redpanda 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5265bdbd4c6f552bbd4778fcc5e75315cbfd370a840cb7a2e8bc34b75a57b5af
+  data.tar.gz: d3324517a4954ac7d0d03d7caa4077c6dcd0fb08ebc5f1c06f2a0d2b4ae45725
+SHA512:
+  metadata.gz: 43d8a17e27c73569ee50980524f7c3df669b418971fad87f1f6bbc4b4937c5be9cb1db2336ba5fbe8e60775c79bf6c33f3a69337e20bc21c55959e2b9b75dc94
+  data.tar.gz: 783e4de366113fea14722068a1e2db1f1ba65866ebeddd85db0cb328082545de9d1d122650160e6cb7be4a77dbef1ec5c05cd9f7271f16b279043655c765d18e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.0] - 2023-06-10
+
+### Added
+
+- Initial release of the Redpanda module

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.3)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-redpanda (0.1.0)
+      testcontainers-core (~> 0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.99.0)
+    ffi (1.15.5)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    mini_portile2 (2.8.2)
+    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)
+    rdkafka (0.12.0)
+      ffi (~> 1.15)
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    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)
+    standard (1.28.2)
+      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
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  rake (~> 13.0)
+  rdkafka (~> 0.12)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-redpanda!
+
+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 Redpanda
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'testcontainers-redpanda'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-redpanda
+```
+
+## Usage
+
+### Creating a Redpanda container
+
+Create a new instance of the `Testcontainers::RedpandaContainer` class:
+
+```ruby
+container = Testcontainers::RedpandaContainer.new
+```
+
+
+This creates a new container with the default MariaDB image. You can customize it by passing arguments to the constructor:
+
+```ruby
+container = Testcontainers::MariadbContainer.new("vectorized/redpanda")
+```
+
+### Starting and stopping the container
+
+Start the container:
+
+```ruby
+container.start
+```
+
+
+Stop the container when you're done:
+
+```ruby
+container.stop
+```
+
+### Connecting to the Redpanda container
+
+Once the container is running, you can obtain the connection details using the following methods:
+
+```ruby
+host = container.host
+port = container.mapped_port(9092)
+```
+
+or
+
+```ruby
+connection_url = container.connection_url
+```
+
+
+Use these connection details to connect to the Redpanda container using your preferred Kafka client library.
+
+
+
+### Example
+
+Here's a complete example of how to use testcontainers-redpanda to create a container, connect an consumer and a producer to it, and deliver one message:
+
+```ruby
+require "testcontainers/redpada"
+require "rdkafka"
+
+container = Testcontainers::RedpandaContainer.new
+container.start
+
+config = {
+  "bootstrap.servers": container.connection_url,
+  "group.id": "ruby-test"
+}
+
+consumer = Rdkafka::Config.new(config).consumer
+consumer.subscribe("ruby-test-topic")
+
+producer = Rdkafka::Config.new(config).producer
+producer.produce(payload: "Hello, Redpanda!", topic: "ruby-test-topic").wait
+
+message = consumer.each do |msg|
+  break msg
+end
+
+puts msg.inspect
+
+container.stop
+```
+
+### Using with RSpec
+
+You can manage the Redpanda container in the before(:suite) / after(:suite) blocks in your spec_helper.rb:
+
+```ruby
+RSpec.configure do |config|
+  # This helps us to have access to the `RSpec.configuration.redpanda_container` without using global variables.
+  config.add_setting :redpanda_container, default: nil
+
+  config.before(:suite) do
+    config.redpanda_container = Testcontainers::RedpandaContainer.new.start
+    # Use the container connection details in your tests
+  end
+
+  config.after(:suite) do
+    config.redpanda_container&.stop
+    config.redpanda_container&.remove
+  end
+end
+```
+
+## 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/redpanda/version.rb

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

data/lib/testcontainers/redpanda.rb

@@ -0,0 +1,87 @@
+require_relative "redpanda/version"
+require "testcontainers"
+
+module Testcontainers
+  # RedpandaContainer class is used to manage containers that run a Redpanda
+  class RedpandaContainer < ::Testcontainers::DockerContainer
+    # Default port used by the container
+    REDPANDA_DEFAULT_PORT = 9092
+
+    # Default port used for schema registry
+    REDPANDA_DEFAULT_SCHEMA_REGISTRY_PORT = 8081
+
+    # Default image used by the container
+    REDPANDA_DEFAULT_IMAGE = "redpandadata/redpanda:latest"
+
+    # Default path to the startup script
+    STARTUP_SCRIPT_PATH = "/testcontainers.sh"
+
+    # Initializes a new instance of RedpandaContainer
+    #
+    # @param image [String] the image to use
+    # @param kwargs [Hash] the options to pass to the container. See {DockerContainer#initialize}
+    # @return [RedpandaContainer] a new instance of RedpandaContainer
+    def initialize(image = REDPANDA_DEFAULT_IMAGE, **kwargs)
+      super(image, **kwargs)
+    end
+
+    # Starts the container
+    #
+    # @return [RedpandaContainer] self
+    def start
+      with_exposed_ports(REDPANDA_DEFAULT_PORT, REDPANDA_DEFAULT_SCHEMA_REGISTRY_PORT)
+      with_entrypoint(%w[/bin/sh])
+      with_command(["-c", "while [ ! -f #{STARTUP_SCRIPT_PATH} ]; do sleep 0.1; done; #{STARTUP_SCRIPT_PATH}"])
+      super
+
+      # Copy the startup script to the container
+      copy_file_to_container("/tmp" + STARTUP_SCRIPT_PATH, _startup_script)
+
+      # File is copied with root owner and permissions, so we need to change them
+      exec_as_root(%w[chmod 777] + ["/tmp" + STARTUP_SCRIPT_PATH])
+      exec_as_root(%w[chown redpanda:redpanda] + ["/tmp" + STARTUP_SCRIPT_PATH])
+
+      # Copy the startup script to expected location
+      exec_as_root(%w[cp] + ["/tmp" + STARTUP_SCRIPT_PATH] + [STARTUP_SCRIPT_PATH])
+
+      wait_for_logs(/Successfully started Redpanda!/)
+      self
+    end
+
+    def port
+      REDPANDA_DEFAULT_PORT
+    end
+
+    # Returns the Redpanda connection url (e.g. localhost:9092)
+    #
+    # @return [String] the Redpanda connection url
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def connection_url
+      "#{host}:#{mapped_port(port)}"
+    end
+
+    def bootstrap_servers
+      "PLAINTEXT://#{host}:#{mapped_port(port)}"
+    end
+
+    def schema_registry_address
+      "http://#{host}:#{mapped_port(REDPANDA_DEFAULT_SCHEMA_REGISTRY_PORT)}"
+    end
+
+    private
+
+    def _startup_script
+      startup_script = StringIO.new
+      startup_script.print("#!/bin/sh\n")
+      startup_script.print("/usr/bin/rpk redpanda start --mode dev-container")
+      startup_script.print(" --kafka-addr PLAINTEXT://0.0.0.0:29092,OUTSIDE://0.0.0.0:9092")
+      startup_script.print(" --advertise-kafka-addr PLAINTEXT://0.0.0.0:29092,OUTSIDE://#{host}:#{mapped_port(port)}")
+      startup_script
+    end
+
+    def exec_as_root(cmd, options = {})
+      exec(cmd, options.merge({"User" => "root"}))
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-redpanda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 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: rdkafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+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/redpanda.rb
+- lib/testcontainers/redpanda/version.rb
+homepage: https://github.com/testcontainers/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/redpanda
+  source_code_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/redpanda
+  changelog_uri: https://github.com/testcontainers/testcontainers-ruby/blob/main/redpanda/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: Redpanda module'
+test_files: []