Add tests for ffi-rzmq and isolate test execution for each ZMQ adapter

Author: mrkn

Gemfile

@@ -16,4 +16,5 @@ end
 group :test do
   gem 'cztop'
   gem 'rbczmq'
+  gem 'ffi-rzmq'
 end

ci/Dockerfile.main.erb

@@ -1,8 +1,9 @@
 FROM iruby-test-base:ruby-<%= ruby_version %>
 
+RUN gem install cztop \
+    && gem install rbczmq -- --with-system-libs
+
 RUN mkdir -p /iruby
 ADD . /iruby
 WORKDIR /iruby
-RUN gem install cztop \
-    && gem install rbczmq -- --with-system-libs \
-    && bundle install
+RUN bundle install

lib/iruby/session.rb

@@ -7,9 +7,9 @@ module IRuby
   class Session
     include SessionSerialize
 
-    def initialize(config)
+    def initialize(config, adapter_name=nil)
       @config = config
-      @adapter = create_session_adapter(config)
+      @adapter = create_session_adapter(config, adapter_name)
 
       setup
       setup_sockets
@@ -108,8 +108,8 @@ def check_socket_type(socket_type)
       end
     end
 
-    def create_session_adapter(config)
-      adapter_class = SessionAdapter.select_adapter_class
+    def create_session_adapter(config, adapter_name)
+      adapter_class = SessionAdapter.select_adapter_class(adapter_name)
       adapter_class.new(config)
     end
   end

lib/iruby/session_adapter.rb

@@ -39,18 +39,23 @@ def make_rep_socket(protocol, host, port)
     require_relative 'session_adapter/ffirzmq_adapter'
     require_relative 'session_adapter/pyzmq_adapter'
 
-    def self.select_adapter_class
+    def self.select_adapter_class(name=nil)
       classes = {
         'rbczmq' => SessionAdapter::RbczmqAdapter,
         'cztop' => SessionAdapter::CztopAdapter,
         'ffi-rzmq' => SessionAdapter::FfirzmqAdapter,
         'pyzmq' => SessionAdapter::PyzmqAdapter
       }
-      if (name = ENV.fetch('IRUBY_SESSION_ADAPTER', nil))
+      if (name ||= ENV.fetch('IRUBY_SESSION_ADAPTER', nil))
         cls = classes[name]
         unless cls.available?
-          raise SessionAdapterNotFound,
-                "Session adapter `#{name}` from IRUBY_SESSION_ADAPTER is unavailable"
+          if ENV['IRUBY_SESSION_ADAPTER']
+            raise SessionAdapterNotFound,
+                  "Session adapter `#{name}` from IRUBY_SESSION_ADAPTER is unavailable"
+          else
+            raise SessionAdapterNotFound,
+                  "Session adapter `#{name}` is unavailable"
+          end
         end
         return cls
       end

lib/iruby/session_adapter/ffirzmq_adapter.rb

@@ -4,6 +4,32 @@ class FfirzmqAdapter < BaseAdapter
       def self.load_requirements
         require 'ffi-rzmq'
       end
+
+      def heartbeat_loop(sock)
+        @heartbeat_device = ZMQ::Device.new(sock, sock)
+      end
+
+      private
+
+      def make_socket(type, protocol, host, port)
+        case type
+        when :ROUTER, :PUB, :REP
+          type = ZMQ.const_get(type)
+        else
+          if ZMQ.const_defined?(type)
+            raise ArgumentError, "Unsupported ZMQ socket type: #{type_symbol}"
+          else
+            raise ArgumentError, "Invalid ZMQ socket type: #{type_symbol}"
+          end
+        end
+        zmq_context.socket(type).tap do |sock|
+          sock.bind("#{protocol}://#{host}:#{port}")
+        end
+      end
+
+      def zmq_context
+        @zmq_context ||= ZMQ::Context.new
+      end
     end
   end
 end

lib/iruby/session_adapter/rbczmq_adapter.rb

@@ -14,7 +14,7 @@ def recv(sock)
       end
 
       def heartbeat_loop(sock)
-        ZMQ.proxy(socket, socket)
+        ZMQ.proxy(sock, sock)
       end
 
       private

run-test.sh

@@ -0,0 +1,11 @@
+#! /bin/bash
+
+set -ex
+
+# ADAPTERS="cztop rbczmq ffi-rzmq pyzmq"
+ADAPTERS="cztop rbczmq ffi-rzmq"
+
+for adapter in $ADAPTERS; do
+  export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter
+  bundle exec rake test TESTOPTS=-v
+done

tasks/ci.rake

@@ -59,7 +59,7 @@ namespace :ci do
     task :script do
       volumes = ['-v', "#{Dir.pwd}:/iruby"] if ENV['attach_pwd']
       sh 'docker', 'run', '--rm', '-it', *volumes,
-         iruby_test_image_name, 'bundle', 'exec', 'rake', 'test'
+         iruby_test_image_name, 'bash', 'run-test.sh'
     end
   end
 end

test/iruby/session_adapter/cztop_adapter_test.rb

