agent_xmpp 0.1.0

data/test/cases/test_version_discovery.rb

@@ -0,0 +1,67 @@
+##############################################################################################################
+require 'test_helper'
+
+##############################################################################################################
+class TestClientVersionDiscovery < Test::Unit::TestCase
+
+  #.........................................................................................................
+  def setup
+    @troy = AgentXmpp::Xmpp::Jid.new('troy@nowhere.com/home')
+    @noone = AgentXmpp::Xmpp::Jid.new('noone@nowhere.com/nothing')
+    @config = {'jid' => 'test@nowhere.com', 'roster' =>[@troy.bare.to_s], 'password' => 'nopass'}
+    @client = TestClient.new(@config)
+    test_init_roster(@client)
+    @delegate = @client.new_delegate
+  end
+  
+  ####-------------------------------------------------------------------------------------------------------
+  context "on receiving a presence message of type=available from a jid in configured roster" do
+  
+    #.........................................................................................................
+    setup do
+      AgentXmpp::Xmpp::IdGenerator.set_gen_id([1,2])
+      @delegate.on_version_get_method.should_not be_called
+      @delegate.on_version_result_method.should_not be_called
+      AgentXmpp::Roster.find_by_jid(@troy).should be_nil
+      @client.receiving(PresenceMessages.recv_presence_available(@client, @troy.to_s)).should \
+        respond_with(VersionDiscoveryMessages.send_iq_get_query_version(@client, @troy.to_s))
+      AgentXmpp::Roster.find_by_jid(@troy).should_not be_nil
+    end  
+  
+    #.........................................................................................................
+    should "send a client version request to that jid and do nothing if the result is an error" do
+      @client.receiving(VersionDiscoveryMessages.recv_iq_result_query_version(@client, @troy.to_s)).should not_respond
+      AgentXmpp::Roster.has_version?(@troy).should be(true)
+      @delegate.on_version_result_method.should be_called
+    end
+        
+    #.........................................................................................................
+    should "respond to client version requests from that jid" do
+      @client.receiving(VersionDiscoveryMessages.recv_iq_result_query_version(@client, @troy.to_s)).should not_respond
+      AgentXmpp::Roster.has_version?(@troy).should be(true)
+      @delegate.on_version_result_method.should be_called
+      @client.receiving(VersionDiscoveryMessages.recv_iq_get_query_version(@client, @troy.to_s)).should \
+        respond_with(VersionDiscoveryMessages.send_iq_result_query_version(@client, @troy.to_s))
+      @delegate.on_version_get_method.should be_called
+    end
+    
+    #.........................................................................................................
+    should "send a client version request to that jid and update roster with result version information" do
+      @delegate.on_version_error_method.should_not be_called
+      @client.receiving(VersionDiscoveryMessages.recv_iq_error_query_version(@client, @troy.to_s)).should not_respond
+      AgentXmpp::Roster.has_version?(@troy).should be(false)
+      @delegate.on_version_error_method.should be_called
+    end
+      
+  end
+          
+  #.........................................................................................................
+  should "not respond to client version requests from jids not in configured roster" do
+    @delegate.on_version_get_method.should_not be_called
+    AgentXmpp::Contact.has_jid?(@noone).should be(false)
+    @client.receiving(VersionDiscoveryMessages.recv_iq_get_query_version(@client, @noone.to_s)).should not_respond
+    @delegate.on_version_get_method.should be_called
+  end
+    
+end
+

data/test/helpers/matchers.rb

@@ -0,0 +1,23 @@
+####------------------------------------------------------------------------------------------------------
+def_matcher :respond_with do |receiver, matcher, args|
+  prepare_msg = lambda{|msg| msg.collect{|i| i.split(/\n+/).inject("") {|p, m| p + m.strip.gsub(/id='\d+'/, '').gsub(/\s+/, " ")}}}
+  given = prepare_msg[[receiver].flatten].join
+  expected = prepare_msg[args].join
+  matcher.positive_msg = "Expected response message of \"#{expected}\" but was given message \"#{given}\""
+  matcher.negative_msg = "Expected response message \"#{expected}\" to not match given message \"#{given}\""
+  given.include?(expected)
+end
+
+####------------------------------------------------------------------------------------------------------
+def_matcher :not_respond do |receiver, matcher, args|
+  matcher.positive_msg = "Expected no responce"
+  matcher.negative_msg = "Expected a response"
+  receiver.nil? || receiver.empty?
+end
+
+####------------------------------------------------------------------------------------------------------
+def_matcher :be_called do |receiver, matcher, args|
+  matcher.positive_msg = "Expected client delgate method '#{receiver.last}' to be called"
+  matcher.negative_msg = "Expected client delgate method '#{receiver.last}' to not be called"
+  receiver.first
+end

