Added once feature

CHANGELOG.md

@@ -6,12 +6,14 @@
 ### Added
 - Added possibility to use callable when setting 'default_stage'
 - Added console init template for TYPO3 CMS [#1300]
+- Added possibility to run a task only once [#1311]
 - Added `git_recursive` option
 - Added `shallow` task option
 
 ### Removed 
 - Removed `terminate_message` option
 
+
 ## v5.1.3
 [v5.1.2...v5.1.3](https://github.com/deployphp/deployer/compare/v5.1.2...v5.1.3)
 
@@ -270,7 +272,7 @@
 
 ## v4.0.0
 🙄
-
+[#1311]: https://github.com/deployphp/deployer/pull/1311
 [#1300]: https://github.com/deployphp/deployer/pull/1300
 [#1290]: https://github.com/deployphp/deployer/pull/1290
 [#1283]: https://github.com/deployphp/deployer/pull/1283

src/Task/Task.php

@@ -61,6 +61,20 @@ class Task
      */
     private $private = false;
 
+    /**
+     * Mark task to run only once, of the first node from the pool
+     *
+     * @var bool
+     */
+    private $once = false;
+
+    /**
+     * Mark if the task has run at least once
+     *
+     * @var bool
+     */
+    private $hasRun = false;
+
     /**
      * Shallow task will not print execution message/finish massage.
      * Useful for success messages and info printing.
@@ -89,6 +103,10 @@ public function run(Context $context)
         // Call task
         call_user_func($this->callback);
 
+        if ($this->once) {
+            $this->hasRun = true;
+        }
+
         // Clear working_path
         if ($context->getConfig() !== null) {
             $context->getConfig()->set('working_path', false);
@@ -142,6 +160,17 @@ public function isLocal()
         return $this->local;
     }
 
+    public function once()
+    {
+        $this->once = true;
+        return $this;
+    }
+
+    public function isOnce()
+    {
+        return $this->once;
+    }
+
     /**
      * @param array $hosts
      * @return $this
@@ -180,6 +209,11 @@ public function onStage(...$stages)
      */
     public function shouldBePerformed(...$hosts)
     {
+        // don't allow to run again it the task has been marked to run only once
+        if ($this->once && $this->hasRun) {
+            return false;
+        }
+
         foreach ($hosts as $host) {
             $onHost = empty($this->on['hosts']) || in_array($host->getHostname(), $this->on['hosts'], true);
 

test/src/Task/TaskTest.php

@@ -40,6 +40,9 @@ public function testTask()
 
         $task->setPrivate();
         self::assertTrue($task->isPrivate());
+
+        $task->once();
+        self::assertTrue($task->isOnce());
     }
 
     public function testShouldBePerformed()
@@ -126,6 +129,38 @@ public function testInit()
         $task3->run($context);
         self::assertEquals(1, StubTask::$runned);
     }
+
+    public function testOnce()
+    {
+        $a = (new Host('a'))->stage('prod')->roles('app');
+        $b = (new Host('b'))->stage('prod')->roles('app');
+
+        $context = self::getMockBuilder(Context::class)->disableOriginalConstructor()->getMock();
+
+        // Test create task with [$object, 'method']
+        $mock = self::getMockBuilder('stdClass')
+            ->setMethods(['callback'])
+            ->getMock();
+
+        $task1 = new Task('only:once', [$mock, 'callback']);
+        $task1
+            ->onHosts('a', 'b')
+            ->once();
+        self::assertTrue($task1->shouldBePerformed($a));
+        self::assertEquals([true, true], array_map([$task1, 'shouldBePerformed'], [$a, $b]));
+        $task1->run($context);
+        self::assertFalse($task1->shouldBePerformed($b));
+        self::assertEquals([false, false], array_map([$task1, 'shouldBePerformed'], [$a, $b]));
+
+        $task2 = new Task('multiple:runs', [$mock, 'callback']);
+        $task2
+            ->onHosts('a', 'b');
+        self::assertTrue($task2->shouldBePerformed($a));
+        self::assertEquals([true, true], array_map([$task2, 'shouldBePerformed'], [$a, $b]));
+        $task2->run($context);
+        self::assertTrue($task2->shouldBePerformed($b));
+        self::assertEquals([true, true], array_map([$task2, 'shouldBePerformed'], [$a, $b]));
+    }
 }
 
 /**