troystribling-agent_xmpp 0.0.0 → 0.0.1

data/test/cases/test_service_discovery.rb

@@ -0,0 +1,168 @@
+##############################################################################################################
+require 'test_helper'
+
+##############################################################################################################
+class TestServiceDiscovery < Test::Unit::TestCase
+
+  #.........................................................................................................
+  def setup
+    @client = TestClient.new()
+    test_init_roster(@client)
+    @delegate = @client.new_delegate
+    @server = AgentXmpp::Xmpp::Jid.new(@client.jid.domain)
+    @test = AgentXmpp::Xmpp::Jid.new('test@plan-b.ath.cx/home')
+    @noone = AgentXmpp::Xmpp::Jid.new('noone@plan-b.ath.cx/nowhere')
+  end
+
+  ####------------------------------------------------------------------------------------------------------
+  context "after sesson start a disco#info request addressed to the server should be generated" do
+      
+    #.........................................................................................................
+    setup do
+      @delegate.did_receive_discoinfo_result_method.should_not be_called
+      AgentXmpp.roster.has_discoinfo?(@server).should be(false)
+      @client.receiving(ServiceDiscoveryMessages.recv_iq_result_query_discoinfo(@client, @server.to_s)).should \
+        respond_with(ServiceDiscoveryMessages.send_iq_get_query_discoitems(@client, @server.to_s))
+      @delegate.did_receive_discoinfo_result_method.should be_called
+      AgentXmpp.roster.has_discoinfo?(@server).should be(true)
+    end
+      
+    #.........................................................................................................
+    should "and the result update the server roster entry and generate a disco#info request if the result is not an error" do
+    end
+    
+    #.........................................................................................................
+    should "update the server roster entry with result of server disco#items request if the result is not an error" do
+      @delegate.did_receive_discoitems_result_method.should_not be_called
+      AgentXmpp.roster.has_discoitems?(@server).should be(false)
+      @client.receiving(ServiceDiscoveryMessages.recv_iq_result_query_discoitems(@client, @server.to_s)).should not_respond
+      @delegate.did_receive_discoitems_result_method.should be_called
+      AgentXmpp.roster.has_discoitems?(@server).should be(true)
+    end
+    
+    #.........................................................................................................
+    should "not update the server roster entry with the disco#items result if the result is an error" do
+      @delegate.did_receive_discoitems_result_method.should_not be_called
+      @delegate.did_receive_discoitems_error_method.should_not be_called
+      AgentXmpp.roster.has_discoitems?(@server).should be(false)
+      @client.receiving(ServiceDiscoveryMessages.recv_iq_error_query_discoitems(@client, @server.to_s)).should not_respond
+      @delegate.did_receive_discoitems_result_method.should_not be_called
+      @delegate.did_receive_discoitems_error_method.should be_called
+      AgentXmpp.roster.has_discoitems?(@server).should be(false)
+    end
+  
+  end  
+  
+  ####------------------------------------------------------------------------------------------------------
+  context "after transition of contact to presence with type=available a disco#info request addressed to the contact should be genearated and the result" do
+   
+    #.........................................................................................................
+    setup do
+      AgentXmpp::Xmpp::IdGenerator.set_gen_id([1,2])
+      @client.receiving(PresenceMessages.recv_presence_available(@client, @test.to_s))
+      @delegate.did_receive_discoinfo_result_method.should_not be_called
+      AgentXmpp.roster.has_discoinfo?(@test).should be(false)
+      AgentXmpp::Xmpp::IdGenerator.set_gen_id
+      @client.receiving(ServiceDiscoveryMessages.recv_iq_result_query_discoinfo(@client, @test.to_s)).should \
+        respond_with(ServiceDiscoveryMessages.send_iq_get_query_discoitems(@client, @test.to_s))
+      @delegate.did_receive_discoinfo_result_method.should be_called
+      AgentXmpp.roster.has_discoinfo?(@test).should be(true)
+    end
+          
+    #.........................................................................................................
+    should "update the contact roster entry and generate a disco#items request if the result is not an error" do
+    end
+      
+    #.........................................................................................................
+    should "update the contact roster entry with result of contact disco#items request if the result is not an error" do
+        @delegate.did_receive_discoitems_result_method.should_not be_called
+        AgentXmpp.roster.has_discoitems?(@test).should be(false)
+        @client.receiving(ServiceDiscoveryMessages.recv_iq_result_query_discoitems(@client, @test.to_s)).should not_respond
+        @delegate.did_receive_discoitems_result_method.should be_called
+        AgentXmpp.roster.has_discoitems?(@test).should be(true)
+    end
+      
+    #.........................................................................................................
+    should "not update the contact roster entry with the disco#info result or geneate a disco#items request if the result is an error" do
+        @delegate.did_receive_discoitems_result_method.should_not be_called
+        @delegate.did_receive_discoitems_error_method.should_not be_called
+        AgentXmpp.roster.has_discoitems?(@test).should be(false)
+        @client.receiving(ServiceDiscoveryMessages.recv_iq_error_query_discoitems(@client, @test.to_s)).should not_respond
+        @delegate.did_receive_discoitems_result_method.should_not be_called
+        @delegate.did_receive_discoitems_error_method.should be_called
+        AgentXmpp.roster.has_discoitems?(@test).should be(false)
+    end
+      
+  end
+  
+  #.........................................................................................................
+  should "not update the roster entry with the disco#info result or geneate a disco#items request if an error is received as a result of a disco#info request" do
+    @delegate.did_receive_discoinfo_result_method.should_not be_called
+    @delegate.did_receive_discoinfo_error_method.should_not be_called    
+    AgentXmpp.roster.has_discoinfo?(@server).should be(false)
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_error_query_discoinfo(@client, @server.to_s)).should not_respond
+    AgentXmpp.roster.has_discoinfo?(@server).should be(false)
+    @delegate.did_receive_discoinfo_result_method.should_not be_called
+    @delegate.did_receive_discoinfo_error_method.should be_called    
+  end
+  
+  #.........................................................................................................
+  should "respond with features and identity when get disco#info is received without a specified node from a jid in the configuration roster" do
+    @delegate.did_receive_discoinfo_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoinfo(@client, @test.to_s)).should \
+      respond_with(ServiceDiscoveryMessages.send_iq_result_query_discoinfo(@client, @test.to_s))
+    @delegate.did_receive_discoinfo_get_method.should be_called
+  end
+  
+  #.........................................................................................................
+  should "respond with service-unavailable error when get disco#info is received for unsupported node" do
+    @delegate.did_receive_discoinfo_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoinfo_error(@client, @test.to_s)).should \
+      respond_with(ServiceDiscoveryMessages.send_iq_error_discoinfo_service_unavailable(@client, @test.to_s))
+    @delegate.did_receive_discoinfo_get_method.should be_called
+  end
+  
+  #.........................................................................................................
+  should "not respond if get disco#info is received from a jid not in the configuration roster" do
+    AgentXmpp.roster.has_jid?(@noone).should be(false)
+    @delegate.did_receive_discoinfo_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoinfo(@client, @noone.to_s)).should not_respond
+    AgentXmpp.roster.has_jid?(@noone).should be(false)
+    @delegate.did_receive_discoinfo_get_method.should be_called
+  end
+  
+  #.........................................................................................................
+  should "respond with empty result when get disco#items is received with no specified node from a jid in the configuration roster" do
+    @delegate.did_receive_discoitems_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoitems(@client, @test.to_s)).should \
+      respond_with(ServiceDiscoveryMessages.send_iq_result_query_discoitems(@client, @test.to_s))
+    @delegate.did_receive_discoitems_get_method.should be_called
+  end
+  
+  #.........................................................................................................
+  should "respond with command nodes when get disco#items is received for the node 'http://jabber.org/protocol/commands'" do
+    @delegate.did_receive_discoitems_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoitems_for_commands_node(@client, @test.to_s)).should \
+      respond_with(ServiceDiscoveryMessages.send_iq_result_query_discoitems_for_commands_node(@client, @test.to_s))
+    @delegate.did_receive_discoitems_get_method.should be_called
+  end
+  
+  #.........................................................................................................
+  should "respond with item-not-found error when get disco#items is received for unsupported node" do
+    @delegate.did_receive_discoitems_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoitems_error(@client, @test.to_s)).should \
+      respond_with(ServiceDiscoveryMessages.send_iq_error_discoitems_item_not_found(@client, @test.to_s))
+    @delegate.did_receive_discoitems_get_method.should be_called
+  end
+  
+  #.........................................................................................................
+  should "not respond if get disco#items is received from a jid not in the configuration roster" do
+    AgentXmpp.roster.has_jid?(@noone).should be(false)
+    @delegate.did_receive_discoitems_get_method.should_not be_called
+    @client.receiving(ServiceDiscoveryMessages.recv_iq_get_query_discoitems(@client, @noone.to_s)).should not_respond
+    AgentXmpp.roster.has_jid?(@noone).should be(false)
+    @delegate.did_receive_discoitems_get_method.should be_called
+  end
+    
+end
+

