omf_common 6.0.0 → 6.0.2.pre.1

data/test/omf_common/auth/ssh_pub_key_convert_spec.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe OmfCommon::Auth::SSHPubKeyConvert do
+  it "must import ssh pub key format to ruby rsa instance" do
+    private_folder = "#{File.dirname(__FILE__)}/../../fixture"
+
+    pub_key = OpenSSL::PKey::RSA.new(File.read("#{private_folder}/omf_test.pub.pem"))
+
+    ssh_pub_key = File.read("#{private_folder}/omf_test.pub")
+
+    OmfCommon::Auth::SSHPubKeyConvert.convert(ssh_pub_key).to_s.must_equal pub_key.to_s
+  end
+end

data/test/omf_common/comm/topic_spec.rb

@@ -0,0 +1,175 @@
+require 'test_helper'
+
+describe OmfCommon::Comm::Topic do
+  describe "when using factory method to initialise" do
+    before  do
+      @topic = OmfCommon::Comm::Topic.create(:bob)
+    end
+
+    it "must add it to the instance list" do
+      OmfCommon::Comm::Topic[:bob].must_equal @topic
+    end
+
+    it "must have interface for its address" do
+      lambda { @topic.address }.must_raise NotImplementedError
+    end
+
+    it "must have interface for on_subscribed handler" do
+      lambda { @topic.on_subscribed }.must_raise NotImplementedError
+    end
+
+    it "must have error? returns false by default" do
+      @topic.error?.must_equal false
+    end
+
+    it "must have interface for timer :after" do
+      OmfCommon::Eventloop.init(type: :em)
+
+      @topic.after(5, & lambda {})
+
+      OmfCommon.eventloop.run do
+        @topic.after(0.1) do |t|
+          t.must_equal @topic
+          OmfCommon.eventloop.stop
+        end
+      end
+
+      OmfCommon::Eventloop.reset
+    end
+  end
+
+  describe "when interact with topic instance" do
+    before do
+      @comm = mock
+      OmfCommon.stubs(:comm).returns(@comm)
+      @topic = OmfCommon::Comm::Topic.create(:bob)
+      @comm.stubs(:local_address).returns(:bob_address)
+    end
+
+    after do
+      OmfCommon::Comm.reset
+      OmfCommon.unstub(:comm)
+      OmfCommon::Message::XML::Message.any_instance.unstub(:mid)
+    end
+
+    it "must create and send frcp create message" do
+      @topic.create(:rtype).must_equal @topic
+    end
+
+    it "must create and send frcp configure message" do
+      @topic.configure(attr: 'value').must_equal @topic
+    end
+
+    it "must create and send frcp request message" do
+      @topic.request([:attr]).must_equal @topic
+    end
+
+    it "must create and send frcp inform message" do
+      @topic.inform('CREATION.OK', attr: 'value').must_equal @topic
+    end
+
+    it "must create and send frcp inform message" do
+      lambda { @topic.release(:bob) }.must_raise ArgumentError
+      @topic.release(@topic)
+    end
+
+    it "must create different types of message handlers" do
+      @topic.class_eval do
+        define_method(:handlers, &(lambda { @handlers }))
+      end
+
+      [:message, :inform].each do |name|
+        m_name = "on_#{name}"
+        # No callback block given shall fail
+        lambda { @topic.send(m_name) }.must_raise ArgumentError
+        cbk = proc {}
+        @topic.send(m_name, &(cbk))
+        @topic.handlers[name].must_include cbk
+      end
+
+      @topic.class_eval do
+        undef_method(:handlers)
+      end
+    end
+
+    it "must send a message and register callbacks" do
+      @topic.class_eval do
+        define_method(:context2cbk, &(lambda { @context2cbk }))
+        define_method(:_send_message_public) do |*args|
+          _send_message(*args)
+        end
+      end
+
+      cbk = proc { 'called' }
+      msg = mock
+      msg.stubs(:mid).returns(:bob_id)
+
+      @topic._send_message_public(msg, cbk)
+
+      h = @topic.context2cbk['bob_id']
+      h.must_be_kind_of Hash
+      h[:block].call.must_equal 'called'
+
+      @topic.class_eval do
+        undef_method(:context2cbk)
+        undef_method(:_send_message_public)
+      end
+    end
+
+    it "must process incoming messages and trigger registered callbacks" do
+      @topic.class_eval do
+        define_method(:handlers, &(lambda { @handlers }))
+        define_method(:context2cbk, &(lambda { @context2cbk }))
+        define_method(:on_incoming_message_public) do |*args|
+          on_incoming_message(*args)
+        end
+      end
+
+      msg = mock
+      msg.stubs(:operation).returns(:inform)
+      msg.stubs(:itype).with(:ruby).returns('creation_ok')
+      msg.stubs(:cid).returns(:bob_id)
+
+      OmfCommon::Message::XML::Message.any_instance.stubs(:mid).returns(:bob_id)
+
+      cbk_called = [false, false, false, false]
+
+      @topic.create(:rtype) do |reply_msg|
+        cbk_called[0] = true
+        reply_msg.cid.must_equal :bob_id
+      end
+
+      @topic.on_inform do |incoming_msg|
+        cbk_called[1] = true
+        incoming_msg.cid.must_equal :bob_id
+      end
+
+      @topic.on_message do |incoming_msg|
+        cbk_called[2] = true
+        incoming_msg.cid.must_equal :bob_id
+      end
+
+      @topic.on_creation_ok do |incoming_msg|
+        cbk_called[3] = true
+        incoming_msg.cid.must_equal :bob_id
+      end
+
+      @topic.on_incoming_message_public(msg)
+
+      msg.stubs(:itype).returns(:status)
+
+      @topic.on_incoming_message_public(msg)
+
+      cbk_called[0].must_equal true
+      cbk_called[1].must_equal true
+      cbk_called[2].must_equal true
+      cbk_called[3].must_equal true
+
+      @topic.class_eval do
+        undef_method(:context2cbk)
+        undef_method(:handlers)
+        undef_method(:on_incoming_message_public)
+      end
+    end
+  end
+end

