nonnative 2.19.0 → 2.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e83e6a409c77b42f73d52473d360f136255a62f5227bb08b770d129082ccd69b
-  data.tar.gz: f2cb0c6bf4b4bcfa7a9ab95851735b987b16ab180aa4ff9278e334e473863aca
+  metadata.gz: '08e1e5b760ed902c52e55ef0694bddeb1e36580891ab9a778767a04ea02b1d9c'
+  data.tar.gz: d632a3b8047ebada176e3db071caada192b87d8c255d6beb0e14a1010874103f
 SHA512:
-  metadata.gz: e282a3e79b1319d47154ffac90b305ef5344eb78d9f960e30b3d6a851303f1b736b2f0456e24816a8459db9b5368f4e90d10777fd385e26da3748ac7a894f29f
-  data.tar.gz: 10b38f3e4b0d3d279add988ae32af3c60990715b1fa0c96e94efa6adad29b6f86868b243d2d000e0005815c1c80c4c28a79889a105ef0cf265555b80e4b60b39
+  metadata.gz: bfeba487e42d817e967c0a1cfe0814e5fc75c4d360399dcbd0caaf6ddef83c11efb8a4aff8ffe58ee6566be138b3b85e146e5ffe44dc431e734cf22544956019
+  data.tar.gz: 268c3d360f3d23b18a69317cbe656b06d24b8f94799c245108e94e5e269ac852c000d74d3427168fd2ad5b2c56ea24a3bb21e1507c77d9e4cce713fac4b57a3b

data/.circleci/config.yml

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

data/Gemfile.lock

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

data/README.md

@@ -37,7 +37,7 @@ gem install nonnative
 
 ## Usage
 
-Nonnative is configured via {#Nonnative.configure} (programmatic) or `config.load_file(...)` (YAML).
+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.
 
@@ -50,11 +50,14 @@ High-level configuration fields:
 - `servers`: in-process Ruby servers started in threads.
 - `services`: external dependencies (proxy-only; no process/thread started by Nonnative).
 
-Runner fields (process/server/service):
+Common runner fields:
+- `name`: runner name used for lookup.
+- `host`/`port`: 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, this is the endpoint your tests/clients should hit.
+
+Process/server fields:
 - `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. `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).
+- `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. Nested `proxy.host` also defaults to `127.0.0.1`. In-process server implementations typically bind there via `proxy.host` / `proxy.port`.
 
@@ -95,7 +98,7 @@ 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:
+Set it up programmatically:
 
 ```ruby
 require 'nonnative'
@@ -121,7 +124,7 @@ Nonnative.configure do |config|
 
   config.process do |p|
     p.name = 'start_2'
-    p.command = -> { 'features/support/bin/start 12_322' }
+    p.command = -> { ['features/support/bin/start', '12_322'] }
     p.timeout = 0.5
     p.wait = 0.1
     p.port = 12_322
@@ -130,7 +133,7 @@ Nonnative.configure do |config|
 end
 ```
 
-Setup it up through configuration:
+Set it up through configuration:
 
 ```yaml
 version: "1.0"
@@ -152,7 +155,9 @@ processes:
       TEST: true
   -
     name: start_2
-    command: features/support/bin/start 12_322
+    command:
+      - features/support/bin/start
+      - "12_322"
     timeout: 5
     wait: 1
     port: 12322
@@ -211,7 +216,7 @@ module Nonnative
 end
 ```
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 require 'nonnative'
@@ -224,7 +229,7 @@ Nonnative.configure do |config|
 
   config.server do |s|
     s.name = 'server_1'
-    s.klass = Nonnative::EchoServer
+    s.klass = Nonnative::TCPServer
     s.timeout = 1
     s.port = 12_323
     s.log = 'server_1.log'
@@ -232,7 +237,7 @@ Nonnative.configure do |config|
 
   config.server do |s|
     s.name = 'server_2'
-    s.klass = Nonnative::EchoServer
+    s.klass = Nonnative::TCPServer
     s.timeout = 1
     s.port = 12_324
     s.log = 'server_2.log'
@@ -240,7 +245,7 @@ Nonnative.configure do |config|
 end
 ```
 
-Setup it up through configuration:
+Set it up through configuration:
 
 ```yaml
 version: "1.0"
@@ -250,13 +255,13 @@ log: nonnative.log
 servers:
   -
     name: server_1
-    class: Nonnative::EchoServer
+    class: Nonnative::TCPServer
     timeout: 1
     port: 12323
     log: server_1.log
   -
     name: server_2
-    class: Nonnative::EchoServer
+    class: Nonnative::TCPServer
     timeout: 1
     port: 12324
     log: server_2.log
@@ -294,7 +299,7 @@ module Nonnative
 end
 ```
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 require 'nonnative'
@@ -315,7 +320,7 @@ Nonnative.configure do |config|
 end
 ```
 
-Setup it up through configuration:
+Set it up through configuration:
 
 ```yaml
 version: "1.0"
