nonnative 2.15.1 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df0fc1bbc0cd9de5368098691bb6c4b812029d70a3d8df236b587874b96e9baf
-  data.tar.gz: 431042c13689b0dec97b2064c130a1b104a167fafecda20f6e90aff2e9c22190
+  metadata.gz: e83e6a409c77b42f73d52473d360f136255a62f5227bb08b770d129082ccd69b
+  data.tar.gz: f2cb0c6bf4b4bcfa7a9ab95851735b987b16ab180aa4ff9278e334e473863aca
 SHA512:
-  metadata.gz: 5dd146af474ac19e1173b38701a75383dd5650e6a182b529c20d2290c44a037072025eee23cc0f6bd06326fc91690d6da83ff746be5cac443609703d5da59075
-  data.tar.gz: 7d7dcbebffa532f5dfe93b4c80ff563d4b0bd5c329a092fc69fcbe1930cd8dac1f191cc04a9ff2dd0de15447b3f446ea134bd9708993e20e7bac780c41122d99
+  metadata.gz: e282a3e79b1319d47154ffac90b305ef5344eb78d9f960e30b3d6a851303f1b736b2f0456e24816a8459db9b5368f4e90d10777fd385e26da3748ac7a894f29f
+  data.tar.gz: 10b38f3e4b0d3d279add988ae32af3c60990715b1fa0c96e94efa6adad29b6f86868b243d2d000e0005815c1c80c4c28a79889a105ef0cf265555b80e4b60b39

data/.circleci/config.yml

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

data/AGENTS.md

@@ -1,13 +1,16 @@
 # AGENTS.md
 
+## Shared skills
+
+This repository uses the shared skills from `bin/skills/`. Read
+`bin/AGENTS.md` for the canonical shared skill list and use the smallest
+matching skill for the task.
+
 `nonnative` is a Ruby gem for end-to-end testing systems implemented in other
 languages. It starts processes, in-process servers, and proxy-only services,
 waits on TCP readiness/shutdown, and can place fault-injection proxies in front
 of dependencies.
 
-Use `./bin/skills/coding-standards` for shared coding, review, testing,
-documentation, and PR conventions. This file only adds repo-specific context.
-
 ## Map And Commands
 
 - Library: `lib/nonnative/**/*.rb`
@@ -76,6 +79,9 @@ Fault-injection states: `none`, `close_all`, `delay`, `invalid_data`.
 
 Config rules:
 
+- YAML config is loaded as data only via `Nonnative::ConfigurationFile`; ERB is not evaluated and arbitrary Ruby object tags are rejected
+- Runner `host` and nested `proxy.host` default to `127.0.0.1`; use explicit `0.0.0.0` only when external access is intended
+- Process `command` can be a legacy shell string or an argv array; prefer argv arrays for new config, and `go:` config builds argv internally
 - YAML services belong under `services:`, not `processes:`
 - There is no top-level `config.wait`; `wait` is per runner
 - Programmatic service config uses `config.service do |s| ... end`, so use `s.host` / `s.port`
@@ -104,4 +110,4 @@ Limitations:
 - Process lifecycle: `lib/nonnative/process.rb`
 - Proxies: `lib/nonnative/fault_injection_proxy.rb`, `lib/nonnative/socket_pair_factory.rb`
 - Cucumber: `lib/nonnative/cucumber.rb`, `lib/nonnative/startup.rb`, `features/support/env.rb`
-- Config loading: `lib/nonnative/configuration.rb`, `lib/nonnative/configuration_runner.rb`, `lib/nonnative/configuration_proxy.rb`
+- Config loading: `lib/nonnative/configuration.rb`, `lib/nonnative/configuration_file.rb`, `lib/nonnative/configuration_runner.rb`, `lib/nonnative/configuration_proxy.rb`

data/Gemfile.lock

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

data/README.md

