nonnative 2.13.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf1427ceb9bd3e1a93d7879934477938eb677a12f1687439e99d477ed32ddfa
-  data.tar.gz: c8db117445b7de2b9f16eec5fb36839aeeb6b0496f4e8077d9ce70852fe2b303
+  metadata.gz: f556739cd561141b772bdeaa9f7cdc8f9934d734bf7517d4e17ef16f2f809f15
+  data.tar.gz: fbba3f9c3f5902d2c385a8e509c27f681f6e44876d02ee7d63b00a66edb19a1d
 SHA512:
-  metadata.gz: a0c388775687f4f0832200cddf41def76228097216a80485554ed1874be54a66564946c3bdde65b3c78ce651c6664794c83d8b59e66c24e1719fb0c482295f08
-  data.tar.gz: 150f9db8f08b7ef7ea0697be96e1f4a4c779b3674d66283a7461b0f3037fc448baa3886d42f8984ddee47190ed3269d9c659badb7b333da859ce31e685c82a47
+  metadata.gz: 65e74315f3bb6e81b1c2797fce743c2f0741a52e2edd40ba608a30e4d582e08b1408008249dd76e81972a438054810390b709f785e6ef455b719ef89658a572c
+  data.tar.gz: 0e43f244c7867e12a512a71aea9f70f2fa0323c62f97f5c417512e131450a7fc714419cb2af0798a692848d5fe95111417ea263b80c1ce5a6f853663a0c03fce

data/.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 jobs:
   build:
     docker:
-      - image: alexfalkowski/ruby:2.5
+      - image: alexfalkowski/ruby:2.12
     working_directory: ~/nonnative
     steps:
       - checkout:
@@ -35,7 +35,7 @@ jobs:
     resource_class: arm.large
   sync:
     docker:
-      - image: alexfalkowski/release:7.6
+      - image: alexfalkowski/release:7.13
     working_directory: ~/nonnative
     steps:
       - checkout:
@@ -46,7 +46,7 @@ jobs:
     resource_class: arm.large
   version:
     docker:
-      - image: alexfalkowski/release:7.6
+      - image: alexfalkowski/release:7.13
     working_directory: ~/nonnative
     steps:
       - checkout:
@@ -58,7 +58,7 @@ jobs:
     resource_class: arm.large
   wait-all:
     docker:
-      - image: alexfalkowski/ruby:2.5
+      - image: alexfalkowski/ruby:2.12
     steps:
       - run: echo "all applicable jobs finished"
     resource_class: arm.large

data/AGENTS.md

@@ -2,6 +2,13 @@
 
 This repo is the `nonnative` Ruby gem: a Ruby-first harness for end-to-end testing of systems implemented in other languages by starting processes/servers/services, waiting on TCP port readiness, and optionally putting fault-injection proxies in front of them.
 
+## Shared skill
+
+Use the shared `coding-standards` skill from `./bin/skills/coding-standards`
+for cross-repository coding, review, testing, documentation, and PR
+conventions. Treat this `AGENTS.md` as the repo-specific companion to that
+skill.
+
 ## Quick map
 
 - Library code: `lib/nonnative/**/*.rb`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nonnative (2.13.0)
+    nonnative (2.15.0)
       concurrent-ruby (>= 1, < 2)
       config (>= 5, < 6)
       cucumber (>= 7, < 12)
@@ -206,4 +206,4 @@ DEPENDENCIES
   simplecov-cobertura
 
 BUNDLED WITH
-  4.0.8
+  4.0.10

data/README.md

@@ -681,6 +681,8 @@ services:
 
 The `fault_injection` proxy allows you to simulate failures by injecting them. We currently support the following:
 
+Clients connect to the runner `host`/`port`, while the proxy forwards traffic to nested `proxy.host`/`proxy.port`.
+
 - `close_all` - Closes the socket as soon as it connects.
 - `delay` - This delays the communication between the connection. Default is 2 secs can be configured through options.
 - `invalid_data` - This takes the input and rearranges it to produce invalid data.

