Emit restart events when job restarted automatically

Send an event through the task itself after the `auto_duplicate` when the job
have been process and send for restart. While the `auto_duplicate` could be
used as a single point for the event's emission it interferes with other
functions which also emit events independently. For instance from the API
restart, it processes the payload and adds data to it, so it left as is.
Using the `restart_openqa_job` from the Restart module should not duplicate
the event which is emitted by the API, which also invoke `auto_duplicate`. And
it should also trigger the event when the job is processed and not while is
queued.

That should make sure that the event is send to AMQP for jobs with
`RETRY` once it is actually triggered.

issue: https://progress.opensuse.org/issues/190557
Signed-off-by: Ioannis Bonatakis <[email protected]>

Author: d3flex

lib/OpenQA/Task/Job/Restart.pm

@@ -17,6 +17,7 @@ sub restart_delay { $ENV{OPENQA_JOB_RESTART_DELAY} // 5 }
 sub restart_openqa_job ($minion_job, $openqa_job) {
     my $cloned_job_or_error = $openqa_job->auto_duplicate;
     my $is_ok = ref $cloned_job_or_error || $cloned_job_or_error =~ qr/(already.*clone|direct parent)/i;
+    OpenQA::Events->singleton->emit_event('job_restart', data => {id => $openqa_job->id}) if $is_ok;
     $minion_job->note(
         ref $cloned_job_or_error
         ? (cluster_cloned => $cloned_job_or_error->{cluster_cloned})

t/10-jobs.t

@@ -19,6 +19,7 @@ use OpenQA::Jobs::Constants;
 use OpenQA::Test::Case;
 use Test::MockModule 'strict';
 use Test::Mojo;
+use Test::Output;
 use Test::Warnings qw(:report_warnings warning);
 use Mojo::File 'path';
 use Mojo::JSON qw(decode_json encode_json);
@@ -899,7 +900,8 @@ subtest 'job setting based retriggering' => sub {
     my $finalize_job_count_before = @{$get_jobs->('finalize_job_results')};
     $job->update({state => SCHEDULED, result => NONE});
     $job->done(result => FAILED);
-    perform_minion_jobs($minion);
+    stdout_like { perform_minion_jobs($minion) } qr/Job \d+ duplicated as \d+/,
+      'check debug message from auto_duplicate';
     is $jobs->count, $jobs_nr + 2, 'job retriggered as it FAILED (with retry)';
     $job->update;
     $job->discard_changes;

t/api/18-job-amqp-event.t

@@ -0,0 +1,55 @@
+#!/usr/bin/env perl
+# Copyright SUSE LLC
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+use Test::Most;
+use FindBin;
+use lib "$FindBin::Bin/../lib", "$FindBin::Bin/../../external/os-autoinst-common/lib";
+use Mojo::Base -signatures;
+use Test::Mojo;
+use Test::MockModule;
+use Test::MockObject;
+use OpenQA::Test::Case;
+use OpenQA::Test::Client 'client';
+use Test::Output qw(combined_like);
+
+OpenQA::Test::Case->new->init_data(fixtures_glob => '01-jobs.pl 03-users.pl');
+my $t = client(Test::Mojo->new('OpenQA::WebAPI'));
+my $jobs = $t->app->schema->resultset('Jobs');
+
+subtest 'Jobs should emit exactly one event' => sub {
+    my @emitted_events;
+    my $mock_emit = Test::MockObject->new();
+    $mock_emit->mock(
+        emit => sub ($self, $type, $args) {
+            my (undef, undef, undef, $data) = @$args;
+            push @emitted_events, {type => $type, data => $data};
+        });
+    # include the events emitted by OpenQA::Events->singleton->emit_event()
+    $mock_emit->mock(
+        # uncoverable subroutine
+        emit_event => sub ($self, $type, %args) {    # uncoverable statement
+            push @emitted_events, {type => $type, data => $args{data}};    # uncoverable statement
+        });
+
+    my $mock_events = Test::MockModule->new('OpenQA::Events');
+    $mock_events->redefine(singleton => sub { return $mock_emit });
+    my $scheduler_mock = Test::MockModule->new('OpenQA::Scheduler::Client');
+    $scheduler_mock->redefine(wakeup => sub { });
+
+    my %params = (TEST => 'event_test', DISTRI => 'foo', VERSION => 'bar', ARCH => 'baz');
+    $t->post_ok('/api/v1/jobs', form => \%params)->status_is(200);
+    my $job_id = $t->tx->res->json->{id};
+    is(scalar @emitted_events, 1, 'exactly one event was emitted on create');
+    is($emitted_events[0]->{data}{id}, $job_id, 'job_id is emitted on event');
+    is($emitted_events[0]->{type}, 'openqa_job_create', 'data has correct event type');
+
+    @emitted_events = ();
+    combined_like { $t->post_ok('/api/v1/jobs/99926/restart?force=1')->status_is(200) } qr/Job 99926 duplicated/,
+      'Job restarted successfully';
+    is(scalar @emitted_events, 1, 'exactly one event was emitted on restart');
+    is($emitted_events[0]->{data}{id}, 99926, 'job_id is emitted on event');
+    is($emitted_events[0]->{type}, 'openqa_job_restart', 'data has correct event type');
+};
+
+done_testing;