data/test/omf_common/comm/xmpp/communicator_spec.rb

@@ -1,6 +1,5 @@
 require 'test_helper'
 require 'fixture/pubsub'
-require 'em/minitest/spec'
 
 require 'omf_common/comm/xmpp/communicator'
 
@@ -18,7 +17,7 @@ describe OmfCommon::Comm::XMPP::Communicator do
 
     it "must be able to connect and tigger on_connected callbacks" do
       Blather::Client.stub :new, @client do
-        @xmpp.jid.inspect.must_equal "bob@example.com"
+        @xmpp.jid.to_s.must_equal "bob@example.com"
 
         @xmpp.on_connected do |communicator|
           communicator.must_be_kind_of OmfCommon::Comm::XMPP::Communicator
@@ -168,8 +167,8 @@ describe OmfCommon::Comm::XMPP::Communicator do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'create'
-      m1.body.to_xml.must_match /<property key="type" type="string">engine<\/property>/
-      m2.body.to_xml.must_match /<property key="type" type="string">engine<\/property>/
+      m1.body.marshall[1].must_match /<property key="type" type="string">engine<\/property>/
+      m2.body.marshall[1].must_match /<property key="type" type="string">engine<\/property>/
     end
 
     it "must generate omf configure xml fragment" do
@@ -181,8 +180,8 @@ describe OmfCommon::Comm::XMPP::Communicator do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'configure'
-      m1.body.to_xml.must_match /<property key="throttle" type="integer">50<\/property>/
-      m2.body.to_xml.must_match /<property key="throttle" type="integer">50<\/property>/
+      m1.body.marshall[1].must_match /<property key="throttle" type="integer">50<\/property>/
+      m2.body.marshall[1].must_match /<property key="throttle" type="integer">50<\/property>/
     end
 
     it "must generate omf inform xml fragment" do
