SL/BackgroundJob/SelfTest.pm

   1 package SL::BackgroundJob::SelfTest;
   2
   3 use strict;
   4
   5 use parent qw(SL::BackgroundJob::Base);
   6
   7 use Test::Builder;
   8 use TAP::Parser;
   9 use TAP::Parser::Aggregator;
  10 use Sys::Hostname;
  11 use FindBin;
  12
  13 use SL::DB::AuthUser;
  14 use SL::DB::Default;
  15 use SL::Common;
  16
  17 use Rose::Object::MakeMethods::Generic (
  18   array => [
  19    'modules'     => {},
  20    'add_modules' => { interface => 'add', hash_key => 'modules' },
  21    'errors'      => {},
  22    'add_errors'  => { interface => 'add', hash_key => 'errors' },
  23    'full_diag'      => {},
  24    'add_full_diag'  => { interface => 'add', hash_key => 'full_diag' },
  25   ],
  26   scalar => [
  27    qw(diag tester config aggreg),
  28   ],
  29 );
  30
  31 sub create_job {
  32   $_[0]->create_standard_job('20 2 * * *'); # every day at 2:20 am
  33 }
  34
  35 sub setup {
  36   my ($self) = @_;
  37
  38   $self->config($::lx_office_conf{self_test} || {});
  39
  40   $self->tester(Test::Builder->new);
  41   $self->tester->reset; # stupid Test::Builder mplementation uses class variables
  42   $self->aggreg(TAP::Parser::Aggregator->new);
  43
  44   $self->modules(split /\s+/, $self->config->{modules});
  45 }
  46
  47 sub run {
  48   my $self        = shift;
  49   $self->setup;
  50
  51   return 1 unless $self->modules;
  52
  53   foreach my $module ($self->modules) {
  54     $self->run_module($module);
  55   }
  56
  57   $self->log(
  58     sprintf "SelfTest status: %s, passed: %s, failed: %s, unexpectedly succeeded: %s",
  59              $self->aggreg->get_status,
  60              $self->aggreg->passed,
  61              $self->aggreg->failed,
  62              $self->aggreg->todo_passed,
  63   );
  64
  65   if (!$self->aggreg->all_passed || $self->config->{send_email_on_success}) {
  66     $self->_send_email;
  67   }
  68
  69   return 1;
  70 }
  71
  72 sub run_module {
  73   my ($self, $module) = @_;
  74
  75   # TAP usually prints out to STDOUT and STDERR, capture those for TAP::Parser
  76   my $output;
  77
  78   $self->tester->output        (\$output);
  79   $self->tester->failure_output(\$output);
  80   $self->tester->todo_output   (\$output);
  81
  82   # sanitize module name;
  83   # this allows unicode package names, which are known to be buggy in 5.10, you should avoid them
  84   $module =~ s/[^\w:]//g;
  85   $module = "SL::BackgroundJob::SelfTest::$module";
  86
  87   # try to load module;
  88   (my $file = $module) =~ s|::|/|g;
  89   eval {
  90     require $file . '.pm';
  91     1
  92   } or $self->add_errors($::locale->text('Could not load class #1 (#2): "#3"', $module, $file, $@)) && return;
  93
  94   eval {
  95     my $worker = $module->new;
  96     $worker->tester($self->tester);
  97
  98     $worker->run;
  99     1;
 100   } or $self->add_errors($::locale->text('Could not load class #1, #2', $module, $@)) && return;
 101
 102   $self->add_full_diag($output);
 103   $self->{diag_per_module}{$module} = $output;
 104
 105   my $parser = TAP::Parser->new({ tap => $output});
 106   $parser->run;
 107
 108   $self->aggreg->add($module => $parser);
 109 }
 110
 111 sub _email_user {
 112   $_[0]{email_user} ||= SL::DB::Manager::AuthUser->find_by(login => $_[0]->config->{send_email_to});
 113 }
 114
 115 sub _send_email {
 116   my ($self) = @_;
 117
 118   return if !$self->config || !$self->config->{send_email_to};
 119
 120   my $user  = $self->_email_user;
 121   my $email = $user ? $user->get_config_value('email') : undef;
 122
 123   return unless $email;
 124
 125   my ($output, $content_type) = $self->_prepare_report;
 126
 127   my $mail              = Mailer->new;
 128   $mail->{from}         = $self->config->{email_from};
 129   $mail->{to}           = $email;
 130   $mail->{subject}      = $self->config->{email_subject};
 131   $mail->{content_type} = $content_type;
 132   $mail->{message}      = $$output;
 133
 134   $mail->send;
 135 }
 136
 137 sub _prepare_report {
 138   my ($self) = @_;
 139
 140   my $user = $self->_email_user;
 141   my $template = Template->new({ 'INTERPOLATE' => 0,
 142                                  'EVAL_PERL'   => 0,
 143                                  'ABSOLUTE'    => 1,
 144                                  'CACHE_SIZE'  => 0,
 145                                });
 146
 147   return unless $template;
 148   my $email_template = $self->config->{email_template};
 149   my $filename       = $email_template || ( (SL::DB::Default->get->templates || "templates/mails") . "/self_test/status_mail.txt" );
 150   my $content_type   = $filename =~ m/.html$/ ? 'text/html' : 'text/plain';
 151
 152
 153   my %params = (
 154     SELF     => $self,
 155     host     => hostname,
 156     database => $::myconfig{dbname},
 157     path     => $FindBin::Bin,
 158   );
 159
 160   my $output;
 161   $template->process($filename, \%params, \$output) || die $template->error;
 162
 163   return (\$output, $content_type);
 164 }
 165
 166 sub log {
 167   my $self = shift;
 168   $::lxdebug->message(0, "[" . __PACKAGE__ . "] @_") if $self->config->{log_to_file};
 169 }
 170
 171
 172 1;
 173
 174 __END__
 175
 176 =head1 NAME
 177
 178 SL::BackgroundJob::SelfTest - pluggable self testing
 179
 180 =head1 SYNOPSIS
 181
 182   use SL::BackgroundJob::SelfTest;
 183   SL::BackgroundJob::SelfTest->new->run;;
 184
 185 =head1 DESCRIPTION
 186
 187
 188
 189 =head1 FUNCTIONS
 190
 191 =head1 BUGS
 192
 193 =head1 AUTHOR
 194
 195 =cut