uringmachine 0.5 → 0.6

data/lib/uringmachine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class UringMachine
-  VERSION = '0.5'
+  VERSION = '0.6'
 end

data/lib/uringmachine.rb

@@ -8,8 +8,12 @@ UM = UringMachine
 class UringMachine
   @@fiber_map = {}
 
-  def spin(value = nil, &block)
-    f = Fiber.new do |resume_value|
+  def fiber_map
+    @@fiber_map
+  end
+
+  def spin(value = nil, fiber_class = Fiber, &block)
+    f = fiber_class.new do |resume_value|
       block.(resume_value)
     rescue Exception => e
       STDERR.puts "Unhandled fiber exception: #{e.inspect}"
@@ -30,4 +34,8 @@ class UringMachine
     @resolver ||= DNSResolver.new(self)
     @resolver.resolve(hostname, type)
   end
+
+  def ssl_accept(fd, ssl_ctx)
+    SSL::Connection.new(self, fd, ssl_ctx)
+  end
 end

data/test/helper.rb

@@ -51,6 +51,12 @@ module Minitest::Assertions
 end
 
 class UMBaseTest < Minitest::Test
+  # pull in UM constants
+  UM.constants.each do |c|
+    v = UM.const_get(c)
+    const_set(c, v) if v.is_a?(Integer)
+  end
+
   attr_accessor :machine
   
   def setup

data/test/test_actor.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'socket'
+require 'uringmachine/actor'
+
+class ActorTest < UMBaseTest
+  module Counter
+    def setup
+      @count = 0      
+    end
+
+    def incr
+      @count += 1
+    end
+
+    def get
+      @count
+    end
+
+    def reset
+      @count = 0
+    end
+  end
+
+  def test_basic_actor_functionality
+    actor = @machine.spin_actor(Counter)
+    
+    assert_kind_of Fiber, actor
+
+    assert_equal 0, actor.call(:get)
+    assert_equal 1, actor.call(:incr)
+    assert_equal actor, actor.cast(:incr)
+    assert_equal 2, actor.call(:get)
+    assert_equal actor, actor.cast(:reset)
+    assert_equal 0, actor.call(:get)
+  end
+
+  module Counter2
+    def setup(count)
+      @count = count
+    end
+
+    def incr
+      @count += 1
+    end
+
+    def get
+      @count
+    end
+
+    def reset
+      @count = 0
+    end
+  end
+
+
+  def test_actor_with_args
+    actor = @machine.spin_actor(Counter2, 43)
+    
+    assert_equal 43, actor.call(:get)
+  end
+end

