grahamc/hydra - Change 5EQYVRWECBDJORGI5DRIOUEJXSXMRCQNT2562BM4Z4U52LT7JUHAC

Add a plugin mechanism

You can now add plugins to Hydra by writing a module called Hydra::Plugin::<whatever> and putting it in Perl's search path. The only plugin operation currently supported in buildFinished, called when hydra-build has finished doing a build.

For instance, a Twitter notification plugin would look like this:

package Hydra::Plugin::TwitterNotification;

sub buildFinished { my ($self, $db, $config, $build, $dependents) = @_; print STDERR "tweeting about build ", $build->id, "\n"; # send tweet… }

Created by Eelco Dolstra on May 8, 2013

5EQYVRWECBDJORGI5DRIOUEJXSXMRCQNT2562BM4Z4U52LT7JUHAC

Dependencies

In channels

main

upstream

Change contents

File addition: Plugin (d--x------)
[6.53]

File addition: EmailNotification.pm (----------)

[0.1]

package Hydra::Plugin::EmailNotification;
use strict;
use feature qw/switch/;
use POSIX qw(strftime);
use Email::Sender::Simple qw(sendmail);
use Email::Sender::Transport::SMTP;
use Email::Simple;
use Email::Simple::Creator;
use Sys::Hostname::Long;
use Text::Table;
use File::Slurp;
use Hydra::Helper::Nix;
sub statusDescription {
    my ($buildstatus) = @_;
    my $status = "Failed";
    given ($buildstatus) {
        when (0) { $status = "Success"; }
        when (1) { $status = "Failed with non-zero exit code"; }
        when (2) { $status = "Dependency failed"; }
        when (4) { $status = "Cancelled"; }
    }
   return $status;
}
sub buildFinished {
    my ($self, $db, $config, $build, $dependents) = @_;
    die unless $build->finished;
    my $prevBuild;
    ($prevBuild) = $db->resultset('Builds')->search(
        { project => $build->project->name
        , jobset => $build->jobset->name
        , job => $build->job->name
        , system => $build->system
        , finished => 1
        , id => { '<', $build->id }
        , -not => { buildstatus => { -in => [4, 3]} }
        }, { order_by => ["id DESC"] }
        );
    # Do we want to send mail?
    unless ($ENV{'HYDRA_FORCE_SEND_MAIL'}) {
        return unless $build->jobset->enableemail && ($build->maintainers ne "" || $build->jobset->emailoverride ne "");
        # If build is cancelled or aborted, do not send email.
        return if $build->buildstatus == 4 || $build->buildstatus == 3;
        # If there is a previous (that is not cancelled or aborted) build
        # with same buildstatus, do not send email.
        return if defined $prevBuild && ($build->buildstatus == $prevBuild->buildstatus);
    }
    # Send mail.
    # !!! should use the Template Toolkit here.
    my $to = (!$build->jobset->emailoverride eq "") ? $build->jobset->emailoverride : $build->maintainers;
    print STDERR "sending mail notification to ", $to, "\n";
    my $jobName = $build->project->name . ":" . $build->jobset->name . ":" . $build->job->name;
    my $status = statusDescription($build->buildstatus);
    my $baseurl = hostname_long;
    my $sender = $config->{'notification_sender'} ||
        (($ENV{'USER'} || "hydra") .  "@" . $baseurl);
    my $selfURI = $config->{'base_uri'} || "http://localhost:3000";
    sub showTime { my ($x) = @_; return strftime('%Y-%m-%d %H:%M:%S', localtime($x)); }
    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);
    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);
    my $loglines = 50;
    my $logtext = logContents($build->drvpath, $loglines);
    $logtext = removeAsciiEscapes($logtext);
    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"
        . "\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;
    my $email = Email::Simple->create(
        header => [
            To      => $to,
            From    => "Hydra Build Daemon <$sender>",
            Subject => "$status: Hydra job $jobName on " . $build->system . ", build " . $build->id,
            'X-Hydra-Instance' => $baseurl,
            'X-Hydra-Project'  => $build->project->name,
            'X-Hydra-Jobset'   => $build->jobset->name,
            'X-Hydra-Job'      => $build->job->name,
            'X-Hydra-System'   => $build->system
        ],
        body => "",
    );
    $email->body_set($body);
    if (defined $ENV{'HYDRA_MAIL_SINK'}) {
        # For testing, redirect all mail to a file.
        write_file($ENV{'HYDRA_MAIL_SINK'}, { append => 1 }, $email->as_string . "\n");
    } else {
        sendmail($email);
    }
}
1;