@@ -194,8 +193,8 @@ describe OmfCommon::Comm::XMPP::Communicator do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'inform'
-      m1.body.to_xml.must_match /<property key="itype" type="string">CREATION.OK<\/property>/
-      m2.body.to_xml.must_match /<property key="itype" type="string">CREATION.OK<\/property>/
+      m1.body.marshall[1].must_match /<property key="itype" type="string">CREATION.OK<\/property>/
+      m2.body.marshall[1].must_match /<property key="itype" type="string">CREATION.OK<\/property>/
     end
 
     it "must generate omf release xml fragment" do
@@ -207,8 +206,8 @@ describe OmfCommon::Comm::XMPP::Communicator do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'release'
-      m1.body.to_xml.must_match /<property key="res_id" type="integer">100<\/property>/
-      m2.body.to_xml.must_match /<property key="res_id" type="integer">100<\/property>/
+      m1.body.marshall[1].must_match /<property key="res_id" type="integer">100<\/property>/
+      m2.body.marshall[1].must_match /<property key="res_id" type="integer">100<\/property>/
     end
 
     it "must generate omf request xml fragment" do
@@ -222,12 +221,12 @@ describe OmfCommon::Comm::XMPP::Communicator do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'request'
-      m1.body.to_xml.must_match /<property key="max_rpm"\/>/
-      m1.body.to_xml.must_match /<property key="provider" type="hash">/
-      m2.body.to_xml.must_match /<property key="provider" type="hash">/
-      m1.body.to_xml.must_match /<country type="string">japan<\/country>/
-      m2.body.to_xml.must_match /<country type="string">japan<\/country>/
-      m1.body.to_xml.must_match /<property key="max_power"\/>/
+      m1.body.marshall[1].must_match /<property key="max_rpm"\/>/
+      m1.body.marshall[1].must_match /<property key="provider" type="hash">/
+      m2.body.marshall[1].must_match /<property key="provider" type="hash">/
+      m1.body.marshall[1].must_match /<country type="string">japan<\/country>/
+      m2.body.marshall[1].must_match /<country type="string">japan<\/country>/
+      m1.body.marshall[1].must_match /<property key="max_power"\/>/
     end
   end
 

data/test/omf_common/comm/xmpp/topic_spec.rb

@@ -1,6 +1,7 @@
+require 'test_helper'
 require 'fixture/pubsub'
-require 'em/minitest/spec'
 
+require 'omf_common/comm/xmpp/communicator'
 require 'omf_common/comm/xmpp/topic'
 
 describe OmfCommon::Comm::XMPP::Topic do
@@ -20,7 +21,10 @@ describe OmfCommon::Comm::XMPP::Topic do
   end
 
   describe "when calling operation method" do
+    include EM::MiniTest::Spec
+
     it "must send create message" do
+      skip
       OmfCommon.stub :comm, @xmpp do
         Blather::Client.stub :new, @client do
           published = Blather::XMPPNode.parse(published_xml)
@@ -32,10 +36,39 @@ describe OmfCommon::Comm::XMPP::Topic do
           end
 
           @client.stub :write, write_callback do
-            @topic.create(:bob, { hrn: 'bob' })
+            @xmpp.stub :local_address, 'test_addr' do
+              @topic.create(:bob, { hrn: 'bob' })
+            end
+          end
+        end
+      end
+    end
+
+    it "must trigger operation callbacks" do
+      skip
+      OmfCommon.stub :comm, @xmpp do
+        Blather::Client.stub :new, @client do
+          @client.stub :write, proc {} do
+            @xmpp.stub :local_address, 'test_addr' do
+              omf_create = OmfCommon::Message.create(:create, { type: 'engine' })
+              omf_create.stub :mid, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+                warn omf_create.mid
+                OmfCommon::Message.stub :create, omf_create do
+                  @topic.create(:bob, { hrn: 'bob' }) do |reply_msg|
+                    error 'bob'
+                    #reply_msg.cid.must_equal "bf840fe9-c176-4fae-b7de-6fc27f183f76"
+                    done!
+                  end
+
+                  @client.receive_data Blather::XMPPNode.parse(omf_created_xml)
+                end
+              end
+            end
           end
         end
       end
