Add OpenSearch module

guilleiguaran · guilleiguaran · commit 1232e6ff3b7f · 2025-10-19T19:16:29.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ TestContainers is composed of modules for common databases and services. This ch
 - [ComposeContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/compose/CHANGELOG.md)
 
 - [ElasticsearchContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/elasticsearch/CHANGELOG.md)
+- [OpensearchContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/opensearch/CHANGELOG.md)
 
 - [MariadbContainer](https://github.com/testcontainers/testcontainers-ruby/tree/main/mariadb/CHANGELOG.md)
 
@@ -32,4 +33,3 @@ TestContainers is composed of modules for common databases and services. This ch
 
 - ComposeContainer. See the [testcontainers-compose readme](https://github.com/testcontainers/testcontainers-ruby/tree/main/compose/README.md) for more information.
 - SeleniumContainer. See the [testcontainers-selenium readme](https://github.com/testcontainers/testcontainers-ruby/tree/main/selenium/README.md) for more information.
-
diff --git a/Gemfile b/Gemfile
@@ -11,6 +11,7 @@ gem "testcontainers-redis", path: "./redis"
 gem "testcontainers-postgres", path: "./postgres"
 gem "testcontainers-nginx", path: "./nginx"
 gem "testcontainers-elasticsearch", path: "./elasticsearch"
+gem "testcontainers-opensearch", path: "./opensearch"
 gem "testcontainers-mariadb", path: "./mariadb"
 gem "testcontainers-mongo", path: "./mongo"
 gem "testcontainers-redpanda", path: "./redpanda"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -48,6 +48,12 @@ PATH
     testcontainers-nginx (0.2.0)
       testcontainers-core (~> 0.1)
 
+PATH
+  remote: opensearch
+  specs:
+    testcontainers-opensearch (0.1.0)
+      testcontainers-core (~> 0.1)
+
 PATH
   remote: postgres
   specs:
@@ -214,6 +220,7 @@ DEPENDENCIES
   testcontainers-mongo!
   testcontainers-mysql!
   testcontainers-nginx!
+  testcontainers-opensearch!
   testcontainers-postgres!
   testcontainers-rabbitmq!
   testcontainers-redis!
diff --git a/Rakefile b/Rakefile
@@ -6,7 +6,7 @@ require "rake/testtask"
 require "yard"
 require "standard/rake"
 
-MODULES = %w[core mysql redis postgres nginx elasticsearch mariadb mongo redpanda]
+MODULES = %w[core mysql redis postgres nginx elasticsearch opensearch mariadb mongo redpanda]
 
 %w[test standard].each do |task_name|
   desc "Run #{task_name} task for all projects"
diff --git a/core/lib/testcontainers/docker_container.rb b/core/lib/testcontainers/docker_container.rb
@@ -818,7 +818,8 @@ def mount_names
     # @return [String] The environment variable's value.
     # @return [nil] If the environment variable does not exist.
     def get_env(key)
-      env_entry = env.find { |entry| entry.start_with?("#{key}=") }
+      env_list = env || []
+      env_entry = env_list.find { |entry| entry.start_with?("#{key}=") }
       env_entry&.split("=")&.last
     end
 
diff --git a/module-gen/Gemfile.lock b/module-gen/Gemfile.lock
@@ -5,6 +5,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
 
 DEPENDENCIES
   thor (~> 1.2)
diff --git a/opensearch/CHANGELOG.md b/opensearch/CHANGELOG.md
@@ -0,0 +1,6 @@
+## [Unreleased]
+
+### Added
+
+- Initial release of `testcontainers-opensearch` with an `OpensearchContainer`
+  configured for single-node development usage.
diff --git a/opensearch/Gemfile b/opensearch/Gemfile
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in testcontainers-opensearch.gemspec
+gemspec
+
+# Use the latest version of testcontainers-core from the local path
+gem "testcontainers-core", path: "../core"
diff --git a/opensearch/Gemfile.lock b/opensearch/Gemfile.lock
@@ -0,0 +1,104 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.2.0)
+      base64 (~> 0.3)
+      docker-api (~> 2.4)
+      java-properties (~> 0.3.0)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-opensearch (0.1.0)
+      testcontainers-core (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    base64 (0.3.0)
+    docker-api (2.4.0)
+      excon (>= 0.64.0)
+      multi_json
+    excon (1.3.0)
+      logger
+    faraday (2.14.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    java-properties (0.3.0)
+    json (2.15.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.26.0)
+    minitest-hooks (1.5.2)
+      minitest (> 5.3)
+    multi_json (1.17.0)
+    net-http (0.6.0)
+      uri
+    opensearch-ruby (3.4.0)
+      faraday (>= 1.0, < 3)
+      multi_json (>= 1.0)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.6.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.11.3)
+    rubocop (1.80.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.51.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.80.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.0.4)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  opensearch-ruby (~> 3.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-opensearch!
+
+BUNDLED WITH
+   2.6.9
diff --git a/opensearch/LICENSE.txt b/opensearch/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.
diff --git a/opensearch/README.md b/opensearch/README.md
@@ -0,0 +1,57 @@
+# Testcontainers module for Opensearch
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'testcontainers-opensearch'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-opensearch
+```
+
+## Usage
+
+```ruby
+require "testcontainers/opensearch"
+
+container = Testcontainers::OpensearchContainer.new.start
+
+begin
+  container.wait_for_healthcheck
+  client = OpenSearch::Client.new(url: container.opensearch_url)
+  client.ping # => true
+ensure
+  container.stop if container.running?
+  container.remove if container.exists?
+end
+```
+
+The container exposes ports 9200 (HTTP) and 9600 (metrics) by default and
+disables the security plugin so you can connect without credentials. Override
+environment variables via `with_env` before calling `start` if you need to
+change the defaults.
+
+## 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).
diff --git a/opensearch/Rakefile b/opensearch/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]
diff --git a/opensearch/lib/testcontainers/opensearch.rb b/opensearch/lib/testcontainers/opensearch.rb
@@ -0,0 +1,53 @@
+require_relative "opensearch/version"
+require "testcontainers"
+
+module Testcontainers
+  # OpensearchContainer manages Docker containers running OpenSearch.
+  # It mirrors the Elasticsearch container API but targets the OpenSearch images
+  # and defaults, including disabled security for simple integration tests.
+  class OpensearchContainer < ::Testcontainers::DockerContainer
+    OPENSEARCH_DEFAULT_HTTP_PORT = 9200
+    OPENSEARCH_DEFAULT_METRICS_PORT = 9600
+    OPENSEARCH_DEFAULT_IMAGE = "opensearchproject/opensearch:2.12.0"
+
+    # Initializes a new OpenSearch container.
+    #
+    # @param image [String] Docker image to use.
+    # @param http_port [Integer] Port to expose for HTTP traffic (default: 9200).
+    # @param metrics_port [Integer] Port to expose for the metrics endpoint (default: 9600).
+    # @param kwargs [Hash] Additional options forwarded to DockerContainer.
+    attr_reader :http_port, :metrics_port
+
+    def initialize(image = OPENSEARCH_DEFAULT_IMAGE, http_port: nil, metrics_port: nil, **kwargs)
+      @http_port = http_port || OPENSEARCH_DEFAULT_HTTP_PORT
+      @metrics_port = metrics_port || OPENSEARCH_DEFAULT_METRICS_PORT
+      super(image, **kwargs)
+    end
+
+    # Starts the container with the appropriate exposed ports and environment.
+    def start
+      with_exposed_ports(http_port, metrics_port)
+      _configure
+      super
+    end
+
+    # Returns the URL to access the OpenSearch HTTP endpoint.
+    #
+    # @param protocol [String] scheme to use (default: "http").
+    # @param port [Integer] HTTP port to use (default: mapped http_port).
+    def opensearch_url(protocol: "http", port: http_port)
+      "#{protocol}://#{host}:#{mapped_port(port)}"
+    end
+
+    private
+
+    def _configure
+      add_env("discovery.type", "single-node") unless get_env("discovery.type")
+      add_env("bootstrap.memory_lock", "true") unless get_env("bootstrap.memory_lock")
+      add_env("plugins.security.disabled", "true") unless get_env("plugins.security.disabled")
+      add_env("DISABLE_INSTALL_DEMO_CONFIG", "true") unless get_env("DISABLE_INSTALL_DEMO_CONFIG")
+      add_env("DISABLE_SECURITY_PLUGIN", "true") unless get_env("DISABLE_SECURITY_PLUGIN")
+      add_env("OPENSEARCH_JAVA_OPTS", "-Xms512m -Xmx512m") unless get_env("OPENSEARCH_JAVA_OPTS")
+    end
+  end
+end
diff --git a/opensearch/lib/testcontainers/opensearch/version.rb b/opensearch/lib/testcontainers/opensearch/version.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Testcontainers
+  module Opensearch
+    VERSION = "0.1.0"
+  end
+end
diff --git a/opensearch/test/opensearch_container_test.rb b/opensearch/test/opensearch_container_test.rb
diff --git a/opensearch/test/test_helper.rb b/opensearch/test/test_helper.rb
diff --git a/opensearch/testcontainers-opensearch.gemspec b/opensearch/testcontainers-opensearch.gemspec