data/lib/nonnative/fault_injection_proxy.rb

@@ -18,15 +18,15 @@ module Nonnative
   #
   # ## Wiring
   #
-  # When enabled, your test/client should typically connect to {#host}:{#port} (the proxy endpoint),
-  # and the proxy will connect onward to the underlying service.
+  # When enabled, your test/client should connect to the runner `host` / `port` (the proxy endpoint),
+  # and the proxy will forward traffic to the upstream target exposed by {#host}:{#port}.
   #
   # ## Configuration
   #
   # The proxy is configured via the runner’s `proxy` hash:
   #
   # - `kind`: `"fault_injection"`
-  # - `host` / `port`: where the proxy should be reached by clients (exposed via {#host}/{#port})
+  # - `host` / `port`: upstream target behind the proxy (exposed via {#host}/{#port})
   # - `log`: file path used by this proxy’s internal logger
   # - `wait`: sleep interval (seconds) applied after state changes
   # - `options`:
@@ -35,6 +35,21 @@ module Nonnative
   # @see Nonnative::Proxy
   # @see Nonnative::SocketPairFactory
   class FaultInjectionProxy < Nonnative::Proxy
+    class Connection
+      attr_accessor :pair, :thread
+      attr_reader :socket
+
+      def initialize(socket)
+        @socket = socket
+      end
+
+      def close
+        pair&.close
+        socket.close unless socket.closed?
+        thread&.terminate
+      end
+    end
+
     # @param service [Nonnative::ConfigurationRunner] runner configuration with proxy settings
     def initialize(service)
       @connections = Concurrent::Hash.new
@@ -48,7 +63,7 @@ module Nonnative
     # Starts the proxy accept loop in a background thread.
     #
     # This binds a TCP server on the underlying runner’s `service.host` / `service.port`.
-    # Clients should connect to {#host}:{#port}.
+    # Clients connect to that runner endpoint, while upstream traffic is forwarded to {#host}:{#port}.
     #
     # @return [void]
     def start
@@ -58,12 +73,21 @@ module Nonnative
       Nonnative.logger.info "started with host '#{service.host}' and port '#{service.port}' for proxy 'fault_injection'"
     end
 
-    # Stops the proxy and closes its listening socket.
+    # Stops the proxy, closes active connections, and closes its listening socket.
     #
     # @return [void]
     def stop
-      thread&.terminate
-      tcp_server&.close
+      mutex.synchronize do
+        close_connections
+      end
+
+      server = @tcp_server
+      @tcp_server = nil
+      server&.close
+
+      listener_thread = @thread
+      @thread = nil
+      listener_thread&.join
 
       Nonnative.logger.info "stopped with host '#{service.host}' and port '#{service.port}' for proxy 'fault_injection'"
     end
@@ -98,14 +122,14 @@ module Nonnative
       apply_state :none
     end
 
-    # Returns the host clients should connect to when using this proxy.
+    # Returns the upstream host behind this proxy.
     #
     # @return [String]
     def host
       service.proxy.host
     end
 
-    # Returns the port clients should connect to when using this proxy.
+    # Returns the upstream port behind this proxy.
     #
     # @return [Integer]
     def port
@@ -118,14 +142,16 @@ module Nonnative
 
     def perform_start
       loop do
-        thread = Thread.start(tcp_server.accept) do |local_socket|
-          id = Thread.current.object_id
-
-          accept_connection id, local_socket
+        local_socket = tcp_server.accept
+        id = local_socket.object_id
+        register_connection(id, local_socket)
+        connection_thread = Thread.start(local_socket) do |accepted_socket|
+          accept_connection id, accepted_socket
         end
-
-        connections[thread.object_id] = thread
+        attach_connection_thread(id, connection_thread)
       end
+    rescue IOError, Errno::EBADF
+      nil
     end
 
     def accept_connection(id, socket)
