File Coverage

lib/Test/MonitorSites.pm

Criterion	Covered	Total	%
statement	19	21	90.4
branch			n/a
condition			n/a
subroutine	7	7	100.0
pod			n/a
total	26	28	92.8

package Test::MonitorSites;

use warnings;
use strict;
use Carp;
use Cwd;
use Config::Simple;
use WWW::Mechanize;
use Test::WWW::Mechanize;
use Test::HTML::Tidy;
use HTTP::Request::Common;
use Test::More;
use Data::Dumper;
use Test::Builder;
use Mail::Mailer;
# use Mail::Mailer qw(mail);

use vars qw($VERSION);
$VERSION = '0.15';

1; # Magic true value required at end of module

sub new {
  my $class = shift;
  my $args = shift;
  my $self = {};
  my ($cfg,%sites,@sites,$site);

  if (defined($args->{'config_file'})){
    my $config_file = $args->{'config_file'};
    if(-s $config_file){
      $cfg = new Config::Simple($config_file);
      if(!defined($cfg->{'_DATA'})){
        $self->{'config_file'} = undef;
        $self->{'error'} .= 'No configuration data is available.';
      } else {
        foreach my $key (keys %{$cfg->{'_DATA'}}){
          if($key =~ m/^site_/){
            $site = $key;
            $site =~ s/^site_//;
            push @sites, $site;
          }
        }
        # print STDERR @sites, "\n";
        $self->{'sites'} = \@sites;
        foreach my $s (@sites){
          # if($s =~ m/not ok/) { print "Found Error; \$s is $s\n"; exit; }
          if(!defined($cfg->{'_DATA'}{"site_$s"}{'ip'})){
            $cfg->{'_DATA'}{"site_$s"}{'ip'} = [ '0.0.0.0' ];
          }
        }
        my $cwd = getcwd();
        # {
          # no strict 'refs';
          # $cwd = `pwd`;
        # }
        # print STDERR "The current working directory is: $cwd.\n";
        if(defined($cfg->param('global.result_log'))){
          if($cfg->param('global.result_log') !~ m/^\//){
            $self->{'result_log'} = $cwd . '/' . $cfg->param('global.result_log');
          } else {
            $self->{'result_log'} = $cfg->param('global.result_log');
          }
        } else {
          $self->{'result_log'} = "$cwd/Test_MonitorSites_result.log";
        }
        if(!defined($cfg->param('global.MonitorSites_email'))){
          $self->{'error'} .= "Configuration fails to define global.MonitorSites_email for From: line.\n";
          $cfg->param('global.MonitorSites_email','[e-mail]');
        } else {
          1;
        }
        foreach my $i ('ips', 'critical_errors', 'servers_with_failures', 'tests', 'sites') {
          $self->{'result'}->{$i} = 0;
        }
        if(!defined($cfg->param('global.report_success'))
            || $cfg->param('global.report_success') != 1){
          $cfg->param('global.report_success',0);
        }
        if(!defined($cfg->param('global.MonitorSites_subject'))) {
          $cfg->param('global.MonitorSites_subject','Critical Failures');
        }
        if(!defined($cfg->param('global.MonitorSites_all_ok_subject'))) {
          $cfg->param('global.MonitorSites_all_ok_subject','Servers All OK');
        }
      }
    } else {
      $self->{'config_file'} = undef;
      $self->{'error'} .= 'The config_file was not found, or was empty.';
    }
  } else {
    $self->{'config_file'} = undef;
    $self->{'error'} .= 'The config_file was not set in the constructor.';
  }
  $self->{'config'} = $cfg;
  my $agent = WWW::Mechanize->new();
  my $mech = Test::WWW::Mechanize->new();
  $self->{'agent'} = $agent;
  $self->{'mech'} = $mech;

  bless $self, $class;
  return $self;
}