data/test/test_async_op.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'socket'
+
+class AsyncOpTest < UMBaseTest
+  def setup
+    super
+    @t0 = monotonic_clock
+    @op = machine.prep_timeout(0.05)
+  end
+
+  def test_async_op_await
+    assert_equal 1, machine.pending_count
+    res = @op.await
+    t1 = monotonic_clock
+    assert_in_range 0.04..0.08, t1 - @t0
+    assert_equal 0, machine.pending_count
+    assert_equal (-ETIME), res
+    assert_equal true, @op.done?
+    assert_equal false, @op.cancelled?
+  end
+
+  def test_async_op_join
+    assert_equal 1, machine.pending_count
+    res = @op.join
+    t1 = monotonic_clock
+    assert_in_range 0.04..0.08, t1 - @t0
+    assert_equal 0, machine.pending_count
+    assert_equal (-ETIME), res
+    assert_equal true, @op.done?
+    assert_equal false, @op.cancelled?
+  end
+
+  def test_async_op_cancel
+    machine.sleep(0.01)
+    assert_equal 1, machine.pending_count
+    @op.cancel
+    assert_equal false, @op.done?
+    
+    machine.sleep(0.01)
+  
+    assert_equal 0, machine.pending_count
+    assert_equal true, @op.done?
+    assert_equal (-ECANCELED), @op.result
+    assert_equal true, @op.cancelled?
+  end
+
+  def test_async_op_await_with_cancel
+    machine.spin do
+      @op.cancel
+    end
+
+    res = @op.await
+  
+    assert_equal 0, machine.pending_count
+    assert_equal true, @op.done?
+    assert_equal (-ECANCELED), res
+    assert_equal true, @op.cancelled?
+  end
+
+  class TOError < RuntimeError; end
+
+  def test_async_op_await_with_timeout
+    e = nil
+  
+    begin
+      machine.timeout(0.01, TOError) do
+        @op.await
+      end
+    rescue => e
+    end
+
+    assert_equal 0, machine.pending_count
+    assert_kind_of TOError, e
+    assert_equal true, @op.done?
+    assert_equal (-ECANCELED), @op.result
+    assert_equal true, @op.cancelled?
+  end
+
+  def test_async_op_await_with_timeout2
+    e = nil
+  
+    begin
+      machine.timeout(0.1, TOError) do
+        @op.await
+      end
+    rescue => e
+    end
+
+    # machine.timeout is cancelled async, so CQE is not yet reaped
+    assert_equal 1, machine.pending_count
+    assert_nil e
+    assert_equal true, @op.done?
+    assert_equal (-ETIME), @op.result
+    assert_equal false, @op.cancelled?
+
+    # wait for timeout cancellation
+    machine.sleep(0.01)
+    assert_equal 0, machine.pending_count
+  end
+end
+
+class PrepTimeoutTest < UMBaseTest
+  def test_prep_timeout
+    op = machine.prep_timeout(0.03)
+    assert_kind_of UM::AsyncOp, op
+    assert_equal :timeout, op.kind
+
+    assert_equal false, op.done?
+    assert_nil op.result
+
+    machine.sleep(0.05)
+
+    assert_equal true, op.done?
+    assert_equal (-ETIME), op.result
+    assert_equal false, op.cancelled?
+  end
+end

data/test/test_ssl.rb

