serverengine 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b802588a6e93b69c2dc9810ab33b9e3195e14d93c5f977961a04cc6d88cacf1
-  data.tar.gz: 9921383ec5ae39cfe982da9ce8c0b432bbc553c2ea5d2090a2d849ec2500c230
+  metadata.gz: 7350069b97302faf3d6c50118875bf055a7094bc31845185cd4e6b4d3e0a9f61
+  data.tar.gz: 02e1c1e261b6ea6dde6a77a984c8f94dccf237093dda7949174acd2658c9897b
 SHA512:
-  metadata.gz: ea4c0e4b34490665e4287c0f43e4ea1f32c10fe022464a69326505ec21aad2650e53b842c2aaeec2a969d914f73715ee059b2bdbb3d72d14b0bce51192bf217c
-  data.tar.gz: 3e30810b08b8667f2295b41fca60c4683126d8936e32169d0789b8ec02ba3965fc631dbe069c9a8cf057e109ccaa9ad3ad14f4507b2388dcd9ae27463ce39651
+  metadata.gz: 66ae31cea3ff4779a648d64c00e54ff01e76912cd2a4ce1f6105b83657bdbdaea0e9b2c54972cc171ed2aa2a01794dd4c2c3b2e73fdb1754a7013cee2fd0c1a5
+  data.tar.gz: 8b023a4052650036480ce2f899ac367279dcc341a3d98536c7a3fc91cf227622a3707f7315a9eead3a0a2335792700723dda3a527aa422c5aa06d2ff27824b11

data/.github/workflows/linux.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.1', '3.0', '2.7' ]
+        ruby: [ '3.2', '3.1', '3.0', '2.7' ]
         os:
           - ubuntu-latest
     name: Unit testing with Ruby ${{ matrix.ruby }} on ${{ matrix.os }}

data/.github/workflows/windows.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.1', '2.7' ]
+        ruby: [ '3.2', '3.1', '2.7' ]
         os:
           - windows-latest
         include:

data/Changelog

@@ -1,3 +1,9 @@
+2023-03-14 version 2.3.2
+
+* Accept `nil` for `ServerEngine::SocketManager::Server.open` to select path automatically
+* Care excluded port ranges of Windows in `ServerEngine::SocketManager.generate_path`
+* Update to Rake 13 and RSpec 3 to support running tests on Ruby 3.2
+
 2022-12-22 version 2.3.1
 
 * Don't treat as error when worker shuts down with exit status 0

data/README.md