@@ -38,6 +38,8 @@ gem install nonnative
 ## Usage
 
 Nonnative is configured via {#Nonnative.configure} (programmatic) or `config.load_file(...)` (YAML).
+YAML configuration is loaded as data only: ERB is not evaluated and arbitrary Ruby objects are not
+deserialized.
 
 High-level configuration fields:
 - `version`: configuration version (example: `"1.0"`).
@@ -51,10 +53,12 @@ High-level configuration fields:
 Runner fields (process/server/service):
 - `timeout`: max time (seconds) for readiness/shutdown port checks.
 - `wait`: small sleep (seconds) between lifecycle steps.
-- `host`/`port`: client-facing address used for readiness/shutdown port checks. When a `fault_injection` proxy is enabled, this is the endpoint your tests/clients should hit.
+- `host`/`port`: client-facing address used for readiness/shutdown port checks. `host` defaults to `127.0.0.1`. When a `fault_injection` proxy is enabled, this is the endpoint your tests/clients should hit.
 - `log`: per-runner log file (used by process output redirection or server implementations).
 
-For `fault_injection`, the nested `proxy.host`/`proxy.port` describe the upstream target behind the proxy. In-process server implementations typically bind there via `proxy.host` / `proxy.port`.
+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`.
+
+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`/`port`, results are undefined.
 
 ### Lifecycle strategies (Cucumber integration)
 
@@ -88,6 +92,8 @@ This calls `Nonnative.start` immediately and registers an `at_exit` stop.
 ### Processes
 
 A process is some sort of command that you would run locally.
+Commands can be strings or argv arrays. String commands preserve legacy shell semantics, while argv arrays
+avoid shell interpretation and are preferred for new configuration.
 
 Setup it up programmatically:
 
@@ -102,7 +108,7 @@ Nonnative.configure do |config|
 
   config.process do |p|
     p.name = 'start_1'
-    p.command = -> { 'features/support/bin/start 12_321' }
+    p.command = -> { ['features/support/bin/start', '12_321'] }
     p.timeout = 5
     p.wait = 0.1
     p.port = 12_321
@@ -134,7 +140,9 @@ log: nonnative.log
 processes:
   -
     name: start_1
-    command: features/support/bin/start 12_321
+    command:
+      - features/support/bin/start
+      - "12_321"
     timeout: 5
     wait: 1
     port: 12321
@@ -760,7 +768,7 @@ Then I should reset the proxy for service 'service_1'
 
 ### Go
 
-As we love using go as a language for services we have added support to start binaries with defined parameters. This expects that you build your services in the format of `command sub_command --params`
+As we love using go as a language for services we have added support to start binaries with defined parameters. This expects that you build your services in the format of `command sub_command --params`. YAML `go:` configuration is executed as argv entries, without shell interpretation.
 
 To get this to work you will need to create a `main_test.go` file with these contents:
 
@@ -782,12 +790,16 @@ Then to compile this binary you will need to do the following:
 go test -mod vendor -c -tags features -covermode=count -o your_binary -coverpkg=./... github.com/your_location
 ```
 
-Setup it up programmatically:
+Setup it up programmatically as an argv process command:
 
 ```ruby
-tools = %w[prof trace cover]
-
-Nonnative.go_executable(tools, 'reports', 'your_binary', 'sub_command', '--config config.yaml')
+Nonnative.configure do |config|
+  config.process do |p|
+    p.name = 'go'
+    p.command = -> { ['your_binary', 'sub_command', '--config', 'config.yaml'] }
+    p.port = 12_345
+  end
+end
 ```
 
 Setup it up through configuration:

data/lib/nonnative/configuration.rb

@@ -52,13 +52,14 @@ module Nonnative
 
     # Loads a configuration file and appends its runners to this instance.
     #
-    # The file is loaded using the `config` gem via {Nonnative.configurations}. Top-level attributes are
-    # copied onto this object, and runner sections are transformed into configuration runner objects.
+    # The file is loaded using safe YAML parsing. ERB is not evaluated,
+    # arbitrary object deserialization is not allowed, top-level attributes are copied onto this object,
+    # and runner sections are transformed into configuration runner objects.
     #
     # @param path [String] path to a configuration file (typically YAML)
     # @return [void]
     def load_file(path)
-      cfg = Nonnative.configurations(path)
+      cfg = Nonnative::ConfigurationFile.load(path)
 
       self.version = cfg.version
       self.name = cfg.name
@@ -140,7 +141,7 @@ module Nonnative
         params = go.parameters || []
         tools = go.tools || []
 
-        -> { Nonnative.go_executable(tools, go.output, go.executable, go.command, *params) }
+        -> { Nonnative.go_executable_args(tools, go.output, go.executable, go.command, *params) }
       else
         -> { process.command }
       end

data/lib/nonnative/configuration_file.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Nonnative
+  # Safely loads a YAML configuration file into the Config::Options shape used by Nonnative.
+  class ConfigurationFile
+    class << self
+      # Loads a file into a Config::Options instance.
+      #
+      # YAML files are parsed as data only: ERB is not evaluated and arbitrary object deserialization is not allowed.
+      #
+      # @param path [String] file path
+      # @return [Config::Options]
+      def load(path)
+        Config::Options.new.tap do |config|
+          config.add_source!(safe_load_yaml(path))
+          config.load!
+        end
+      end
+
+      private
+
+      def safe_load_yaml(path)
+        contents = File.read(path)
+        config = YAML.safe_load(contents, aliases: true) || {}
+        return config if config.is_a?(Hash)
+
+        raise ArgumentError, "Configuration file '#{path}' must contain a YAML mapping"
+      rescue Psych::SyntaxError => e
+        raise ArgumentError, "YAML syntax error occurred while parsing #{path}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/nonnative/configuration_process.rb

@@ -11,11 +11,21 @@ module Nonnative
   # @see Nonnative::Configuration
   # @see Nonnative::Process
   class ConfigurationProcess < ConfigurationRunner
-    # @return [Proc] a callable that returns the command string to execute (e.g. `-> { "./bin/api" }`)
+    # @return [Proc] a callable that returns the command to execute
+    #   as a shell string or argv array
+    #   (e.g. `-> { "./bin/api" }` or `-> { ["./bin/api", "--port", "8080"] }`)
+    attr_accessor :command
+
     # @return [String, nil] signal name to use for stopping (defaults to `"INT"` when not set)
+    attr_accessor :signal
+
     # @return [Numeric] readiness timeout (seconds) used when waiting for the port to open/close
+    attr_accessor :timeout
+
     # @return [String] log file path to append process stdout/stderr to
+    attr_accessor :log
+
     # @return [Hash, nil] environment variables to pass to the spawned process
-    attr_accessor :command, :signal, :timeout, :log, :environment
+    attr_accessor :environment
   end
 end

data/lib/nonnative/configuration_proxy.rb

@@ -15,7 +15,7 @@ module Nonnative
   # @see Nonnative.proxies
   class ConfigurationProxy
     # @return [String] proxy kind name (for example `"none"` or `"fault_injection"`)
-    # @return [String] upstream host used by proxy implementations (defaults to `"0.0.0.0"`)
+    # @return [String] upstream host used by proxy implementations (defaults to `"127.0.0.1"`)
     # @return [Integer] upstream port used by proxy implementations (defaults to `0`)
     # @return [String, nil] path to proxy log file (implementation-dependent)
     # @return [Numeric] wait interval (seconds) after proxy state changes (defaults to `0.1`)
@@ -27,7 +27,7 @@ module Nonnative
     #
     # Defaults:
     # - `kind`: `"none"`
-    # - `host`: `"0.0.0.0"`
+    # - `host`: `"127.0.0.1"`
     # - `port`: `0`
     # - `wait`: `0.1`
     # - `options`: `{}`
@@ -35,7 +35,7 @@ module Nonnative
     # @return [void]
     def initialize
       self.kind = 'none'
-      self.host = '0.0.0.0'
+      self.host = '127.0.0.1'
       self.port = 0
       self.wait = 0.1
       self.options = {}

data/lib/nonnative/configuration_runner.rb

@@ -14,7 +14,7 @@ module Nonnative
   # @see Nonnative::ConfigurationService
   class ConfigurationRunner
     # @return [String, nil] runner name used for lookup (for example via `pool.process_by_name`)
-    # @return [String] host to bind/connect to (defaults to `"0.0.0.0"`)
+    # @return [String] host to bind/connect to (defaults to `"127.0.0.1"`)
     # @return [Integer] port to bind/connect to
     # @return [Numeric] wait interval (seconds) used by runners between lifecycle steps
     attr_accessor :name, :host, :port, :wait
@@ -30,14 +30,14 @@ module Nonnative
     # Creates a runner configuration with defaults.
     #
     # Defaults:
-    # - `host`: `"0.0.0.0"`
+    # - `host`: `"127.0.0.1"`
     # - `port`: `0`
     # - `wait`: `0.1`
     # - `proxy`: a new {Nonnative::ConfigurationProxy} with its own defaults
     #
     # @return [void]
     def initialize
-      self.host = '0.0.0.0'
+      self.host = '127.0.0.1'
       self.port = 0
       self.wait = 0.1
 

data/lib/nonnative/cucumber.rb

@@ -88,6 +88,8 @@ module Nonnative
     end
 
     module LifecycleSteps
+      SERVICE_UNAVAILABLE = 'Service Unavailable'
+
       def install_state_steps
         install_start_step
         install_attempt_start_step
@@ -125,7 +127,11 @@ module Nonnative
 
         Then('I should see {string} as unhealthy') do |service|
           wait_for { Nonnative.observability.health(opts).code }.to eq(503)
-          wait_for { Nonnative.observability.health(opts).body }.to include(service)
+          wait_for { Nonnative.observability.health(opts).body }.to satisfy do |body|
+            body = body.to_s.strip
+
+            body == SERVICE_UNAVAILABLE || body.include?(service)
+          end
         end
       end
 
@@ -134,7 +140,11 @@ module Nonnative
 
         Then('I should see {string} as healthy') do |service|
           wait_for { Nonnative.observability.health(opts).code }.to eq(200)
-          wait_for { Nonnative.observability.health(opts).body }.to_not include(service)
+          wait_for { Nonnative.observability.health(opts).body }.to satisfy do |body|
+            body = body.to_s.strip
+
+            body != SERVICE_UNAVAILABLE && !body.include?(service)
+          end
         end
       end
 

data/lib/nonnative/go_command.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Nonnative
-  # Builds command lines for running a Go test binary with optional profiling/trace/coverage flags.
+  # Builds commands for running a Go test binary with optional profiling/trace/coverage flags.
   #
-  # This helper is used by {Nonnative.go_executable} and by YAML configuration when a process has a
-  # `go:` section (see {Nonnative::Configuration}).
+  # This helper is used by YAML configuration when a process has a `go:` section
+  # (see {Nonnative::Configuration}).
   #
   # The generated flags use Go's `testing` package flags (e.g. `-test.cpuprofile=...`), so this
   # is intended to run a binary compiled from `go test -c`.
@@ -21,10 +21,10 @@ module Nonnative
   #
   # @example
   #   cmd = Nonnative::GoCommand.new(%w[prof cover], './svc.test', 'reports')
-  #   cmd.executable('serve', '--config', 'config.yaml')
-  #   # => "./svc.test -test.cpuprofile=... -test.coverprofile=... serve --config config.yaml"
+  #   cmd.executable_args('serve', '--config', 'config.yaml')
+  #   # => ["./svc.test", "-test.cpuprofile=...", "-test.coverprofile=...", "serve", "--config", "config.yaml"]
   #
-  # @see Nonnative.go_executable
+  # @see Nonnative.go_executable_args
   class GoCommand
     # @param tools [Array<String>, nil] tool names to enable (see class docs)
     # @param exec [String] path to the compiled Go test binary
@@ -35,16 +35,15 @@ module Nonnative
       @output = output
     end
 
-    # Returns an executable command string including enabled `-test.*` flags.
+    # Returns an executable argv array including enabled `-test.*` flags.
     #
     # A short random suffix is appended to output filenames to reduce collisions across runs.
     #
     # @param cmd [String] command/sub-command argument passed to the Go test binary
     # @param params [Array<String>] additional parameters passed after `cmd`
-    # @return [String] the full command to execute
-    def executable(cmd, *params)
-      params = params.join(' ')
-      "#{exec} #{flags(cmd).join(' ')} #{cmd} #{params}".strip
+    # @return [Array<String>] argv entries to execute
+    def executable_args(cmd, *params)
+      [exec, *flags(cmd), cmd, *params.flatten.compact.map(&:to_s)]
     end
 
     private

data/lib/nonnative/process.rb

@@ -89,10 +89,10 @@ module Nonnative
         environment[k] = ENV.fetch(k, nil) || environment[k]
       end
 
-      command = service.command.call
+      command = Array(service.command.call)
 
-      spawn(environment, command, %i[out err] => [service.log, 'a']).tap do |pid|
-        Nonnative.logger.info "started '#{command}' with pid '#{pid}'"
+      spawn(environment, *command, %i[out err] => [service.log, 'a']).tap do |pid|
+        Nonnative.logger.info "started '#{command.join(' ')}' with pid '#{pid}'"
       end
     end
 

data/lib/nonnative/version.rb

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

data/lib/nonnative.rb

@@ -67,6 +67,7 @@ require 'nonnative/stop_error'
 require 'nonnative/not_found_error'
 require 'nonnative/timeout'
 require 'nonnative/port'
+require 'nonnative/configuration_file'
 require 'nonnative/configuration'
 require 'nonnative/configuration_runner'
 require 'nonnative/configuration_process'
@@ -113,16 +114,6 @@ module Nonnative
     # @return [Nonnative::Pool, nil] the pool instance, or `nil` if not started yet
     attr_accessor :pool
 
-    # Loads one or more configuration files using the `config` gem.
-    #
-    # This is primarily used by {Nonnative::Configuration#load_file}, but is public for advanced cases.
-    #
-    # @param files [Array<String>] paths to configuration files
-    # @return [Config::Options] the loaded configuration object
-    def configurations(*files)
-      Config.load_files(files)
-    end
-
     # Returns the current configuration (memoized).
     #
     # @return [Nonnative::Configuration]
@@ -162,7 +153,7 @@ module Nonnative
       File.readlines(path).select { |l| predicate.call(l) }
     end
 
-    # Builds a Go test executable command line with optional profiling/trace/coverage flags.
+    # Builds a Go test executable argv array with optional profiling/trace/coverage flags.
     #
     # This is used when process configuration specifies a `go` section.
     #
@@ -171,9 +162,9 @@ module Nonnative
     # @param exec [String] the test binary (or wrapper) to execute
     # @param cmd [String] the command argument passed to the test binary
     # @param params [Array<String>] extra parameters for the command
-    # @return [String] executable command string
-    def go_executable(tools, output, exec, cmd, *params)
-      Nonnative::GoCommand.new(tools, exec, output).executable(cmd, params)
+    # @return [Array<String>] executable argv entries
+    def go_executable_args(tools, output, exec, cmd, *params)
+      Nonnative::GoCommand.new(tools, exec, output).executable_args(cmd, *params)
     end
 
     # Returns an HTTP client for common health/readiness endpoints.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nonnative
 version: !ruby/object:Gem::Version
-  version: 2.15.1
+  version: 2.19.0
 platform: ruby
 authors:
 - Alejandro Falkowski
@@ -288,6 +288,7 @@ files:
 - lib/nonnative.rb
 - lib/nonnative/close_all_socket_pair.rb
 - lib/nonnative/configuration.rb
+- lib/nonnative/configuration_file.rb
 - lib/nonnative/configuration_process.rb
 - lib/nonnative/configuration_proxy.rb
 - lib/nonnative/configuration_runner.rb
@@ -345,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.11
 specification_version: 4
 summary: Allows you to keep using the power of ruby to test other systems
 test_files: []