sub test_sites {
  my $self = shift;
  my $sites = shift;
  my(%sites);
  if(defined($sites)){
    %sites = %{$sites};
  } elsif(defined($self->{'config'}->{'_DATA'})) {
    %sites = %{$self->{'config'}->{'_DATA'}};
    foreach my $key (keys %sites){
      if($key !~ m/^site_/){
        delete $sites{$key};
      }
    }
  } else {
    $self->{'error'} .= 'No sites have been identified for testing.  Please add sites to: ' . $self->{'config_file'};
  }

  my ($key, $url, $expected_content,$expected,$ip);
  my(@url,@expected,@sites,@test_links,@test_valid_html);
  my $agent = $self->{'agent'};
  my $mech = $self->{'mech'};
  # print STDERR Dumper(\%sites);
  my $log_file = $self->{'result_log'};
  my $log_file_ok = $log_file . '_ok';
  my $log_file_diag = $log_file . '_diag';
  my $log_file_todo = $log_file . '_todo';

  my $Test = Test::Builder->new;
  my @handle_names = qw/ output failure_output todo_output /;
  my %old;
  $old{$_} = $Test->$_ for @handle_names;
  $Test->$_(\*STDOUT) for @handle_names;

  {
    $Test->output($log_file_ok);
    $Test->failure_output($log_file_diag);
    $Test->todo_output($log_file_todo);

    # print STDERR Dumper(\%sites);
    foreach my $site (keys %sites){
      if($site !~ m/^site_/){ next; }
      # diag("The site is $site");
      $site =~ s/^site_//;
      # if($site =~ m/not ok/) { print "Found Error; \$site is $site\n"; exit; }
      # diag("The site is $site");
      push @sites, $site;
      $self->{'result'}->{'sites'}++;
      $ip = @{$self->{'config'}->{'_DATA'}->{"site_$site"}->{'ip'}}[0];
      if (defined($ip) && !defined($self->{'result'}->{'ips_tested'}->{$ip})){
        $self->{'result'}->{'ips_tested'}->{$ip} = 1;
        $self->{'result'}->{'ips'}++;
      }
      # diag("The site is $site");
      # diag("The hash key is site_$site");
      $url = $self->{'config'}->{'_DATA'}->{"site_$site"}->{'url'};
      $expected = $self->{'config'}->{'_DATA'}->{"site_$site"}->{'expected_content'};
      # diag("The url is $url.");
      @url = @{$url};
      @expected = @{$expected};
      # $self->_test_tests();
      $self->_test_site($agent,$url[0],$expected[0]);
      $self->{'result'}->{'tests'} = $self->{'result'}->{'tests'} + 2;
      if(defined($sites{"site_$site"}{'test_links'})){
        @test_links = @{$sites{"site_$site"}{'test_links'}};
        if ($test_links[0] == 1) {
          $self->_test_links($mech,$url[0]);
          $self->{'result'}->{'tests'} = $self->{'result'}->{'tests'} + 1;
        } else {
          diag("Skipping tests of links at: $site.");
        }
      }
      if(defined($sites{"site_$site"}{'test_valid_html'})){
        @test_valid_html = @{$sites{"site_$site"}{'test_valid_html'}};
        if ($test_valid_html[0] == 1) {
          $self->_test_valid_html($mech,$url[0]);
          $self->{'result'}->{'tests'} = $self->{'result'}->{'tests'} + 1;
        } else {
          diag("Skipping tests of html validity at: $site.");
        }
      }

    }
  }
  $Test->todo_output(*STDOUT);
  $Test->failure_output(*STDERR);
  $Test->output(*STDOUT);

  my $critical_failures = $self->_analyze_test_logs();
  # print STDERR "Count of critical failures: $critical_failures->{'count'}\n";
  # print "global.report_success is " . $self->{'config'}->param('global.report_success');
  if($critical_failures->{'count'} != 0){
    # print STDERR "Next we send an sms message.\n";
    $self->sms($critical_failures);
  } elsif ($self->{'config'}->param('global.report_success') == 1) {
    $self->sms($critical_failures);
  } else {
    $self->{'error'} .= "We won't send an sms, there were no critical_failures and global.report_success is not set true.\n";
  }

  if(defined($self->{'config'}->param('global.results_recipients'))){
    if($self->{'config'}->param('global.send_summary')
        || $self->{'config'}->param('global.send_diagnostics')){
      # print STDERR "Next we send some email.\n";
      $self->email($critical_failures);
    } else {
      $self->{'error'} .= "We won't send an email, neither send_summary nor send_diagnostics were set to true in the configuration file.\n";
    }
  } else {
    $self->{'error'} .= "We won't send an email, there was no results_recipient defined in the configuration file.\n";
  }

  my %result = (
           'ips'     => $self->{'result'}->{'ips'},
           'sites'   => $self->{'sites'},
           'planned' => '',
           'run'     => $self->{'result'}->{'tests'},
           'passed'  => '',
           'failed'  => $critical_failures->{'count'},
 'critical_failures' => $critical_failures,
       );

  # print Dumper($critical_failures);
  return \%result;
}