data/test/cases/test_session_management.rb

@@ -0,0 +1,120 @@
+##############################################################################################################
+require 'test_helper'
+
+##############################################################################################################
+class TestSessionManagement < Test::Unit::TestCase
+
+  #.........................................................................................................
+  def setup
+    @client = TestClient.new
+    AgentXmpp::Xmpp::IdGenerator.set_gen_id
+    @delegate = @client.new_delegate
+  end
+  
+  #.........................................................................................................
+  should "authenticate with PLAIN SASL authentication when stream features includes PLAIN authentication" do
+  
+    #### connect to server
+    @client.client.pipe.connection_completed.should \
+      respond_with(SessionMessages.send_supported_xml_version(@client), SessionMessages.send_stream(@client))
+  
+    #### receive pre authentication stream feautues and mechanisms and authenticate
+    @delegate.did_authenticate_method.should_not be_called
+    @delegate.did_receive_preauthenticate_features_method.should_not be_called
+    @client.receiving(SessionMessages.recv_preauthentication_stream_features_with_plain_SASL(@client)).should \
+      respond_with(SessionMessages.send_auth_plain(@client)) 
+    @client.receiving(SessionMessages.recv_auth_success(@client)).should respond_with(SessionMessages.send_stream(@client)) 
+    @delegate.did_receive_preauthenticate_features_method.should be_called
+    @delegate.did_authenticate_method.should be_called
+  
+    #### bind resource
+    @delegate.did_bind_method.should_not be_called
+    @delegate.did_receive_postauthenticate_features_method.should_not be_called
+    @client.receiving(SessionMessages.recv_postauthentication_stream_features(@client)).should respond_with(SessionMessages.send_iq_set_bind(@client)) 
+    @client.receiving(SessionMessages.recv_iq_result_bind(@client)).should respond_with(SessionMessages.send_iq_set_session(@client)) 
+    @delegate.did_receive_postauthenticate_features_method.should be_called
+    @delegate.did_bind_method.should be_called
+  
+    #### start session and request roster
+    @delegate.did_start_session_method.should_not be_called
+    @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.did_start_session_method.should be_called
+  
+  end
+  
+  #.........................................................................................................
+  should "raise exception when stream features do not include PLAIN authentication" do
+  
+    #### connect to server
+    @client.client.pipe.connection_completed
+  
+    #### receive pre authentication stream feautues which do not include plain authentication
+    lambda{@client.receiving(SessionMessages.recv_preauthentication_stream_features_without_plain_SASL(@client))}.should \
+      raise_error(AgentXmpp::AgentXmppError) 
+  end
+  
+  #.........................................................................................................
+  should "raise exception when authentication fails" do
+    
+    #### connect to server
+    @client.client.pipe.connection_completed
+  
+    #### receive pre authentication stream feautues and mechanisms and authenticate
+    @client.receiving(SessionMessages.recv_preauthentication_stream_features_with_plain_SASL(@client)).should \
+      respond_with(SessionMessages.send_auth_plain(@client)) 
+    lambda{@client.receiving(SessionMessages.recv_auth_failure(@client))}.should raise_error(AgentXmpp::AgentXmppError) 
+    
+  end
+  
+  #.........................................................................................................
+  should "raise exception when bind fails" do
+  
+    #### connect to server
+    @client.client.pipe.connection_completed
+  
+    #### receive pre authentication stream feautues and mechanisms and authenticate
+    @delegate.did_authenticate_method.should_not be_called
+    @delegate.did_receive_preauthenticate_features_method.should_not be_called
+    @client.receiving(SessionMessages.recv_preauthentication_stream_features_with_plain_SASL(@client)).should \
+      respond_with(SessionMessages.send_auth_plain(@client)) 
+    @client.receiving(SessionMessages.recv_auth_success(@client)).should respond_with(SessionMessages.send_stream(@client)) 
+    @delegate.did_receive_preauthenticate_features_method.should be_called
+    @delegate.did_authenticate_method.should be_called
+  
+    #### bind resource and receive error
+    @client.receiving(SessionMessages.recv_postauthentication_stream_features(@client)).should respond_with(SessionMessages.send_iq_set_bind(@client)) 
+    lambda{@client.receiving(SessionMessages.recv_error_bind(@client))}.should raise_error(AgentXmpp::AgentXmppError) 
+  
+  end
+  
+  #.........................................................................................................
+  should "raise exception when session start fails" do
+  
+    #### connect to server
+    @client.client.pipe.connection_completed
+  
+    #### receive pre authentication stream feautues and mechanisms and authenticate
+    @delegate.did_authenticate_method.should_not be_called
+    @delegate.did_receive_preauthenticate_features_method.should_not be_called
+    @client.receiving(SessionMessages.recv_preauthentication_stream_features_with_plain_SASL(@client)).should \
+      respond_with(SessionMessages.send_auth_plain(@client)) 
+    @client.receiving(SessionMessages.recv_auth_success(@client)).should respond_with(SessionMessages.send_stream(@client)) 
+    @delegate.did_receive_preauthenticate_features_method.should be_called
+    @delegate.did_authenticate_method.should be_called
+  
+    #### bind resource
+    @delegate.did_receive_postauthenticate_features_method.should_not be_called
+    @delegate.did_bind_method.should_not be_called
+    @client.receiving(SessionMessages.recv_postauthentication_stream_features(@client)).should respond_with(SessionMessages.send_iq_set_bind(@client)) 
+    @client.receiving(SessionMessages.recv_iq_result_bind(@client)).should respond_with(SessionMessages.send_iq_set_session(@client)) 
+    @delegate.did_receive_postauthenticate_features_method.should be_called
+    @delegate.did_bind_method.should be_called
+  
+    #### start session and request roster
+    lambda{@client.receiving(SessionMessages.recv_error_session(@client))}.should raise_error(AgentXmpp::AgentXmppError) 
+  
+  end
+  
+end

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.did_receive_version_get_method.should_not be_called
+      @delegate.did_receive_version_result_method.should_not be_called
+      AgentXmpp.roster.resource(@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.resource(@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.did_receive_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.did_receive_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.did_receive_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.did_receive_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.did_receive_version_error_method.should be_called
+    end
+      
+  end
+          
+  #.........................................................................................................
+  should "not respond to client version requests from jids not in configured roster" do
+    @delegate.did_receive_version_get_method.should_not be_called
+    AgentXmpp.roster.has_jid?(@noone).should be(false)
+    @client.receiving(VersionDiscoveryMessages.recv_iq_get_query_version(@client, @noone.to_s)).should not_respond
+    @delegate.did_receive_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