nonnative 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 786062cd10bbaba4298dd41abc683bc7a5fd769ea7c41a05e39a9f41bc2c5d96
-  data.tar.gz: 1d0e8303858861f849aacbcb54ba2bac1f5a8336fdb74c44d09cb48881658c9f
+  metadata.gz: 3e20a9fa436249c182c4fc90bfaaeeaed91035899d31340eba35d1f4208a31ab
+  data.tar.gz: c68e618e0a2a48cf9958210a8200a96c2aff7c0406eeec332bea01cf9290e860
 SHA512:
-  metadata.gz: 729e1141493b2b21c5c9014216a73aade7f7ec1ab03686ab581cbcb1b1c28d2d469a4fd5e416bcd391c2f8056725433a0befe40c283357166b0743f3f4f2d834
-  data.tar.gz: e17dfe6bd69bbf4d0faf76d0b37502a32abf1ca0943d24f261c4c32301be86fff18e302f65dc9af32ac499ca73d5fe4a08ede17422d2de715a15b4c986ea64c7
+  metadata.gz: c228d28fa41f6e9d526c107feedb4aebfed673aca7b47d7262913db7ceb04468772a1ca068fd4cf696a46a50fc52f01f3dfb9934547945c6ef78b03298cd6cc4
+  data.tar.gz: 60ebed64503ac1505ccd4398330290627600f14519d40389ba96a5e02189762e7d54b314ee98fdd31220f9aba560fc6e09ad7340ffc3925b3f3359747bcf0c0f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nonnative (3.0.0)
+    nonnative (3.1.0)
       concurrent-ruby (>= 1, < 2)
       config (>= 5, < 6)
       cucumber (>= 7, < 12)

data/README.md

@@ -58,19 +58,23 @@ High-level configuration fields:
 
 Common runner fields:
 - `name`: runner name used for lookup.
-- `host`/`ports`: client-facing address. `host` defaults to `127.0.0.1`. For processes and servers, this address is also used for readiness/shutdown port checks. When a `fault_injection` proxy is enabled, clients should hit the first configured port.
+- `host`: client-facing host. Defaults to `127.0.0.1`.
 
 Process/server fields:
+- `ports`: client-facing ports. These are also used for readiness/shutdown port checks. When a `fault_injection` proxy is enabled, clients should hit the first configured port.
 - `timeout`: max time (seconds) for readiness/shutdown port checks.
 - `wait`: small sleep (seconds) between lifecycle steps.
 - `log`: per-runner log file used by process output redirection or server implementations.
 
+Service fields:
+- `port`: client-facing proxy port. Services do not get TCP readiness/shutdown checks from Nonnative.
+
 For `fault_injection`, the nested `proxy.host`/`proxy.port` describe the upstream target behind the proxy. Nested `proxy.host` also defaults to `127.0.0.1`. In-process server implementations typically bind there via `proxy.host` / `proxy.port`.
 
 > [!IMPORTANT]
-> When a proxy is enabled, tests and clients connect to the runner `host` and first configured `ports` entry; the nested `proxy.host`/`proxy.port` is the upstream target behind the proxy.
+> When a proxy is enabled, tests and clients connect to the runner `host` and client-facing endpoint (`ports` first entry for processes/servers, `port` for services); the nested `proxy.host`/`proxy.port` is the upstream target behind the proxy.
 
-Nonnative readiness and shutdown checks are TCP-only. Configure ports that are dedicated to the test run; if another process is already listening on the same `host`/`ports` endpoint, results are undefined.
+Nonnative readiness and shutdown checks are TCP-only. Configure process/server ports that are dedicated to the test run; if another process is already listening on the same endpoint, results are undefined.
 
 > [!WARNING]
 > Readiness and shutdown checks only prove that a TCP port opened or closed. They do not verify HTTP status, gRPC health, schema readiness, migrations, or application-specific health.
@@ -561,13 +565,13 @@ Nonnative.configure do |config|
   config.service do |s|
     s.name = 'postgres'
     s.host = '127.0.0.1'
-    s.ports = [5432]
+    s.port = 5432
   end
 
   config.service do |s|
     s.name = 'redis'
     s.host = '127.0.0.1'
-    s.ports = [6379]
+    s.port = 6379
   end
 end
 ```
@@ -583,13 +587,11 @@ services:
   -
     name: postgres
     host: 127.0.0.1
-    ports:
-      - 5432
+    port: 5432
   -
     name: redis
     host: 127.0.0.1
-    ports:
-      - 6379
+    port: 6379
 ```
 
 Then load the file with:
