mirror of
https://github.com/andres-montanez/Magallanes
synced 2024-05-31 12:53:16 +02:00
[Nostromo] Refactor FS Tasks flagging system
This commit is contained in:
parent
2c087ab477
commit
f6886f3d28
|
@ -2,6 +2,7 @@ CHANGELOG for 3.x
|
||||||
=================
|
=================
|
||||||
|
|
||||||
* 3.0.X (2017-XX-XX)
|
* 3.0.X (2017-XX-XX)
|
||||||
|
* [#344] Allow to flag Filesystem tasks
|
||||||
* [PR#346] Add new File System task, to change file's modes (fs/chmod)
|
* [PR#346] Add new File System task, to change file's modes (fs/chmod)
|
||||||
* [BUGFIX] [PR#342] Ignore empty exclude lines
|
* [BUGFIX] [PR#342] Ignore empty exclude lines
|
||||||
* [PR#330] Allow Composer task options to be overwritten at environment level
|
* [PR#330] Allow Composer task options to be overwritten at environment level
|
||||||
|
|
|
@ -48,33 +48,6 @@ abstract class AbstractFileTask extends AbstractTask
|
||||||
*/
|
*/
|
||||||
abstract protected function getParameters();
|
abstract protected function getParameters();
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the default "flags".
|
|
||||||
*
|
|
||||||
* @return null|string
|
|
||||||
*/
|
|
||||||
protected function getDefaultFlags()
|
|
||||||
{
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the flags for the current command.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
protected function getFlags()
|
|
||||||
{
|
|
||||||
$options = $this->getOptions();
|
|
||||||
$flags = $this->getDefaultFlags();
|
|
||||||
|
|
||||||
if (array_key_exists('flags', $options) && !empty($options['flags'])) {
|
|
||||||
$flags = trim($options['flags']);
|
|
||||||
}
|
|
||||||
|
|
||||||
return empty($flags) ? '' : $flags.' ';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a file with the placeholders replaced
|
* Returns a file with the placeholders replaced
|
||||||
*
|
*
|
||||||
|
|
|
@ -28,11 +28,7 @@ class ChangeModeTask extends AbstractFileTask
|
||||||
public function getDescription()
|
public function getDescription()
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
$description = sprintf('[FS] Change mode of "%s" to "%s"', $this->getFile('file'), $this->options['mode']);
|
return sprintf('[FS] Change mode of "%s" to "%s"', $this->getFile('file'), $this->options['mode']);
|
||||||
if ($this->options['flags'] != null) {
|
|
||||||
$description = sprintf('[FS] Change mode of "%s" to "%s" with flags "%s"', $this->getFile('file'), $this->options['mode'], $this->options['flags']);
|
|
||||||
}
|
|
||||||
return $description;
|
|
||||||
} catch (Exception $exception) {
|
} catch (Exception $exception) {
|
||||||
return '[FS] Chmod [missing parameters]';
|
return '[FS] Chmod [missing parameters]';
|
||||||
}
|
}
|
||||||
|
@ -40,7 +36,11 @@ class ChangeModeTask extends AbstractFileTask
|
||||||
|
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
$cmd = sprintf('chmod %s %s %s', $this->options['flags'], $this->options['mode'], $this->getFile('file'));
|
$file = $this->getFile('file');
|
||||||
|
$mode = $this->options['mode'];
|
||||||
|
$flags = $this->options['flags'];
|
||||||
|
|
||||||
|
$cmd = sprintf('chmod %s %s "%s"', $flags, $mode, $file);
|
||||||
|
|
||||||
/** @var Process $process */
|
/** @var Process $process */
|
||||||
$process = $this->runtime->runCommand($cmd);
|
$process = $this->runtime->runCommand($cmd);
|
||||||
|
|
|
@ -28,7 +28,7 @@ class CopyTask extends AbstractFileTask
|
||||||
public function getDescription()
|
public function getDescription()
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
return sprintf('[FS] Copy %s"%s" to "%s"', $this->getFlags(), $this->getFile('from'), $this->getFile('to'));
|
return sprintf('[FS] Copy "%s" to "%s"', $this->getFile('from'), $this->getFile('to'));
|
||||||
} catch (Exception $exception) {
|
} catch (Exception $exception) {
|
||||||
return '[FS] Copy [missing parameters]';
|
return '[FS] Copy [missing parameters]';
|
||||||
}
|
}
|
||||||
|
@ -38,10 +38,9 @@ class CopyTask extends AbstractFileTask
|
||||||
{
|
{
|
||||||
$copyFrom = $this->getFile('from');
|
$copyFrom = $this->getFile('from');
|
||||||
$copyTo = $this->getFile('to');
|
$copyTo = $this->getFile('to');
|
||||||
|
$flags = $this->options['flags'];
|
||||||
|
|
||||||
$flags = $this->getFlags();
|
$cmd = sprintf('cp %s "%s" "%s"', $flags, $copyFrom, $copyTo);
|
||||||
|
|
||||||
$cmd = sprintf('cp %s"%s" "%s"', $flags, $copyFrom, $copyTo);
|
|
||||||
|
|
||||||
/** @var Process $process */
|
/** @var Process $process */
|
||||||
$process = $this->runtime->runCommand($cmd);
|
$process = $this->runtime->runCommand($cmd);
|
||||||
|
@ -51,11 +50,11 @@ class CopyTask extends AbstractFileTask
|
||||||
|
|
||||||
protected function getParameters()
|
protected function getParameters()
|
||||||
{
|
{
|
||||||
return ['from', 'to'];
|
return ['from', 'to', 'flags'];
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function getDefaultFlags()
|
public function getDefaults()
|
||||||
{
|
{
|
||||||
return '-p';
|
return ['flags' => '-p'];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -28,7 +28,7 @@ class LinkTask extends AbstractFileTask
|
||||||
public function getDescription()
|
public function getDescription()
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
return sprintf('[FS] Link %s"%s" to "%s"', $this->getFlags(), $this->getFile('from'), $this->getFile('to'));
|
return sprintf('[FS] Link "%s" to "%s"', $this->getFile('from'), $this->getFile('to'));
|
||||||
} catch (Exception $exception) {
|
} catch (Exception $exception) {
|
||||||
return '[FS] Link [missing parameters]';
|
return '[FS] Link [missing parameters]';
|
||||||
}
|
}
|
||||||
|
@ -38,10 +38,9 @@ class LinkTask extends AbstractFileTask
|
||||||
{
|
{
|
||||||
$linkFrom = $this->getFile('from');
|
$linkFrom = $this->getFile('from');
|
||||||
$linkTo = $this->getFile('to');
|
$linkTo = $this->getFile('to');
|
||||||
|
$flags = $this->options['flags'];
|
||||||
|
|
||||||
$flags = $this->getFlags();
|
$cmd = sprintf('ln %s "%s" "%s"', $flags, $linkFrom, $linkTo);
|
||||||
|
|
||||||
$cmd = sprintf('ln %s"%s" "%s"', $flags, $linkFrom, $linkTo);
|
|
||||||
|
|
||||||
/** @var Process $process */
|
/** @var Process $process */
|
||||||
$process = $this->runtime->runCommand($cmd);
|
$process = $this->runtime->runCommand($cmd);
|
||||||
|
@ -51,11 +50,11 @@ class LinkTask extends AbstractFileTask
|
||||||
|
|
||||||
protected function getParameters()
|
protected function getParameters()
|
||||||
{
|
{
|
||||||
return ['from', 'to'];
|
return ['from', 'to', 'flags'];
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function getDefaultFlags()
|
public function getDefaults()
|
||||||
{
|
{
|
||||||
return '-snf';
|
return ['flags' => '-snf'];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -28,7 +28,7 @@ class MoveTask extends AbstractFileTask
|
||||||
public function getDescription()
|
public function getDescription()
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
return sprintf('[FS] Move %s"%s" to "%s"', $this->getFlags(), $this->getFile('from'), $this->getFile('to'));
|
return sprintf('[FS] Move "%s" to "%s"', $this->getFile('from'), $this->getFile('to'));
|
||||||
} catch (Exception $exception) {
|
} catch (Exception $exception) {
|
||||||
return '[FS] Move [missing parameters]';
|
return '[FS] Move [missing parameters]';
|
||||||
}
|
}
|
||||||
|
@ -38,9 +38,9 @@ class MoveTask extends AbstractFileTask
|
||||||
{
|
{
|
||||||
$moveFrom = $this->getFile('from');
|
$moveFrom = $this->getFile('from');
|
||||||
$moveTo = $this->getFile('to');
|
$moveTo = $this->getFile('to');
|
||||||
$flags = $this->getFlags();
|
$flags = $this->options['flags'];
|
||||||
|
|
||||||
$cmd = sprintf('mv %s"%s" "%s"', $flags, $moveFrom, $moveTo);
|
$cmd = sprintf('mv %s "%s" "%s"', $flags, $moveFrom, $moveTo);
|
||||||
|
|
||||||
/** @var Process $process */
|
/** @var Process $process */
|
||||||
$process = $this->runtime->runCommand($cmd);
|
$process = $this->runtime->runCommand($cmd);
|
||||||
|
@ -50,6 +50,11 @@ class MoveTask extends AbstractFileTask
|
||||||
|
|
||||||
protected function getParameters()
|
protected function getParameters()
|
||||||
{
|
{
|
||||||
return ['from', 'to'];
|
return ['from', 'to', 'flags'];
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getDefaults()
|
||||||
|
{
|
||||||
|
return ['flags' => null];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -28,7 +28,7 @@ class RemoveTask extends AbstractFileTask
|
||||||
public function getDescription()
|
public function getDescription()
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
return sprintf('[FS] Remove %s"%s"', $this->getFlags(), $this->getFile('file'));
|
return sprintf('[FS] Remove "%s"', $this->getFile('file'));
|
||||||
} catch (Exception $exception) {
|
} catch (Exception $exception) {
|
||||||
return '[FS] Remove [missing parameters]';
|
return '[FS] Remove [missing parameters]';
|
||||||
}
|
}
|
||||||
|
@ -37,9 +37,9 @@ class RemoveTask extends AbstractFileTask
|
||||||
public function execute()
|
public function execute()
|
||||||
{
|
{
|
||||||
$file = $this->getFile('file');
|
$file = $this->getFile('file');
|
||||||
$flags = $this->getFlags();
|
$flags = $this->options['flags'];
|
||||||
|
|
||||||
$cmd = sprintf('rm %s"%s"', $flags, $file);
|
$cmd = sprintf('rm %s "%s"', $flags, $file);
|
||||||
|
|
||||||
/** @var Process $process */
|
/** @var Process $process */
|
||||||
$process = $this->runtime->runCommand($cmd);
|
$process = $this->runtime->runCommand($cmd);
|
||||||
|
@ -49,6 +49,11 @@ class RemoveTask extends AbstractFileTask
|
||||||
|
|
||||||
protected function getParameters()
|
protected function getParameters()
|
||||||
{
|
{
|
||||||
return ['file'];
|
return ['file', 'flags'];
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getDefaults()
|
||||||
|
{
|
||||||
|
return ['flags' => null];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -29,14 +29,13 @@ class ChangeModeTest extends TestCase
|
||||||
$task->setRuntime($runtime);
|
$task->setRuntime($runtime);
|
||||||
|
|
||||||
$this->assertContains('a.txt', $task->getDescription());
|
$this->assertContains('a.txt', $task->getDescription());
|
||||||
$this->assertContains('-R', $task->getDescription());
|
|
||||||
$this->assertContains('o+w', $task->getDescription());
|
$this->assertContains('o+w', $task->getDescription());
|
||||||
$task->execute();
|
$task->execute();
|
||||||
|
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'chmod -R o+w a.txt',
|
0 => 'chmod -R o+w "a.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
@ -59,14 +58,13 @@ class ChangeModeTest extends TestCase
|
||||||
$task->setRuntime($runtime);
|
$task->setRuntime($runtime);
|
||||||
|
|
||||||
$this->assertContains('a.txt', $task->getDescription());
|
$this->assertContains('a.txt', $task->getDescription());
|
||||||
$this->assertNotContains('-R', $task->getDescription());
|
|
||||||
$this->assertContains('o+w', $task->getDescription());
|
$this->assertContains('o+w', $task->getDescription());
|
||||||
$task->execute();
|
$task->execute();
|
||||||
|
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'chmod o+w a.txt',
|
0 => 'chmod o+w "a.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
@ -89,14 +87,13 @@ class ChangeModeTest extends TestCase
|
||||||
$task->setRuntime($runtime);
|
$task->setRuntime($runtime);
|
||||||
|
|
||||||
$this->assertContains('test.txt', $task->getDescription());
|
$this->assertContains('test.txt', $task->getDescription());
|
||||||
$this->assertContains('-R', $task->getDescription());
|
|
||||||
$this->assertContains('o+w', $task->getDescription());
|
$this->assertContains('o+w', $task->getDescription());
|
||||||
$task->execute();
|
$task->execute();
|
||||||
|
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'chmod -R o+w test.txt',
|
0 => 'chmod -R o+w "test.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
|
|
@ -50,6 +50,35 @@ class FileSystemTaskTest extends TestCase
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testCopyTaskWithFlags()
|
||||||
|
{
|
||||||
|
$runtime = new RuntimeMockup();
|
||||||
|
$runtime->setConfiguration(['environments' => ['test' => []]]);
|
||||||
|
$runtime->setEnvironment('test');
|
||||||
|
|
||||||
|
$task = new CopyTask();
|
||||||
|
$task->setOptions(['from' => 'a.txt', 'to' => 'b.txt', 'flags' => '-rp']);
|
||||||
|
$task->setRuntime($runtime);
|
||||||
|
|
||||||
|
$this->assertContains('a.txt', $task->getDescription());
|
||||||
|
$this->assertContains('b.txt', $task->getDescription());
|
||||||
|
$task->execute();
|
||||||
|
|
||||||
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
|
$testCase = array(
|
||||||
|
0 => 'cp -rp "a.txt" "b.txt"',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Check total of Executed Commands
|
||||||
|
$this->assertEquals(count($testCase), count($ranCommands));
|
||||||
|
|
||||||
|
// Check Generated Commands
|
||||||
|
foreach ($testCase as $index => $command) {
|
||||||
|
$this->assertEquals($command, $ranCommands[$index]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public function testCopyReplaceTask()
|
public function testCopyReplaceTask()
|
||||||
{
|
{
|
||||||
$runtime = new RuntimeMockup();
|
$runtime = new RuntimeMockup();
|
||||||
|
@ -147,7 +176,36 @@ class FileSystemTaskTest extends TestCase
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'mv "a.txt" "b.txt"',
|
0 => 'mv "a.txt" "b.txt"',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Check total of Executed Commands
|
||||||
|
$this->assertEquals(count($testCase), count($ranCommands));
|
||||||
|
|
||||||
|
// Check Generated Commands
|
||||||
|
foreach ($testCase as $index => $command) {
|
||||||
|
$this->assertEquals($command, $ranCommands[$index]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testMoveWithFlagsTask()
|
||||||
|
{
|
||||||
|
$runtime = new RuntimeMockup();
|
||||||
|
$runtime->setConfiguration(['environments' => ['test' => []]]);
|
||||||
|
$runtime->setEnvironment('test');
|
||||||
|
|
||||||
|
$task = new MoveTask();
|
||||||
|
$task->setOptions(['from' => 'a.txt', 'to' => 'b.txt', 'flags' => '-n']);
|
||||||
|
$task->setRuntime($runtime);
|
||||||
|
|
||||||
|
$this->assertContains('a.txt', $task->getDescription());
|
||||||
|
$this->assertContains('b.txt', $task->getDescription());
|
||||||
|
$task->execute();
|
||||||
|
|
||||||
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
|
$testCase = array(
|
||||||
|
0 => 'mv -n "a.txt" "b.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
@ -176,7 +234,7 @@ class FileSystemTaskTest extends TestCase
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'mv "test.txt" "b.txt"',
|
0 => 'mv "test.txt" "b.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
@ -224,7 +282,7 @@ class FileSystemTaskTest extends TestCase
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'rm "a.txt"',
|
0 => 'rm "a.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
@ -280,7 +338,7 @@ class FileSystemTaskTest extends TestCase
|
||||||
$ranCommands = $runtime->getRanCommands();
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
$testCase = array(
|
$testCase = array(
|
||||||
0 => 'rm "test.txt"',
|
0 => 'rm "test.txt"',
|
||||||
);
|
);
|
||||||
|
|
||||||
// Check total of Executed Commands
|
// Check total of Executed Commands
|
||||||
|
@ -341,6 +399,35 @@ class FileSystemTaskTest extends TestCase
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testLinkTaskWithFlags()
|
||||||
|
{
|
||||||
|
$runtime = new RuntimeMockup();
|
||||||
|
$runtime->setConfiguration(['environments' => ['test' => []]]);
|
||||||
|
$runtime->setEnvironment('test');
|
||||||
|
|
||||||
|
$task = new LinkTask();
|
||||||
|
$task->setOptions(['from' => 'a.txt', 'to' => 'b.txt', 'flags' => '-P']);
|
||||||
|
$task->setRuntime($runtime);
|
||||||
|
|
||||||
|
$this->assertContains('a.txt', $task->getDescription());
|
||||||
|
$this->assertContains('b.txt', $task->getDescription());
|
||||||
|
$task->execute();
|
||||||
|
|
||||||
|
$ranCommands = $runtime->getRanCommands();
|
||||||
|
|
||||||
|
$testCase = array(
|
||||||
|
0 => 'ln -P "a.txt" "b.txt"',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Check total of Executed Commands
|
||||||
|
$this->assertEquals(count($testCase), count($ranCommands));
|
||||||
|
|
||||||
|
// Check Generated Commands
|
||||||
|
foreach ($testCase as $index => $command) {
|
||||||
|
$this->assertEquals($command, $ranCommands[$index]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public function testLinkReplaceTask()
|
public function testLinkReplaceTask()
|
||||||
{
|
{
|
||||||
$runtime = new RuntimeMockup();
|
$runtime = new RuntimeMockup();
|
||||||
|
|
Loading…
Reference in a new issue