omf_common 6.0.0.pre.6 → 6.0.0.pre.7

data/test/omf_common/command_spec.rb

@@ -4,11 +4,17 @@ require 'omf_common/command'
 describe OmfCommon::Command do
   describe "when use util file to execute a system command" do
     it "must not print anything to stdout if executed successfully" do
-      OmfCommon::Command.execute("date").must_match /^.+/
+      OmfCommon::Command.execute("ruby -e 'puts 100'").must_match /100/
     end
 
     it "must capture and log errors if command not found" do
-      OmfCommon::Command.execute("dte -z").must_be_nil
+      OmfCommon::Command.execute("blahblah -z").must_be_nil
+    end
+
+    it "must log error when exit status is not 0" do
+      OmfCommon::Command.execute("ruby -e 'exit 1'").must_be_nil
+      OmfCommon::Command.execute("ruby -e 'exit 2'").must_be_nil
+      OmfCommon::Command.execute("ruby -e 'exit 3'").must_be_nil
     end
   end
 end

data/test/omf_common/dsl/xmpp_spec.rb

@@ -0,0 +1,309 @@
+require 'test_helper'
+require 'fixture/pubsub'
+require 'em/minitest/spec'
+
+describe OmfCommon::DSL::Xmpp do
+  before do
+    @client = Blather::Client.new
+    @stream = MiniTest::Mock.new
+    @stream.expect(:send, true, [Blather::Stanza])
+    @client.post_init @stream, Blather::JID.new('n@d/r')
+    @xmpp = Class.new { include OmfCommon::DSL::Xmpp }.new
+  end
+
+  describe "when communicating to xmpp server (via mocking)" do
+    include EM::MiniTest::Spec
+
+    it "must be able to connect" do
+      Blather::Stream::Client.stub(:start, @client) do
+        Blather::Client.stub :new, @client do
+          @xmpp.jid.inspect.must_equal "n@d/r"
+          @xmpp.connect('bob', 'pw', 'example.com')
+          @xmpp.jid.inspect.must_equal "bob@example.com"
+        end
+      end
+    end
+
+    it "must be able to disconnect" do
+      Blather::Stream::Client.stub(:start, @client) do
+        Blather::Client.stub :new, @client do
+          @stream.expect(:close_connection_after_writing, true)
+          @xmpp.disconnect
+          @stream.verify
+        end
+      end
+    end
+
+    it "must be able to subscribe & trigger callback when subscribed" do
+      Blather::Client.stub :new, @client do
+        subscription = Blather::XMPPNode.parse(subscription_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSub::Subscribe
+          subscription.id = event.id
+          @client.receive_data subscription
+        end
+        @client.stub :write, write_callback do
+          @xmpp.subscribe('xmpp_topic') { |e| e.must_equal subscription; done! }
+        end
+      end
+      wait!
+    end
+
+    it "must be able to create topic & trigger callback when created" do
+      Blather::Client.stub :new, @client do
+        created = Blather::XMPPNode.parse(created_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSub::Create
+          created.id = event.id
+          @client.receive_data created
+        end
+        @client.stub :write, write_callback do
+          @xmpp.create_topic('xmpp_topic') { |event| event.must_equal created; done! }
+        end
+      end
+      wait!
+    end
+
+    it "must be able to delete topic & trigger callback when topic deleted" do
+      Blather::Client.stub :new, @client do
+        deleted = Blather::XMPPNode.parse(fabulous_xmpp_empty_success_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSubOwner::Delete
+          deleted.id = event.id
+          @client.receive_data deleted
+        end
+        @client.stub :write, write_callback do
+          @xmpp.delete_topic('xmpp_topic') { |event| event.must_equal deleted; done! }
+        end
+      end
+      wait!
+    end
+
+    it "must be able to list affiliations (owned pubsub nodes) & react if received" do
+      Blather::Client.stub :new, @client do
+        affiliations = Blather::XMPPNode.parse(affiliations_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSub::Affiliations
+          affiliations.id = event.id
+          @client.receive_data affiliations
+        end
+        @client.stub :write, write_callback do
+          @xmpp.affiliations { |event| event[:owner].must_equal %w(node1 node2); done! }
+        end
+      end
+      wait!
+    end
+
+    it "must be able to publish if message is valid" do
+      Blather::Client.stub :new, @client do
+        @stream.expect(:send, true, [Blather::Stanza::PubSub::Publish])
+        @xmpp.publish 'xmpp_topic', Message.create {|v| v.property('type', 'test')}
+        proc { @xmpp.publish 'xmpp_topic', Message.inform {|v| v.element('blah', 'blah')} }.must_raise StandardError
+        @stream.verify
+      end
+    end
+
+    it "must trigger callback when item published" do
+      Blather::Client.stub :new, @client do
+        published = Blather::XMPPNode.parse(published_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSub::Publish
+          published.id = event.id
+          @client.receive_data published
+        end
+        @client.stub :write, write_callback do
+          @xmpp.publish 'xmpp_topic', Message.create {|v| v.property('type', 'test')} do |event|
+            event.must_equal published
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must be able to unsubscribe" do
+      Blather::Client.stub :new, @client do
+        @stream.expect(:send, true, [Blather::Stanza::PubSub::Subscriptions])
+        @xmpp.unsubscribe
+        @stream.verify
+      end
+    end
+
+    it "must trigger callback when unsubscribed (all topics)" do
+      Blather::Client.stub :new, @client do
+        2.times do
+          @stream.expect(:send, true, [Blather::Stanza])
+        end
+
+        subscriptions = Blather::XMPPNode.parse(subscriptions_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSub::Subscriptions
+          subscriptions.id = event.id
+          @client.receive_data subscriptions
+        end
+        @client.stub :write, write_callback do
+          @xmpp.unsubscribe
+        end
+        @stream.verify
+      end
+    end
+
+    it "must be able to add a topic event handler" do
+      Blather::Client.stub :new, @client do
+        @xmpp.topic_event
+        @stream.verify
+      end
+    end
+  end
+
+  describe "when omf message related methods" do
+    it "must generate omf create xml fragment" do
+      m1 = @xmpp.create_message([type: 'engine'])
+      m2 = @xmpp.create_message do |v|
+        v.property('type', 'engine')
+      end
+      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>/
+    end
+
+    it "must generate omf configure xml fragment" do
+      m1 = @xmpp.configure_message([throttle: 50])
+      m2 = @xmpp.configure_message do |v|
+        v.property('throttle', 50)
+      end
+      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="fixnum">50<\/property>/
+      m2.body.to_xml.must_match /<property key="throttle" type="fixnum">50<\/property>/
+    end
+
+    it "must generate omf inform xml fragment" do
+      m1 = @xmpp.inform_message([inform_type: 'CREATED'])
+      m2 = @xmpp.inform_message do |v|
+        v.property('inform_type', 'CREATED')
+      end
+      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="inform_type" type="string">CREATED<\/property>/
+      m2.body.to_xml.must_match /<property key="inform_type" type="string">CREATED<\/property>/
+    end
+
+    it "must generate omf release xml fragment" do
+      m1 = @xmpp.release_message([resource_id: 100])
+      m2 = @xmpp.release_message do |v|
+        v.property('resource_id', 100)
+      end
+      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="resource_id" type="fixnum">100<\/property>/
+      m2.body.to_xml.must_match /<property key="resource_id" type="fixnum">100<\/property>/
+    end
+
+    it "must generate omf request xml fragment" do
+      m1 = @xmpp.request_message([:max_rpm, {:provider => {country: 'japan'}}, :max_power])
+      m2 = @xmpp.request_message do |v|
+        v.property('max_rpm')
+        v.property('provider', { country: 'japan' })
+        v.property('max_power')
+      end
+      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"\/>/
+    end
+  end
+
+  describe "when informed message received" do
+    include EM::MiniTest::Spec
+
+    it "must react to omf created message" do
+      Blather::Client.stub :new, @client do
+        omf_create = OmfCommon::Message.create { |v| v.property('type', 'engine') }
+        omf_create.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_created = Blather::XMPPNode.parse(omf_created_xml)
+          @client.receive_data omf_created
+          @xmpp.on_created_message(omf_create) do |n|
+            n.must_equal Message.parse(omf_created.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must react to omf status message" do
+      Blather::Client.stub :new, @client do
+        omf_request = OmfCommon::Message.request { |v| v.property('bob') }
+        omf_request.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_status = Blather::XMPPNode.parse(omf_status_xml)
+          @client.receive_data omf_status
+          @xmpp.on_status_message(omf_request) do |n|
+            n.must_equal Message.parse(omf_status.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must react to omf release message" do
+      Blather::Client.stub :new, @client do
+        omf_release = OmfCommon::Message.release { |v| v.property('resource_id', '100') }
+        omf_release.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_released = Blather::XMPPNode.parse(omf_released_xml)
+          @client.receive_data omf_released
+          @xmpp.on_released_message(omf_release) do |n|
+            n.must_equal Message.parse(omf_released.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must react to omf failed message" do
+      Blather::Client.stub :new, @client do
+        omf_create = OmfCommon::Message.create { |v| v.property('type', 'engine') }
+        omf_create.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_failed = Blather::XMPPNode.parse(omf_failed_xml)
+          @client.receive_data omf_failed
+          @xmpp.on_failed_message(omf_create) do |n|
+            n.must_equal Message.parse(omf_failed.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+  end
+
+  describe "when use event machine style method" do
+    include EM::MiniTest::Spec
+
+    it "must accept these methods and forward to event machine" do
+      @xmpp.add_timer(0.05) { done! }
+      @xmpp.add_periodic_timer(0.05) { done! }
+      wait!
+    end
+  end
+
+  describe "when asked to get a topic object" do
+    it "must return a topic object (pubsub topic) or nil if not found" do
+      topic = @xmpp.get_topic('xmpp_topic')
+      topic.must_be_kind_of OmfCommon::Topic
+      topic.comm.must_equal @xmpp
+    end
+  end
+end
+

data/test/omf_common/message_spec.rb

@@ -8,7 +8,7 @@ describe OmfCommon::Message do
   describe "when constructing valid messages" do
     it "must return a create or configure XML element without failing" do
       %w(create configure).each do |msg_name|
-        message = Message.send(msg_name) do |m|
+        message = Message.__send__(msg_name) do |m|
           PROP_ELEMENTS.each_with_index do |prop_element, index|
             if index == 0
               m.property(prop_element, rand(100))
@@ -27,33 +27,45 @@ describe OmfCommon::Message do
     it "must return a request XML element without failing" do
       request = Message.request('foo@bar') do |m|
         PROP_ELEMENTS.each do |prop_element|
-          m.property(prop_element) do |p|
-            p.element('min_value', 'test')
-            p.element('max_value', 'test')
-          end
+          m.property(prop_element, {min_value: 'test', max_value: 'test'})
         end
       end
       request.valid?.must_equal true
     end
 
     it "must return a release XML element without failing" do
-      release = Message.release
+      release = Message.release { |v| v.element('resource_id', 'test') }
       release.valid?.must_equal true
     end
 
     it "must return a inform XML element without failing" do
-      inform = Message.inform('9012c3bc-68de-459a-ac9f-530cc7168e22', 'CREATED') do |m|
+      inform = Message.inform('CREATED', '9012c3bc-68de-459a-ac9f-530cc7168e22') do |m|
         m.element('resource_id', 'test')
         m.element('resource_address', 'test')
         PROP_ELEMENTS.each do |prop_element|
-          m.property(prop_element) do |p|
-            p.element('current', 'test')
-            p.element('target', 'test')
-          end
+          m.property(prop_element, { current: 'test', target: 'test'})
         end
       end
       inform.valid?.must_equal true
     end
+
+    it "context_id & resource_id shortcut must work too" do
+      m = Message.inform('CREATED', '9012c3bc-68de-459a-ac9f-530cc7168e22') do |m|
+        m.element('resource_id', 'test')
+      end
+      m.resource_id.must_equal 'test'
+      m.context_id.must_equal '9012c3bc-68de-459a-ac9f-530cc7168e22'
+    end
+
+    it "must be able to pretty print an app_event message" do
+      Message.inform('STATUS') do |m|
+        m.property('status_type', 'APP_EVENT')
+        m.property('event', 'DONE.OK')
+        m.property('app', 'app100')
+        m.property('msg', 'Everything will be OK')
+        m.property('seq', 1)
+      end.print_app_event.must_equal "APP_EVENT (app100, #1, DONE.OK): Everything will be OK"
+    end
   end
 
   describe "must be able to parse a XML element into Message object" do
@@ -61,25 +73,48 @@ describe OmfCommon::Message do
       xml = Message.create do |m|
         m.property('type', 'vm')
         m.property('os', 'debian')
-        m.property('memory', 1024) do |p|
-          p.element('unit', 'mb')
-          p.element('precision', '0')
-        end
-      end.to_xml
+        m.property('memory', { value: 1024, unit: 'mb', precision: 0 })
+        m.property('devices', [{ name: 'w0', driver: 'mod_bob'}, { name: 'w1', driver: ['mod1', 'mod2']} ])
+      end.canonicalize
 
       message = Message.parse(xml)
 
       message.must_be_kind_of Message
       message.operation.must_equal :create
-      message.read_element("//property").size.must_equal 3
+      message.read_element("//property").size.must_equal 4
       message.read_content("unit").must_equal 'mb'
-      message.read_element("/create/property").size.must_equal 3
+      message.read_element("/create/property").size.must_equal 4
       message.read_property("type").must_equal 'vm'
       message.read_property(:type).must_equal 'vm'
+
       memory = message.read_property(:memory)
+      memory.must_be_kind_of Hashie::Mash
       memory.value.must_equal 1024
       memory.unit.must_equal 'mb'
       memory.precision.must_equal 0
+
+      devices = message.read_property(:devices)
+      devices.items.must_be_kind_of Array
+      devices.items.size.must_equal 2
+      devices.items.find { |v| v.name == 'w1'}.driver.items.size.must_equal 2
+      # Each property iterator
+      message.each_property do |v|
+        %w(type os memory devices).must_include v.attr('key')
+      end
+    end
+  end
+
+  describe "when query the message object" do
+    it "must return nil if content of a property is empty string" do
+      xml = Message.request do |m|
+        m.property('type', 'vm')
+        m.property('empty')
+        m.element('empty')
+      end
+
+      xml.read_property('type').must_equal 'vm'
+      xml.read_property('empty').must_equal nil
+      xml.read_content('empty').must_equal nil
     end
   end
 end

data/test/omf_common/topic_message_spec.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+require 'fixture/pubsub'
+require 'em/minitest/spec'
+
+include OmfCommon
+
+describe OmfCommon::Topic do
+  before do
+    @client = Blather::Client.new
+    @stream = MiniTest::Mock.new
+    @stream.expect(:send, true, [Blather::Stanza])
+    @client.post_init @stream, Blather::JID.new('n@d/r')
+    @comm = Class.new { include OmfCommon::DSL::Xmpp }.new
+    @topic = @comm.get_topic('mclaren')
+    @message = @comm.request_message([:bob])
+  end
+
+  describe "when topic message object initialised" do
+    include EM::MiniTest::Spec
+
+    it "must be able to publish to a topic" do
+      Blather::Client.stub :new, @client do
+        published = Blather::XMPPNode.parse(published_xml)
+        write_callback = proc do |event|
+          event.must_be_kind_of Blather::Stanza::PubSub::Publish
+          event.node.must_equal @topic.id
+          published.id = event.id
+          @client.receive_data published
+        end
+        @client.stub :write, write_callback do
+          @message.publish(@topic.id) do |event|
+            event.must_equal published
+          end
+
+          # Can publish again
+          @message.publish(@topic.id) do |event|
+            event.must_equal published
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+  end
+
+  describe "when message with same context id arrived " do
+    include EM::MiniTest::Spec
+
+    it "must react to omf created message" do
+      Blather::Client.stub :new, @client do
+        omf_create = @comm.create_message { |v| v.property('type', 'engine') }
+        omf_create.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_created = Blather::XMPPNode.parse(omf_created_xml)
+          @client.receive_data omf_created
+          omf_create.on_inform_created do |n|
+            n.context_id.must_equal "bf840fe9-c176-4fae-b7de-6fc27f183f76"
+            n.must_equal Message.parse(omf_created.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must react to omf status message" do
+      Blather::Client.stub :new, @client do
+        omf_request = @comm.request_message { |v| v.property('bob') }
+        omf_request.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_status = Blather::XMPPNode.parse(omf_status_xml)
+          @client.receive_data omf_status
+          omf_request.on_inform_status do |n|
+            n.context_id.must_equal "bf840fe9-c176-4fae-b7de-6fc27f183f76"
+            n.must_equal Message.parse(omf_status.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must react to omf release message" do
+      Blather::Client.stub :new, @client do
+        omf_release = @comm.release_message { |v| v.property('resource_id', '100') }
+        omf_release.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_released = Blather::XMPPNode.parse(omf_released_xml)
+          @client.receive_data omf_released
+          omf_release.on_inform_released do |n|
+            n.context_id.must_equal "bf840fe9-c176-4fae-b7de-6fc27f183f76"
+            n.must_equal Message.parse(omf_released.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+
+    it "must react to omf failed message" do
+      Blather::Client.stub :new, @client do
+        omf_create = @comm.create_message { |v| v.property('type', 'engine') }
+        omf_create.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+          omf_failed = Blather::XMPPNode.parse(omf_failed_xml)
+          @client.receive_data omf_failed
+          omf_create.on_inform_failed do |n|
+            n.context_id.must_equal "bf840fe9-c176-4fae-b7de-6fc27f183f76"
+            n.must_equal Message.parse(omf_failed.items.first.payload)
+            done!
+          end
+        end
+      end
+      wait!
+    end
+  end
+end