File addition: Plugin.pm (----------)

[6.53]

package Hydra::Plugin;
use Module::Pluggable
    search_path => "Hydra::Plugin",
    require     => 1;
# $plugin->buildFinished($db, $config, $build, $dependents):
#
# Called when build $build has finished.  If the build failed, then
# $dependents is an array ref to a list of builds that have also
# failed as a result (i.e. because they depend on $build or a failed
# dependeny of $build).
1;

Insertion in src/script/hydra-build at line 8 [9.2912]
[7.16]
[8.54]
```
use Hydra::Plugin;
```

Deletion in src/script/hydra-build at line 13 [9.2912]

∅:D[10.30] → [11.276:399]

B:BD[12.1070] → [11.276:399]

B:BD[11.399] → [13.0:25]

B:BD[13.25] → [14.0:21]

B:BD[14.21] → [15.28:69]

B:BD[16.55] → [17.2328:2353]

B:BD[17.2353] → [3.0:24]

use Email::Sender::Simple qw(sendmail);
use Email::Sender::Transport::SMTP;
use Email::Simple;
use Email::Simple::Creator;
use Sys::Hostname::Long;
use Config::General;
use Text::Table;
use POSIX qw(strftime);
use Data::Dump qw(dump);
use feature qw/switch/;

Deletion in src/script/hydra-build at line 19 [9.2912]

∅:D[16.749] → [11.401:402]

B:BD[11.401] → [11.401:402]

B:BD[16.935] → [18.885:886]

∅:D[19.15667] → [20.13:66]

B:BD[16.1033] → [20.13:66]

B:BD[20.66] → [21.0:27]

B:BD[21.27] → [3.25:255]

∅:D[3.255] → [20.330:336]

B:BD[20.330] → [20.330:336]

B:BD[20.336] → [18.887:888]

∅:D[18.888] → [20.341:362]

B:BD[20.341] → [20.341:362]

B:BD[20.362] → [19.15668:15669]

∅:D[19.15669] → [20.362:363]

B:BD[20.362] → [20.362:363]

∅:D[20.363] → [11.402:452]

∅:D[16.1033] → [11.402:452]

B:BD[11.402] → [11.402:452]

B:BD[11.452] → [13.26:27]

B:BD[13.27] → [22.9719:9752]

B:BD[22.9752] → [18.889:890]

B:BD[18.890] → [5.0:117]

∅:D[23.69] → [13.115:147]

∅:D[5.117] → [13.115:147]

∅:D[10.152] → [13.115:147]

∅:D[24.1382] → [13.115:147]

∅:D[25.3790] → [13.115:147]

B:BD[13.115] → [13.115:147]

∅:D[13.147] → [11.452:453]

B:BD[11.452] → [11.452:453]

B:BD[11.453] → [25.3791:3863]

B:BD[25.3863] → [26.309:352]

∅:D[26.352] → [25.3899:3975]

B:BD[25.3899] → [25.3899:3975]

B:BD[25.3975] → [18.891:926]

∅:D[18.926] → [25.4011:4035]

B:BD[25.4011] → [25.4011:4035]

B:BD[25.4035] → [27.0:36]

B:BD[27.36] → [28.0:54]

B:BD[28.54] → [26.353:392]

∅:D[27.68] → [25.4113:4125]

∅:D[26.392] → [25.4113:4125]

B:BD[25.4113] → [25.4113:4125]

B:BD[25.4125] → [5.118:450]

∅:D[5.450] → [13.330:348]

B:BD[13.330] → [13.330:348]

B:BD[13.349] → [13.349:573]

B:BD[13.573] → [5.451:508]

∅:D[20.434] → [13.661:662]

∅:D[5.508] → [13.661:662]

∅:D[25.4574] → [13.661:662]

∅:D[22.9989] → [13.661:662]

B:BD[13.661] → [13.661:662]

B:BD[13.662] → [4.6942:6975]

∅:D[4.6975] → [26.393:446]

B:BD[29.34] → [26.393:446]

∅:D[26.446] → [29.35:90]

B:BD[30.51] → [29.35:90]

∅:D[29.90] → [9.3075:3076]

