Merge pull request #51 from toddr-bot/koan.toddr.bot/fix-issue-32

fix: eliminate unnecessary sleeps from mock test suite

Author: toddr

lib/Net/Jabber/Bot.pm

@@ -13,6 +13,7 @@ use Mozilla::CA;
 
 my $PosInt     = Type::Tiny->new( name => 'PosInt',     parent => Int, constraint => sub { $_ > 0 } );
 my $PosNum     = Type::Tiny->new( name => 'PosNum',     parent => Num, constraint => sub { $_ > 0 } );
+my $NonNegNum  = Type::Tiny->new( name => 'NonNegNum',  parent => Num, constraint => sub { $_ >= 0 } );
 my $HundredInt = Type::Tiny->new( name => 'HundredInt', parent => Num, constraint => sub { $_ > 100 } );
 
 my $CoercedBool = Bool->plus_coercions( Str, sub { ( $_ =~ m/(^on$)|(^true$)/i ) + 0 } );
@@ -25,21 +26,21 @@ has jabber_client => (
 
 #my %connection_hash : ATTR; # Keep track of connection options fed to client.
 
-has 'client_session_id' => ( isa => Str,      is   => 'rw' );
-has 'connect_time'      => ( isa => $PosInt,  is   => 'rw', default => 9_999_999_999 );
-has 'forum_join_grace'  => ( isa => $PosNum,  is   => 'rw', default => 10 );
-has 'server_host'       => ( isa => Str,      is   => 'rw', lazy    => 1, default => sub { shift->server } );
-has 'server'            => ( isa => Str,      is   => 'rw' );
-has 'port'              => ( isa => $PosInt,  is   => 'rw', default => 5222 );
-has 'gtalk'             => ( isa => Bool,     is   => 'rw', default => '0' );
-has 'tls'               => ( isa => Bool,     is   => 'rw', default => '0' );
-has 'ssl_ca_path'       => ( isa => Str,      is   => 'rw', default => Mozilla::CA::SSL_ca_file() );
-has 'ssl_verify'        => ( isa => Bool,     is   => 'rw', default => '1' );
-has 'connection_type'   => ( isa => Str,      is   => 'rw', default => 'tcpip' );
-has 'conference_server' => ( isa => Str,      is   => 'rw' );
-has 'username'          => ( isa => Str,      is   => 'rw' );
-has 'password'          => ( isa => Str,      is   => 'rw' );
-has 'alias'             => ( isa => Str,      lazy => 1, is => 'rw', default => 'net_jabber_bot' );
+has 'client_session_id' => ( isa => Str,         is   => 'rw' );
+has 'connect_time'      => ( isa => $PosInt,     is   => 'rw', default => 9_999_999_999 );
+has 'forum_join_grace'  => ( isa => $NonNegNum,  is   => 'rw', default => 10 );
+has 'server_host'       => ( isa => Str,         is   => 'rw', lazy    => 1, default => sub { shift->server } );
+has 'server'            => ( isa => Str,         is   => 'rw' );
+has 'port'              => ( isa => $PosInt,     is   => 'rw', default => 5222 );
+has 'gtalk'             => ( isa => Bool,        is   => 'rw', default => '0' );
+has 'tls'               => ( isa => Bool,        is   => 'rw', default => '0' );
+has 'ssl_ca_path'       => ( isa => Str,         is   => 'rw', default => Mozilla::CA::SSL_ca_file() );
+has 'ssl_verify'        => ( isa => Bool,        is   => 'rw', default => '1' );
+has 'connection_type'   => ( isa => Str,         is   => 'rw', default => 'tcpip' );
+has 'conference_server' => ( isa => Str,         is   => 'rw' );
+has 'username'          => ( isa => Str,         is   => 'rw' );
+has 'password'          => ( isa => Str,         is   => 'rw' );
+has 'alias'             => ( isa => Str,         lazy => 1, is => 'rw', default => 'net_jabber_bot' );
 
 # Resource defaults to alias_hostname_pid
 has 'resource'            => ( isa => Str, lazy => 1, is => 'rw', default => sub { shift->alias . "_" . hostname . "_" . $$ } );

t/05-helper_functions.t

@@ -2,7 +2,7 @@
 
 use strict;
 use warnings;
-use Test::More tests => 127;
+use Test::More tests => 125;
 use Net::Jabber::Bot;
 
 #InitLog4Perl();
@@ -63,14 +63,13 @@ my $bot = Net::Jabber::Bot->new(
 				 , out_messages_per_second => $out_messages_per_second
 				 , max_message_size => $max_message_size
 				 , max_messages_per_hour => $max_messages_per_hour
+				 , forum_join_grace => 0
 				);
 
 is($bot->message_delay, 0.2, "Message delay is set right to .20 seconds");
 is($bot->max_messages_per_hour, $max_messages_per_hour, "Max messages per hour ($max_messages_per_hour) didn't get messed with by safeties");
 
 isa_ok($bot, "Net::Jabber::Bot");
-ok(1, "Sleeping 12 seconds to make sure we get past initializtion");
-ok((sleep 12) > 10, "Making sure the bot get's past login initialization (sleep 12)");
 process_bot_messages(); # Clean off the queue before we start?
 
 # continue editing here. Need to next enhance mock object to know jabber bot callbacks.

t/06-test_safeties.t

@@ -3,7 +3,7 @@
 use strict;
 use warnings;
 
-use Test::More tests => 129;
+use Test::More tests => 127;
 use Net::Jabber::Bot;
 
 # stuff for mock client object
@@ -62,6 +62,7 @@ my $bot = Net::Jabber::Bot->new({
 				 , out_messages_per_second => $out_messages_per_second
 				 , max_message_size => $max_message_size
 				 , max_messages_per_hour => $max_messages_per_hour
+				 , forum_join_grace => 0
 				});
 
 isa_ok($bot, "Net::Jabber::Bot");
@@ -70,9 +71,7 @@ is($bot->max_messages_per_hour, $max_messages_per_hour, "Max messages per hour (
 is($bot->get_safety_mode, 1, "Validate safety mode is on")
     or die("Safety mode is not turning on. Tests will not be valid");
 
-is($bot->forum_join_grace, 10, "Forum Grace is 10 seconds as expected");
-ok(1, "Sleeping 12 seconds to make sure we get past initializtion");
-ok((sleep 12) > 10, "Making sure the bot get's past initialization (sleep 12)");
+is($bot->forum_join_grace, 0, "Forum Grace is 0 seconds as configured");
 process_bot_messages();
 
 start_new_test("Testing Group Message bursting is not possible");
@@ -211,7 +210,6 @@ sub start_new_test {
 
 
 sub process_bot_messages {
-    sleep 2; # Pause a little to make sure message make it to the server and back.
     ok(defined $bot->Process(5), "Processed new messages and didn't lose connection.");
 }
 

t/07-forum_join_grace.t

@@ -0,0 +1,89 @@
+#!perl
+
+use strict;
+use warnings;
+use Test::More tests => 5;
+use Net::Jabber::Bot;
+
+use FindBin;
+use lib "$FindBin::Bin/lib";
+use MockJabberClient;
+
+my $bot_alias = 'grace_test_bot';
+my $server    = 'talk.google.com';
+
+my %forums_and_responses;
+my $forum1 = 'test_forum1';
+$forums_and_responses{$forum1} = ["jbot:", ""];
+
+my $messages_seen = 0;
+
+# Use a short but nonzero grace period so the test runs fast
+my $bot = Net::Jabber::Bot->new({
+    server               => $server,
+    conference_server     => "conference.$server",
+    port                 => 5222,
+    username             => 'test_username',
+    password             => 'test_pass',
+    alias                => $bot_alias,
+    message_function     => sub { $messages_seen++ },
+    background_function  => sub {},
+    loop_sleep_time      => 5,
+    process_timeout      => 5,
+    forums_and_responses => \%forums_and_responses,
+    ignore_server_messages  => 1,
+    ignore_self_messages    => 0,
+    out_messages_per_second => 5,
+    max_message_size        => 800,
+    max_messages_per_hour   => 100,
+    forum_join_grace        => 2,
+});
+
+isa_ok($bot, "Net::Jabber::Bot");
+is($bot->forum_join_grace, 2, "Forum join grace set to 2 seconds");
+
+# Enable responding to self messages (safety_mode forces ignore_self_messages on,
+# and the mock echoes messages back with the same resource as the bot)
+$bot->respond_to_self_messages(1);
+
+# Send a message immediately — should be ignored (within grace period)
+my $personal_address = "test_user\@$server/$bot_alias";
+$bot->SendPersonalMessage($personal_address, "Hello during grace period");
+$bot->Process(1);
+is($messages_seen, 0, "Message during grace period is ignored");
+
+# Wait past the grace period
+sleep 3;
+
+# Send another message — should be processed now
+$messages_seen = 0;
+$bot->SendPersonalMessage($personal_address, "Hello after grace period");
+$bot->Process(1);
+is($messages_seen, 1, "Message after grace period is processed");
+
+# Test that forum_join_grace => 0 means no grace period at all
+my $bot2 = Net::Jabber::Bot->new({
+    server               => $server,
+    conference_server     => "conference.$server",
+    port                 => 5222,
+    username             => 'test_username2',
+    password             => 'test_pass',
+    alias                => $bot_alias,
+    message_function     => sub { $messages_seen++ },
+    background_function  => sub {},
+    loop_sleep_time      => 5,
+    process_timeout      => 5,
+    forums_and_responses => \%forums_and_responses,
+    ignore_server_messages  => 1,
+    ignore_self_messages    => 0,
+    out_messages_per_second => 5,
+    max_message_size        => 800,
+    max_messages_per_hour   => 100,
+    forum_join_grace        => 0,
+});
+
+$bot2->respond_to_self_messages(1);
+$messages_seen = 0;
+$bot2->SendPersonalMessage($personal_address, "Immediate message with zero grace");
+$bot2->Process(1);
+is($messages_seen, 1, "Message processed immediately when forum_join_grace is 0");

t/07-multiline_messages.t

@@ -2,7 +2,7 @@
 
 use strict;
 use warnings;
-use Test::More tests => 9;
+use Test::More tests => 8;
 use Net::Jabber::Bot;
 
 use FindBin;
@@ -34,13 +34,11 @@ my $bot = Net::Jabber::Bot->new({
     out_messages_per_second => 5,
     max_message_size        => 800,
     max_messages_per_hour   => 100,
+    forum_join_grace        => 0,
 });
 
 isa_ok($bot, "Net::Jabber::Bot");
 
-# Wait past the forum join grace period
-ok((sleep 12) > 10, "Waited past forum join grace period");
-
 # Test 1: Newlines are preserved in sent messages
 {
     my $multiline_msg = "Line one\nLine two\nLine three";

t/07-test_from_parameter.t

@@ -3,7 +3,7 @@
 use strict;
 use warnings;
 
-use Test::More tests => 10;
+use Test::More tests => 9;
 use Net::Jabber::Bot;
 
 # stuff for mock client object
@@ -38,10 +38,10 @@ my $bot = Net::Jabber::Bot->new(
     out_messages_per_second => 5,
     max_message_size       => 1000,
     max_messages_per_hour  => 100,
+    forum_join_grace       => 0,
 );
 
 isa_ok( $bot, "Net::Jabber::Bot" );
-ok( ( sleep 12 ) > 10, "Wait past initialization grace period" );
 
 # Track the last MessageSend args for verification
 my @last_message_send_args;

t/07-test_reconnect_and_leaks.t

@@ -31,6 +31,7 @@ my $bot = Net::Jabber::Bot->new(
     out_messages_per_second => 5,
     max_message_size       => 800,
     max_messages_per_hour  => 100,
+    forum_join_grace       => 0,
 );
 
 isa_ok( $bot, "Net::Jabber::Bot" );
@@ -57,9 +58,6 @@ ok( defined $process_result, "Process works after reconnect" );
 {
     my $personal_address = "test_user\@$server/$bot_alias";
 
-    # Wait for grace period
-    sleep 12;
-
     # Simulate sending messages "yesterday" by injecting an old day entry
     my $today_yday     = ( localtime() )[7];
     my $yesterday_yday = $today_yday > 0 ? $today_yday - 1 : 364;

t/lib/MockJabberClient.pm

@@ -39,15 +39,12 @@ sub Process {
     return if(!$self->{is_connected}); # Return undef if we're not connected.
 
     foreach my $message (@{$self->{message_queue}}) {
-        $timeout = 0; # zero out sleep timer;
         next if(!defined $self->{message_callback});
         $self->{message_callback}->($self->{SESSION}->{id}, $message);
     }
-    
-    
+
     @{$self->{message_queue}} = ();
 
-    sleep $timeout;
     return 1; # undef means we lost connection.
 }