Page MenuHomePhabricator
Files F15461216

D7519.id16978.diff
No OneTemporary
Actions

D7519.id16978.diff
View Options

Index: src/__phutil_library_map__.php
===================================================================
--- src/__phutil_library_map__.php
+++ src/__phutil_library_map__.php
@@ -2248,9 +2248,11 @@
'ReleephStatusFieldSpecification' => 'applications/releeph/field/specification/ReleephStatusFieldSpecification.php',
'ReleephSummaryFieldSpecification' => 'applications/releeph/field/specification/ReleephSummaryFieldSpecification.php',
'ReleephUserView' => 'applications/releeph/view/user/ReleephUserView.php',
+ 'RemoteCommandBuildStepImplementation' => 'applications/harbormaster/step/RemoteCommandBuildStepImplementation.php',
'SleepBuildStepImplementation' => 'applications/harbormaster/step/SleepBuildStepImplementation.php',
'SlowvoteEmbedView' => 'applications/slowvote/view/SlowvoteEmbedView.php',
'SlowvoteRemarkupRule' => 'applications/slowvote/remarkup/SlowvoteRemarkupRule.php',
+ 'VariableBuildStepImplementation' => 'applications/harbormaster/step/VariableBuildStepImplementation.php',
),
'function' =>
array(
@@ -4772,8 +4774,10 @@
'ReleephStatusFieldSpecification' => 'ReleephFieldSpecification',
'ReleephSummaryFieldSpecification' => 'ReleephFieldSpecification',
'ReleephUserView' => 'AphrontView',
+ 'RemoteCommandBuildStepImplementation' => 'VariableBuildStepImplementation',
'SleepBuildStepImplementation' => 'BuildStepImplementation',
'SlowvoteEmbedView' => 'AphrontView',
'SlowvoteRemarkupRule' => 'PhabricatorRemarkupRuleObject',
+ 'VariableBuildStepImplementation' => 'BuildStepImplementation',
),
));
Index: src/applications/harbormaster/controller/HarbormasterStepEditController.php
===================================================================
--- src/applications/harbormaster/controller/HarbormasterStepEditController.php
+++ src/applications/harbormaster/controller/HarbormasterStepEditController.php
@@ -63,6 +63,11 @@
$form = id(new AphrontFormView())
->setUser($viewer);
+ $instructions = $implementation->getSettingRemarkupInstructions();
+ if ($instructions !== null) {
+ $form->appendRemarkupInstructions($instructions);
+ }
+
// We need to render out all of the fields for the settings that
// the implementation has.
foreach ($implementation->getSettingDefinitions() as $name => $opt) {
Index: src/applications/harbormaster/step/BuildStepImplementation.php
===================================================================
--- src/applications/harbormaster/step/BuildStepImplementation.php
+++ src/applications/harbormaster/step/BuildStepImplementation.php
@@ -85,4 +85,11 @@
public function getSettingDefinitions() {
return array();
}
+
+ /**
+ * Return relevant setting instructions as Remarkup.
+ */
+ public function getSettingRemarkupInstructions() {
+ return null;
+ }
}
Index: src/applications/harbormaster/step/RemoteCommandBuildStepImplementation.php
===================================================================
--- /dev/null
+++ src/applications/harbormaster/step/RemoteCommandBuildStepImplementation.php
@@ -0,0 +1,112 @@
+<?php
+
+final class RemoteCommandBuildStepImplementation
+ extends VariableBuildStepImplementation {
+
+ public function getName() {
+ return pht('Run Remote Command');
+ }
+
+ public function getGenericDescription() {
+ return pht('Run a command on another machine.');
+ }
+
+ public function getDescription() {
+ $settings = $this->getSettings();
+
+ return pht(
+ 'Run \'%s\' on \'%s\'.',
+ $settings['command'],
+ $settings['sshhost']);
+ }
+
+ public function execute(HarbormasterBuild $build) {
+ $settings = $this->getSettings();
+
+ $parameters = array();
+ $variables = $this->retrieveVariablesFromBuild($build);
+ $command = $settings['command'];
+ preg_match_all(
+ "/\\\$\\{(?P<name>[a-z]+)\\}/",
+ $command,
+ $matches);
+ foreach ($matches["name"] as $match) {
+ $parameters[] = idx($variables, $match, "");
+ }
+ $command = preg_replace("/\\\$\\{(?P<name>[a-z]+)\\}/", "%s", $command);
+
+ $command = vcsprintf(
+ $command,
+ $parameters);
+
+ if (empty($settings['sshkey'])) {
+ list($err, $stdout, $stderr) = exec_manual(
+ 'ssh -o "StrictHostKeyChecking no" -p %s %s %s',
+ $settings['sshport'],
+ $settings['sshuser'].'@'.$settings['sshhost'],
+ $command);
+ } else {
+ list($err, $stdout, $stderr) = exec_manual(
+ 'ssh -o "StrictHostKeyChecking no" -p %s -i %s %s %s',
+ $settings['sshport'],
+ $settings['sshkey'],
+ $settings['sshuser'].'@'.$settings['sshhost'],
+ $command);
+ }
+
+ if ($err) {
+ // TODO: Create a log entry with the command output.
+ $build->setBuildStatus(HarbormasterBuild::STATUS_FAILED);
+ }
+ }
+
+ public function validateSettings() {
+ $settings = $this->getSettings();
+
+ if ($settings['command'] === null || !is_string($settings['command'])) {
+ return false;
+ }
+ if ($settings['sshhost'] === null || !is_string($settings['sshhost'])) {
+ return false;
+ }
+ if ($settings['sshuser'] === null || !is_string($settings['sshuser'])) {
+ return false;
+ }
+ if ($settings['sshkey'] === null || !is_string($settings['sshkey'])) {
+ return false;
+ }
+ if ($settings['sshport'] === null || !is_int($settings['sshport']) ||
+ $settings['sshport'] <= 0 || $settings['sshport'] >= 65536) {
+ return false;
+ }
+ return true;
+ }
+
+ public function getSettingDefinitions() {
+ return array(
+ 'command' => array(
+ 'name' => 'Command',
+ 'description' => 'The command to execute on the remote machine.',
+ 'type' => BuildStepImplementation::SETTING_TYPE_STRING),
+ 'sshhost' => array(
+ 'name' => 'SSH Host',
+ 'description' => 'The SSH host that the command will be run on.',
+ 'type' => BuildStepImplementation::SETTING_TYPE_STRING),
+ 'sshport' => array(
+ 'name' => 'SSH Port',
+ 'description' => 'The SSH port to connect to.',
+ 'type' => BuildStepImplementation::SETTING_TYPE_INTEGER,
+ 'default' => 22), // TODO: 'default' doesn't do anything yet..
+ 'sshuser' => array(
+ 'name' => 'SSH Username',
+ 'description' => 'The SSH username to use.',
+ 'type' => BuildStepImplementation::SETTING_TYPE_STRING),
+ 'sshkey' => array(
+ 'name' => 'SSH Identity File',
+ 'description' =>
+ 'The path to the SSH identity file (private key) '.
+ 'on the local web server.',
+ 'type' => BuildStepImplementation::SETTING_TYPE_STRING));
+ }
+
+}
Index: src/applications/harbormaster/step/VariableBuildStepImplementation.php
===================================================================
--- /dev/null
+++ src/applications/harbormaster/step/VariableBuildStepImplementation.php
@@ -0,0 +1,67 @@
+<?php
+
+abstract class VariableBuildStepImplementation extends BuildStepImplementation {
+
+ public function retrieveVariablesFromBuild(HarbormasterBuild $build) {
+ $results = array(
+ 'revision' => null,
+ 'commit' => null,
+ 'repository' => null,
+ 'vcs' => null,
+ 'uri' => null,
+ 'timestamp' => null);
+
+ $buildable = $build->getBuildable();
+ $object = $buildable->getBuildableObject();
+
+ $repo = null;
+ if ($object instanceof DifferentialRevision) {
+ $results['revision'] = $object->getID();
+ $repo = $object->getRepository();
+ } else if ($object instanceof PhabricatorRepositoryCommit) {
+ $results['commit'] = $object->getCommitIdentifier();
+ $repo = $object->getRepository();
+ }
+
+ $results['repository'] = $repo->getCallsign();
+ $results['vcs'] = $repo->getVersionControlSystem();
+ $results['uri'] = $repo->getPublicRemoteURI();
+ $results['timestamp'] = time();
+
+ return $results;
+ }
+
+ public function mergeVariables(HarbormasterBuild $build, $string) {
+ $variables = $this->retrieveVariablesFromBuild($build);
+ foreach ($variables as $name => $value) {
+ if ($value === null) {
+ $value = '';
+ }
+ $string = str_replace('${'.$name.'}', $value, $string);
+ }
+ return $string;
+ }
+
+ public function getAvailableVariables() {
+ return array(
+ 'revision' => pht('The differential revision ID, if applicable.'),
+ 'commit' => pht('The commit identifier, if applicable.'),
+ 'repository' => pht('The callsign of the repository in Phabricator.'),
+ 'vcs' => pht('The version control system, either "svn", "hg" or "git".'),
+ 'uri' => pht('The URI to clone or checkout the repository from.'),
+ 'timestamp' => pht('The current UNIX timestamp.'));
+ }
+
+ public function getSettingRemarkupInstructions() {
+ $text = '';
+ $text .= pht('The following variables are available: ')."\n";
+ $text .= "\n";
+ foreach ($this->getAvailableVariables() as $name => $desc) {
+ $text .= ' - `'.$name.'`: '.$desc."\n";
+ }
+ $text .= "\n";
+ $text .= "Use `\${name}` to merge a variable into a setting.";
+ return $text;
+ }
+
+}

File Metadata

Mime Type
text/plain
Expires
Wed, Apr 2, 6:16 AM (4 d, 13 h ago)
Storage Engine
blob
Storage Format
Encrypted (AES-256-CBC)
Storage Handle
7729314
Default Alt Text
D7519.id16978.diff (9 KB)

Event Timeline

Phabricator · Built by Phacility