testcontainers-elasticsearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24ec3386c4c39ac5fc14d069dcefddd9f4db288adf88847d0c80b305c0db3834
+  data.tar.gz: 6d8f827ae56255277b4f2dbcab815ddb478b2990fe7482d78680d63ef534eb93
+SHA512:
+  metadata.gz: 6e6a2fa3094100a9a6266f697a8fa03e2e482822373c62e73ef1531a40446847bdc0e6de074b028066fedf1edca0a1b2ddfcac270fc574ecc7f1233fbd3df032
+  data.tar.gz: 601aff44f9a21c03b92e67ac8394598f852e619786309600e8e23d60176daf8ae7105cdc5516f2e686c06322d1979be7e664b9bf3bf52adebed7a10ee89e7805

data/CHANGELOG.md

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.3)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-elasticsearch (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
+    elastic-transport (8.2.1)
+      faraday (< 3)
+      multi_json
+    elasticsearch (8.7.1)
+      elastic-transport (~> 8)
+      elasticsearch-api (= 8.7.1)
+    elasticsearch-api (8.7.1)
+      multi_json
+    excon (0.99.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    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)
+    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)
+    ruby2_keywords (0.0.5)
+    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
+  elasticsearch (~> 8.7)
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-elasticsearch!
+
+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,133 @@
+# Testcontainers module for Elasticsearch
+
+testcontainers-elasticsearch simplifies the creation and management of ElasticSearch 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-elasticsearch'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-elasticsearch
+```
+
+## Usage
+
+To use the library, you first need to require it:
+
+```ruby
+require "testcontainers/elasticsearch"
+```
+
+### Creating an Elasticsearch container
+
+Create a new instance of the `Testcontainers::ElasticsearchContainer` class:
+
+```ruby
+container = Testcontainers::ElasticsearchContainer.new
+```
+
+This creates a new container with the default Elasticsearch image. You can customize the image by passing an argument to the constructor:
+
+```ruby
+container = Testcontainers::ElasticsearchContainer.new("elasticsearch:7.17.10")
+```
+
+### Starting and stopping the container
+
+Start the container:
+
+```ruby
+container.start
+```
+
+Stop the container when you're done:
+
+```ruby
+container.stop
+```
+
+### Connecting to the Elasticsearch 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 the full Elasticsearch URL:
+
+```ruby
+elasticsearch_url = container.elasticsearch_url
+```
+
+Use this URL to connect to the Elasticsearch container using your preferred Elasticsearch client library.
+
+### Example
+
+Here's a complete example of how to use testcontainers-elasticsearch to create a container, connect to it, and perform a simple health check:
+
+```ruby
+require "testcontainers/elasticsearch"
+require "elasticsearch"
+
+container = Testcontainers::ElasticsearchContainer.new
+container.start
+
+client = Elasticsearch::Client.new(url: ccontainer.elasticsearch_url)
+client.ping #=> true
+
+container.stop
+```
+
+This example creates an Elasticsearch container, connects to it using the `elasticsearch` library, performs a simple ping, and then stops the container.
+
+
+### Using with RSpec
+
+You can manage the 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.elasticsearch_container` without using global variables.
+  config.add_setting :elasticsearch_container, default: nil
+
+  config.before(:suite) do
+    config.elasticsearch_container = Testcontainers::ElasticsearchContainer.new.start
+    ENV["ELASTICSEARCH_URL"] = config.elasticsearch_container.elasticsearch_url
+  end
+
+  config.after(:suite) do
+    config.elasticsearch_container&.stop
+    config.elasticsearch_container&.remove
+  end
+end
+```
+
+This code starts an Elasticsearch container before the test suite runs and stops it after the suite finishes. The Elasticsearch URL is stored in an environment variable, so it's accessible to the tests.
+
+## 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/elasticsearch/version.rb

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

data/lib/testcontainers/elasticsearch.rb

@@ -0,0 +1,89 @@
+require_relative "elasticsearch/version"
+require "testcontainers"
+
+module Testcontainers
+  # ElasticsearchContainer class is used to manage Docker containers running Elasticsearch.
+  # It extends the generic DockerContainer class and provides Elasticsearch-specific functionality.
+  #
+  # @attr_reader username [String] the Elasticsearch username
+  # @attr_reader password [String] the Elasticsearch password
+  class ElasticsearchContainer < ::Testcontainers::DockerContainer
+    ELASTICSEARCH_DEFAULT_HTTP_PORT = 9200
+    ELASTICSEARCH_DEFAULT_TCP_PORT = 9300
+    ELASTICSEARCH_DEFAULT_IMAGE = "docker.elastic.co/elasticsearch/elasticsearch:8.7.1"
+    ELASTICSEARCH_DEFAULT_USERNAME = "elastic"
+    ELASTICSEARCH_DEFAULT_PASSWORD = "elastic"
+
+    attr_reader :username, :password
+
+    # Initializes a new ElasticsearchContainer instance.
+    #
+    # @param image [String] the Elasticsearch Docker image to use
+    # @param http_port [Integer] the port to expose for HTTP traffic, defaults to 9200
+    # @param tcp_port [Integer] the port to expose for TCP traffic, defaults to 9300
+    # @param username [String] the Elasticsearch username, defaults to 'elastic'
+    # @param password [String] the Elasticsearch password, defaults to 'elastic'
+    # @param kwargs [Hash] the options to pass to the container. See {DockerContainer#initialize}
+    # @return [ElasticsearchContainer] a new ElasticsearchContainer instance
+    def initialize(image = ELASTICSEARCH_DEFAULT_IMAGE, http_port: nil, tcp_port: nil, username: nil, password: nil, **kwargs)
+      super(image, **kwargs)
+      @username = username || ELASTICSEARCH_DEFAULT_USERNAME
+      @password = password || ELASTICSEARCH_DEFAULT_PASSWORD
+      @healthcheck ||= add_healthcheck(_default_healthcheck_options)
+      @wait_for ||= add_wait_for(:healthcheck)
+    end
+
+    # Starts the container
+    #
+    # @return [ElasticsearchContainer] self
+    def start
+      with_exposed_ports(http_port, tcp_port)
+      _configure
+      super
+    end
+
+    # Returns the HTTP port used by the container
+    #
+    # @return [Integer] the port used by the container
+    def http_port
+      ELASTICSEARCH_DEFAULT_HTTP_PORT
+    end
+
+    # Returns the TCP (transport) port used by the container
+    #
+    # @return [Integer] the port used by the container
+    def tcp_port
+      ELASTICSEARCH_DEFAULT_TCP_PORT
+    end
+
+    # Returns the URL to access Elasticsearch
+    #
+    # @param protocol [String] the protocol (http or https), defaults to 'http'
+    # @param port [Integer] the port to use, defaults to the HTTP port
+    # @param username [String] the username to use, defaults to the container username
+    # @param password [String] the password to use, defaults to the container password
+    # @return [String] the URL to access Elasticsearch
+    def elasticsearch_url(protocol: nil, port: nil, username: nil, password: nil)
+      if protocol.nil?
+        protocol = (get_env("xpack.security.enabled") == "true") ? "https" : "http"
+      end
+      username ||= @username
+      password ||= @password
+      port ||= http_port
+
+      "#{protocol}://#{username}:#{password}@#{host}:#{mapped_port(port)}"
+    end
+
+    private
+
+    def _configure
+      add_env("ELASTIC_PASSWORD", @password.to_s)
+      add_env("discovery.type", "single-node") unless get_env("discovery.type")
+      add_env("xpack.security.enabled", "false") unless get_env("xpack.security.enabled")
+    end
+
+    def _default_healthcheck_options
+      {test: ["curl", "--silent", "--fail", "localhost:#{http_port}/_cluster/health"], interval: 1, timeout: 5, retries: 5}
+    end
+  end
+end

metadata

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