@@ -144,6 +170,7 @@ module Nonnative
       Nonnative.logger.info "connecting for '#{id}' with socket '#{socket.inspect}' and state '#{state}' for proxy 'fault_injection'"
 
       pair = SocketPairFactory.create(state, service.proxy)
+      attach_connection_pair(id, pair)
       pair.connect(socket)
     rescue StandardError => e
       socket.close
@@ -152,12 +179,10 @@ module Nonnative
     end
 
     def close_connections
-      connections.each do |id, thread|
-        Nonnative.logger.info "closing connection for '#{id}' for proxy 'fault_injection'"
-
-        thread.terminate
+      connections.each do |id, connection|
+        close_connection(id, connection)
       end
-
+    ensure
       connections.clear
     end
 
@@ -177,5 +202,23 @@ module Nonnative
     def read_state
       mutex.synchronize { state }
     end
+
+    def register_connection(id, socket)
+      connections[id] = Connection.new(socket)
+    end
+
+    def attach_connection_thread(id, thread)
+      connections[id]&.thread = thread
+    end
+
+    def attach_connection_pair(id, pair)
+      connections[id]&.pair = pair
+    end
+
+    def close_connection(id, connection)
+      Nonnative.logger.info "closing connection for '#{id}' for proxy 'fault_injection'"
+
+      connection.close
+    end
   end
 end

data/lib/nonnative/grpc_server.rb

@@ -33,8 +33,8 @@ module Nonnative
 
     # Binds the gRPC server and begins serving requests.
     #
-    # The server binds to the proxy host/port so that enabling a proxy results in traffic and readiness
-    # checks consistently targeting the proxy endpoint.
+    # The server binds to the upstream proxy host/port so the fault-injection proxy can expose the
+    # runner host/port as the client-facing endpoint used by readiness checks.
     #
     # @return [void]
     def perform_start

data/lib/nonnative/http_server.rb

@@ -48,8 +48,8 @@ module Nonnative
 
     # Binds the Puma server and begins serving.
     #
-    # The listener binds to the proxy host/port so that enabling a proxy results in traffic and
-    # readiness checks consistently targeting the proxy endpoint.
+    # The listener binds to the upstream proxy host/port so the fault-injection proxy can expose the
+    # runner host/port as the client-facing endpoint used by readiness checks.
     #
     # @return [void]
     def perform_start

data/lib/nonnative/socket_pair.rb

@@ -28,19 +28,27 @@ module Nonnative
     # @param local_socket [TCPSocket] the accepted client socket
     # @return [void]
     def connect(local_socket)
-      remote_socket = create_remote_socket
+      @local_socket = local_socket
+      @remote_socket = create_remote_socket
 
       loop do
-        ready = select([local_socket, remote_socket], nil, nil)
+        ready = select([@local_socket, @remote_socket], nil, nil)
 
-        break if pipe?(ready, local_socket, remote_socket)
-        break if pipe?(ready, remote_socket, local_socket)
+        break if pipe?(ready, @local_socket, @remote_socket)
+        break if pipe?(ready, @remote_socket, @local_socket)
       end
     ensure
-      Nonnative.logger.info "finished connect for local socket '#{local_socket.inspect}' and '#{remote_socket&.inspect}' for 'socket_pair'"
+      Nonnative.logger.info "finished connect for local socket '#{@local_socket.inspect}' and '#{@remote_socket&.inspect}' for 'socket_pair'"
 
-      local_socket.close
-      remote_socket&.close
+      close
+    end
+
+    # Closes any open sockets managed by this pair.
+    #
+    # @return [void]
+    def close
+      close_socket @local_socket
+      close_socket @remote_socket
     end
 
     protected
@@ -94,5 +102,13 @@ module Nonnative
     def write(socket, data)
       socket.write(data)
     end
+
+    def close_socket(socket)
+      return if socket.nil? || socket.closed?
+
+      socket.close
+    rescue IOError
+      nil
+    end
   end
 end

data/lib/nonnative/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nonnative
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Alejandro Falkowski
@@ -345,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Allows you to keep using the power of ruby to test other systems
 test_files: []