+
+      wait!
     end
   end
 
@@ -43,6 +76,7 @@ describe OmfCommon::Comm::XMPP::Topic do
     include EM::MiniTest::Spec
 
     it "must react to omf created message" do
+      skip
       OmfCommon.stub :comm, @xmpp do
         Blather::Client.stub :new, @client do
           omf_create = OmfCommon::Message.create(:create, { type: 'engine' })
@@ -50,8 +84,12 @@ describe OmfCommon::Comm::XMPP::Topic do
             omf_created = Blather::XMPPNode.parse(omf_created_xml)
             @client.receive_data omf_created
             @topic.on_creation_ok(omf_create) do |n|
-              n.must_equal OmfCommon::Message.parse(omf_created.items.first.payload)
-              done!
+              OmfCommon::Message.parse(omf_created.items.first.payload) do |parsed_msg|
+                n.stub :ts, parsed_msg.ts do
+                  n.must_equal parsed_msg
+                end
+                done!
+              end
             end
           end
         end
@@ -60,6 +98,7 @@ describe OmfCommon::Comm::XMPP::Topic do
     end
 
     it "must react to omf status message" do
+      skip
       OmfCommon.stub :comm, @xmpp do
         Blather::Client.stub :new, @client do
           omf_request = OmfCommon::Message.create(:request, [:bob])
@@ -67,8 +106,12 @@ describe OmfCommon::Comm::XMPP::Topic do
             omf_status = Blather::XMPPNode.parse(omf_status_xml)
             @client.receive_data omf_status
             @topic.on_status(omf_request) do |n|
-              n.must_equal OmfCommon::Message.parse(omf_status.items.first.payload)
-              done!
+              OmfCommon::Message.parse(omf_status.items.first.payload) do |parsed_msg|
+                n.stub :ts, parsed_msg.ts do
+                  n.must_equal parsed_msg
+                end
+                done!
+              end
             end
           end
         end
@@ -77,6 +120,7 @@ describe OmfCommon::Comm::XMPP::Topic do
     end
 
     it "must react to omf release message" do
+      skip
       OmfCommon.stub :comm, @xmpp do
         Blather::Client.stub :new, @client do
           omf_release = OmfCommon::Message.create(:release, nil, { res_id: '100' })
@@ -84,8 +128,12 @@ describe OmfCommon::Comm::XMPP::Topic do
             omf_released = Blather::XMPPNode.parse(omf_released_xml)
             @client.receive_data omf_released
             @topic.on_released(omf_release) do |n|
-              n.must_equal OmfCommon::Message.parse(omf_released.items.first.payload)
-              done!
+              OmfCommon::Message.parse(omf_released.items.first.payload) do |parsed_msg|
+                n.stub :ts, parsed_msg.ts do
+                  n.must_equal parsed_msg
+                end
+                done!
+              end
             end
           end
         end
@@ -94,6 +142,7 @@ describe OmfCommon::Comm::XMPP::Topic do
     end
 
     it "must react to omf failed message" do
+      skip
       OmfCommon.stub :comm, @xmpp do
         Blather::Client.stub :new, @client do
           omf_create = OmfCommon::Message.create(:create, { type: 'engine' })
@@ -101,8 +150,12 @@ describe OmfCommon::Comm::XMPP::Topic do
             omf_failed = Blather::XMPPNode.parse(omf_failed_xml)
             @client.receive_data omf_failed
             @topic.on_creation_failed(omf_create) do |n|