sub _analyze_test_logs {
  my $self = shift;
  my $critical_failures = 0;
  my %critical_failures;
  $critical_failures{'count'} = 0;
  foreach my $test ('linked_to','expected_content','all_links','valid'){
    # print STDERR "This \$test is $test.\n";
    if($self->{'config'}->param("critical_failure.$test") == 1){
      $critical_failures{"$test"} = 1;
    }
  }
  my ($url,$test,$test_string,$ip,$param_name,@ip);
  open('SUMMARY','<',$self->{'config'}->param('global.result_log') . '_ok');
  while(){
    if(m/^not ok/){
      $url = $_;
      chomp($url);
      $url =~ s/^.*https?:\/\///;
      $url =~ s/\/.*$//;
      $url =~ s/\.$//;
      if($url =~ m/not ok/) { print "Found parsing error; \$url is $url\n"; exit; }
      $param_name = 'site_' . $url;
      if(defined(@{$self->{'config'}->{'_DATA'}->{"$param_name"}->{'ip'}}[0])){
        @ip = @{$self->{'config'}->{'_DATA'}->{"$param_name"}->{'ip'}};
        # @ip = @{$ip} if(ref($ip));
      } else {
        $self->{'error'} .= "IP address not defined for $url.\n";
        print 'ip array is: ' . Dumper(\$self->{'config'}->{'_DATA'}->{"$param_name"}->{'ip'});
        print 'ip: ' . @{$self->{'config'}->{'_DATA'}->{"$param_name"}->{'ip'}}[0] . "\n";
        # print Dumper(\$self->{'config'}->{'_DATA'});
        # print Dumper(\$self->{'config'}->{'_DATA'}->{"$param_name"});
        # print Dumper(\$self->{'error'});
        print "Site key is: $param_name.\n";
        print "Now exiting.\n";
        exit;
      }
      if(!defined($critical_failures{'failed_tests'}{'ip'}{"$ip[0]"}{'count'})){
        $critical_failures{'failed_tests'}{'ip'}{"$ip[0]"}{'count'} = 0;
      }
      foreach my $test (keys %critical_failures){
        if($test eq 'failed_tests'){ next; }
        $test_string = $test;
        $test_string =~ s/_/ /g;
        if($_ =~ m/$test_string/){
          $critical_failures++;
          $critical_failures{'failed_tests'}{'ip'}{"$ip[0]"}{'count'}++ if(defined($ip[0]));
          $critical_failures{'failed_tests'}{'ip'}{"$ip[0]"}{"$url"} = $_ if(defined($ip[0]));
          $critical_failures{'failed_tests'}{'url'}{"$url"}{"$test"} = $_;
          $critical_failures{'failed_tests'}{'test'}{"$test"}{"$url"} = $_;
        }
      }
    }
  }
  close('SUMMARY');
  $critical_failures{'count'} = $critical_failures;
  if($critical_failures{'count'} == 0){
    # print STDERR "The count of critical failures is 0.\n";
  }

  return \%critical_failures;
}

sub _return_result_log {
  my $self = shift;
  return $self->{'result_log'};
}

sub email {
  my $self = shift;
  my $critical_failures = shift;
  my ($type,@args,$body);

  my %headers = (
         'To'      => $self->{'config'}->param('global.results_recipients'),
         'From'    => $self->{'config'}->param('global.MonitorSites_email'),
         'Subject' => 'MonitorSites log',
       );

  $body = "
    This summary brought to you by
    Test::MonitorSites version $VERSION
    ===================================\n";

    $body .= '    Tests: ' . $self->{'result'}->{'tests'};
    $body .= ', IPs: ' . $self->{'result'}->{'ips'};
    $body .= ', Sites: ' . $self->{'result'}->{'sites'};
    $body .= ', CFs: ' . $critical_failures->{'count'};
    # $body .= ', CFs: ' . $self->{'result'}->{'critical_failures'}->{'count'};
    $body .= "\n    ===================================\n\n";

    # $self->{'result'}->{'message'} = $body;
  # print Dumper(\$self->{'result'});

  my $file = $self->{'config'}->param('global.result_log');
  if($self->{'config'}->param('global.send_summary') == 1){
    open('RESULT','<',$file . '_ok');
    while(){
      $body .= $_;
    }
    close('RESULT');
  } else {
    $self->{'error'} .= "Configuration file disabled email dispatch of results log.\n";
  }

  if(defined($self->{'config'}->param('global.send_diagnostics'))
      && $self->{'config'}->param('global.send_diagnostics') == 1){
    $body .= <<'End_of_Separator';

     ==============================================
     End of Summary, Beginning of Diagnostics
     ==============================================

End_of_Separator

    open('RESULT','<',$file . '_diag');
    while(){
      $body .= $_;
    }
    close('RESULT');
  } else {
    $self->{'error'} .= "Configuration file disabled email dispatch of diagnostic log.\n";
  }

  # is(1,1,'About to send email now.');
  $type = 'sendmail';
  my $mailer = new Mail::Mailer $type, @args;
  $mailer->open(\%headers);
    print $mailer $body;
  $mailer->close;
  return 1;
}