data/test/helpers/mocks.rb

@@ -0,0 +1,82 @@
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  class Connection 
+  
+    #.........................................................................................................
+    def self.new(*args)
+      allocate.instance_eval do
+        initialize(*args)
+        connection_completed
+        self
+      end
+    end
+  
+    #.........................................................................................................
+    def send_data(data)
+      data
+    end
+
+    def connection_completed
+      pipe.connection_completed
+    end
+
+    #.........................................................................................................
+    def error?
+      false
+    end
+
+    #.........................................................................................................
+    def reset_parser
+    end
+      
+  #### Connection  
+  end
+
+  #####-------------------------------------------------------------------------------------------------------
+  class Client 
+  
+    #.........................................................................................................
+    def connect
+      @connection = AgentXmpp::Connection.new(self)    
+    end
+
+    #.........................................................................................................
+    def reconnect
+      true
+    end
+    
+  #### Client  
+  end
+
+  #####-------------------------------------------------------------------------------------------------------
+  class Controller
+    def handle_request  
+      request_callback(request).collect{|m| Send(Xmpp::Stanza::import(REXML::Document.new(m).root))}
+    end
+  end
+
+  #####-------------------------------------------------------------------------------------------------------
+  class Boot  
+    def self.boot     
+    end        
+  end
+
+#### AgentXmpp
+end
+
+
+##############################################################################################################
+module AgentXmpp
+  module Xmpp
+    class IdGenerator
+      @gen_id;
+      class << self
+        def set_gen_id(val=1); @gen_id = val; end
+        def gen_id; @gen_id; end;
+        def generate_id; @gen_id.kind_of?(Array) ? @gen_id.shift : @gen_id; end
+      end
+    end
+  end
+end

data/test/helpers/test_case_extensions.rb

@@ -0,0 +1,45 @@
+#####-------------------------------------------------------------------------------------------------------
+class Test::Unit::TestCase
+
+  #.........................................................................................................
+  def bind_resource(client)
+    AgentXmpp::Xmpp::IdGenerator.set_gen_id
+    client.receiving(SessionMessages.recv_preauthentication_stream_features_with_plain_SASL(client)) 
+    client.receiving(SessionMessages.recv_auth_success(client)) 
+    client.receiving(SessionMessages.recv_postauthentication_stream_features(client)) 
+    client.receiving(SessionMessages.recv_iq_result_bind(client))
+  end
+
+  #.........................................................................................................
+  def test_send_roster_request(client)
+
+    #### client configured with two contacts in roster
+    delegate = client.new_delegate
+    bind_resource(client)
+  
+    #### session starts and roster is requested
+    delegate.on_start_session_method.should_not be_called
+    AgentXmpp::Xmpp::IdGenerator.set_gen_id([1,2])
+    client.receiving(SessionMessages.recv_iq_result_session(client)).should \
+      respond_with(SessionMessages.send_presence_init(client), RosterMessages.send_iq_get_query_roster(client), \
+                   ServiceDiscoveryMessages.send_iq_get_query_discoinfo(client, client.jid.domain)) 
+    delegate.on_start_session_method.should be_called
+    AgentXmpp::Xmpp::IdGenerator.set_gen_id
+  end
+  
+  #.........................................................................................................
+  def test_init_roster(client)
+
+    #### client configured with two contacts in roster
+    test_send_roster_request(client)
+    delegate = client.new_delegate
+  
+    #### receive roster request and verify that roster items are activated
+    delegate.on_all_roster_items_method.should_not be_called     
+    AgentXmpp::Roster.find_all{|r| r[:status].should be(:inactive)}  
+    client.receiving(RosterMessages.recv_iq_result_query_roster(client, AgentXmpp.config['roster'])).should not_respond
+    AgentXmpp::Roster.find_all{|r| r[:status].should be(:both)}  
+    delegate.on_all_roster_items_method.should be_called     
+  end
+  
+end

data/test/helpers/test_client.rb