∅:D[30.118] → [9.3075:3076]

∅:D[15.130] → [9.3075:3076]

∅:D[31.153] → [9.3075:3076]

∅:D[32.207] → [9.3075:3076]

∅:D[11.503] → [9.3075:3076]

∅:D[20.517] → [9.3075:3076]

∅:D[13.736] → [9.3075:3076]

∅:D[12.1093] → [9.3075:3076]

B:BD[9.3075] → [9.3075:3076]

B:BD[9.3076] → [26.447:515]

∅:D[26.515] → [15.131:221]

B:BD[14.153] → [15.131:221]

B:BD[15.221] → [2.0:89]

∅:D[2.89] → [15.309:623]

B:BD[15.309] → [15.309:623]

B:BD[15.623] → [19.15670:15755]

∅:D[19.15755] → [15.674:759]

B:BD[15.674] → [15.674:759]

B:BD[15.759] → [22.9990:10203]

∅:D[22.10203] → [15.1032:1062]

B:BD[15.1032] → [15.1032:1062]


sub statusDescription {
    my ($buildstatus) = @_;
    my $status = "Failed";
    given ($buildstatus) {
        when (0) { $status = "Success"; }
        when (1) { $status = "Failed with non-zero exit code"; }
        when (2) { $status = "Dependency failed"; }
        when (4) { $status = "Cancelled"; }
    }
   return $status;
}
sub sendEmailNotification {
    my ($build) = @_;
    die unless $build->finished;
    return unless $build->jobset->enableemail && ($build->maintainers ne "" || $build->jobset->emailoverride ne "");
    # Do we want to send mail?
    my $prevBuild;
    ($prevBuild) = $db->resultset('Builds')->search(
        { project => $build->project->name
        , jobset => $build->jobset->name
        , job => $build->job->name
        , system => $build->system
        , finished => 1
        , id => { '<', $build->id }
        , -not => { buildstatus => { -in => [4, 3]} }
        }, { order_by => ["id DESC"] }
        );
    # If build is cancelled or aborted, do not send email.
    return if $build->buildstatus == 4 || $build->buildstatus == 3;
    # If there is a previous (that is not cancelled or aborted) build
    # with same buildstatus, do not send email.
    return if defined $prevBuild && ($build->buildstatus == $prevBuild->buildstatus);
    # Send mail.
    # !!! should use the Template Toolkit here.
    print STDERR "sending mail notification to ", $build->maintainers, "\n";
    my $jobName = $build->project->name . ":" . $build->jobset->name . ":" . $build->job->name;
    my $status = statusDescription($build->buildstatus);
    my $baseurl = hostname_long;
    my $sender = $config->{'notification_sender'} ||
        (($ENV{'USER'} || "hydra") .  "@" . $baseurl);
    my $selfURI = $config->{'base_uri'} || "http://localhost:3000";
    sub showTime { my ($x) = @_; return strftime('%Y-%m-%d %H:%M:%S', localtime($x)); }
    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);

Deletion in src/script/hydra-build at line 20 [9.2912]

B:BD[15.1063] → [15.1063:1103]

B:BD[15.1103] → [2.90:200]

∅:D[2.200] → [15.1211:1425]

B:BD[15.1211] → [15.1211:1425]

B:BD[15.1425] → [17.2354:2425]

∅:D[17.2425] → [15.1463:1698]

B:BD[15.1463] → [15.1463:1698]

    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);

