Extend all "ManagementWorkflow" classes from a base class

Summary:
Ref T2015. Not directly related to Drydock, but I've wanted to do this for a bit.

Introduce a common base class for all the workflows in the scripts in `bin/*`. This slightly reduces code duplication by moving `isExecutable()` to the base, but also provides `getViewer()`. This is a little nicer than `PhabricatorUser::getOmnipotentUser()` and gives us a layer of indirection if we ever want to introduce more general viewer mechanisms in scripts.

Test Plan: Lint; ran some of the scripts.

Reviewers: btrahan

Reviewed By: btrahan

CC: aran

Maniphest Tasks: T2015

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

Author: epriestley

src/__phutil_library_map__.php

@@ -1560,6 +1560,7 @@
     'PhabricatorMainMenuIconView' => 'view/page/menu/PhabricatorMainMenuIconView.php',
     'PhabricatorMainMenuSearchView' => 'view/page/menu/PhabricatorMainMenuSearchView.php',
     'PhabricatorMainMenuView' => 'view/page/menu/PhabricatorMainMenuView.php',
+    'PhabricatorManagementWorkflow' => 'infrastructure/management/PhabricatorManagementWorkflow.php',
     'PhabricatorManiphestConfigOptions' => 'applications/maniphest/config/PhabricatorManiphestConfigOptions.php',
     'PhabricatorManiphestTaskTestDataGenerator' => 'applications/maniphest/lipsum/PhabricatorManiphestTaskTestDataGenerator.php',
     'PhabricatorMarkupCache' => 'applications/cache/storage/PhabricatorMarkupCache.php',
@@ -3020,7 +3021,7 @@
     'DivinerReturnTableView' => 'AphrontTagView',
     'DivinerSectionView' => 'AphrontTagView',
     'DivinerStaticPublisher' => 'DivinerPublisher',
-    'DivinerWorkflow' => 'PhutilArgumentWorkflow',
+    'DivinerWorkflow' => 'PhabricatorManagementWorkflow',
     'DoorkeeperBridge' => 'Phobject',
     'DoorkeeperBridgeAsana' => 'DoorkeeperBridge',
     'DoorkeeperBridgeJIRA' => 'DoorkeeperBridge',
@@ -3099,7 +3100,7 @@
     'DrydockManagementCreateResourceWorkflow' => 'DrydockManagementWorkflow',
     'DrydockManagementLeaseWorkflow' => 'DrydockManagementWorkflow',
     'DrydockManagementReleaseWorkflow' => 'DrydockManagementWorkflow',
-    'DrydockManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'DrydockManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'DrydockPHIDTypeBlueprint' => 'PhabricatorPHIDType',
     'DrydockPHIDTypeLease' => 'PhabricatorPHIDType',
     'DrydockPHIDTypeResource' => 'PhabricatorPHIDType',
@@ -3197,7 +3198,7 @@
     'HarbormasterDAO' => 'PhabricatorLiskDAO',
     'HarbormasterHTTPRequestBuildStepImplementation' => 'VariableBuildStepImplementation',
     'HarbormasterManagementBuildWorkflow' => 'HarbormasterManagementWorkflow',
-    'HarbormasterManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'HarbormasterManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'HarbormasterObject' => 'HarbormasterDAO',
     'HarbormasterPHIDTypeBuild' => 'PhabricatorPHIDType',
     'HarbormasterPHIDTypeBuildItem' => 'PhabricatorPHIDType',
@@ -3672,7 +3673,7 @@
     'PhabricatorAuditListView' => 'AphrontView',
     'PhabricatorAuditMailReceiver' => 'PhabricatorObjectMailReceiver',
     'PhabricatorAuditManagementDeleteWorkflow' => 'PhabricatorAuditManagementWorkflow',
-    'PhabricatorAuditManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorAuditManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorAuditPreviewController' => 'PhabricatorAuditController',
     'PhabricatorAuditReplyHandler' => 'PhabricatorMailReplyHandler',
     'PhabricatorAuthAccountView' => 'AphrontView',