@@ -370,8 +370,8 @@ se.run
 ```ruby
 module MyServer
   def before_run
-    @socket_manager_path = ServerEngine::SocketManager::Server.generate_path
-    @socket_manager_server = ServerEngine::SocketManager::Server.open(@socket_manager_path)
+    @socket_manager_server = ServerEngine::SocketManager::Server.open
+    @socket_manager_path = @socket_manager_server.path
   end
 
   def after_run

data/examples/server.rb

@@ -41,8 +41,8 @@ module MyServer
   attr_reader :socket_manager_path
 
   def before_run
-    @socket_manager_path = ServerEngine::SocketManager::Server.generate_path
-    @socket_manager_server = ServerEngine::SocketManager::Server.open(@socket_manager_path)
+    @socket_manager_server = ServerEngine::SocketManager::Server.open
+    @socket_manager_path = @socket_manager_server.path
   rescue Exception => e
     logger.error "unexpected error in server, class #{e.class}: #{e.message}"
     raise

data/lib/serverengine/socket_manager.rb

@@ -77,19 +77,23 @@ module ServerEngine
           port = ENV['SERVERENGINE_SOCKETMANAGER_PORT']
           return port.to_i if port
 
-          for port in get_dynamic_port_range
-            if `netstat -na | findstr "#{port}"`.length == 0
-              return port
-            end
-          end
+          excluded_port_ranges = get_excluded_port_ranges
+          get_dynamic_port_range
+            .reject { |port| excluded_port_ranges.any? { |range| range.cover?(port) } }
+            .find { |port| `netstat -na | findstr "#{port}"`.length == 0 }
         else
           base_dir = (ENV['SERVERENGINE_SOCKETMANAGER_SOCK_DIR'] || '/tmp')
           File.join(base_dir, 'SERVERENGINE_SOCKETMANAGER_' + Time.now.utc.iso8601 + '_' + Process.pid.to_s)
         end
       end
 
-      def self.open(path)
-        new(path)
+      def self.open(path = nil)
+        return new(path) unless path.nil?
+        if ServerEngine.windows?
+          new(0)
+        else
+          new(self.generate_path)
+        end
       end
 
       def initialize(path)
@@ -198,6 +202,27 @@ module ServerEngine
             return 49152..65535
           end
         end
+
+        def self.get_excluded_port_ranges
+          # Example output of netsh:
+          #
+          # Protocol tcp Port Exclusion Ranges
+          #
+          # Start Port    End Port
+          # ----------    --------
+          #       2869        2869
+          #      49152       49251
+          #      50000       50059     *
+          #      57095       57194
+          #
+          # * - Administered port exclusions.
+          #
+          `netsh int ipv4 show excludedportrange tcp`
+            .force_encoding("ASCII-8BIT")
+            .lines
+            .map { |line| line.match(/\s*(\d+)\s*(\d+)[\s\*]*/) ? $1.to_i..$2.to_i : nil }
+            .compact
+        end
       end
     end
 

data/lib/serverengine/socket_manager_win.rb

@@ -108,8 +108,9 @@ module ServerEngine
       end
 
       def start_server(addr)
-        # TODO: use TCPServer, but this is risky because using not conflict path is easy,
-        # but using not conflict port is difficult. Then We had better implement using NamedPipe.
+        # We need to take care about selecting an available port.
+        # By passing `nil` or `0` as `addr`, an available port is automatically selected.
+        # However, we should consider using NamedPipe instead of TCPServer.
         @server = TCPServer.new("127.0.0.1", addr)
         @thread = Thread.new do
           begin
@@ -123,7 +124,7 @@ module ServerEngine
           end
         end
 
-        return path
+        return @server.addr[1]
       end
 
       def stop_server

data/lib/serverengine/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "2.3.1"
+  VERSION = "2.3.2"
 end

data/serverengine.gemspec

@@ -16,13 +16,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.1.0"
+  gem.required_ruby_version = ">= 2.3.0"
 
   gem.add_dependency "sigdump", ["~> 0.2.2"]
 
   # rake v12.x doesn't work with rspec 2. rspec should be updated to 3
-  gem.add_development_dependency "rake", ["~> 11.0"]
-  gem.add_development_dependency "rspec", ["~> 2.13.0"]
+  gem.add_development_dependency "rake", ["~> 13.0"]
+  gem.add_development_dependency "rspec", ["~> 3.12.0"]
 
   gem.add_development_dependency 'rake-compiler-dock', ['~> 0.5.0']
   gem.add_development_dependency 'rake-compiler', ['~> 0.9.4']

data/spec/daemon_logger_spec.rb

@@ -150,7 +150,7 @@ describe ServerEngine::DaemonLogger do
   end
 
   it 'inter-process locking on rotation' do
-    pending "fork is not implemented in Windows" if ServerEngine.windows?
+    skip "fork is not implemented in Windows" if ServerEngine.windows?
 
     log = DaemonLogger.new("tmp/se4.log", level: 'trace', log_rotate_age: 3, log_rotate_size: 10)
     r, w = IO.pipe
@@ -175,7 +175,7 @@ describe ServerEngine::DaemonLogger do
   end
 
   it 'reopen log when path is renamed' do
-    pending "rename isn't supported on windows" if ServerEngine.windows?
+    skip "rename isn't supported on windows" if ServerEngine.windows?
 
     log = DaemonLogger.new("tmp/rotate.log", { level: 'info', log_rotate_age: 0  })
 

data/spec/daemon_spec.rb

@@ -11,7 +11,7 @@ describe ServerEngine::Daemon do
   end
 
   it 'run and graceful stop by signal' do
-    pending "not supported signal base commands on Windows" if ServerEngine.windows?
+    skip "not supported signal base commands on Windows" if ServerEngine.windows?
 
     dm = Daemon.new(TestServer, TestWorker, daemonize: true, pid_path: "tmp/pid", command_sender: "signal")
     dm.main
@@ -33,7 +33,7 @@ describe ServerEngine::Daemon do
   end
 
   it 'signals' do
-    pending "not supported signal base commands on Windows" if ServerEngine.windows?
+    skip "not supported signal base commands on Windows" if ServerEngine.windows?
     dm = Daemon.new(TestServer, TestWorker, daemonize: true, pid_path: "tmp/pid", command_sender: "signal")
     dm.main
 
@@ -112,7 +112,7 @@ describe ServerEngine::Daemon do
   end
 
   it 'exits with status 0 when it was stopped normally' do
-    pending "worker type process(fork) cannot be used in Windows" if ServerEngine.windows?
+    skip "worker type process(fork) cannot be used in Windows" if ServerEngine.windows?
     dm = Daemon.new(
       TestServer,
       TestWorker,
@@ -135,7 +135,7 @@ describe ServerEngine::Daemon do
   end
 
   it 'exits with status of workers if worker exits with status specified in unrecoverable_exit_codes, without supervisor' do
-    pending "worker type process(fork) cannot be used in Windows" if ServerEngine.windows?
+    skip "worker type process(fork) cannot be used in Windows" if ServerEngine.windows?
 
     dm = Daemon.new(
       TestServer,
@@ -159,7 +159,7 @@ describe ServerEngine::Daemon do
   end
 
   it 'exits with status of workers if worker exits with status specified in unrecoverable_exit_codes, with supervisor' do
-    pending "worker type process(fork) cannot be used in Windows" if ServerEngine.windows?
+    skip "worker type process(fork) cannot be used in Windows" if ServerEngine.windows?
 
     dm = Daemon.new(
       TestServer,

data/spec/multi_process_server_spec.rb

@@ -17,7 +17,7 @@ require 'securerandom'
     end
 
     it 'scale up' do
-      pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
+      skip "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
       config = {
         workers: 2,
@@ -50,7 +50,7 @@ require 'securerandom'
     end
 
     it 'scale down' do
-      pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
+      skip "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
       config = {
         workers: 2,
@@ -98,7 +98,7 @@ end
     end
 
     it 'raises SystemExit when all workers exit with specified code by unrecoverable_exit_codes' do
-      pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
+      skip "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
       config = {
         workers: 4,
@@ -127,7 +127,7 @@ end
     end
 
     it 'raises SystemExit immediately when a worker exits if stop_immediately_at_unrecoverable_exit specified' do
-      pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
+      skip "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
       config = {
         workers: 4,
@@ -172,7 +172,7 @@ describe "log level for exited proccess" do
   end
 
   it 'stop' do
-    pending "Windows environment does not support fork" if ServerEngine.windows?
+    skip "Windows environment does not support fork" if ServerEngine.windows?
 
     config = {
       workers: 1,
@@ -197,7 +197,7 @@ describe "log level for exited proccess" do
   end
 
   it 'non zero exit status' do
-    pending "Windows environment does not support fork" if ServerEngine.windows?
+    skip "Windows environment does not support fork" if ServerEngine.windows?
 
     config = {
       workers: 1,
@@ -232,7 +232,7 @@ describe "log level for exited proccess" do
   end
 
   it 'zero exit status' do
-    pending "Windows environment does not support fork" if ServerEngine.windows?
+    skip "Windows environment does not support fork" if ServerEngine.windows?
 
     config = {
       workers: 1,

data/spec/socket_manager_spec.rb

@@ -1,4 +1,5 @@
 require 'socket'
+require 'rr'
 
 describe ServerEngine::SocketManager do
   include_context 'test server and worker'
@@ -21,9 +22,23 @@ describe ServerEngine::SocketManager do
 
   if ServerEngine.windows?
     context 'Server.generate_path' do
-      it 'returns socket path as port number' do
-        path = SocketManager::Server.generate_path
-        expect(path).to be_between(49152, 65535)
+      context 'with socket path as port number' do
+        it 'returns a port in the dynamic port range' do
+          path = SocketManager::Server.generate_path
+          expect(path).to be_between(49152, 65535)
+        end
+
+        it 'returns a port which is not excluded' do
+          excluded_port_ranges = [
+            49152..49251,
+            50000..50059,
+          ]
+          RR.stub(SocketManager::Server).get_excluded_port_ranges { excluded_port_ranges }
+          path = SocketManager::Server.generate_path
+          excluded_port_ranges.each do |range|
+            expect(path).not_to be_between(range.first, range.last)
+          end
+        end
       end
 
       it 'can be changed via environment variable' do
@@ -33,6 +48,13 @@ describe ServerEngine::SocketManager do
         ENV.delete('SERVERENGINE_SOCKETMANAGER_PORT')
       end
     end
+
+    context 'Server.open' do
+      it 'returns server with automatically selected socket path as port number' do
+        server = SocketManager::Server.open
+        expect(server.path).to be_between(49152, 65535)
+      end
+    end
   else
     context 'Server.generate_path' do
       it 'returns socket path under /tmp' do
@@ -47,6 +69,13 @@ describe ServerEngine::SocketManager do
         ENV.delete('SERVERENGINE_SOCKETMANAGER_SOCK_DIR')
       end
     end
+
+    context 'Server.open' do
+      it 'returns server with automatically selected socket path under /tmp' do
+        server = SocketManager::Server.open
+        expect(server.path).to include('/tmp/SERVERENGINE_SOCKETMANAGER_')
+      end
+    end
   end
 
   context 'with thread' do

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
 require 'bundler'
 require 'rspec'
-
-RSpec.configure do |config|
-  config.color_enabled = true
-end
+require 'fileutils'
 
 begin
   Bundler.setup(:default, :test)

data/spec/supervisor_spec.rb

@@ -90,7 +90,7 @@ describe ServerEngine::Supervisor do
     context "when using #{sender} as command_sender" do
 
       it 'start and graceful stop' do
-        pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
+        skip 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
         sv, t = start_supervisor(command_sender: sender)
 
@@ -113,7 +113,7 @@ describe ServerEngine::Supervisor do
       end
 
       it 'immediate stop' do
-        pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
+        skip 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
         sv, t = start_supervisor(command_sender: sender)
 
@@ -131,7 +131,7 @@ describe ServerEngine::Supervisor do
       end
 
       it 'graceful restart' do
-        pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
+        skip 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
         sv, t = start_supervisor(command_sender: sender)
 
@@ -155,7 +155,7 @@ describe ServerEngine::Supervisor do
       end
 
       it 'immediate restart' do
-        pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
+        skip 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
         sv, t = start_supervisor(command_sender: sender)
 
@@ -179,7 +179,7 @@ describe ServerEngine::Supervisor do
       end
 
       it 'reload' do
-        pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
+        skip 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
         sv, t = start_supervisor(command_sender: sender)
 
@@ -200,7 +200,7 @@ describe ServerEngine::Supervisor do
       # TODO detach
 
       it 'auto restart in limited ratio' do
-        pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
+        skip 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
         RR.stub(ServerEngine).dump_uncaught_error
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rake-compiler-dock
   requirement: !ruby/object:Gem::Requirement
@@ -175,14 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: ServerEngine - multiprocess server framework