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