fix #33: track CI failures through the cron job

nunoplopes · nunoplopes · commit dd30a420166b · 2025-02-09T10:42:15.000Z
diff --git a/cron.php b/cron.php
@@ -196,6 +196,16 @@ function run_patch_stats() {
             new PatchComment($patch, "New branch hash: $newhash"));
           echo "Patch $patch->id changed hash from $oldhash to $newhash\n";
         }
+
+        if ($pr = $patch->getPR()) {
+          foreach ($patch->getHashes() as $hash) {
+            $failed = $pr->failedCIjobs($hash);
+            foreach ($failed as $job) {
+              $patch->addCIError($hash, $job['name']);
+            }
+          }
+        }
+
         echo "Updated patch $patch->id\n";
 
       } catch (ValidationException $ex) {
diff --git a/entities/Patch.php b/entities/Patch.php
@@ -69,6 +69,11 @@ abstract class Patch
    */
   public $comments;
 
+  /** @OneToMany(targetEntity="PatchCIError", mappedBy="patch", cascade={"persist"})
+   *  @OrderBy({"id" = "ASC"})
+   */
+  public $ci_failures;
+
   /** @ManyToMany(targetEntity="User") */
   public $students;
 
@@ -202,8 +207,9 @@ static function factory(ProjGroup $group, string $url, $type,
   }
 
   public function __construct() {
-    $this->comments = new \Doctrine\Common\Collections\ArrayCollection();
-    $this->students = new \Doctrine\Common\Collections\ArrayCollection();
+    $this->comments    = new \Doctrine\Common\Collections\ArrayCollection();
+    $this->ci_failures = new \Doctrine\Common\Collections\ArrayCollection();
+    $this->students    = new \Doctrine\Common\Collections\ArrayCollection();
   }
 
   abstract public function isValid() : bool;
@@ -329,10 +335,33 @@ public function wasMerged() {
            $this->status == PATCH_MERGED_ILLEGAL;
   }
 
-  public function getSubmitter() : User {
+  public function getSubmitter() : ?User {
     return $this->comments[0]->user;
   }
 
+  public function getSubmitterName() : string {
+    $user = $this->getSubmitter();
+    return $user ? $user->shortName() : '(Bot)';
+  }
+
+  public function getHashes() {
+    $hashes = [];
+    foreach ($this->comments as $comment) {
+      if (preg_match('/New branch hash: (\S+)/', $comment->text, $m))
+        $hashes[] = $m[1];
+    }
+    $hashes[] = $this->hash;
+    return $hashes;
+  }
+
+  public function addCIError($hash, $name) {
+    foreach ($this->ci_failures as $error) {
+      if ($error->hash == $hash && $error->name == $name)
+        return;
+    }
+    $this->ci_failures->add(new PatchCIError($this, $hash, $name));
+  }
+
   public function set_status($status) {
     $status = (int)$status;
     if (!isset(self::get_status_options()[$status]))
diff --git a/entities/PatchCIError.php b/entities/PatchCIError.php
@@ -0,0 +1,34 @@
+<?php
+// Copyright (c) 2022-present Instituto Superior Técnico.
+// Distributed under the MIT license that can be found in the LICENSE file.
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
+use Doctrine\ORM\Mapping\JoinColumn;
+use Doctrine\ORM\Mapping\ManyToOne;
+
+/** @Entity */
+class PatchCIError
+{
+  /** @Id @Column @GeneratedValue */
+  public int $id;
+
+  /** @ManyToOne(inversedBy="ci_failures")
+   *  @JoinColumn(nullable=false)
+   */
+  public Patch $patch;
+
+  /** @Column(length=64) */
+  public string $hash;
+
+  /** @Column(length=128) */
+  public string $name;
+
+  public function __construct(Patch $patch, string $hash, string $name) {
+    $this->patch = $patch;
+    $this->hash  = $hash;
+    $this->name  = $name;
+  }
+}
diff --git a/pages/editpatch.php b/pages/editpatch.php
@@ -76,6 +76,27 @@
 }
 echo "</table>\n";
 
+$ci_failures = [];
+foreach ($patch->ci_failures as $ci) {
+  $ci_failures[$ci->hash][] = $ci->name;
+}
+
+if ($ci_failures) {
+  echo <<<HTML
+<p>&nbsp;</p>
+<p><b>CI Failures:</b></p>
+<table>
+  <tr><th>Commit hash</th><th>Failed CI jobs</th></tr>
+HTML;
+
+  foreach ($ci_failures as $hash => $names) {
+    echo "<tr><td>$hash</td><td>",
+         nl2br(htmlspecialchars(implode("\n", $names))),
+         "</td></tr>\n";
+  }
+  echo "</table>\n";
+}
+
 // Add approve/reject buttons to simplify the life of TAs
 $extra_buttons = '';
 if ($patch->status <= PATCH_REVIEWED && auth_at_least(ROLE_TA)) {
diff --git a/pages/patches.php b/pages/patches.php
@@ -87,7 +87,7 @@
       '+'         => $patch->lines_added,
       '-'         => $patch->lines_deleted,
       'Files'     => $patch->files_modified,
-      'Submitter' => htmlspecialchars($patch->getSubmitter()->shortName()),
+      'Submitter' => htmlspecialchars($patch->getSubmitterName()),
       'Authors'   => implode(', ', $authors),
     ];
   }

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@`
`87`	`87`	`'+' => $patch->lines_added,`
`88`	`88`	`'-' => $patch->lines_deleted,`
`89`	`89`	`'Files' => $patch->files_modified,`
`90`		`- 'Submitter' => htmlspecialchars($patch->getSubmitter()->shortName()),`
	`90`	`+ 'Submitter' => htmlspecialchars($patch->getSubmitterName()),`
`91`	`91`	`'Authors' => implode(', ', $authors),`
`92`	`92`	`];`
`93`	`93`	`}`