@@ -0,0 +1,155 @@
+require_relative "helper"
+
+__END__
+
+require 'uringmachine/ssl'
+require 'openssl'
+require 'localhost'
+
+class TestSSLContext < Minitest::Test
+
+  if false
+    def test_raises_with_invalid_keystore_file
+      ctx = UM::SSL::Context.new
+
+      exception = assert_raises(ArgumentError) { ctx.keystore = "/no/such/keystore" }
+      assert_equal("Keystore file '/no/such/keystore' does not exist", exception.message)
+    end
+
+    def test_raises_with_unreadable_keystore_file
+      ctx = UM::SSL::Context.new
+
+      File.stub(:exist?, true) do
+        File.stub(:readable?, false) do
+          exception = assert_raises(ArgumentError) { ctx.keystore = "/unreadable/keystore" }
+          assert_equal("Keystore file '/unreadable/keystore' is not readable", exception.message)
+        end
+      end
+    end
+  else
+    def test_raises_with_invalid_key_file
+      ctx = UM::SSL::Context.new
+
+      exception = assert_raises(ArgumentError) { ctx.key = "/no/such/key" }
+      assert_equal("Key file '/no/such/key' does not exist", exception.message)
+    end
+
+    def test_raises_with_unreadable_key_file
+      ctx = UM::SSL::Context.new
+
+      File.stub(:exist?, true) do
+        File.stub(:readable?, false) do
+          exception = assert_raises(ArgumentError) { ctx.key = "/unreadable/key" }
+          assert_equal("Key file '/unreadable/key' is not readable", exception.message)
+        end
+      end
+    end
+
+    def test_raises_with_invalid_cert_file
+      ctx = UM::SSL::Context.new
+
+      exception = assert_raises(ArgumentError) { ctx.cert = "/no/such/cert" }
+      assert_equal("Cert file '/no/such/cert' does not exist", exception.message)
+    end
+
+    def test_raises_with_unreadable_cert_file
+      ctx = UM::SSL::Context.new
+
+      File.stub(:exist?, true) do
+        File.stub(:readable?, false) do
+          exception = assert_raises(ArgumentError) { ctx.key = "/unreadable/cert" }
+          assert_equal("Key file '/unreadable/cert' is not readable", exception.message)
+        end
+      end
+    end
+
+    def test_raises_with_invalid_key_pem
+      ctx = UM::SSL::Context.new
+
+      exception = assert_raises(ArgumentError) { ctx.key_pem = nil }
+      assert_equal("'key_pem' is not a String", exception.message)
+    end
+
+    def test_raises_with_unreadable_ca_file
+      ctx = UM::SSL::Context.new
+
+      File.stub(:exist?, true) do
+        File.stub(:readable?, false) do
+          exception = assert_raises(ArgumentError) { ctx.ca = "/unreadable/cert" }
+          assert_equal("ca file '/unreadable/cert' is not readable", exception.message)
+        end
+      end
+    end
+
+    def test_raises_with_invalid_cert_pem
+      ctx = UM::SSL::Context.new
+
+      exception = assert_raises(ArgumentError) { ctx.cert_pem = nil }
+      assert_equal("'cert_pem' is not a String", exception.message)
+    end
+
+    def test_raises_with_invalid_key_password_command
+      ctx = UM::SSL::Context.new
+      ctx.key_password_command = '/unreadable/decrypt_command'
+
+      assert_raises(Errno::ENOENT) { ctx.key_password }
+    end
+  end
+end
+
+class TestSSLServer < UMBaseTest
+  def setup
+    super
+    @port = assign_port
+    @ssl_ctx = create_ssl_ctx
+  end
+
+  def create_ssl_ctx
+    authority = Localhost::Authority.fetch
+    authority.server_context
+  end
+
+  def test_ssl_accept
+    server_fd = machine.socket(UM::AF_INET, UM::SOCK_STREAM, 0, 0)
+    machine.bind(server_fd, '127.0.0.1', @port)
+    res = machine.listen(server_fd, 5)
+    assert_equal 0, res
+    assert_equal 0, machine.pending_count
+
+    fd = nil
+    sock = nil
+
+    reply = nil
+    t = Thread.new do
+      p 21
+      sleep 0.1
+      p 22
+      sock = TCPSocket.new('127.0.0.1', @port)
+      p 23
+      sleep 0.1
+      p 24
+      client = OpenSSL::SSL::SSLSocket.new(sock)
+      p 25
+      client.connect
+      p 26
+      client.write('foobar')
+      p 27
+      reply = client.read(8192)
+      p 28
+    end
+
+    p 11
+    fd = machine.accept(server_fd)
+    p 12
+    sock = machine.ssl_accept(fd, @ssl_ctx)
+    msg = +''
+    p 13
+    ret = sock.recv(msg, 8192)
+    p 14
+    sock.send("Hello: #{msg} (#{ret})", 0)
+    p 15
+    machine.close(fd)
+
+    assert_equal 'Hello: foobar (6)', reply
+  end
+end

data/test/test_um.rb

@@ -212,6 +212,57 @@ class SleepTest < UMBaseTest
   end
 end
 
+class PeriodicallyTest < UMBaseTest
+  class Cancel < StandardError; end
+
+  def test_periodically
+    count = 0
+    cancel = 0
+
+    t0 = monotonic_clock
+    assert_equal 0, machine.pending_count
+    begin
+      machine.periodically(0.01) do
+        count += 1
+        raise Cancel if count >= 5
+      end
+    rescue Cancel
+      cancel = 1
+    end
+    machine.snooze
+    assert_equal 0, machine.pending_count
+    t1 = monotonic_clock
+    assert_in_range 0.05..0.09, t1 - t0
+    assert_equal 5, count
+    assert_equal 1, cancel 
+  end
+
+  def test_periodically_with_timeout
+    count = 0
+    cancel = 0
+
+    t0 = monotonic_clock
+    assert_equal 0, machine.pending_count
+    begin
+      machine.timeout(0.05, Cancel) do
+        machine.periodically(0.01) do
+          count += 1
+          raise Cancel if count >= 5
+        end
+      end
+    rescue Cancel
+      cancel = 1
+    end
+    machine.snooze
+    assert_equal 0, machine.pending_count
+    t1 = monotonic_clock
+    assert_in_range 0.05..0.08, t1 - t0
+    assert_in_range 4..6, count
+    assert_equal 1, cancel 
+
+  end
+end
+
 class ReadTest < UMBaseTest
   def test_read
     r, w = IO.pipe