@@ -359,7 +364,7 @@ module Nonnative
 end
 ```
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 require 'nonnative'
@@ -380,7 +385,7 @@ Nonnative.configure do |config|
 end
 ```
 
-Setup it up through configuration:
+Set it up through configuration:
 
 ```yaml
 version: "1.0"
@@ -428,7 +433,7 @@ module Nonnative
 end
 ```
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 require 'nonnative'
@@ -449,7 +454,7 @@ Nonnative.configure do |config|
 end
 ```
 
-Setup it up through configuration:
+Set it up through configuration:
 
 ```yaml
 version: "1.0"
@@ -711,7 +716,7 @@ Clients connect to the runner `host`/`port`, while the proxy forwards traffic to
 
 ###### Fault Injection Processes
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 name = 'name of process in configuration'
@@ -730,7 +735,7 @@ Then I should reset the proxy for process 'process_1'
 
 ###### Fault Injection Servers
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 name = 'name of server in configuration'
@@ -749,7 +754,7 @@ Then I should reset the proxy for server 'server_1'
 
 ###### Fault Injection Services
 
-Setup it up programmatically:
+Set it up programmatically:
 
 ```ruby
 name = 'name of service in configuration'
@@ -768,11 +773,26 @@ 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`. YAML `go:` configuration is executed as argv entries, without shell interpretation.
+As we love using Go as a language for services we have added support to start binaries with defined parameters.
+
+Programmatic Go binaries can be configured as normal argv process commands:
+
+```ruby
+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
+```
+
+YAML `go:` configuration is for Go test binaries compiled with `go test -c`. It builds argv entries in this order: executable, optional `-test.*` profiling/trace/coverage flags, command, then parameters. Parameter strings are parsed into argv words with shell-style quoting, but the argv entries are executed without shell interpretation.
 
 To get this to work you will need to create a `main_test.go` file with these contents:
 
 ```go
+//go:build features
 // +build features
 
 package main
@@ -780,7 +800,7 @@ package main
 import "testing"
 
 func TestFeatures(t *testing.T) {
- main()
+    main()
 }
 ```
 
@@ -790,19 +810,7 @@ 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 as an argv process command:
-
-```ruby
-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:
+Set it up through configuration:
 
 ```yaml
 version: "1.0"
@@ -818,7 +826,7 @@ processes:
       executable: your_binary
       command: sub_command
       parameters:
-        - --config config.yaml
+        - "-i file:.config/server.yml"
     timeout: 5
     port: 8000
     log: go.log

data/lib/nonnative/go_command.rb

@@ -19,6 +19,8 @@ module Nonnative
   #
   # If `tools` is `nil` or empty, all tools (`prof`, `trace`, `cover`) are enabled.
   #
+  # Parameter strings are parsed into argv words using shell-style quoting, then executed without a shell.
+  #
   # @example
   #   cmd = Nonnative::GoCommand.new(%w[prof cover], './svc.test', 'reports')
   #   cmd.executable_args('serve', '--config', 'config.yaml')
@@ -40,16 +42,20 @@ module Nonnative
     # 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`
+    # @param params [Array<String>] additional parameter strings passed after `cmd`
     # @return [Array<String>] argv entries to execute
     def executable_args(cmd, *params)
-      [exec, *flags(cmd), cmd, *params.flatten.compact.map(&:to_s)]
+      [exec, *flags(cmd), cmd, *parameter_args(params)]
     end
 
     private
 
     attr_reader :tools, :exec, :output
 
+    def parameter_args(params)
+      params.flatten.compact.flat_map { |p| Shellwords.split(p.to_s) }
+    end
+
     def flags(cmd)
       suffix = SecureRandom.alphanumeric(4)
       m = File.basename(exec, File.extname(exec))

data/lib/nonnative/version.rb

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

data/lib/nonnative.rb

@@ -46,6 +46,7 @@ require 'timeout'
 require 'yaml'
 require 'open3'
 require 'securerandom'
+require 'shellwords'
 
 require 'grpc'
 require 'sinatra'
@@ -161,7 +162,7 @@ module Nonnative
     # @param output [String] directory where outputs should be written
     # @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
+    # @param params [Array<String>] extra parameter strings for the command
     # @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)

metadata

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