@@ -0,0 +1,44 @@
+##############################################################################################################
+class TestClient
+
+  #.........................................................................................................
+  attr_reader :client, :config, :jid
+
+  #.........................................................................................................
+  def initialize(config = nil)
+    @config = config || File.open('test/helpers/agent_xmpp.yml') {|yf| YAML::load(yf)}
+    @client = AgentXmpp::Client.new(@config)
+    @jid = @client.jid
+    @client.connect
+  end
+
+  #.........................................................................................................
+  def connection
+    @client.connection
+  end
+  
+  #.........................................................................................................
+  def responder_list
+    @client.pipe.responder_list
+  end
+
+  #.........................................................................................................
+  def new_delegate
+    @client.remove_delegate(@delegate) unless @delegate.nil?
+    @delegate = TestDelegate.new
+    @client.add_delegate(@delegate)
+    @delegate
+  end
+    
+  #.........................................................................................................
+  def receiving(msg)
+    prepared_msg = msg.split(/\n/).inject("") {|p, m| p + m.strip}
+    doc = REXML::Document.new(prepared_msg).root
+    doc = doc.elements.first if doc.name.eql?('stream')
+    if ['presence', 'message', 'iq'].include?(doc.name)
+      doc = AgentXmpp::Xmpp::Stanza::import(doc) 
+    end
+    client.connection.receive(doc)
+  end
+
+end

data/test/helpers/test_delegate.rb