@@ -742,7 +744,7 @@ Nonnative.configure do |config|
   config.service do |s|
     s.name = 'redis'
     s.host = '127.0.0.1'
-    s.ports = [16_379]
+    s.port = 16_379
 
     s.proxy = {
       kind: 'fault_injection',
@@ -769,8 +771,7 @@ services:
   -
     name: redis
     host: 127.0.0.1
-    ports:
-      - 16379
+    port: 16379
     proxy:
       kind: fault_injection
       host: 127.0.0.1
@@ -785,7 +786,7 @@ services:
 
 The `fault_injection` proxy allows you to simulate failures by injecting them. We currently support the following:
 
-Clients connect to the runner `host` and first configured `ports` entry, while the proxy forwards traffic to nested `proxy.host`/`proxy.port`.
+Clients connect to the runner `host` and client-facing endpoint, while the proxy forwards traffic to nested `proxy.host`/`proxy.port`.
 
 - `close_all` - Closes the socket as soon as it connects.
 - `delay` - Delays traffic on the connection. Defaults to 2 seconds and can be configured through options.

data/lib/nonnative/configuration.rb

@@ -165,7 +165,7 @@ module Nonnative
         service do |service_config|
           service_config.name = loaded_service.name
           service_config.host = loaded_service.host if loaded_service.host
-          assign_ports(service_config, loaded_service)
+          assign_service_port(service_config, loaded_service)
 
           assign_proxy(service_config, loaded_service.proxy)
         end
@@ -193,6 +193,13 @@ module Nonnative
       runner.ports = loaded.ports if loaded.ports
     end
 
+    def assign_service_port(service, loaded)
+      values = loaded.to_h
+      raise ArgumentError, "Use 'port' instead of 'ports' for service '#{loaded.name}'" if values.key?(:ports) || values.key?('ports')
+
+      service.port = loaded.port if loaded.port
+    end
+
     def assign_proxy(runner, loaded_proxy)
       return unless loaded_proxy
 

data/lib/nonnative/configuration_runner.rb

@@ -41,7 +41,7 @@ module Nonnative
     # @return [void]
     def initialize
       self.host = '127.0.0.1'
-      self.ports = [0]
+      @ports = [0]
       self.wait = 0.1
 
       @proxy = Nonnative::ConfigurationProxy.new

data/lib/nonnative/configuration_service.rb

@@ -11,5 +11,33 @@ module Nonnative
   # @see Nonnative::Configuration
   # @see Nonnative::Service
   class ConfigurationService < ConfigurationRunner
+    # @return [Integer] client-facing port used by the service proxy
+    attr_accessor :port
+
+    # Creates a service configuration with defaults.
+    #
+    # @return [void]
+    def initialize
+      super
+
+      self.port = 0
+    end
+
+    # Services expose a single proxy listener, so plural runner ports are not supported.
+    #
+    # @return [void]
+    # @raise [ArgumentError] when plural service ports are read
+    def ports
+      raise ArgumentError, "Use 'port' instead of 'ports' for service '#{name}'"
+    end
+
+    # Services expose a single proxy listener, so plural runner ports are not supported.
+    #
+    # @param _value [Array<Integer>] ignored plural ports
+    # @return [void]
+    # @raise [ArgumentError] when plural service ports are assigned
+    def ports=(_value)
+      raise ArgumentError, "Use 'port' instead of 'ports' for service '#{name}'"
+    end
   end
 end

data/lib/nonnative/fault_injection_proxy.rb

@@ -18,8 +18,8 @@ module Nonnative
   #
   # ## Wiring
   #
-  # When enabled, your test/client should connect to the runner `host` and first configured port (the
-  # proxy endpoint), and the proxy will forward traffic to the upstream target exposed by {#host}:{#port}.
+  # When enabled, your test/client should connect to the runner `host` and primary port (the proxy
+  # endpoint), and the proxy will forward traffic to the upstream target exposed by {#host}:{#port}.
   #
   # ## Configuration
   #
@@ -62,7 +62,7 @@ module Nonnative
 
     # Starts the proxy accept loop in a background thread.
     #
-    # This binds a TCP server on the underlying runner’s `service.host` and first configured port.
+    # This binds a TCP server on the underlying runner’s `service.host` and primary port.
     # Clients connect to that runner endpoint, while upstream traffic is forwarded to {#host}:{#port}.
     #
     # @return [void]

data/lib/nonnative/version.rb

@@ -4,5 +4,5 @@ module Nonnative
   # The current gem version.
   #
   # @return [String]
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nonnative
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Alejandro Falkowski