@@ -3687,7 +3688,7 @@
     'PhabricatorAuthManagementLDAPWorkflow' => 'PhabricatorAuthManagementWorkflow',
     'PhabricatorAuthManagementRecoverWorkflow' => 'PhabricatorAuthManagementWorkflow',
     'PhabricatorAuthManagementRefreshWorkflow' => 'PhabricatorAuthManagementWorkflow',
-    'PhabricatorAuthManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorAuthManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorAuthNeedsApprovalController' => 'PhabricatorAuthController',
     'PhabricatorAuthNewController' => 'PhabricatorAuthProviderConfigController',
     'PhabricatorAuthOldOAuthRedirectController' => 'PhabricatorAuthController',
@@ -3740,7 +3741,7 @@
     'PhabricatorBusyExample' => 'PhabricatorUIExample',
     'PhabricatorCacheDAO' => 'PhabricatorLiskDAO',
     'PhabricatorCacheManagementPurgeWorkflow' => 'PhabricatorSearchManagementWorkflow',
-    'PhabricatorCacheManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorCacheManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorCalendarBrowseController' => 'PhabricatorCalendarController',
     'PhabricatorCalendarController' => 'PhabricatorController',
     'PhabricatorCalendarDAO' => 'PhabricatorLiskDAO',
@@ -3815,7 +3816,7 @@
     'PhabricatorConfigManagementGetWorkflow' => 'PhabricatorConfigManagementWorkflow',
     'PhabricatorConfigManagementListWorkflow' => 'PhabricatorConfigManagementWorkflow',
     'PhabricatorConfigManagementSetWorkflow' => 'PhabricatorConfigManagementWorkflow',
-    'PhabricatorConfigManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorConfigManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorConfigOption' =>
     array(
       0 => 'Phobject',
@@ -3892,7 +3893,7 @@
     'PhabricatorDaemonManagementStartWorkflow' => 'PhabricatorDaemonManagementWorkflow',
     'PhabricatorDaemonManagementStatusWorkflow' => 'PhabricatorDaemonManagementWorkflow',
     'PhabricatorDaemonManagementStopWorkflow' => 'PhabricatorDaemonManagementWorkflow',
-    'PhabricatorDaemonManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorDaemonManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorDataNotAttachedException' => 'Exception',
     'PhabricatorDebugController' => 'PhabricatorController',
     'PhabricatorDefaultFileStorageEngineSelector' => 'PhabricatorFileStorageEngineSelector',
@@ -3946,7 +3947,7 @@
     'PhabricatorFactManagementDestroyWorkflow' => 'PhabricatorFactManagementWorkflow',
     'PhabricatorFactManagementListWorkflow' => 'PhabricatorFactManagementWorkflow',
     'PhabricatorFactManagementStatusWorkflow' => 'PhabricatorFactManagementWorkflow',
-    'PhabricatorFactManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorFactManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorFactRaw' => 'PhabricatorFactDAO',
     'PhabricatorFactSimpleSpec' => 'PhabricatorFactSpec',
     'PhabricatorFactUpdateIterator' => 'PhutilBufferedIterator',
@@ -3960,7 +3961,7 @@
       1 => 'PhabricatorApplicationSearchResultsControllerInterface',
     ),
     'PhabricatorFeedManagementRepublishWorkflow' => 'PhabricatorFeedManagementWorkflow',
-    'PhabricatorFeedManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorFeedManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorFeedPublicStreamController' => 'PhabricatorFeedController',
     'PhabricatorFeedQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
     'PhabricatorFeedSearchEngine' => 'PhabricatorApplicationSearchEngine',