@@ -0,0 +1,60 @@
+##############################################################################################################
+class TestDelegate
+
+  ####------------------------------------------------------------------------------------------------------
+  class << self
+    
+    #.........................................................................................................
+    @@callback_methods = []
+    
+    #.........................................................................................................
+    def delegate_callbacks(*args)
+      args.each do |meth| 
+        @@callback_methods.push(meth)
+        class_eval <<-do_eval
+          def #{meth}(*args)
+            AgentXmpp.logger.info "TEST_DELEGATE #{meth.to_s.upcase}"
+            @#{meth}_method = true
+            nil
+          end
+          def #{meth}_method
+            [@#{meth}_method, "#{meth.to_s}"]
+          end
+          attr_writer :#{meth}_method
+        do_eval
+      end
+    end 
+                         
+  end
+  
+  #---------------------------------------------------------------------------------------------------------
+  #### connection
+  delegate_callbacks :on_connect, :on_disconnect, :on_did_not_connect, :on_did_not_authenticate
+
+  #### authentication
+  delegate_callbacks :on_authenticate, :on_bind, :on_start_session, :on_preauthenticate_features,
+                     :on_postauthenticate_features
+
+  #### presence
+  delegate_callbacks :on_presence, :on_presence_subscribe, :on_presence_unsubscribed, :on_presence_subscribed, :on_presence_unavailable
+
+  #### roster management
+  delegate_callbacks :on_roster_item, :on_all_roster_items, :on_acknowledge_add_roster_item, 
+                     :on_roster_result, :on_roster_set, :on_remove_roster_item, :on_acknowledge_remove_roster_item, 
+                     :on_remove_roster_item_error, :on_add_roster_item_error
+
+  #### service discovery management
+  delegate_callbacks :on_version_result, :on_version_get, :on_version_error, :on_discoinfo_result,
+                     :on_discoinfo_get, :on_discoitems_get, :on_discoitems_result,
+                     :on_discoinfo_error, :on_discoitems_error
+
+   #### errors
+   delegate_callbacks :on_unsupported_message
+  
+  #---------------------------------------------------------------------------------------------------------
+  def initialize
+    @@callback_methods.each{|m| send("#{m.to_s}_method=".to_sym, false)}
+  end
+  
+#### TestDelegate 
+end

data/test/helpers/test_helper.rb

@@ -0,0 +1,91 @@
+#####-------------------------------------------------------------------------------------------------------
+require 'test/unit'
+require 'rubygems'
+begin
+  require 'shoulda'
+rescue LoadError
+  abort "shoulda is not available. In order to run test, you must: sudo gem install thoughtbot-shoulda --source=http://gems.github.com"
+end
+begin
+  require 'matchy'
+rescue LoadError
+  abort "matchy is not available. In order to run test, you must: sudo gem install mhennemeyer-matchy --source=http://gems.github.com"
+end
+
+#####-------------------------------------------------------------------------------------------------------
+$:.unshift('lib')
+require 'rubygems'
+require 'agent_xmpp'
+
+#####-------------------------------------------------------------------------------------------------------
+require 'test_delegate'
+require 'mocks'
+require 'test_client'
+require 'matchers'
+require 'test_case_extensions'
+
+#####-------------------------------------------------------------------------------------------------------
+require 'application_messages'
+require 'roster_messages'
+require 'version_discovery_messages'
+require 'service_discovery_messages'
+require 'session_messages'
+require 'presence_messages'
+require 'error_messages'
+
+#####-------------------------------------------------------------------------------------------------------
+AgentXmpp.app_path = 'test/helpers'
+AgentXmpp.logger.level = Logger::DEBUG
+
+####------------------------------------------------------------------------------------------------------
+before_start do
+  AgentXmpp.logger.info "AgentXmpp::BootApp.before_start"
+end
+
+after_connected do |pipe|
+  AgentXmpp.logger.info "AgentXmpp::BootApp.after_connected"
+end
+
+restarting_client do |pipe|
+  AgentXmpp.logger.info "AgentXmpp::BootApp.restarting_client"
+end
+
+discovered_pubsub_service do |pipe|
+  AgentXmpp.logger.info "discovered_pubsub_service"
+end
+
+#####-------------------------------------------------------------------------------------------------------
+execute 'scalar' do
+  AgentXmpp.logger.info "ACTION: scalar"
+  'scalar' 
+end
+
+#.........................................................................................................
+execute 'hash' do
+  AgentXmpp.logger.info "ACTION: hash"
+  {:attr1 => 'val1', :attr2 => 'val2'}
+end
+
+#.........................................................................................................
+execute 'scalar_array' do
+  AgentXmpp.logger.info "ACTION: array"
+  ['val1', 'val2','val3', 'val4'] 
+end
+
+#.........................................................................................................
+execute 'hash_array' do
+  AgentXmpp.logger.info "ACTION: hash_array"
+  {:attr1 => ['val11', 'val11'], :attr2 => 'val12'}
+end
+
+#.........................................................................................................
+execute 'array_hash' do
+  AgentXmpp.logger.info "ACTION: array_hash"
+  [{:attr1 => 'val11', :attr2 => 'val12'}, {:attr1 => 'val21', :attr2 => 'val22'}, {:attr1 => 'val31', :attr2 => 'val32'}]
+end
+
+#.........................................................................................................
+execute 'array_hash_array' do
+  AgentXmpp.logger.info "ACTION: hash_array"
+  [{:attr1 => ['val11', 'val11'], :attr2 => 'val12'}, {:attr1 => ['val21', 'val21'], :attr2 => 'val22'}, {:attr1 => ['val31', 'val31'], :attr2 => 'val32'}]
+end

data/test/messages/application_messages.rb

@@ -0,0 +1,206 @@
+##############################################################################################################
+module ApplicationMessages
+
+  #####-------------------------------------------------------------------------------------------------------
+  class << self
+    
+    #### received messages    
+    #.........................................................................................................
+    def recv_iq_set_command_execute(client, node, from)
+      <<-MSG
+        <iq from='#{from}' to='#{client.client.jid.to_s}' id='1' type='set' xmlns='jabber:client'>
+          <command node='#{node}' action='execute' xmlns='http://jabber.org/protocol/commands'/>
+        </iq>
+      MSG
+    end
+
+    #.........................................................................................................
+    def recv_message_chat(client, from)
+      <<-MSG
+        <message from='#{from}' to='#{client.client.jid.to_s}' type='chat' xmlns='jabber:client'>
+          <body>fuck you</body>
+        </message>
+      MSG
+    end
+
+    #### sent messages    
+    #.........................................................................................................
+    def send_iq_result_command_x_data_scalar(client, to)
+      <<-MSG
+        <iq id='1' to='#{to}' type='result' xmlns='jabber:client'>
+          <command node='scalar' status='completed' xmlns='http://jabber.org/protocol/commands'>
+            <x type='result' xmlns='jabber:x:data'>
+              <field>
+                <value>scalar</value>
+              </field>
+            </x>
+          </command>
+        </iq>      
+      MSG
+    end
+
+    #.........................................................................................................
+    def send_iq_result_command_x_data_hash(client, to)
+      <<-MSG
+        <iq id='1' to='#{to}' type='result' xmlns='jabber:client'>
+          <command node='hash' status='completed' xmlns='http://jabber.org/protocol/commands'>
+            <x type='result' xmlns='jabber:x:data'>
+              <field var='attr1'>
+                <value>val1</value>
+              </field>
+              <field var='attr2'>
+                <value>val2</value>
+              </field>
+            </x>
+          </command>
+        </iq>
+      MSG
+     end
+
+    #.........................................................................................................
+    def send_iq_result_command_x_data_scalar_array(client, to)
+      <<-MSG
+        <iq id='1' to='#{to}' type='result' xmlns='jabber:client'>
+          <command node='scalar_array' status='completed' xmlns='http://jabber.org/protocol/commands'>
+            <x type='result' xmlns='jabber:x:data'>
+              <field type='list-multi'>
+                <value>val1</value>
+                <value>val2</value>
+                <value>val3</value>
+                <value>val4</value>
+              </field>
+            </x>
+          </command>
+        </iq>
+      MSG
+    end
+
+    #.........................................................................................................
+    def send_iq_result_command_x_data_hash_array(client, to)
+      <<-MSG
+        <iq id='1' to='#{to}' type='result' xmlns='jabber:client'>
+          <command node='hash_array' status='completed' xmlns='http://jabber.org/protocol/commands'>
+            <x type='result' xmlns='jabber:x:data'>
+              <field type='list-multi' var='attr1'>
+                <value>val11</value>
+                <value>val11</value>
+              </field>
+              <field var='attr2'>
+                <value>val12</value>
+              </field>
+            </x>
+          </command>
+        </iq>
+      MSG
+     end
+
+    #.........................................................................................................
+    def send_iq_result_command_x_data_array_hash(client, to)
+      <<-MSG
+        <iq id='1' to='#{to}' type='result' xmlns='jabber:client'>
+          <command node='array_hash' status='completed' xmlns='http://jabber.org/protocol/commands'>
+            <x type='result' xmlns='jabber:x:data'>
+              <reported>
+                <field var='attr1'/>
+                <field var='attr2'/>
+              </reported>
+              <item>
+                <field var='attr1'>
+                  <value>val11</value>
+                </field>
+                <field var='attr2'>
+                  <value>val12</value>
+                </field>
+              </item>
+              <item>
+                <field var='attr1'>
+                  <value>val21</value>
+                </field>
+                <field var='attr2'>
+                  <value>val22</value>
+                </field>
+              </item>
+              <item>
+                <field var='attr1'>
+                  <value>val31</value>
+                </field>
+                <field var='attr2'>
+                  <value>val32</value>
+                </field>
+              </item>
+            </x>
+          </command>
+        </iq>
+      MSG
+     end
+
+     #.........................................................................................................
+     def send_iq_result_command_x_data_array_hash_array(client, to)
+       <<-MSG
+         <iq id='1' to='#{to}' type='result' xmlns='jabber:client'>
+           <command node='array_hash_array' status='completed' xmlns='http://jabber.org/protocol/commands'>
+             <x type='result' xmlns='jabber:x:data'>
+               <reported>
+                 <field var='attr1'/>
+                 <field var='attr2'/>
+               </reported>
+               <item>
+                 <field type='list-multi' var='attr1'>
+                   <value>val11</value>
+                   <value>val11</value>
+                 </field>
+                 <field var='attr2'>
+                   <value>val12</value>
+                 </field>
+               </item>
+               <item>
+                 <field type='list-multi' var='attr1'>
+                   <value>val21</value>
+                   <value>val21</value>
+                 </field>
+                 <field var='attr2'>
+                   <value>val22</value>
+                 </field>
+               </item>
+               <item>
+                 <field type='list-multi' var='attr1'>
+                   <value>val31</value>
+                   <value>val31</value>
+                 </field>
+                 <field var='attr2'>
+                   <value>val32</value>
+                 </field>
+               </item>
+             </x>
+           </command>
+         </iq>
+       MSG
+      end
+
+    #.........................................................................................................
+    def send_error_command_routing(client, node, to)
+      <<-MSG
+        <iq id='1' to='#{to}' type='error' xmlns='jabber:client'>
+          <command node='#{node}' action='execute' xmlns='http://jabber.org/protocol/commands'/>
+          <error code='404' type='cancel'>
+            <item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
+            <text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'>no route for specified command node</text>
+          </error>
+        </iq>
+      MSG
+    end
+       
+    #.........................................................................................................
+    def send_message_chat(client, to)
+      <<-MSG
+        <message to='#{to}' type='chat' xmlns='jabber:client'>
+          <body>#{AgentXmpp::AGENT_XMPP_NAME} #{AgentXmpp::VERSION}, #{AgentXmpp::OS_VERSION}</body>
+        </message>
+       MSG
+    end
+       
+  ## self  
+  end
+ 
+#### ApplicationMessages      
+end