From 42edd3a9d8165b1cf544be6149ccc8abda6c10e2 Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Mon, 10 Jan 2022 20:23:48 -0500 Subject: [PATCH] hydra-notify: respond to cached_build_queued --- doc/manual/src/notifications.md | 7 ++ src/lib/Hydra/Event.pm | 2 + src/lib/Hydra/Event/CachedBuildQueued.pm | 59 ++++++++++++ src/lib/Hydra/Plugin.pm | 6 ++ src/script/hydra-notify | 1 + t/Event/CachedBuildQueued.t | 111 +++++++++++++++++++++++ 6 files changed, 186 insertions(+) create mode 100644 src/lib/Hydra/Event/CachedBuildQueued.pm create mode 100644 t/Event/CachedBuildQueued.t diff --git a/doc/manual/src/notifications.md b/doc/manual/src/notifications.md index 8d824177..2423670c 100644 --- a/doc/manual/src/notifications.md +++ b/doc/manual/src/notifications.md @@ -14,6 +14,13 @@ Note that the notification format is subject to change and should not be conside * **When:** Issued directly after an evaluation completes, when that evaluation includes this finished build. * **Delivery Semantics:** At most once per evaluation. + +### `cached_build_queued` + +* **Payload:** Exactly two values, tab separated: The ID of the evaluation which contains the finished build, followed by the ID of the queued build. +* **When:** Issued directly after an evaluation completes, when that evaluation includes this queued build. +* **Delivery Semantics:** At most once per evaluation. + ### `build_queued` * **Payload:** Exactly one value, the ID of the build. diff --git a/src/lib/Hydra/Event.pm b/src/lib/Hydra/Event.pm index 9feb532a..9efeda67 100644 --- a/src/lib/Hydra/Event.pm +++ b/src/lib/Hydra/Event.pm @@ -3,6 +3,7 @@ package Hydra::Event; use strict; use warnings; use Hydra::Event::CachedBuildFinished; +use Hydra::Event::CachedBuildQueued; use Hydra::Event::BuildFinished; use Hydra::Event::BuildQueued; use Hydra::Event::BuildStarted; @@ -14,6 +15,7 @@ my %channels_to_events = ( step_finished => \&Hydra::Event::StepFinished::parse, build_finished => \&Hydra::Event::BuildFinished::parse, cached_build_finished => \&Hydra::Event::CachedBuildFinished::parse, + cached_build_queued => \&Hydra::Event::CachedBuildQueued::parse, ); diff --git a/src/lib/Hydra/Event/CachedBuildQueued.pm b/src/lib/Hydra/Event/CachedBuildQueued.pm new file mode 100644 index 00000000..7e4aa5ba --- /dev/null +++ b/src/lib/Hydra/Event/CachedBuildQueued.pm @@ -0,0 +1,59 @@ +package Hydra::Event::CachedBuildQueued; + +use strict; +use warnings; + +sub parse :prototype(@) { + if (@_ != 2) { + die "cached_build_queued: payload takes two arguments, but ", scalar(@_), " were given"; + } + + my @failures = grep(!/^\d+$/, @_); + if (@failures > 0) { + die "cached_build_queued: payload arguments should be integers, but we received the following non-integers:", @failures; + } + + my ($evaluation_id, $build_id) = map int, @_; + return Hydra::Event::CachedBuildQueued->new($evaluation_id, $build_id); +} + +sub new { + my ($self, $evaluation_id, $build_id) = @_; + return bless { + "evaluation_id" => $evaluation_id, + "build_id" => $build_id, + "evaluation" => undef, + "build" => undef, + }, $self; +} + +sub interestedIn { + my ($self, $plugin) = @_; + return int(defined($plugin->can('cachedBuildQueued'))); +} + +sub load { + my ($self, $db) = @_; + + if (!defined($self->{"build"})) { + $self->{"build"} = $db->resultset('Builds')->find($self->{"build_id"}) + or die "build $self->{'build_id'} does not exist\n"; + } + + if (!defined($self->{"evaluation"})) { + $self->{"evaluation"} = $db->resultset('JobsetEvals')->find($self->{"evaluation_id"}) + or die "evaluation $self->{'evaluation_id'} does not exist\n"; + } +} + +sub execute { + my ($self, $db, $plugin) = @_; + + $self->load($db); + + $plugin->cachedBuildQueued($self->{"evaluation"}, $self->{"build"}); + + return 1; +} + +1; diff --git a/src/lib/Hydra/Plugin.pm b/src/lib/Hydra/Plugin.pm index 5742b3fb..b42e4b4c 100644 --- a/src/lib/Hydra/Plugin.pm +++ b/src/lib/Hydra/Plugin.pm @@ -36,6 +36,12 @@ sub instantiate { # my ($self, $build) = @_; # } +# # Called when build $build has been queued again by evaluation $evaluation +# where $build has not yet finished. +# sub cachedBuildQueued { +# my ($self, $evaluation, $build) = @_; +# } + # # Called when build $build is a finished build, and is # part evaluation $evaluation # sub cachedBuildFinished { diff --git a/src/script/hydra-notify b/src/script/hydra-notify index 6bc736e9..04130f4f 100755 --- a/src/script/hydra-notify +++ b/src/script/hydra-notify @@ -97,6 +97,7 @@ $listener->subscribe("build_finished"); $listener->subscribe("build_queued"); $listener->subscribe("build_started"); $listener->subscribe("cached_build_finished"); +$listener->subscribe("cached_build_queued"); $listener->subscribe("hydra_notify_dump_metrics"); $listener->subscribe("step_finished"); diff --git a/t/Event/CachedBuildQueued.t b/t/Event/CachedBuildQueued.t new file mode 100644 index 00000000..780b568f --- /dev/null +++ b/t/Event/CachedBuildQueued.t @@ -0,0 +1,111 @@ +use strict; +use warnings; +use Setup; + +my %ctx = test_init(); + +require Hydra::Schema; +require Hydra::Model::DB; +use Hydra::Event; +use Hydra::Event::CachedBuildQueued; + +use Test2::V0; +use Test2::Tools::Exception; +use Test2::Tools::Mock qw(mock_obj); + +my $db = Hydra::Model::DB->new; +hydra_setup($db); + +subtest "Parsing" => sub { + like( + dies { Hydra::Event::parse_payload("cached_build_queued", "") }, + qr/takes two arguments/, + "empty payload" + ); + like( + dies { Hydra::Event::parse_payload("cached_build_queued", "abc123") }, + qr/takes two arguments/, + "missing the build ID" + ); + + like( + dies { Hydra::Event::parse_payload("cached_build_queued", "123\t456\t789\t012\t345") }, + qr/takes two arguments/, + "too many arguments" + ); + like( + dies { Hydra::Event::parse_payload("cached_build_queued", "abc123\tdef456") }, + qr/should be integers/, + "evaluation ID should be an integer" + ); + like( + dies { Hydra::Event::parse_payload("cached_build_queued", "123\tabc123") }, + qr/should be integers/, + "build ID should be an integer" + ); + is( + Hydra::Event::parse_payload("cached_build_queued", "123\t456"), + Hydra::Event::CachedBuildQueued->new(123, 456), + "one dependent build" + ); +}; + +my $project = $db->resultset('Projects')->create({name => "tests", displayname => "", owner => "root"}); +my $jobset = createBaseJobset("basic", "basic.nix", $ctx{jobsdir}); +ok(evalSucceeds($jobset), "Evaluating jobs/basic.nix should exit with return code 0"); +is(nrQueuedBuildsForJobset($jobset), 3, "Evaluating jobs/basic.nix should result in 3 builds"); + +subtest "interested" => sub { + my $event = Hydra::Event::CachedBuildQueued->new(123, 456); + + subtest "A plugin which does not implement the API" => sub { + my $plugin = {}; + my $mock = mock_obj $plugin => (); + + is($event->interestedIn($plugin), 0, "The plugin is not interesting."); + }; + + subtest "A plugin which does implement the API" => sub { + my $plugin = {}; + my $mock = mock_obj $plugin => ( + add => [ + "cachedBuildQueued" => sub {} + ] + ); + + is($event->interestedIn($plugin), 1, "The plugin is interesting."); + }; +}; + +subtest "load" => sub { + my ($build) = $db->resultset('Builds')->search({ }, { limit => 1 })->single; + my $evaluation = $build->jobsetevals->search({}, { limit => 1 })->single; + + my $event = Hydra::Event::CachedBuildQueued->new($evaluation->id, $build->id); + + $event->load($db); + is($event->{"evaluation"}->id, $evaluation->id, "The evaluation record matches."); + is($event->{"build"}->id, $build->id, "The build record matches."); + + # Create a fake "plugin" with a cachedBuildQueued sub, the sub sets this + # global passedEvaluation and passedBuild variables for verifying. + my $passedEvaluation; + my $passedBuild; + my $plugin = {}; + my $mock = mock_obj $plugin => ( + add => [ + "cachedBuildQueued" => sub { + my ($self, $evaluation, $build) = @_; + $passedEvaluation = $evaluation; + $passedBuild = $build; + } + ] + ); + + $event->execute($db, $plugin); + + is($passedEvaluation->id, $evaluation->id, "The plugin's cachedBuildQueued hook is called with a matching evaluation"); + is($passedBuild->id, $build->id, "The plugin's cachedBuildQueued hook is called with a matching build"); +}; + +done_testing;