sub sms {
  my $self = shift;
  my $critical_failures = shift;
  my %critical_failures = %{$critical_failures};
  my %headers = (
         'To'      => $self->{'config'}->param('global.sms_recipients'),
         'From'    => $self->{'config'}->param('global.MonitorSites_email'),
         'Subject' => $self->{'config'}->param('global.MonitorSites_subject'),
       );

  ### diag('report_by_ip is: ' . $self->{'config'}->param("global.report_by_ip"));
  my ($mailer,$type,@args,$body,$test,$url,$ip);
  my($failing_domains,$failing_domains_at_ip);
  if($critical_failures->{'count'} == 0){
    $headers{'Subject'} = $self->{'config'}->param('global.MonitorSites_all_ok_subject');

    $body = '';
    $body .= 'Tests: ' . $self->{'result'}->{'tests'};
    $body .= ', IPs: ' . $self->{'result'}->{'ips'};
    $body .= ', Sites: ' . $self->{'result'}->{'sites'};
    $body .= ', CFs: ' . $self->{'result'}->{'critical_errors'};
    $body .= '; No critical errors found.';
    $self->{'result'}->{'message'} = $body;

    $mailer = new Mail::Mailer $type, @args;
    $mailer->open(\%headers);
      print $mailer $body;
    $mailer->close;
    $self->_log_sms($body);

  } elsif(defined($self->{'config'}->param("global.report_by_ip"))
      && $self->{'config'}->param("global.report_by_ip") == 1) {
      foreach my $ip (keys %{$critical_failures{'failed_tests'}{'ip'}}){
        if($critical_failures{'failed_tests'}{'ip'}{$ip}{'count'} != 0
            || $self->{'config'}->param('global.report_success') == 1) {
          $failing_domains = 0;
          $failing_domains_at_ip = "";
          foreach my $url (keys %{$critical_failures{'failed_tests'}{'ip'}{"$ip"}}){
            if($url eq 'count'){ next; }
            $failing_domains++;
            $failing_domains_at_ip .= "NOK: $url, ";
          }
          $body = "$critical_failures{'failed_tests'}{'ip'}{$ip}{'count'}";
          $body .= " critical errors at $ip; incl $failing_domains domains: ";
          $body .= $failing_domains_at_ip;
          # is(1,1,'About to send sms now about $url.');
          $mailer = new Mail::Mailer $type, @args;
          $mailer->open(\%headers);
            print $mailer $body;
          $mailer->close;
          $self->_log_sms($body);
        }
      }
  } else {
    my $i = 0;
    foreach my $url (keys %{$critical_failures{'failed_tests'}{'url'}}){
      $i++;
      $body = "Failure: $i of $critical_failures{'count'}: $url: ";
      foreach my $test (keys %{$critical_failures{'failed_tests'}{'url'}{"$url"}}){
        $body .= "Not OK: $test, ";
      }
      # is(1,1,'About to send sms now about $url.');
      $mailer = new Mail::Mailer $type, @args;
      $mailer->open(\%headers);
        print $mailer $body;
      $mailer->close;
      $self->_log_sms($body);
    }
  }

  return 1;
}

sub _log_sms {
  my $self = shift;
  my $body = shift;

  my $header = "To: " . $self->{'config'}->param('global.sms_recipients') . "\n";
  $header .= "From: " . $self->{'config'}->param('global.MonitorSites_email') . "\n";
  $header .= "Subject:Critical Failures\n";
  my $log_msg = $header . $body;

  my @sms_log;
  if(defined($self->{'sms_log'})){
    @sms_log = @{$self->{'sms_log'}};
  } else {
    @sms_log = ();
  }

  push @sms_log, $log_msg;
  $self->{'sms_log'} = \@sms_log;
  my $count = @sms_log;

  return $count;
}

sub _test_tests {
  is(12,12,'Twelve is twelve.');
  is(12,13,'Twelve is thirteen.');
  diag("Diagnostic output from subroutine called while redirecting output.");
  return;
}

sub _test_links {
  my ($self,$mech,$url) = @_;
  $mech->get_ok($url, " . . . linked to $url");
  $mech->page_links_ok( " . . . successfully checked all links for $url" );
  return;
}

sub _test_valid_html {
  my ($self,$mech,$url) = @_;
  $mech->get_ok($url, " . . . linked to $url");
  html_tidy_ok( $mech->content(), " . . . html content is valid for $url" );
  return;
}

sub _test_site {
  my($self,$agent,$url,$expected_content) = @_;
  $agent->get("$url");
  is ($agent->success,1,"Successfully linked to $url.");
  like($agent->content,qr/$expected_content/," . . . and found expected content at $url");
  return $agent->success();
}

__END__