Provide ANSI color information for Harbormaster build status via API

Summary:
Ref PHI261. This moves Harbormaster build status to work more similarly to other modern status types, like Differential revision status, where we try to specify as much behavior on the server as possible so that the client and server can vary independently.

(I don't have any specific plans to make Harbormaster build status configurable on the server side, but it isn't out of the question.)

Test Plan: Ran `harbormaster.querybuilds` (saw same data as before) and `harbormaster.build.search` (saw same data as before, plus new ANSI color data).

Reviewers: amckinley

Reviewed By: amckinley

Subscribers: PHID-OPKG-gm6ozazyms6q6i22gyam

Differential Revision: https://secure.phabricator.com/D18838

src/applications/harbormaster/conduit/HarbormasterQueryBuildsConduitAPIMethod.php

@@ -65,6 +65,16 @@ final class HarbormasterQueryBuildsConduitAPIMethod
       $fields = idx($build_data, 'fields', array());
       unset($build_data['fields']);
       unset($build_data['attachments']);
+
+      // To retain backward compatibility, remove newer keys from the
+      // result array.
+      $fields['buildStatus'] = array_select_keys(
+        $fields['buildStatus'],
+        array(
+          'value',
+          'name',
+        ));
+
       $data[] = array_mergev(array($build_data, $querybuilds, $fields));
     }
 

src/applications/harbormaster/constants/HarbormasterBuildStatus.php

@@ -55,67 +55,28 @@ final class HarbormasterBuildStatus extends Phobject {
    * @return string Human-readable name.
    */
   public static function getBuildStatusName($status) {
-    $map = self::getBuildStatusMap();
-    return idx($map, $status, pht('Unknown ("%s")', $status));
+    $spec = self::getBuildStatusSpec($status);
+    return idx($spec, 'name', pht('Unknown ("%s")', $status));
   }
 
   public static function getBuildStatusMap() {
-    return array(
-      self::STATUS_INACTIVE => pht('Inactive'),
-      self::STATUS_PENDING => pht('Pending'),
-      self::STATUS_BUILDING => pht('Building'),
-      self::STATUS_PASSED => pht('Passed'),
-      self::STATUS_FAILED => pht('Failed'),
-      self::STATUS_ABORTED => pht('Aborted'),
-      self::STATUS_ERROR => pht('Unexpected Error'),
-      self::STATUS_PAUSED => pht('Paused'),
-      self::STATUS_DEADLOCKED => pht('Deadlocked'),
-    );
+    $specs = self::getBuildStatusSpecMap();
+    return ipull($specs, 'name');
   }
 
   public static function getBuildStatusIcon($status) {
-    switch ($status) {
-      case self::STATUS_INACTIVE:
-      case self::STATUS_PENDING:
-        return PHUIStatusItemView::ICON_OPEN;
-      case self::STATUS_BUILDING:
-        return PHUIStatusItemView::ICON_RIGHT;
-      case self::STATUS_PASSED:
-        return PHUIStatusItemView::ICON_ACCEPT;
-      case self::STATUS_FAILED:
-        return PHUIStatusItemView::ICON_REJECT;
-      case self::STATUS_ABORTED:
-        return PHUIStatusItemView::ICON_MINUS;
-      case self::STATUS_ERROR:
-        return PHUIStatusItemView::ICON_MINUS;
-      case self::STATUS_PAUSED:
-        return PHUIStatusItemView::ICON_MINUS;
-      case self::STATUS_DEADLOCKED:
-        return PHUIStatusItemView::ICON_WARNING;
-      default:
-        return PHUIStatusItemView::ICON_QUESTION;
-    }
+    $spec = self::getBuildStatusSpec($status);
+    return idx($spec, 'icon', 'fa-question-circle');
   }
 
   public static function getBuildStatusColor($status) {
-    switch ($status) {
-      case self::STATUS_INACTIVE:
-        return 'dark';
-      case self::STATUS_PENDING:
-      case self::STATUS_BUILDING:
-        return 'blue';
-      case self::STATUS_PASSED:
-        return 'green';
-      case self::STATUS_FAILED:
-      case self::STATUS_ABORTED:
-      case self::STATUS_ERROR:
-      case self::STATUS_DEADLOCKED:
-        return 'red';
-      case self::STATUS_PAUSED:
-        return 'dark';
-      default:
-        return 'bluegrey';
-    }
+    $spec = self::getBuildStatusSpec($status);
+    return idx($spec, 'color', 'bluegrey');
+  }
+
+  public static function getBuildStatusANSIColor($status) {
+    $spec = self::getBuildStatusSpec($status);
+    return idx($spec, 'color.ansi', 'magenta');
   }
 
   public static function getWaitingStatusConstants() {
@@ -142,4 +103,67 @@ final class HarbormasterBuildStatus extends Phobject {
     );
   }
 
+  private static function getBuildStatusSpecMap() {
+    return array(
+      self::STATUS_INACTIVE => array(
+        'name' => pht('Inactive'),
+        'icon' => 'fa-circle-o',
+        'color' => 'dark',
+        'color.ansi' => 'yellow',
+      ),
+      self::STATUS_PENDING => array(
+        'name' => pht('Pending'),
+        'icon' => 'fa-circle-o',
+        'color' => 'blue',
+        'color.ansi' => 'yellow',
+      ),
+      self::STATUS_BUILDING => array(
+        'name' => pht('Building'),
+        'icon' => 'fa-chevron-circle-right',
+        'color' => 'blue',
+        'color.ansi' => 'yellow',
+      ),
+      self::STATUS_PASSED => array(
+        'name' => pht('Passed'),
+        'icon' => 'fa-check-circle',
+        'color' => 'green',
+        'color.ansi' => 'green',
+      ),
+      self::STATUS_FAILED => array(
+        'name' => pht('Failed'),
+        'icon' => 'fa-times-circle',
+        'color' => 'red',
+        'color.ansi' => 'red',
+      ),
+      self::STATUS_ABORTED => array(
+        'name' => pht('Aborted'),
+        'icon' => 'fa-minus-circle',
+        'color' => 'red',
+        'color.ansi' => 'red',
+      ),
+      self::STATUS_ERROR => array(
+        'name' => pht('Unexpected Error'),
+        'icon' => 'fa-minus-circle',
+        'color' => 'red',
+        'color.ansi' => 'red',
+      ),
+      self::STATUS_PAUSED => array(
+        'name' => pht('Paused'),
+        'icon' => 'fa-minus-circle',
+        'color' => 'dark',
+        'color.ansi' => 'yellow',
+      ),
+      self::STATUS_DEADLOCKED => array(
+        'name' => pht('Deadlocked'),
+        'icon' => 'fa-exclamation-circle',
+        'color' => 'red',
+        'color.ansi' => 'red',
+      ),
+    );
+  }
+
+  private static function getBuildStatusSpec($status) {
+    return idx(self::getBuildStatusSpecMap(), $status, array());
+  }
+
 }

src/applications/harbormaster/storage/build/HarbormasterBuild.php

@@ -435,6 +435,8 @@ final class HarbormasterBuild extends HarbormasterDAO
       'buildStatus' => array(
         'value' => $status,
         'name' => HarbormasterBuildStatus::getBuildStatusName($status),
+        'color.ansi' =>
+          HarbormasterBuildStatus::getBuildStatusANSIColor($status),
       ),
       'initiatorPHID' => nonempty($this->getInitiatorPHID(), null),
       'name' => $this->getName(),