Use Template::Toolkit to generate email messages

[?]

May 9, 2013, 12:23 PM

LDICTHWYJ2SP6IU3PK2K2PW5FN54HP7W4KTL324YYTTNPVJ4HSLQC

Dependencies

[2] QDJRQIFF If multiple dependent builds fail, send a single email
[3] 5EQYVRWE Add a plugin mechanism
[4] BLVQGJ4L Use OO-style plugins

Change contents

edit in src/lib/Hydra/Plugin/EmailNotification.pm at line 12

[3.273]→[3.273:290](∅→∅)

use Text::Table;
edit in src/lib/Hydra/Plugin/EmailNotification.pm at line 13

[3.307]

[3.307]

use Template;
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 18

[3.333]→[3.333:385](∅→∅)

sub statusDescription {
my ($buildstatus) = @_;

[3.333]

[3.385]

sub showStatus {
my ($build) = @_;
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 22

[3.413]→[3.413:440](∅→∅)

given ($buildstatus) {

[3.413]

[3.440]

given ($build->buildstatus) {
edit in src/lib/Hydra/Plugin/EmailNotification.pm at line 30

[3.669]

[2.35]

}

sub showJobName {
my ($build) = @_;
return $build->project->name . ":" . $build->jobset->name . ":" . $build->job->name;
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 43

[2.183]→[2.183:415](∅→∅)

, jobset => $build->jobset->name
, job => $build->job->name
, system => $build->system
, finished => 1
, id => { '<', $build->id }
, -not => { buildstatus => { -in => [4, 3]} }

[2.183]

[2.415]

, jobset => $build->jobset->name
, job => $build->job->name
, system => $build->system
, finished => 1
, id => { '<', $build->id }
, -not => { buildstatus => { -in => [4, 3]} }
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 54

[2.488]→[2.488:617](∅→∅),[2.617]→[3.669:671](∅→∅),[3.669]→[3.669:671](∅→∅)

sub showJobName {
my ($build) = @_;
return $build->project->name . ":" . $build->jobset->name . ":" . $build->job->name;
}

[2.488]

[3.671]

my $template = <<EOF;
Hi,

The status of Hydra job [% showJobName(build) %] (on [% build.system %]) [% IF prevBuild && build.buildstatus != prevBuild.buildstatus %]has changed from "[% showStatus(prevBuild) %]" to "[% showStatus(build) %]"[% ELSE %]is "[% showStatus(build) %]"[% END %]. For details, see

[% baseurl %]/build/[% build.id %]

[% IF dependents.size > 0 -%]
The following dependent jobs also failed:

[% FOREACH b IN dependents -%]
* [% showJobName(b) %] ([% baseurl %]/build/[% b.id %])
[% END -%]

[% END -%]
[% IF build.buildstatus == 0 -%]
Yay!
[% ELSE -%]
Go forth and fix [% IF dependents.size == 0 -%]it[% ELSE %]them[% END %].
[% END -%]

Regards,

The Hydra build daemon.
EOF
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 121

[3.1967]→[2.1968:2010](∅→∅)

my $jobName = showJobName $build;

[3.1967]

[3.2063]

my $tt = Template->new({});
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 123

[3.2064]→[2.2011:2072](∅→∅)

my $status = statusDescription($build->buildstatus);

[3.2064]

[3.2121]

my $vars =
{ build => $build, prevBuild => getPrevBuild($self, $build)
, dependents => [grep { $_->id != $build->id } @builds]
, baseurl => $self->{config}->{'base_uri'} || "http://localhost:3000"
, showJobName => \&showJobName, showStatus => \&showStatus
};
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 130

[3.2122]→[2.2073:2234](∅→∅)

my $baseurl = hostname_long;
my $sender = $self->{config}->{'notification_sender'} ||
(($ENV{'USER'} || "hydra") . "@" . $baseurl);

[3.2122]

[3.2263]

my $body;
$tt->process(\$template, $vars, \$body)
or die "failed to generate email from template";
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 134

[3.2264]→[2.2235:2315](∅→∅)

my $selfURI = $self->{config}->{'base_uri'} || "http://localhost:3000";

[3.2264]

[3.2332]

# stripping trailing spaces from lines
$body =~ s/[\ ]+$//gm;
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 137

[3.2333]→[2.2316:2408](∅→∅)

sub showTime { my ($x) = @_; return strftime('%Y-%m-%d %H:%M:%S', localtime($x)); }

[3.2333]

[3.2421]

print "$body\n";
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 139

[3.2422]→[2.2409:3293](∅→∅)

my $infoTable = Text::Table->new({ align => "left" }, \ " | ", { align => "left" });
my @lines = (
[ "Build ID:", $build->id ],
[ "Nix name:", $build->nixname ],
[ "Short description:", $build->description || '(not given)' ],
[ "Maintainer(s):", $build->maintainers ],
[ "System:", $build->system ],
[ "Derivation store path:", $build->drvpath ],
[ "Output store path:", join(", ", map { $_->path } $build->buildoutputs) ],
[ "Time added:", showTime $build->timestamp ],
);
push @lines, (
[ "Build started:", showTime $build->starttime ],
[ "Build finished:", showTime $build->stoptime ],
[ "Duration:", $build->stoptime - $build->starttime . "s" ],
) if $build->starttime;
$infoTable->load(@lines);

[3.2422]

[3.3238]

my $sender = $self->{config}->{'notification_sender'} ||
(($ENV{'USER'} || "hydra") . "@" . hostname_long);
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 142

[3.3239]→[2.3294:4032](∅→∅)

my $inputsTable = Text::Table->new(
{ title => "Name", align => "left" }, \ " | ",
{ title => "Type", align => "left" }, \ " | ",
{ title => "Value", align => "left" });
@lines = ();
foreach my $input ($build->inputs) {
my $type = $input->type;
push @lines,
[ $input->name
, $input->type
, ( $input->type eq "build" || $input->type eq "sysbuild")
? $input->dependency->id
: ($input->type eq "string" || $input->type eq "boolean")
? $input->value : ($input->uri . ':' . $input->revision)
];
}
$inputsTable->load(@lines);

[3.3239]

[3.3909]

#my $loglines = 50;
#my $logtext = logContents($build->drvpath, $loglines);
#$logtext = removeAsciiEscapes($logtext);
edit in src/lib/Hydra/Plugin/EmailNotification.pm at line 146

[3.3910]→[2.4033:4172](∅→∅),[2.4172]→[3.4037:4038](∅→∅),[3.4037]→[3.4037:4038](∅→∅),[3.4038]→[2.4173:4226](∅→∅),[2.4226]→[3.4986:4987](∅→∅),[3.4986]→[3.4986:4987](∅→∅),[3.4987]→[2.4227:4419](∅→∅),[2.4419]→[3.5057:5058](∅→∅),[3.5057]→[3.5057:5058](∅→∅),[3.5058]→[2.4420:5551](∅→∅)

my $loglines = 50;
my $logtext = logContents($build->drvpath, $loglines);
$logtext = removeAsciiEscapes($logtext);

my $prevBuild = getPrevBuild($self, $build);

my $foo = "\nIn addition, the following jobs failed:\n";
foreach my $b (@builds) {
$foo .= " " . showJobName($b) . " ($selfURI/build/" . $b->id . ")\n";
}

my $body = "Hi,\n"
. "\n"
. "This is to let you know that Hydra build " . $build->id
. " of job " . $jobName . " " . (defined $prevBuild ? "has changed from '" . statusDescription($prevBuild->buildstatus) . "' to '$status'" : "is '$status'" ) .".\n"
. $foo
. "\n"
. "Complete build information can be found on this page: "
. "$selfURI/build/" . $build->id . "\n"
. ($build->buildstatus != 0 ? "\nThe last $loglines lines of the build log are shown at the bottom of this email.\n" : "")
. "\n"
. "A summary of the build information follows:\n"
. "\n"
. $infoTable->body
. "\n"
. "The build inputs were:\n"
. "\n"
. $inputsTable->title
. $inputsTable->rule('-', '+')
. $inputsTable->body
. "\n"
. "Regards,\n\nThe Hydra build daemon.\n"
. ($build->buildstatus != 0 ? "\n---\n$logtext" : "");

# stripping trailing spaces from lines
$body =~ s/[\ ]+$//gm;
replacement in src/lib/Hydra/Plugin/EmailNotification.pm at line 150

[2.5709]→[2.5709:5862](∅→∅)

Subject => "$status: Hydra job $jobName on " . $build->system . ", build " . $build->id,
'X-Hydra-Instance' => $baseurl,

[2.5709]

[2.5862]

Subject => showStatus($build) . ": Hydra job " . showJobName($build) . " on " . $build->system,
'X-Hydra-Instance' => $vars->{baseurl},