testcontainers-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca35e10e3cf74f54fde8d1701bb3d275176bc511e4759d9065daf0d5885a27bd
+  data.tar.gz: 47bc00397d4d39c5824bba2691bef242e68c52e7525a695627da5e408ade997e
+SHA512:
+  metadata.gz: 3c196752899a7430b2b0ed79e955248c5f220961de30d40046e4d7f7973a29eebf6a9d474154c3a98114f389432a97595b81239aad0c7e7fb86b3bc5d0ffe4dd
+  data.tar.gz: 0afd3c2cf257ad42f6d725cea831050987c10f647a9800d99d6172f8237740de1cc2b47650155e37d251976ad941ce9534605dd3cc21b263cea9505a2c2e21f5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.0] - 2023-05-13
+
+### Added
+
+- Initial release of the Redis module

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.1)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-redis (0.1.0)
+      testcontainers-core (~> 0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    connection_pool (2.4.0)
+    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)
+    redis (5.0.6)
+      redis-client (>= 0.9.0)
+    redis-client (0.14.1)
+      connection_pool
+    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)
+  redis (~> 5.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-redis!
+
+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,149 @@
+# Testcontainers module for Redis
+
+`testcontainers-redis` simplifies the creation and management of Redis containers for testing purposes using the Testcontainers library.
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'testcontainers-redis'
+end
+```
+
+
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-redis
+```
+
+
+## Usage
+
+To use the library, you first need to require it:
+
+```ruby
+require 'testcontainers/redis'
+```
+
+
+### Creating a Redis container
+
+Create a new instance of the `Testcontainers::RedisContainer` class:
+
+```ruby
+container = Testcontainers::RedisContainer.new
+```
+
+
+
+This creates a new container with the default Redis image. You can customize these by passing arguments to the constructor:
+
+```ruby
+container = Testcontainers::RedisContainer.new("redis:6.0-alpine", password: "custom_pass")
+```
+
+
+### Starting and stopping the container
+
+Start the container:
+
+```ruby
+container.start
+```
+
+
+
+Stop the container when you're done:
+
+```ruby
+container.stop
+```
+
+
+### Connecting to the Redis 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 Redis URL:
+
+```ruby
+redis_url = container.redis_url
+```
+
+Use this URL to connect to the Redis container using your preferred Redis client library.
+
+### Customizing the container
+
+You can also customize the container before of starting it, e.g setting a custom password for
+client's authentication:
+
+```ruby
+container.with_password("custom_pass")
+```
+
+or using a custom `redis.conf` (saved under `$PWD/custom/conf` in this
+example):
+
+```ruby
+container.with_filesystem_binds(["#{Dir.pwd}/custom/conf:/usr/local/etc/redis:rw"])
+container.with_cmd("redis-server /usr/local/etc/redis/redis.conf")
+```
+
+### Example
+
+Here's a complete example of how to use `testcontainers-redis` to create a container, connect to it, and run a simple command:
+
+```ruby
+require 'testcontainers/redis'
+require 'redis'
+
+container = Testcontainers::RedisContainer.new
+container.start
+
+client = Redis.new(url: container.redis_url)
+
+client.set("mykey", "hello world")
+value = client.get("mykey")
+
+puts value
+
+client.quit
+container.stop
+```
+
+This example creates a Redis container, connects to it using the `redis` gem, sets and retrieves a key-value pair, and then stops the container.
+
+### Example with RSpec
+
+Take a look to the files [examples/redis_container_rspec.rb](https://github.com/guilleiguaran/testcontainers-ruby/blob/main/examples/redis_container_rspec.rb) for a example using RSpec.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guilleiguaran/testcontainers. 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/guilleiguaran/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/guilleiguaran/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/redis/version.rb

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

data/lib/testcontainers/redis.rb

@@ -0,0 +1,70 @@
+require_relative "redis/version"
+require "testcontainers"
+
+module Testcontainers
+  # RedisContainer class is used to manage containers that run a Redis database
+  #
+  # @attr_reader [String] port used by the container
+  # @attr_reader [String] password used by the container
+  class RedisContainer < ::Testcontainers::DockerContainer
+    # Default port used by the container
+    REDIS_DEFAULT_PORT = 6379
+
+    # Default image used by the container
+    REDIS_DEFAULT_IMAGE = "redis:latest"
+
+    attr_reader :port, :password
+
+    # Initializes a new instance of RedisContainer
+    #
+    # @param image [String] the image to use
+    # @param port [String] the port to use
+    # @param kwargs [Hash] the options to pass to the container. See {DockerContainer#initialize}
+    # @return [RedisContainer] a new instance of RedisContainer
+    def initialize(image = REDIS_DEFAULT_IMAGE, port: nil, **kwargs)
+      super(image, **kwargs)
+      @port = port || ENV.fetch("REDIS_PORT", REDIS_DEFAULT_PORT)
+      @password = password || ENV.fetch("REDIS_PASSWORD", nil)
+    end
+
+    # Starts the container
+    #
+    # @return [RedisContainer] self
+    def start
+      with_exposed_ports(@port)
+      _configure
+      super
+    end
+
+    # Sets the password to use
+    #
+    # @param password [String] the password to use
+    # @return [RedisContainer] self
+    def with_password(password)
+      @password = password
+      self
+    end
+
+    # Returns the Redis connection url (e.g. redis://:password@localhost:6379/0)
+    #
+    # @param protocol [String] the protocol to use in the string (default: "redis")
+    # @return [String] the Redis connection url
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def redis_url(protocol: "redis", db: 0)
+      if @password.nil? || @password.empty?
+        "#{protocol}://#{host}:#{mapped_port(port)}/#{db}"
+      else
+        "#{protocol}://:#{password}@#{host}:#{mapped_port(port)}/#{db}"
+      end
+    end
+
+    alias_method :database_url, :redis_url
+
+    private
+
+    def _configure
+      add_env("REDIS_PASSWORD", @password) unless @password.nil? || @password.empty?
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillermo Iguaran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-13 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !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: redis
+  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'
+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/redis.rb
+- lib/testcontainers/redis/version.rb
+homepage: https://github.com/guilleiguaran/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/redis
+  source_code_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/redis
+  changelog_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/redis/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: Redis module'
+test_files: []