@@ -274,6 +325,26 @@ class ReadTest < UMBaseTest
     assert_equal 3, result
     assert_equal 'foobar', buffer
   end
+
+  def test_read_with_string_io
+    require 'stringio'
+
+    buffer = +'foo'
+    sio = StringIO.new(buffer)
+    
+    r, w = IO.pipe
+    w << 'bar'
+
+    result = machine.read(r.fileno, buffer, 100, -1)
+    assert_equal 3, result
+    assert_equal 'foobar', sio.read
+
+    w << 'baz'
+
+    result = machine.read(r.fileno, buffer, 100, -1)
+    assert_equal 3, result
+    assert_equal 'baz', sio.read
+  end
 end
 
 class ReadEachTest < UMBaseTest
@@ -1048,6 +1119,4 @@ class WaitTest < UMBaseTest
 
     assert_raises(Errno::ECHILD) { machine.waitpid(1, UM::WEXITED) }    
   end
-
 end
-

data/uringmachine.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 3.3'
 
-  s.add_development_dependency  'rake-compiler',        '1.2.7'
-  s.add_development_dependency  'minitest',             '5.25.1'
+  s.add_development_dependency  'rake-compiler',        '1.2.9'
+  s.add_development_dependency  'minitest',             '5.25.4'
   s.add_development_dependency  'http_parser.rb',       '0.8.0'
-  s.add_development_dependency  'benchmark-ips',        '2.10.0'
+  s.add_development_dependency  'benchmark-ips',        '2.14.0'
+  s.add_development_dependency  'localhost',            '1.3.1'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: uringmachine
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Sharon Rosner
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -16,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.9
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.25.1
+        version: 5.25.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.25.1
+        version: 5.25.4
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
@@ -58,15 +57,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
-description:
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: localhost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 email: sharon@noteflakes.com
 executables: []
 extensions:
@@ -84,19 +96,26 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- examples/bm_http_parse.rb
+- examples/bm_queue.rb
 - examples/bm_snooze.rb
+- examples/bm_sqlite.rb
 - examples/bm_write.rb
 - examples/dns_client.rb
 - examples/echo_server.rb
 - examples/http_server.rb
 - examples/inout.rb
 - examples/nc.rb
+- examples/pg.rb
 - examples/server_client.rb
 - examples/snooze.rb
+- examples/stream.rb
 - examples/write_dev_null.rb
 - ext/um/extconf.rb
 - ext/um/um.c
 - ext/um/um.h
+- ext/um/um_async_op.c
+- ext/um/um_async_op_class.c
 - ext/um/um_buffer.c
 - ext/um/um_class.c
 - ext/um/um_const.c
@@ -104,13 +123,22 @@ files:
 - ext/um/um_mutex_class.c
 - ext/um/um_op.c
 - ext/um/um_queue_class.c
+- ext/um/um_ssl.c
+- ext/um/um_ssl.h
+- ext/um/um_ssl_class.c
 - ext/um/um_sync.c
 - ext/um/um_utils.c
 - lib/uringmachine.rb
+- lib/uringmachine/actor.rb
 - lib/uringmachine/dns_resolver.rb
+- lib/uringmachine/ssl.rb
+- lib/uringmachine/ssl/context_builder.rb
 - lib/uringmachine/version.rb
 - supressions/ruby.supp
 - test/helper.rb
+- test/test_actor.rb
+- test/test_async_op.rb
+- test/test_ssl.rb
 - test/test_um.rb
 - uringmachine.gemspec
 - vendor/liburing/.github/actions/codespell/stopwords
@@ -413,7 +441,6 @@ metadata:
   source_code_uri: https://github.com/digital-fabric/uringmachine
   documentation_uri: https://www.rubydoc.info/gems/uringmachine
   changelog_uri: https://github.com/digital-fabric/uringmachine/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options:
 - "--title"
 - UringMachine
@@ -432,8 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A lean, mean io_uring machine
 test_files: []