-              n.must_equal OmfCommon::Message.parse(omf_failed.items.first.payload)
-              done!
+              OmfCommon::Message.parse(omf_failed.items.first.payload) do |parsed_msg|
+                n.stub :ts, parsed_msg.ts do
+                  n.must_equal parsed_msg
+                end
+                done!
+              end
             end
           end
         end

data/test/omf_common/comm_spec.rb

@@ -1,18 +1,75 @@
 require 'test_helper'
+require 'omf_common/comm/local/local_communicator'
 
 describe OmfCommon::Comm do
-  describe 'when initialised with a pubsub implementation' do
-    it 'must return a instance with all methods defined in corresponding module loaded' do
-      skip
-      @comm = OmfCommon::Comm.new(:xmpp)
-      %w(connect disconnect create_topic delete_topic subscribe unsubscribe publish affiliations).each do |m|
-        @comm.must_respond_to m
+  describe "when initialised without providing a pubsub implementation" do
+    before do
+      OmfCommon::Comm.any_instance.stubs(:on_connected)
+      @abstract_comm = OmfCommon::Comm.new(bob: nil)
+      @topic = mock
+    end
+
+    it "must raise no implementation error for abstract methods" do
+      OmfCommon::Comm.any_instance.unstub(:on_connected)
+      [:disconnect, :on_connected, :on_connected].each do |m|
+        lambda { @abstract_comm.send(m, ) }.must_raise NotImplementedError
       end
 
-      # also existing blather DSL should work  too
-      %w(when_ready shutdown).each do |m|
-        @comm.must_respond_to m
+      [:create_topic, :delete_topic].each do |m|
+        lambda { @abstract_comm.send(m, :bob) }.must_raise NotImplementedError
       end
     end
+
+    it "must return options" do
+      @abstract_comm.options.must_equal(bob: nil)
+    end
+
+    it "must return connection info" do
+      @abstract_comm.conn_info.must_equal({ proto: nil, user: nil, domain: nil })
+    end
+
+    it "must be able to subscribe to a topic" do
+      @abstract_comm.stubs(:create_topic).returns(@topic)
+      @topic.expects(:on_subscribed)
+      @abstract_comm.subscribe(:bob) { 'do nothing' }
+    end
+
+    it "must be able to publish message" do
+      @abstract_comm.stubs(:create_topic).returns(@topic)
+      @topic.expects(:publish)
+      @abstract_comm.publish(:bob, 'message')
+    end
+  end
+
+  describe 'when initialised with a pubsub implementation' do
+    after do
+      OmfCommon::Comm.reset
+    end
+
+    it 'must fail if you throw in rubbish options' do
+      lambda { OmfCommon::Comm.init(bob: nil) }.must_raise ArgumentError
+      lambda { OmfCommon::Comm.init(provider: {}) }.must_raise ArgumentError
+      lambda { OmfCommon::Comm.init(provider: { constructor: {}, require: {} }) }.must_raise TypeError
+    end
+
+    it 'must fail if already initialised' do
+      OmfCommon::Comm::Local::Communicator.any_instance.stubs(:on_connected)
+      OmfCommon::Message.stubs(:init)
+      error = lambda do
+        OmfCommon::Comm.init(type: :local)
+        OmfCommon::Comm.init(type: :local)
+      end.call rescue $!
+      error.message.must_match /Comms layer already initialised/
+    end
+
+    it 'must handle auth options and be able to return singleton instance' do
+      OmfCommon::Comm::Local::Communicator.any_instance.stubs(:on_connected)
+
+      OmfCommon::Message.stubs(:init)
+      OmfCommon::Auth::CertificateStore.stubs(:init)
+      OmfCommon::Comm.init(type: :local, auth: {})
+
+      OmfCommon::Comm.instance.must_be_kind_of OmfCommon::Comm::Local::Communicator
+    end
   end
 end