testcontainers-mockserver 7.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29ff7e8bdedf1475e38853d86161078462ffa1feb4515ce00c0121ab3b7106c5
+  data.tar.gz: 7aa54f86ae05a6e42deaac805a2a16edc12ce33e122b5d120011b65c372a1462
+SHA512:
+  metadata.gz: c87272ad66182de8ded033c7db1f65f9c6fd5e6a131c83314275806f0b947ecb09ca2e418cf98f4811fff066c23838977c9d0738f43170e7c106d03eb826e248
+  data.tar.gz: fa99c0dd424769f73908006c48d9638da1384def02bb01a070a46ece9b75278c503bbae43faba99ecc58b81789deea8870b481697566b58348c4f1e67290758b

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+# During in-repo development and CI the MockServer Ruby client is resolved from
+# the sibling monorepo directory rather than RubyGems, so the testcontainers
+# module always tests against the current client. Published gem consumers get
+# the released "mockserver-client" gem via the gemspec runtime dependency.
+gem "mockserver-client", path: "../../mockserver-client-ruby"

data/README.md

@@ -0,0 +1,84 @@
+# testcontainers-mockserver (Ruby)
+
+A [Testcontainers](https://github.com/testcontainers/testcontainers-ruby) module for
+[MockServer](https://www.mock-server.com) — the open-source HTTP(S) mock server and proxy.
+
+It starts the official `mockserver/mockserver` Docker image, waits for MockServer to
+become ready (`PUT /mockserver/status` → `200`), and exposes connection helpers plus a
+ready-wired [`mockserver-client`](https://rubygems.org/gems/mockserver-client) instance.
+
+## Install
+
+```ruby
+# Gemfile
+gem "testcontainers-mockserver", group: :test
+```
+
+```sh
+bundle install
+```
+
+Requires Ruby >= 3.0 and a running Docker daemon.
+
+## Usage
+
+```ruby
+require "testcontainers/mockserver"
+
+container = Testcontainers::MockServerContainer.new.start
+
+# A ready-wired MockServer client pointed at the mapped host/port
+client = container.client
+client
+  .when(MockServer::HttpRequest.request(path: "/hello"))
+  .respond(MockServer::HttpResponse.response(status_code: 200, body: "world"))
+
+# Point the system under test at the container endpoint
+container.endpoint        # => "http://localhost:49152"
+container.secure_endpoint # => "https://localhost:49152" (HTTP/HTTPS share the port)
+
+container.stop            # also closes the cached client
+```
+
+Block form auto-stops the container:
+
+```ruby
+Testcontainers::MockServerContainer.new.use do |container|
+  client = container.client
+  # ...
+end
+```
+
+By default the image tag is derived from the MockServer client library version on the
+load path (`mockserver/mockserver:mockserver-<version>`), so the container and client
+always match. Falls back to `:latest` when the version cannot be resolved. Pass an
+explicit image to pin it:
+
+```ruby
+Testcontainers::MockServerContainer.new("mockserver/mockserver:mockserver-7.4.0")
+```
+
+## Configuration helpers
+
+Each returns the container for chaining, and must be called before `start`.
+
+| Helper | What it does |
+|--------|--------------|
+| `with_server_port(port)` | Change the port MockServer listens on inside the container. |
+| `with_log_level(level)` | Set `MOCKSERVER_LOG_LEVEL` (e.g. `"DEBUG"`). |
+| `with_property(key, value)` | Set any MockServer configuration property by its env-var name. |
+| `with_initialization_json(path)` | Mount a JSON file and load its expectations at startup. |
+
+## Connection helpers
+
+| Method | Returns |
+|--------|---------|
+| `client` | A cached `MockServer::Client` connected to the container. |
+| `endpoint` | `http://host:port` |
+| `secure_endpoint` | `https://host:port` (same unified port) |
+| `server_port` | The mapped host port. |
+| `host` | The host MockServer is reachable on. |
+
+## License
+
+Apache-2.0

data/lib/testcontainers/mockserver/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Testcontainers
+  module Mockserver
+    # Version of the testcontainers-mockserver gem. Kept in lockstep with the
+    # MockServer release version by the release tooling.
+    VERSION = "7.4.0"
+  end
+end

data/lib/testcontainers/mockserver.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+require "testcontainers"
+require "mockserver-client"
+
+require_relative "mockserver/version"
+
+module Testcontainers
+  # A Testcontainers module for MockServer.
+  #
+  # Starts the official +mockserver/mockserver+ Docker image, waits for the
+  # server to begin listening, and exposes connection helpers (host, mapped
+  # port, HTTP/HTTPS endpoints) plus a ready-wired {#client}.
+  #
+  # MockServer serves HTTP, HTTPS, SOCKS, and HTTP CONNECT on a single unified
+  # port (default +1080+).
+  #
+  # @example Basic usage
+  #   container = Testcontainers::MockServerContainer.new.start
+  #   client = container.client
+  #   client.when(
+  #     MockServer::HttpRequest.request(path: "/hello")
+  #   ).respond(
+  #     MockServer::HttpResponse.response(body: "world")
+  #   )
+  #   # point the system under test at container.endpoint
+  #   container.stop
+  #
+  # @example Block form (auto-stop)
+  #   Testcontainers::MockServerContainer.new.use do |container|
+  #     client = container.client
+  #     # ...
+  #   end
+  class MockServerContainer < ::Testcontainers::DockerContainer
+    # Default MockServer port (HTTP, HTTPS, SOCKS, and HTTP CONNECT are all
+    # served on a single unified port).
+    MOCKSERVER_DEFAULT_PORT = 1080
+
+    # The Docker image name on Docker Hub.
+    IMAGE = "mockserver/mockserver"
+
+    # Version of this gem (kept in lockstep with the MockServer release).
+    VERSION = ::Testcontainers::Mockserver::VERSION
+
+    # @param image [String, nil] full Docker image reference; when +nil+ the tag
+    #   is derived from the MockServer client library version (see {.default_image}).
+    # @param port [Integer] the port MockServer listens on inside the container
+    def initialize(image = nil, port: MOCKSERVER_DEFAULT_PORT, **kwargs)
+      super(image || self.class.default_image, **kwargs)
+      @port = port
+      @client = nil
+      add_exposed_port(port)
+      # Wait until MockServer answers PUT /mockserver/status with HTTP 200, the
+      # same readiness signal used by the sibling polyglot modules. A host-side
+      # TCP-port wait is unreliable here because the Docker port proxy accepts
+      # connections before MockServer has bound inside the container.
+      @wait_for = ->(container) { container.wait_until_ready }
+      with_env("SERVER_PORT", port.to_s)
+    end
+
+    # Returns the mapped host port for MockServer.
+    #
+    # @return [Integer] the host port mapped to the MockServer container port
+    def server_port
+      mapped_port(@port)
+    end
+
+    # Blocks until MockServer answers PUT /mockserver/status with HTTP 200.
+    # Used as the container's wait strategy.
+    #
+    # @param timeout [Integer] maximum seconds to wait
+    # @param interval [Float] seconds between polls
+    # @return [true] once MockServer is ready
+    # @raise [Testcontainers::TimeoutError] if MockServer is not ready in time
+    def wait_until_ready(timeout: 60, interval: 0.25)
+      uri = URI("http://#{host}:#{server_port}/mockserver/status")
+      deadline = Time.now + timeout
+      loop do
+        begin
+          response = Net::HTTP.start(uri.hostname, uri.port, open_timeout: 2, read_timeout: 5) do |http|
+            http.request(Net::HTTP::Put.new(uri))
+          end
+          return true if response.code == "200"
+        rescue StandardError
+          # MockServer is not accepting connections yet
+        end
+        raise ::Testcontainers::TimeoutError, "MockServer did not become ready within #{timeout}s" if Time.now > deadline
+
+        sleep interval
+      end
+    end
+
+    # @return [String] the HTTP endpoint in the form +http://host:port+
+    def endpoint
+      "http://#{host}:#{server_port}"
+    end
+
+    # MockServer serves HTTP and HTTPS on the same unified port.
+    #
+    # @return [String] the HTTPS endpoint in the form +https://host:port+
+    def secure_endpoint
+      "https://#{host}:#{server_port}"
+    end
+
+    # Returns a {MockServer::Client} connected to this container. The client is
+    # created lazily on first call and cached; it is closed automatically when
+    # the container is stopped via {#stop}.
+    #
+    # @return [MockServer::Client] a client connected to the running container
+    def client
+      @client ||= MockServer::Client.new(host, server_port)
+    end
+
+    # Stops the cached client (if any) and the container.
+    #
+    # @return [MockServerContainer] self
+    def stop(force: false)
+      if @client
+        begin
+          @client.close
+        rescue StandardError # rubocop:disable Lint/SuppressedException
+          # best-effort close; ignore errors while tearing down the client
+        ensure
+          @client = nil
+        end
+      end
+      super
+    end
+
+    # Overrides the port MockServer listens on inside the container. Replaces
+    # the exposed port so the TCP wait strategy targets the correct port.
+    #
+    # @param port [Integer]
+    # @return [MockServerContainer] self
+    def with_server_port(port)
+      @port = port
+      # Replace the exposed port (and its binding) rather than appending, so the
+      # TCP wait strategy never blocks on a port MockServer is not listening on.
+      @exposed_ports = nil
+      @port_bindings = nil
+      add_exposed_port(port)
+      @wait_for = ->(container) { container.wait_until_ready }
+      # Replace (not append) the SERVER_PORT env var — @env is an ordered list
+      # and get_env returns the first match, so a stale entry would shadow this.
+      @env&.reject! { |entry| entry.start_with?("SERVER_PORT=") }
+      with_env("SERVER_PORT", port.to_s)
+    end
+
+    # Sets the MockServer log level (e.g. "INFO", "DEBUG", "WARN", "ERROR", "TRACE").
+    #
+    # @param level [String]
+    # @return [MockServerContainer] self
+    def with_log_level(level)
+      with_env("MOCKSERVER_LOG_LEVEL", level)
+    end
+
+    # Sets a single MockServer property as an environment variable. The key must
+    # be in MockServer env-var form (e.g. "MOCKSERVER_MAX_EXPECTATIONS").
+    #
+    # @param key [String]
+    # @param value [String]
+    # @return [MockServerContainer] self
+    def with_property(key, value)
+      with_env(key, value.to_s)
+    end
+
+    # Mounts an initialization JSON file into the container and configures
+    # MockServer to load its expectations at startup.
+    #
+    # @param host_init_json_path [String] path on the host to the JSON file
+    # @return [MockServerContainer] self
+    def with_initialization_json(host_init_json_path)
+      container_path = "/config/initializerJson.json"
+      add_filesystem_bind(File.expand_path(host_init_json_path), container_path, "ro")
+      with_env("MOCKSERVER_INITIALIZATION_JSON_PATH", container_path)
+    end
+
+    # Resolves the default Docker image, deriving the tag from the MockServer
+    # client library version so the container image stays in lockstep with the
+    # client. Falls back to +:latest+ when the version cannot be resolved.
+    #
+    # @return [String] e.g. "mockserver/mockserver:mockserver-7.3.0"
+    def self.default_image
+      tag = if defined?(MockServer::VERSION) && !MockServer::VERSION.to_s.empty?
+              "mockserver-#{MockServer::VERSION}"
+            else
+              "latest"
+            end
+      "#{IMAGE}:#{tag}"
+    end
+  end
+end

data/testcontainers-mockserver.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "testcontainers/mockserver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "testcontainers-mockserver"
+  spec.version       = Testcontainers::Mockserver::VERSION
+  spec.authors       = ["James Bloom"]
+  spec.email         = ["jamesdbloom@gmail.com"]
+  spec.summary       = "Testcontainers module for MockServer"
+  spec.description   = "Testcontainers module for MockServer — starts a mockserver/mockserver " \
+                       "Docker container, waits for readiness, and exposes connection helpers " \
+                       "plus a ready-wired MockServer client."
+  spec.homepage      = "https://www.mock-server.com"
+  spec.license       = "Apache-2.0"
+
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata = {
+    "source_code_uri"   => "https://github.com/mock-server/mockserver-monorepo",
+    "changelog_uri"     => "https://www.mock-server.com/mock_server/changelog.html",
+    "bug_tracker_uri"   => "https://github.com/mock-server/mockserver-monorepo/issues",
+    "documentation_uri" => "https://www.mock-server.com/mock_server/mockserver_testcontainers.html",
+  }
+
+  spec.files         = Dir["lib/**/*.rb"] + %w[README.md Gemfile testcontainers-mockserver.gemspec]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mockserver-client", ">= 5.15"
+  spec.add_dependency "testcontainers-core", "~> 0.2"
+
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.6"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-mockserver
+version: !ruby/object:Gem::Version
+  version: 7.4.0
+platform: ruby
+authors:
+- James Bloom
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mockserver-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.15'
+- !ruby/object:Gem::Dependency
+  name: testcontainers-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Testcontainers module for MockServer — starts a mockserver/mockserver
+  Docker container, waits for readiness, and exposes connection helpers plus a ready-wired
+  MockServer client.
+email:
+- jamesdbloom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/testcontainers/mockserver.rb
+- lib/testcontainers/mockserver/version.rb
+- testcontainers-mockserver.gemspec
+homepage: https://www.mock-server.com
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/mock-server/mockserver-monorepo
+  changelog_uri: https://www.mock-server.com/mock_server/changelog.html
+  bug_tracker_uri: https://github.com/mock-server/mockserver-monorepo/issues
+  documentation_uri: https://www.mock-server.com/mock_server/mockserver_testcontainers.html
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Testcontainers module for MockServer
+test_files: []