nonnative 1.41.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50953dcfe695bf9196b5d3968a88f15fa6db81c630c0537e8c796ad63486d15f
-  data.tar.gz: f910aec0fdb41fd9cea678657be191be85756d2c99ae45d64750a6f31c2534f7
+  metadata.gz: 16a378ffdce68b4ac61ec07aed090eab3b907b9138ea4bcce3a1d435bc386723
+  data.tar.gz: 8a3f84148bf7d47786f0bd0793c16524ab49b6ec779ca6ce23d3d4b2c16d2053
 SHA512:
-  metadata.gz: 621d4af2d17163e749f0a706b991a52583f32603f64ba3a0fd978c31961c1de11c4b713a0023e0baf7309a9abf072f8642a4551d5a87d1c33bb4caa8844116b6
-  data.tar.gz: 7f1516ab344e4ce99388046490809cb6a63e4de40909aab41c018b73d18e70d3d3b6c76069b9a747a15eed801d9bc94d83e097012bd82cdbcc49ff7a140443eb
+  metadata.gz: 31c1a5e132f2686355a595b76f5da900256b3948fe70e6b64b07d76e93603ac24f808914b2d0bec97bdabe57a8cfca4888a1293e50cf0ca04e7fb1e9b6e7d6c1
+  data.tar.gz: b7fb0522f26ff25b988ba464c4993647e22b595a8a6f857216fcf9cc4f821360720361e486b3e578962f15b5ec63334a43495da405355d57efe21e254c5b7897

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.42.1](https://github.com/alexfalkowski/nonnative/compare/v1.42.0...v1.42.1) (2021-04-30)
+
+## [1.42.0](https://github.com/alexfalkowski/nonnative/compare/v1.41.0...v1.42.0) (2021-04-30)
+
+
+### Features
+
+* add services ([#80](https://github.com/alexfalkowski/nonnative/issues/80)) ([454980e](https://github.com/alexfalkowski/nonnative/commit/454980e1eb141995c96203fcf9254bfe2cb0133e))
+
 ## [1.41.0](https://github.com/alexfalkowski/nonnative/compare/v1.40.2...v1.41.0) (2021-04-30)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nonnative (1.41.0)
+    nonnative (1.42.0)
       concurrent-ruby (~> 1.0, >= 1.0.5)
       cucumber (>= 6, < 7)
       grpc (>= 1, < 2)

data/README.md

@@ -33,12 +33,12 @@ Or install it yourself as:
 
 Configure nonnative with the following:
 
-- Process/Server that you want to start.
+- Process, Server or Service that you want to start.
 - A timeout value.
 - Port to verify.
 - The class for servers.
 - The log for servers/processes
-- The strategy for processes/servers.
+- The strategy for processes, servers and services.
 
 ### Strategy
 
@@ -53,6 +53,8 @@ This can be overridden by the following environment variables:
 
 ### Processes
 
+A process is some sort of command that you would run locally.
+
 Setup it up programmatically:
 
 ```ruby
@@ -84,7 +86,7 @@ Setup it up through configuration:
 
 ```yaml
 version: 1.0
-strategy: manual
+strategy: startup
 processes:
   -
     name: start_1
@@ -111,6 +113,8 @@ Nonnative.load_configuration('configuration.yml')
 
 ### Servers
 
+A server is a dependency to some external API.
+
 Define your server:
 
 ```ruby
@@ -140,7 +144,7 @@ Setup it up programmatically:
 require 'nonnative'
 
 Nonnative.configure do |config|
-  config.strategy = :manual
+  config.strategy = :startup
 
   config.server do |s|
     s.name = 'server_1'
@@ -164,7 +168,7 @@ Setup it up through configuration:
 
 ```yaml
 version: 1.0
-strategy: manual
+strategy: startup
 servers:
   -
     name: server_1
@@ -220,7 +224,7 @@ Setup it up programmatically:
 require 'nonnative'
 
 Nonnative.configure do |config|
-  config.strategy = :manual
+  config.strategy = :startup
 
   config.server do |s|
     s.name = 'http_server_1'
@@ -236,7 +240,7 @@ Setup it up through configuration:
 
 ```yaml
 version: 1.0
-strategy: manual
+strategy: startup
 servers:
   -
     name: http_server_1
@@ -282,7 +286,7 @@ Setup it up programmatically:
 require 'nonnative'
 
 Nonnative.configure do |config|
-  config.strategy = :manual
+  config.strategy = :startup
 
   config.server do |s|
     s.name = 'grpc_server_1'
@@ -298,7 +302,7 @@ Setup it up through configuration:
 
 ```yaml
 version: 1.0
-strategy: manual
+strategy: startup
 servers:
   -
     name: grpc_server_1
@@ -315,6 +319,53 @@ require 'nonnative'
 
 Nonnative.load_configuration('configuration.yml')
 ```
+
+### Services
+
+A service is an external dependency to your system. This is usually an expensive process to start like a DB and you would prefer to be managed externally. Services are not really exciting by themselves, it's when we add proxies that they allow us to do some extra work.
+
+Setup it up programmatically:
+
+```ruby
+require 'nonnative'
+
+Nonnative.configure do |config|
+  config.strategy = :startup
+
+  config.service do |s|
+    s.name = 'postgres'
+    p.port = 5432
+  end
+
+  config.service do |s|
+    s.name = 'redis'
+    s.port = 6379
+  end
+end
+```
+
+Setup it up through configuration:
+
+```yaml
+version: 1.0
+strategy: startup
+processes:
+  -
+    name: postgres
+    port: 5432
+  -
+    name: redis
+    port: 6379
+```
+
+Then load the file with
+
+```ruby
+require 'nonnative'
+
+Nonnative.load_configuration('configuration.yml')
+```
+
 #### Proxies
 
 We allow different proxies to be configured. These proxies can be used to simulate all kind of situations. The proxies that can be configured are:
@@ -329,7 +380,7 @@ Setup it up programmatically:
 require 'nonnative'
 
 Nonnative.configure do |config|
-  config.strategy = :manual
+  config.strategy = :startup
 
   config.process do |p|
     p.proxy = {
@@ -348,7 +399,7 @@ Setup it up through configuration:
 
 ```yaml
 version: 1.0
-strategy: manual
+strategy: startup
 processes:
   -
     proxy:
@@ -367,7 +418,7 @@ Setup it up programmatically:
 require 'nonnative'
 
 Nonnative.configure do |config|
-  config.strategy = :manual
+  config.strategy = :startup
 
   config.server do |s|
     s.proxy = {
@@ -386,7 +437,7 @@ Setup it up through configuration:
 
 ```yaml
 version: 1.0
-strategy: manual
+strategy: startup
 servers:
   -
     proxy:
@@ -397,6 +448,44 @@ servers:
         delay: 5
 ```
 
+##### Services
+
+Setup it up programmatically:
+
+```ruby
+require 'nonnative'
+
+Nonnative.configure do |config|
+  config.strategy = :startup
+
+  config.service do |s|
+    s.proxy = {
+      type: 'fault_injection',
+      port: 20_000,
+      log: 'features/logs/proxy_server.log',
+      options: {
+        delay: 5
+      }
+    }
+  end
+end
+```
+
+Setup it up through configuration:
+
+```yaml
+version: 1.0
+strategy: startup
+services:
+  -
+    proxy:
+      type: fault_injection
+      port: 20000
+      log: features/logs/proxy_server.log
+      options:
+        delay: 5
+```
+
 ##### Fault Injection
 
 The `fault_injection` proxy allows you to simulate failures by injecting them. We currently support the following:
@@ -428,6 +517,18 @@ server.proxy.close_all # To use close_all.
 server.proxy.reset # To reset it back to a good state.
 ```
 
+###### Services
+
+Setup it up programmatically:
+
+```ruby
+name = 'name of service in configuration'
+service = Nonnative.pool.service_by_name(name)
+
+service.proxy.close_all # To use close_all.
+service.proxy.reset # To reset it back to a good state.
+```
+
 ### 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`

data/lib/nonnative.rb

@@ -19,14 +19,16 @@ require 'nonnative/stop_error'
 require 'nonnative/timeout'
 require 'nonnative/port'
 require 'nonnative/configuration'
-require 'nonnative/configuration_service'
+require 'nonnative/configuration_runner'
 require 'nonnative/configuration_process'
 require 'nonnative/configuration_server'
+require 'nonnative/configuration_service'
 require 'nonnative/configuration_proxy'
-require 'nonnative/service'
+require 'nonnative/runner'
 require 'nonnative/process'
-require 'nonnative/pool'
 require 'nonnative/server'
+require 'nonnative/service'
+require 'nonnative/pool'
 require 'nonnative/http_client'
 require 'nonnative/http_server'
 require 'nonnative/grpc_server'

data/lib/nonnative/close_all_socket_pair.rb

@@ -3,7 +3,6 @@
 module Nonnative
   class CloseAllSocketPair < SocketPair
     def connect(local_socket)
-    ensure
       local_socket.close
     end
   end

data/lib/nonnative/configuration.rb

@@ -47,6 +47,20 @@ module Nonnative
         end
       end
 
+      def services(file, config)
+        services = file['services'] || []
+        services.each do |fd|
+          config.service do |s|
+            s.name = fd['name']
+            s.timeout = fd['timeout']
+            s.port = fd['port']
+            s.log = fd['log']
+
+            proxy s, fd['proxy']
+          end
+        end
+      end
+
       def proxy(server, proxy)
         return unless proxy
 
@@ -63,9 +77,10 @@ module Nonnative
       @strategy = Strategy.new
       @processes = []
       @servers = []
+      @services = []
     end
 
-    attr_accessor :processes, :servers
+    attr_accessor :processes, :servers, :services
     attr_reader :strategy
 
     def strategy=(value)
@@ -85,5 +100,12 @@ module Nonnative
 
       servers << server
     end
+
+    def service
+      service = Nonnative::ConfigurationService.new
+      yield service
+
+      services << service
+    end
   end
 end

data/lib/nonnative/configuration_process.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nonnative
-  class ConfigurationProcess < ConfigurationService
+  class ConfigurationProcess < ConfigurationRunner
     attr_accessor :command, :signal
   end
 end

data/lib/nonnative/configuration_runner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nonnative
+  class ConfigurationRunner
+    attr_accessor :name, :timeout, :port, :log
+    attr_reader :proxy
+
+    def initialize
+      @proxy = Nonnative::ConfigurationProxy.new
+    end
+
+    def proxy=(value)
+      proxy.type = value[:type]
+      proxy.port = value[:port]
+      proxy.log = value[:log]
+      proxy.options = value[:options]
+    end
+  end
+end

data/lib/nonnative/configuration_server.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nonnative
-  class ConfigurationServer < ConfigurationService
+  class ConfigurationServer < ConfigurationRunner
     attr_accessor :klass
   end
 end

data/lib/nonnative/configuration_service.rb

@@ -1,19 +1,6 @@
 # frozen_string_literal: true
 
 module Nonnative
-  class ConfigurationService
-    attr_accessor :name, :timeout, :port, :log
-    attr_reader :proxy
-
-    def initialize
-      @proxy = Nonnative::ConfigurationProxy.new
-    end
-
-    def proxy=(value)
-      proxy.type = value[:type]
-      proxy.port = value[:port]
-      proxy.log = value[:log]
-      proxy.options = value[:options]
-    end
+  class ConfigurationService < ConfigurationRunner
   end
 end

data/lib/nonnative/fault_injection_proxy.rb

@@ -17,8 +17,8 @@ module Nonnative
     end
 
     def stop
-      thread.terminate
-      tcp_server.close
+      thread&.terminate
+      tcp_server&.close
     end
 
     def close_all

data/lib/nonnative/pool.rb

@@ -7,11 +7,13 @@ module Nonnative
     end
 
     def start(&block)
+      services.each(&:start)
       [servers, processes].each { |t| process(t, :start, :open?, &block) }
     end
 
     def stop(&block)
       [processes, servers].each { |t| process(t, :stop, :closed?, &block) }
+      services.each(&:stop)
     end
 
     def process_by_name(name)
@@ -24,22 +26,31 @@ module Nonnative
       servers[index].first
     end
 
+    def service_by_name(name)
+      index = configuration.services.find_index { |s| s.name == name }
+      services[index]
+    end
+
     private
 
     attr_reader :configuration
 
     def processes
-      @processes ||= configuration.processes.map do |d|
-        [Nonnative::Process.new(d), Nonnative::Port.new(d)]
+      @processes ||= configuration.processes.map do |p|
+        [Nonnative::Process.new(p), Nonnative::Port.new(p)]
       end
     end
 
     def servers
-      @servers ||= configuration.servers.map do |d|
-        [d.klass.new(d), Nonnative::Port.new(d)]
+      @servers ||= configuration.servers.map do |s|
+        [s.klass.new(s), Nonnative::Port.new(s)]
       end
     end
 
+    def services
+      @services ||= configuration.services.map { |s| Nonnative::Service.new(s) }
+    end
+
     def process(all, type_method, port_method, &block)
       types = []
       pids = []

data/lib/nonnative/process.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nonnative
-  class Process < Nonnative::Service
+  class Process < Runner
     def start
       unless process_exists?
         proxy.start

data/lib/nonnative/runner.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Nonnative
+  class Runner
+    attr_reader :proxy
+
+    def initialize(service)
+      @service = service
+      @timeout = Nonnative::Timeout.new(service.timeout)
+      @proxy = Nonnative::ProxyFactory.create(service)
+    end
+
+    def name
+      service.name
+    end
+
+    protected
+
+    attr_reader :service, :timeout
+
+    def wait_start
+      sleep 0.1
+    end
+
+    def wait_stop
+      sleep 0.1
+    end
+  end
+end

data/lib/nonnative/server.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 module Nonnative
-  class Server < Nonnative::Service
-    attr_reader :proxy
-
+  class Server < Runner
     def start
       unless thread
         proxy.start

data/lib/nonnative/service.rb

@@ -1,29 +1,13 @@
 # frozen_string_literal: true
 
 module Nonnative
-  class Service
-    attr_reader :proxy
-
-    def initialize(service)
-      @service = service
-      @timeout = Nonnative::Timeout.new(service.timeout)
-      @proxy = Nonnative::ProxyFactory.create(service)
-    end
-
-    def name
-      service.name
-    end
-
-    protected
-
-    attr_reader :service, :timeout
-
-    def wait_start
-      sleep 0.1
+  class Service < Runner
+    def start
+      proxy.start
     end
 
-    def wait_stop
-      sleep 0.1
+    def stop
+      proxy.stop
     end
   end
 end

data/lib/nonnative/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nonnative
-  VERSION = '1.41.0'
+  VERSION = '1.42.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nonnative
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Alex Falkowski
@@ -262,6 +262,7 @@ files:
 - lib/nonnative/configuration.rb
 - lib/nonnative/configuration_process.rb
 - lib/nonnative/configuration_proxy.rb
+- lib/nonnative/configuration_runner.rb
 - lib/nonnative/configuration_server.rb
 - lib/nonnative/configuration_service.rb
 - lib/nonnative/delay_socket_pair.rb
@@ -280,6 +281,7 @@ files:
 - lib/nonnative/process.rb
 - lib/nonnative/proxy.rb
 - lib/nonnative/proxy_factory.rb
+- lib/nonnative/runner.rb
 - lib/nonnative/server.rb
 - lib/nonnative/service.rb
 - lib/nonnative/socket_pair.rb