Deletion in src/script/hydra-build at line 21 [9.2912]
B:BD[33.1] → [33.1:24]
B:BD[33.24] → [34.10650:10709]
∅:D[18.1020] → [35.205:250]
∅:D[34.10709] → [35.205:250]
B:BD[35.205] → [35.205:250]
∅:D[36.108] → [13.807:846]
∅:D[33.132] → [13.807:846]
∅:D[14.153] → [13.807:846]
∅:D[35.250] → [13.807:846]
∅:D[37.386] → [13.807:846]
∅:D[15.1698] → [13.807:846]
B:BD[13.807] → [13.807:846]
B:BD[13.846] → [38.0:67]
B:BD[38.67] → [22.10240:10414]
∅:D[39.183] → [13.965:980]
∅:D[40.186] → [13.965:980]
∅:D[20.701] → [13.965:980]
∅:D[25.4696] → [13.965:980]
∅:D[22.10414] → [13.965:980]
B:BD[13.965] → [13.965:980]
B:BD[13.980] → [2.201:268]
∅:D[2.268] → [13.1039:1087]
∅:D[15.1763] → [13.1039:1087]
B:BD[13.1039] → [13.1039:1087]
B:BD[13.1087] → [22.10415:10546]
∅:D[33.276] → [13.1087:1102]
∅:D[22.10546] → [13.1087:1102]
B:BD[13.1087] → [13.1087:1102]
B:BD[13.1102] → [15.1764:2044]
B:BD[15.2044] → [33.277:327]
B:BD[33.327] → [18.1021:1084]
∅:D[18.1084] → [33.403:404]
∅:D[22.10611] → [33.403:404]
B:BD[33.403] → [33.403:404]
∅:D[33.404] → [25.4697:4767]
B:BD[13.1153] → [25.4697:4767]
∅:D[11.540] → [9.3076:3077]
∅:D[13.1153] → [9.3076:3077]
∅:D[25.4767] → [9.3076:3077]
B:BD[9.3076] → [9.3076:3077]
B:BD[9.3077] → [25.4768:4875]
∅:D[25.4875] → [11.541:600]
B:BD[9.3077] → [11.541:600]
B:BD[11.600] → [25.4876:4904]
∅:D[25.4904] → [13.1154:1209]
B:BD[11.644] → [13.1154:1209]
B:BD[13.1209] → [5.509:610]
∅:D[5.610] → [29.91:135]
B:BD[20.782] → [29.91:135]
∅:D[29.135] → [20.822:935]
B:BD[20.822] → [20.822:935]
B:BD[20.935] → [41.107:209]
∅:D[41.209] → [11.760:771]
∅:D[20.987] → [11.760:771]
∅:D[13.1287] → [11.760:771]
B:BD[11.760] → [11.760:771]
B:BD[11.771] → [42.0:20]
∅:D[42.20] → [11.808:815]
∅:D[13.1311] → [11.808:815]
B:BD[11.808] → [11.808:815]
B:BD[11.815] → [42.21:50]
∅:D[42.50] → [11.815:816]
B:BD[11.815] → [11.815:816]
B:BD[11.816] → [13.1312:1368]
∅:D[13.1368] → [11.845:846]
B:BD[11.845] → [11.845:846]
B:BD[11.846] → [43.786:808]
∅:D[43.808] → [11.868:870]
∅:D[20.1009] → [11.868:870]
B:BD[11.868] → [11.868:870]
B:BD[11.870] → [19.15756:15757]
∅:D[19.15757] → [11.870:871]
B:BD[11.870] → [11.870:871]
```
    my $loglines = 50;
    my $logtext = logContents($build->drvpath, $loglines);
    $logtext = removeAsciiEscapes($logtext);
    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"
        . "\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;
    my $to = (!$build->jobset->emailoverride eq "") ? $build->jobset->emailoverride : $build->maintainers;
    my $email = Email::Simple->create(
        header => [
            To      => $to,
            From    => "Hydra Build Daemon <$sender>",
            Subject => "$status: Hydra job $jobName on " . $build->system . ", build " . $build->id,
            'X-Hydra-Instance' => $baseurl,
            'X-Hydra-Project'  => $build->project->name,
            'X-Hydra-Jobset'   => $build->jobset->name,
            'X-Hydra-Job'      => $build->job->name,
            'X-Hydra-System'   => $build->system
        ],
        body => "",
    );
    $email->body_set($body);
    print $email->as_string if $ENV{'HYDRA_MAIL_TEST'};
    sendmail($email);
}
```

Replacement in src/script/hydra-build at line 291 [9.2912]

B:BD[11.874] → [13.1369:1403]

    sendEmailNotification $build;

[11.874]

[9.6647]

    foreach my $plugin (Hydra::Plugin->plugins) {
        eval {
            $plugin->buildFinished($db, $config, $build, []);
        };
        if ($@) {
            print STDERR "$plugin->buildFinished: $@\n";
        }
    }

Replacement in src/script/hydra-build at line 306 [9.2912]

B:BD[13.1435] → [13.1435:1503]

    sendEmailNotification $db->resultset('Builds')->find($buildId);

[13.1435]

[16.1071]

    my $build = $db->resultset('Builds')->find($buildId);
    $_->buildFinished($db, $config, $build, []) foreach Hydra::Plugin->plugins;