Support to manage multiple instances in the same crontab, based on in…

…stallation directory
magento · Oct 13, 2017 · 79e9054 · 79e9054
1 parent 9b87eb0
commit 79e9054
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 41 deletions.
diff --git a/app/code/Magento/Cron/etc/di.xml b/app/code/Magento/Cron/etc/di.xml
@@ -43,7 +43,7 @@
             </argument>
         </arguments>
     </type>
-    <type name="Magento\Framework\Crontab\CrontabManager">
+    <type name="Magento\Framework\Crontab\CrontabManagerInterface">
         <arguments>
             <argument name="shell" xsi:type="object">Magento\Framework\App\Shell</argument>
         </arguments>

diff --git a/lib/internal/Magento/Framework/Crontab/CrontabManager.php b/lib/internal/Magento/Framework/Crontab/CrontabManager.php
@@ -5,11 +5,11 @@
  */
 namespace Magento\Framework\Crontab;
 
-use Magento\Framework\ShellInterface;
-use Magento\Framework\Phrase;
+use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filesystem;
-use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Phrase;
+use Magento\Framework\ShellInterface;
 
 /**
  * Manager works with cron tasks
@@ -38,14 +38,38 @@ public function __construct(
         $this->filesystem = $filesystem;
     }
 
+    /**
+     * @return string
+     */
+    private function getTasksBlockStart()
+    {
+        $tasksBlockStart = self::TASKS_BLOCK_START;
+        if (defined('BP')) {
+            $tasksBlockStart .= ' ' . md5(BP);
+        }
+        return $tasksBlockStart;
+    }
+
+    /**
+     * @return string
+     */
+    private function getTasksBlockEnd()
+    {
+        $tasksBlockEnd = self::TASKS_BLOCK_END;
+        if (defined('BP')) {
+            $tasksBlockEnd .= ' ' . md5(BP);
+        }
+        return $tasksBlockEnd;
+    }
+
     /**
      * {@inheritdoc}
      */
     public function getTasks()
     {
         $this->checkSupportedOs();
         $content = $this->getCrontabContent();
-        $pattern = '!(' . self::TASKS_BLOCK_START . ')(.*?)(' . self::TASKS_BLOCK_END . ')!s';
+        $pattern = '!(' . $this->getTasksBlockStart() . ')(.*?)(' . $this->getTasksBlockEnd() . ')!s';
 
         if (preg_match($pattern, $content, $matches)) {
             $tasks = trim($matches[2], PHP_EOL);
@@ -61,14 +85,14 @@ public function getTasks()
      */
     public function saveTasks(array $tasks)
     {
-        $this->checkSupportedOs();
-        $baseDir = $this->filesystem->getDirectoryRead(DirectoryList::ROOT)->getAbsolutePath();
-        $logDir = $this->filesystem->getDirectoryRead(DirectoryList::LOG)->getAbsolutePath();
-
         if (!$tasks) {
             throw new LocalizedException(new Phrase('List of tasks is empty'));
         }
 
+        $this->checkSupportedOs();
+        $baseDir = $this->filesystem->getDirectoryRead(DirectoryList::ROOT)->getAbsolutePath();
+        $logDir = $this->filesystem->getDirectoryRead(DirectoryList::LOG)->getAbsolutePath();
+
         foreach ($tasks as $key => $task) {
             if (empty($task['expression'])) {
                 $tasks[$key]['expression'] = '* * * * *';
@@ -114,11 +138,11 @@ public function removeTasks()
     private function generateSection($content, $tasks = [])
     {
         if ($tasks) {
-            $content .= self::TASKS_BLOCK_START . PHP_EOL;
+            $content .= $this->getTasksBlockStart() . PHP_EOL;
             foreach ($tasks as $task) {
-                $content .=  $task['expression'] . ' ' . PHP_BINARY . ' '. $task['command'] . PHP_EOL;
+                $content .= $task['expression'] . ' ' . PHP_BINARY . ' ' . $task['command'] . PHP_EOL;
             }
-            $content .= self::TASKS_BLOCK_END . PHP_EOL;
+            $content .= $this->getTasksBlockEnd() . PHP_EOL;
         }
 
         return $content;
@@ -133,7 +157,8 @@ private function generateSection($content, $tasks = [])
     private function cleanMagentoSection($content)
     {
         $content = preg_replace(
-            '!' . preg_quote(self::TASKS_BLOCK_START) . '.*?' . preg_quote(self::TASKS_BLOCK_END . PHP_EOL) . '!s',
+            '!' . preg_quote($this->getTasksBlockStart()) . '.*?'
+            . preg_quote($this->getTasksBlockEnd() . PHP_EOL) . '!s',
             '',
             $content
         );
@@ -192,7 +217,7 @@ private function checkSupportedOs()
     {
         if (stripos(PHP_OS, 'WIN') === 0) {
             throw new LocalizedException(
-                new Phrase('Your operation system is not supported to work with this command')
+                new Phrase('Your operating system is not supported to work with this command')
             );
         }
     }

diff --git a/lib/internal/Magento/Framework/Crontab/Test/Unit/CrontabManagerTest.php b/lib/internal/Magento/Framework/Crontab/Test/Unit/CrontabManagerTest.php
@@ -5,15 +5,15 @@
  */
 namespace Magento\Framework\Crontab\Test\Unit;
 
+use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Crontab\CrontabManager;
 use Magento\Framework\Crontab\CrontabManagerInterface;
-use Magento\Framework\ShellInterface;
-use Magento\Framework\Phrase;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filesystem;
-use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Filesystem\Directory\ReadInterface;
 use Magento\Framework\Filesystem\DriverPool;
+use Magento\Framework\Phrase;
+use Magento\Framework\ShellInterface;
 
 class CrontabManagerTest extends \PHPUnit\Framework\TestCase
 {
@@ -87,17 +87,17 @@ public function getTasksDataProvider()
         return [
             [
                 'content' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * /bin/php /var/www/magento/bin/magento cron:run' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
                 'tasks' => ['* * * * * /bin/php /var/www/magento/bin/magento cron:run'],
             ],
             [
                 'content' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * /bin/php /var/www/magento/bin/magento cron:run' . PHP_EOL
                     . '* * * * * /bin/php /var/www/magento/bin/magento setup:cron:run' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
                 'tasks' => [
                     '* * * * * /bin/php /var/www/magento/bin/magento cron:run',
                     '* * * * * /bin/php /var/www/magento/bin/magento setup:cron:run',
@@ -165,17 +165,17 @@ public function removeTasksDataProvider()
         return [
             [
                 'contentBefore' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * /bin/php /var/www/magento/bin/magento cron:run' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
                 'contentAfter' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
             ],
             [
                 'contentBefore' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * /bin/php /var/www/magento/bin/magento cron:run' . PHP_EOL
                     . '* * * * * /bin/php /var/www/magento/bin/magento setup:cron:run' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
                 'contentAfter' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
             ],
             [
@@ -198,14 +198,12 @@ public function testSaveTasksWithEmptyTasksList()
     {
         $baseDirMock = $this->getMockBuilder(ReadInterface::class)
             ->getMockForAbstractClass();
-        $baseDirMock->expects($this->once())
-            ->method('getAbsolutePath')
-            ->willReturn('/var/www/magento2/');
+        $baseDirMock->expects($this->never())
+            ->method('getAbsolutePath');
         $logDirMock = $this->getMockBuilder(ReadInterface::class)
             ->getMockForAbstractClass();
-        $logDirMock->expects($this->once())
-            ->method('getAbsolutePath')
-            ->willReturn('/var/www/magento2/var/log/');
+        $logDirMock->expects($this->never())
+            ->method('getAbsolutePath');
 
         $this->filesystemMock->expects($this->any())
             ->method('getDirectoryRead')
@@ -292,9 +290,9 @@ public function testSaveTasks($tasks, $content, $contentToSave)
     public function saveTasksDataProvider()
     {
         $content = '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-            . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+            . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
             . '* * * * * /bin/php /var/www/magento/bin/magento cron:run' . PHP_EOL
-            . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL;
+            . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL;
 
         return [
             [
@@ -303,41 +301,41 @@ public function saveTasksDataProvider()
                 ],
                 'content' => $content,
                 'contentToSave' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * ' . PHP_BINARY . ' run.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
             ],
             [
                 'tasks' => [
                     ['expression' => '1 2 3 4 5', 'command' => 'run.php']
                 ],
                 'content' => $content,
                 'contentToSave' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '1 2 3 4 5 ' . PHP_BINARY . ' run.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
             ],
             [
                 'tasks' => [
                     ['command' => '{magentoRoot}run.php >> {magentoLog}cron.log']
                 ],
                 'content' => $content,
                 'contentToSave' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * ' . PHP_BINARY . ' /var/www/magento2/run.php >>'
                     . ' /var/www/magento2/var/log/cron.log' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
             ],
             [
                 'tasks' => [
                     ['command' => '{magentoRoot}run.php % cron:run | grep -v "Ran \'jobs\' by schedule"']
                 ],
                 'content' => $content,
                 'contentToSave' => '* * * * * /bin/php /var/www/cron.php' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_START . PHP_EOL
+                    . CrontabManagerInterface::TASKS_BLOCK_START . ' ' . md5(BP) . PHP_EOL
                     . '* * * * * ' . PHP_BINARY . ' /var/www/magento2/run.php'
                     . ' %% cron:run | grep -v \"Ran \'jobs\' by schedule\"' . PHP_EOL
-                    . CrontabManagerInterface::TASKS_BLOCK_END . PHP_EOL,
+                    . CrontabManagerInterface::TASKS_BLOCK_END . ' ' . md5(BP) . PHP_EOL,
             ],
         ];
     }