@@ -0,0 +1,20 @@
+require_relative 'session_adapter_test_base'
+require 'iruby'
+
+module IRubyTest
+  if ENV['IRUBY_TEST_SESSION_ADAPTER_NAME'] == 'cztop'
+    class CztopAdapterTest < SessionAdapterTestBase
+      def adapter_class
+        IRuby::SessionAdapter::CztopAdapter
+      end
+
+      def test_send
+        assert(adapter_class.available?)
+      end
+
+      def test_recv
+        skip
+      end
+    end
+  end
+end

test/iruby/session_adapter/ffirzmq_adapter_test.rb

@@ -0,0 +1,20 @@
+require_relative 'session_adapter_test_base'
+require 'iruby'
+
+module IRubyTest
+  if ENV['IRUBY_TEST_SESSION_ADAPTER_NAME'] == 'ffi-rzmq'
+    class FfirzmqAdapterTest < SessionAdapterTestBase
+      def adapter_class
+        IRuby::SessionAdapter::FfirzmqAdapter
+      end
+
+      def test_send
+        assert(adapter_class.available?)
+      end
+
+      def test_recv
+        skip
+      end
+    end
+  end
+end

test/iruby/session_adapter/rbczmq_adapter_test.rb

@@ -2,34 +2,36 @@
 require 'iruby'
 
 module IRubyTest
-  class RbczmqAdapterTest < SessionAdapterTestBase
-    def adapter_class
-      IRuby::SessionAdapter::RbczmqAdapter
-    end
+  if ENV['IRUBY_TEST_SESSION_ADAPTER_NAME'] == 'rbczmq'
+    class RbczmqAdapterTest < SessionAdapterTestBase
+      def adapter_class
+        IRuby::SessionAdapter::RbczmqAdapter
+      end
 
-    def test_send
-      dummy_message = MiniTest::Mock.new.expect(:called!, true)
+      def test_send
+        dummy_message = MiniTest::Mock.new.expect(:called!, true)
 
-      dummy_socket = MiniTest::Mock.new.expect(:send_message, nil, [dummy_message])
+        dummy_socket = MiniTest::Mock.new.expect(:send_message, nil, [dummy_message])
 
-      ZMQ.stub(:Message, ->(message) { message.called!; message }) do
-        @session_adapter.send(dummy_socket, dummy_message)
-      end
+        ZMQ.stub(:Message, ->(message) { message.called!; message }) do
+          @session_adapter.send(dummy_socket, dummy_message)
+        end
 
-      assert(dummy_message.verify)
-      assert(dummy_socket.verify)
-    end
+        assert(dummy_message.verify)
+        assert(dummy_socket.verify)
+      end
 
-    def test_recv
-      dummy_message = MiniTest::Mock.new
-      dummy_message.expect(:equal?, true, [dummy_message])
+      def test_recv
+        dummy_message = MiniTest::Mock.new
+        dummy_message.expect(:equal?, true, [dummy_message])
 
-      dummy_socket = MiniTest::Mock.new.expect(:recv_message, dummy_message)
+        dummy_socket = MiniTest::Mock.new.expect(:recv_message, dummy_message)
 
-      assert_same(dummy_message, @session_adapter.recv(dummy_socket))
+        assert_same(dummy_message, @session_adapter.recv(dummy_socket))
 
-      assert(dummy_message.verify)
-      assert(dummy_socket.verify)
+        assert(dummy_message.verify)
+        assert(dummy_socket.verify)
+      end
     end
   end
 end

test/iruby/session_test.rb

@@ -3,7 +3,37 @@
 module IRubyTest
   class SessionAdapterSelectionTest < TestBase
     def setup
-      @session_config = {}
+      # https://jupyter-client.readthedocs.io/en/stable/kernels.html#connection-files
+      @session_config = {
+        "control_port" => 0,
+        "shell_port" => 0,
+        "transport" => "tcp",
+        "signature_scheme" => "hmac-sha256",
+        "stdin_port" => 0,
+        "hb_port" => 0,
+        "ip" => "127.0.0.1",
+        "iopub_port" => 0,
+        "key" => "a0436f6c-1916-498b-8eb9-e81ab9368e84"
+      }
+    end
+
+    def test_new_with_session_adapter
+      adapter_name = ENV['IRUBY_TEST_SESSION_ADAPTER_NAME']
+      adapter_class = case adapter_name
+                      when 'cztop'
+                        IRuby::SessionAdapter::CztopAdapter
+                      when 'rbczmq'
+                        IRuby::SessionAdapter::RbczmqAdapter
+                      when 'ffi-rzmq'
+                        IRuby::SessionAdapter::FfirzmqAdapter
+                      when 'pyzmq'
+                        IRuby::SessionAdapter::PyzmqAdapter
+                      else
+                        flunk "Unknown session adapter: #{adapter_name}"
+                      end
+
+      session = IRuby::Session.new(@session_config, adapter_name)
+      assert_kind_of(adapter_class, session.adapter)
     end
 
     def test_without_any_session_adapter