Class: Nonnative::FaultInjectionProxy

Inherits:
Proxy
  • Object
show all
Defined in:
lib/nonnative/fault_injection_proxy.rb

Overview

Fault-injection proxy for TCP services.

This proxy accepts incoming TCP connections and forwards traffic to the configured upstream (service.proxy.host / service.proxy.port) via a socket-pair implementation. It can also inject failures to help validate client resilience.

This class exposes a small public control surface for tests:

  • #close_all: close connections immediately on accept
  • #reset_peer: reset connections immediately on accept (TCP RST rather than a graceful close)
  • #delay: delay reads by a configured duration (default: 2 seconds)
  • #timeout: accept connections and keep them silent until clients time out
  • #invalid_data: forward requests unchanged and mutate upstream responses before they reach clients
  • #reset: return to healthy pass-through behavior

State changes terminate any active connections so new connections observe the new behavior.

Wiring

When enabled, your test/client should connect to the service host and 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 service's proxy hash:

  • kind: "fault_injection"
  • 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:
    • delay: delay duration in seconds used by #delay

See Also:

Defined Under Namespace

Classes: Connection

Instance Method Summary collapse

Constructor Details

#initialize(service) ⇒ FaultInjectionProxy

Returns a new instance of FaultInjectionProxy.

Parameters:



56
57
58
59
60
61
62
63
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 56

def initialize(service)
  @connections = Concurrent::Hash.new
  @logger = Logger.new(service.proxy.log)
  @mutex = Mutex.new
  @state = :none

  super
end

Instance Method Details

#close_all ⇒ void

This method returns an undefined value.

Forces new connections to be closed immediately.



99
100
101
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 99

def close_all
  apply_state :close_all
end

#delay ⇒ void

This method returns an undefined value.

Delays reads before forwarding.

The delay duration is controlled by service.proxy.options[:delay] and defaults to 2 seconds.



118
119
120
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 118

def delay
  apply_state :delay
end

#host ⇒ String

Returns the upstream host behind this proxy.

Returns:

  • (String) 


150
151
152
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 150

def host
  service.proxy.host
end

#invalid_data ⇒ void

This method returns an undefined value.

Mutates upstream responses while forwarding client requests unchanged.



136
137
138
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 136

def invalid_data
  apply_state :invalid_data
end

#port ⇒ Integer

Returns the upstream port behind this proxy.

Returns:

  • (Integer) 


157
158
159
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 157

def port
  service.proxy.port
end

#reset ⇒ void

This method returns an undefined value.

Resets the proxy back to healthy pass-through behavior.



143
144
145
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 143

def reset
  apply_state :none
end

#reset_peer ⇒ void

This method returns an undefined value.

Forces new connections to be reset immediately.

Unlike #close_all, which closes the socket gracefully (FIN), this closes the accepted socket with a zero linger timeout so clients observe a TCP reset (Errno::ECONNRESET).



109
110
111
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 109

def reset_peer
  apply_state :reset_peer
end

#start ⇒ void

This method returns an undefined value.

Starts the proxy accept loop in a background thread.

This binds a TCP server on the service host and port. Clients connect to that service endpoint, while upstream traffic is forwarded to #host:#port.



71
72
73
74
75
76
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 71

def start
  @tcp_server = ::TCPServer.new(service.host, service.port)
  @thread = Thread.new { perform_start }

  Nonnative.logger.info "started with host '#{service.host}' and port '#{service.port}' for proxy 'fault_injection'"
end

#stop ⇒ void

This method returns an undefined value.

Stops the proxy, closes active connections, and closes its listening socket.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 81

def stop
  server = tcp_server
  server&.close

  listener_thread = thread
  listener_thread&.join

  @tcp_server = nil
  @thread = nil

  close_connections

  Nonnative.logger.info "stopped with host '#{service.host}' and port '#{service.port}' for proxy 'fault_injection'"
end

#timeout ⇒ void

This method returns an undefined value.

Accepts connections and stalls without forwarding bytes.

This simulates a dependency that accepts a TCP connection but leaves clients waiting until their own read timeout fires. The proxy keeps the connection silent until reset or stop closes active connections.



129
130
131
 
# File 'lib/nonnative/fault_injection_proxy.rb', line 129

def timeout
  apply_state :timeout
end