From 0ada412979c3b199c5005473fb892788c232be1b Mon Sep 17 00:00:00 2001
From: Graham Christensen <graham@grahamc.com>
Date: Mon, 10 Jan 2022 16:49:35 -0500
Subject: [PATCH] hydra-eval-jobset: write a test validating the events that
 comes out

---
 t/jobs/hydra-eval-notifications.nix         | 30 +++++++
 t/scripts/hydra-eval-jobset/notifications.t | 91 +++++++++++++++++++++
 2 files changed, 121 insertions(+)
 create mode 100644 t/jobs/hydra-eval-notifications.nix
 create mode 100644 t/scripts/hydra-eval-jobset/notifications.t

diff --git a/t/jobs/hydra-eval-notifications.nix b/t/jobs/hydra-eval-notifications.nix
new file mode 100644
index 00000000..0be7a5a4
--- /dev/null
+++ b/t/jobs/hydra-eval-notifications.nix
@@ -0,0 +1,30 @@
+# This file gets copied around, and intentionally does not refer to
+# anything but itself as "default.nix".
+
+let
+  simpleDerivation = name: builderText: derivation {
+    inherit name;
+    system = builtins.currentSystem;
+    builder = "/bin/sh";
+    args = [
+      (builtins.toFile "builder.sh" builderText)
+    ];
+  };
+in
+{
+  stable-job-queued = simpleDerivation "stable-job-queued" ''
+    echo "here is a stable job that passes every time" > $out
+  '';
+
+  stable-job-passing = simpleDerivation "stable-job-passing" ''
+    echo "here is a stable job that passes every time" > $out
+  '';
+
+  stable-job-failing = simpleDerivation "stable-job-failing" ''
+    echo "this job is a stable job that fails every time" > $out
+  '';
+
+  variable-job = simpleDerivation "variable-job" ''
+    echo ${builtins.toFile "default.nix" (builtins.readFile ./default.nix)} > $out
+  '';
+}
diff --git a/t/scripts/hydra-eval-jobset/notifications.t b/t/scripts/hydra-eval-jobset/notifications.t
new file mode 100644
index 00000000..cd716779
--- /dev/null
+++ b/t/scripts/hydra-eval-jobset/notifications.t
@@ -0,0 +1,91 @@
+use feature 'unicode_strings';
+use strict;
+use warnings;
+use Setup;
+use Test2::V0;
+use File::Copy;
+use Hydra::PostgresListener;
+
+my $ctx = test_context(
+    hydra_config => q|
+# No caching for PathInput plugin, otherwise we get wrong values
+# (as it has a 30s window where no changes to the file are considered).
+path_input_cache_validity_seconds = 0
+|
+);
+
+my $dbh = $ctx->db()->storage->dbh;
+my $listener = Hydra::PostgresListener->new($dbh);
+
+$listener->subscribe("cached_build_finished");
+$listener->subscribe("cached_build_queued");
+$listener->subscribe("build_queued");
+$listener->subscribe("eval_failed");
+$listener->subscribe("eval_cached");
+$listener->subscribe("eval_added");
+$listener->subscribe("eval_started");
+$listener->subscribe("builds_added");
+
+
+my $jobsetdir = $ctx->tmpdir . '/jobset';
+mkdir($jobsetdir);
+copy($ctx->jobsdir . '/hydra-eval-notifications.nix', "$jobsetdir/default.nix");
+
+my $builds = $ctx->makeAndEvaluateJobset(
+    expression => "default.nix",
+    jobsdir => $jobsetdir,
+    build => 0
+);
+
+subtest "on the initial evaluation" => sub {
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_started", "every eval starts with a notification");
+    is($listener->block_for_messages(0)->()->{"channel"}, "build_queued", "expect 1/4 builds being queued");
+    is($listener->block_for_messages(0)->()->{"channel"}, "build_queued", "expect 2/4 builds being queued");
+    is($listener->block_for_messages(0)->()->{"channel"}, "build_queued", "expect 3/4 builds being queued");
+    is($listener->block_for_messages(0)->()->{"channel"}, "build_queued", "expect 4/4 builds being queued");
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_added", "the evaluation has completed");
+    is($listener->block_for_messages(0)->()->{"channel"}, "builds_added", "new builds have been scheduled");
+    is($listener->block_for_messages(0)->(), undef, "there are no more messages from the evaluator");
+};
+
+subtest "on a subsequent, totally cached / unchanged evaluation" => sub {
+    ok(evalSucceeds($builds->{"variable-job"}->jobset), "evaluating for the second time");
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_started", "an evaluation has started");
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_cached", "the evaluation finished and nothing changed");
+    is($listener->block_for_messages(0)->(), undef, "there are no more messages from the evaluator");
+};
+
+subtest "on a fresh evaluation with changed sources" => sub {
+    open(my $fh, ">>", "${jobsetdir}/default.nix") or die "didn't open?";
+    say $fh "\n";
+    close $fh;
+
+    ok(runBuild($builds->{"stable-job-passing"}), "building the stable passing job");
+    $builds->{"stable-job-passing"}->discard_changes();
+
+    ok(runBuild($builds->{"stable-job-failing"}), "building the stable failing job");
+    $builds->{"stable-job-failing"}->discard_changes();
+
+    ok(evalSucceeds($builds->{"variable-job"}->jobset), "evaluating for the third time");
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_started", "the evaluation started");
+
+    is($listener->block_for_messages(0)->()->{"channel"}, "build_queued", "expect only one new build being queued");
+
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_added", "a new evaluation was added");
+    is($listener->block_for_messages(0)->()->{"channel"}, "builds_added", "a new build was added");
+    is($listener->block_for_messages(0)->(), undef, "there are no more messages from the evaluator");
+};
+
+subtest "on a fresh evaluation with corrupted sources" => sub {
+    open(my $fh, ">>", "${jobsetdir}/default.nix") or die "didn't open?";
+    say $fh "this is not valid nix code!\n";
+    close $fh;
+
+    ok(evalFails($builds->{"variable-job"}->jobset), "evaluating the corrupted job");
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_started", "the evaluation started");
+    is($listener->block_for_messages(0)->()->{"channel"}, "eval_failed", "the evaluation failed");
+    is($listener->block_for_messages(0)->(), undef, "there are no more messages from the evaluator");
+
+};
+
+done_testing;