@@ -4029,7 +4030,7 @@
     'PhabricatorFilesManagementMigrateWorkflow' => 'PhabricatorFilesManagementWorkflow',
     'PhabricatorFilesManagementPurgeWorkflow' => 'PhabricatorFilesManagementWorkflow',
     'PhabricatorFilesManagementRebuildWorkflow' => 'PhabricatorFilesManagementWorkflow',
-    'PhabricatorFilesManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorFilesManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorFlag' =>
     array(
       0 => 'PhabricatorFlagDAO',
@@ -4077,7 +4078,7 @@
     'PhabricatorLegalpadPHIDTypeDocument' => 'PhabricatorPHIDType',
     'PhabricatorLintEngine' => 'PhutilLintEngine',
     'PhabricatorLipsumGenerateWorkflow' => 'PhabricatorLipsumManagementWorkflow',
-    'PhabricatorLipsumManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorLipsumManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorLipsumMondrianArtist' => 'PhabricatorLipsumArtist',
     'PhabricatorLiskDAO' => 'LiskDAO',
     'PhabricatorLocalDiskFileStorageEngine' => 'PhabricatorFileStorageEngine',
@@ -4119,7 +4120,7 @@
     'PhabricatorMailManagementSendTestWorkflow' => 'PhabricatorSearchManagementWorkflow',
     'PhabricatorMailManagementShowInboundWorkflow' => 'PhabricatorSearchManagementWorkflow',
     'PhabricatorMailManagementShowOutboundWorkflow' => 'PhabricatorSearchManagementWorkflow',
-    'PhabricatorMailManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorMailManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorMailReceiverTestCase' => 'PhabricatorTestCase',
     'PhabricatorMailingListPHIDTypeList' => 'PhabricatorPHIDType',
     'PhabricatorMailingListQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
@@ -4135,6 +4136,7 @@
     'PhabricatorMainMenuIconView' => 'AphrontView',
     'PhabricatorMainMenuSearchView' => 'AphrontView',
     'PhabricatorMainMenuView' => 'AphrontView',
+    'PhabricatorManagementWorkflow' => 'PhutilArgumentWorkflow',
     'PhabricatorManiphestConfigOptions' => 'PhabricatorApplicationConfigOptions',
     'PhabricatorManiphestTaskTestDataGenerator' => 'PhabricatorTestDataGenerator',
     'PhabricatorMarkupCache' => 'PhabricatorCacheDAO',
@@ -4305,7 +4307,7 @@
     'PhabricatorPolicyInterface' => 'PhabricatorPHIDInterface',
     'PhabricatorPolicyManagementShowWorkflow' => 'PhabricatorPolicyManagementWorkflow',
     'PhabricatorPolicyManagementUnlockWorkflow' => 'PhabricatorPolicyManagementWorkflow',
-    'PhabricatorPolicyManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorPolicyManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorPolicyPHIDTypePolicy' => 'PhabricatorPHIDType',
     'PhabricatorPolicyQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
     'PhabricatorPolicyRuleAdministrators' => 'PhabricatorPolicyRule',
@@ -4421,7 +4423,7 @@
     'PhabricatorRepositoryManagementLookupUsersWorkflow' => 'PhabricatorRepositoryManagementWorkflow',
     'PhabricatorRepositoryManagementMarkImportedWorkflow' => 'PhabricatorRepositoryManagementWorkflow',
     'PhabricatorRepositoryManagementPullWorkflow' => 'PhabricatorRepositoryManagementWorkflow',
-    'PhabricatorRepositoryManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorRepositoryManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorRepositoryMercurialCommitChangeParserWorker' => 'PhabricatorRepositoryCommitChangeParserWorker',
     'PhabricatorRepositoryMercurialCommitMessageParserWorker' => 'PhabricatorRepositoryCommitMessageParserWorker',
     'PhabricatorRepositoryMirror' =>
@@ -4459,7 +4461,7 @@
     'PhabricatorS3FileStorageEngine' => 'PhabricatorFileStorageEngine',
     'PhabricatorSSHLog' => 'Phobject',
     'PhabricatorSSHPassthruCommand' => 'Phobject',
-    'PhabricatorSSHWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorSSHWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorSavedQuery' =>
     array(
       0 => 'PhabricatorSearchDAO',
@@ -4480,7 +4482,7 @@
     'PhabricatorSearchEngineMySQL' => 'PhabricatorSearchEngine',
     'PhabricatorSearchHovercardController' => 'PhabricatorSearchBaseController',
     'PhabricatorSearchManagementIndexWorkflow' => 'PhabricatorSearchManagementWorkflow',
-    'PhabricatorSearchManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorSearchManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorSearchOrderController' => 'PhabricatorSearchBaseController',
     'PhabricatorSearchQuery' => 'PhabricatorSearchDAO',
     'PhabricatorSearchResultView' => 'AphrontView',
@@ -4574,7 +4576,7 @@
     'PhabricatorStorageManagementProbeWorkflow' => 'PhabricatorStorageManagementWorkflow',
     'PhabricatorStorageManagementStatusWorkflow' => 'PhabricatorStorageManagementWorkflow',
     'PhabricatorStorageManagementUpgradeWorkflow' => 'PhabricatorStorageManagementWorkflow',
-    'PhabricatorStorageManagementWorkflow' => 'PhutilArgumentWorkflow',
+    'PhabricatorStorageManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorSubscribersQuery' => 'PhabricatorQuery',
     'PhabricatorSubscriptionsEditController' => 'PhabricatorController',
     'PhabricatorSubscriptionsEditor' => 'PhabricatorEditor',

src/applications/audit/management/PhabricatorAuditManagementDeleteWorkflow.php

@@ -178,10 +178,6 @@ public function execute(PhutilArgumentParser $args) {
     return 0;
   }
 
-  private function getViewer() {
-    return PhabricatorUser::getOmnipotentUser();
-  }
-
   private function loadUsers($users) {
     $users = $this->parseList($users);
     if (!$users) {

src/applications/audit/management/PhabricatorAuditManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class PhabricatorAuditManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/auth/management/PhabricatorAuthManagementRecoverWorkflow.php

@@ -22,7 +22,7 @@ protected function didConstruct() {
   public function execute(PhutilArgumentParser $args) {
 
     $can_recover = id(new PhabricatorPeopleQuery())
-      ->setViewer(PhabricatorUser::getOmnipotentUser())
+      ->setViewer($this->getViewer())
       ->withIsAdmin(true)
       ->execute();
     if (!$can_recover) {
@@ -48,7 +48,7 @@ public function execute(PhutilArgumentParser $args) {
     $username = head($usernames);
 
     $user = id(new PhabricatorPeopleQuery())
-      ->setViewer(PhabricatorUser::getOmnipotentUser())
+      ->setViewer($this->getViewer())
       ->withUsernames(array($username))
       ->executeOne();
 

src/applications/auth/management/PhabricatorAuthManagementRefreshWorkflow.php

@@ -33,7 +33,7 @@ protected function didConstruct() {
 
   public function execute(PhutilArgumentParser $args) {
     $console = PhutilConsole::getConsole();
-    $viewer = PhabricatorUser::getOmnipotentUser();
+    $viewer = $this->getViewer();
 
     $query = id(new PhabricatorExternalAccountQuery())
       ->setViewer($viewer);

src/applications/auth/management/PhabricatorAuthManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class PhabricatorAuthManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  final public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/cache/management/PhabricatorCacheManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class PhabricatorCacheManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  final public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/config/management/PhabricatorConfigManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class PhabricatorConfigManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  final public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/daemon/management/PhabricatorDaemonManagementLogWorkflow.php

@@ -32,7 +32,7 @@ public function execute(PhutilArgumentParser $args) {
     $id = head($id);
 
     $daemon = id(new PhabricatorDaemonLogQuery())
-      ->setViewer(PhabricatorUser::getOmnipotentUser())
+      ->setViewer($this->getViewer())
       ->withIDs(array($id))
       ->executeOne();
 

src/applications/daemon/management/PhabricatorDaemonManagementWorkflow.php

@@ -1,11 +1,7 @@
 <?php
 
 abstract class PhabricatorDaemonManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
   protected function loadAvailableDaemonClasses() {
     $loader = new PhutilSymbolLoader();

src/applications/diviner/workflow/DivinerWorkflow.php

@@ -1,6 +1,6 @@
 <?php
 
-abstract class DivinerWorkflow extends PhutilArgumentWorkflow {
+abstract class DivinerWorkflow extends PhabricatorManagementWorkflow {
 
   private $config;
   private $bookConfigPath;
@@ -9,10 +9,6 @@ public function getBookConfigPath() {
     return $this->bookConfigPath;
   }
 
-  public function isExecutable() {
-    return true;
-  }
-
   protected function getConfig($key, $default = null) {
     return idx($this->config, $key, $default);
   }

src/applications/drydock/management/DrydockManagementCloseWorkflow.php

@@ -25,7 +25,7 @@ public function execute(PhutilArgumentParser $args) {
         "Specify one or more resource IDs to close.");
     }
 
-    $viewer = PhabricatorUser::getOmnipotentUser();
+    $viewer = $this->getViewer();
 
     $resources = id(new DrydockResourceQuery())
       ->setViewer($viewer)

src/applications/drydock/management/DrydockManagementCreateResourceWorkflow.php

@@ -49,7 +49,7 @@ public function execute(PhutilArgumentParser $args) {
       $attributes = $options->parse($attributes);
     }
 
-    $viewer = PhabricatorUser::getOmnipotentUser();
+    $viewer = $this->getViewer();
 
     $blueprint = id(new DrydockBlueprintQuery())
       ->setViewer($viewer)

src/applications/drydock/management/DrydockManagementReleaseWorkflow.php

@@ -25,7 +25,7 @@ public function execute(PhutilArgumentParser $args) {
         "Specify one or more lease IDs to release.");
     }
 
-    $viewer = PhabricatorUser::getOmnipotentUser();
+    $viewer = $this->getViewer();
 
     $leases = id(new DrydockLeaseQuery())
       ->setViewer($viewer)

src/applications/drydock/management/DrydockManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class DrydockManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/fact/management/PhabricatorFactManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class PhabricatorFactManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/feed/management/PhabricatorFeedManagementRepublishWorkflow.php

@@ -21,7 +21,7 @@ protected function didConstruct() {
 
   public function execute(PhutilArgumentParser $args) {
     $console = PhutilConsole::getConsole();
-    $viewer = PhabricatorUser::getOmnipotentUser();
+    $viewer = $this->getViewer();
 
     $key = $args->getArg('key');
     if (count($key) < 1) {

src/applications/feed/management/PhabricatorFeedManagementWorkflow.php

@@ -1,10 +1,6 @@
 <?php
 
 abstract class PhabricatorFeedManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  final public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
 }

src/applications/files/management/PhabricatorFilesManagementWorkflow.php

@@ -1,11 +1,7 @@
 <?php
 
 abstract class PhabricatorFilesManagementWorkflow
-  extends PhutilArgumentWorkflow {
-
-  public function isExecutable() {
-    return true;
-  }
+  extends PhabricatorManagementWorkflow {
 
   protected function buildIterator(PhutilArgumentParser $args) {
     $names = $args->getArg('names');
@@ -20,7 +16,7 @@ protected function buildIterator(PhutilArgumentParser $args) {
 
     if ($names) {
       $query = id(new PhabricatorObjectQuery())
-        ->setViewer(PhabricatorUser::getOmnipotentUser())
+        ->setViewer($this->getViewer())
         ->withNames($names)
         ->withTypes(array(PhabricatorFilePHIDTypeFile::TYPECONST));