MAGETWO-93161: Fix Problems with Consumer Runners on Cloud Clusters

Author: Bohdan Korablov

app/code/Magento/MessageQueue/Model/Cron/ConsumersRunner.php

@@ -139,6 +139,8 @@ private function canBeRun($consumerName, array $allowedConsumers = [])
      */
     private function getPidFilePath($consumerName)
     {
-        return $consumerName . static::PID_FILE_EXT;
+        $sanitizedHostname = preg_replace('/[^a-zA-Z0-9]/i', '', gethostname());
+
+        return $consumerName . '-' . $sanitizedHostname . static::PID_FILE_EXT;
     }
 }

app/code/Magento/MessageQueue/Test/Unit/Model/Cron/ConsumersRunnerTest.php

@@ -51,6 +51,8 @@ class ConsumersRunnerTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUp()
     {
+        require_once __DIR__ . '/../../_files/consumers_runner_functions_mocks.php';
+
         $this->phpExecutableFinderMock = $this->getMockBuilder(phpExecutableFinder::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -116,7 +118,7 @@ public function testRun(
         $isRunExpects
     ) {
         $consumerName = 'consumerName';
-        $pidFilePath = 'consumerName.pid';
+        $pidFilePath = 'consumerName-myHostName.pid';
 
         $this->deploymentConfigMock->expects($this->exactly(3))
             ->method('get')
@@ -164,7 +166,7 @@ public function runDataProvider()
                 'isRun' => false,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=20000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=20000'],
                 'allowedConsumers' => [],
                 'shellBackgroundExpects' => 1,
                 'isRunExpects' => 1,
@@ -174,7 +176,7 @@ public function runDataProvider()
                 'isRun' => false,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=10000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=10000'],
                 'allowedConsumers' => [],
                 'shellBackgroundExpects' => 1,
                 'isRunExpects' => 1,
@@ -184,7 +186,7 @@ public function runDataProvider()
                 'isRun' => false,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=10000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=10000'],
                 'allowedConsumers' => ['someConsumer'],
                 'shellBackgroundExpects' => 0,
                 'isRunExpects' => 0,
@@ -194,7 +196,7 @@ public function runDataProvider()
                 'isRun' => true,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=10000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=10000'],
                 'allowedConsumers' => ['someConsumer'],
                 'shellBackgroundExpects' => 0,
                 'isRunExpects' => 0,
@@ -204,7 +206,7 @@ public function runDataProvider()
                 'isRun' => true,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=10000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=10000'],
                 'allowedConsumers' => [],
                 'shellBackgroundExpects' => 0,
                 'isRunExpects' => 1,
@@ -214,7 +216,7 @@ public function runDataProvider()
                 'isRun' => true,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=10000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=10000'],
                 'allowedConsumers' => ['consumerName'],
                 'shellBackgroundExpects' => 0,
                 'isRunExpects' => 1,
@@ -224,7 +226,7 @@ public function runDataProvider()
                 'isRun' => false,
                 'php' => '',
                 'command' => 'php '. BP . '/bin/magento queue:consumers:start %s %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid', '--max-messages=10000'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid', '--max-messages=10000'],
                 'allowedConsumers' => ['consumerName'],
                 'shellBackgroundExpects' => 1,
                 'isRunExpects' => 1,
@@ -234,7 +236,7 @@ public function runDataProvider()
                 'isRun' => false,
                 'php' => '/bin/php',
                 'command' => '/bin/php '. BP . '/bin/magento queue:consumers:start %s %s',
-                'arguments' => ['consumerName', '--pid-file-path=consumerName.pid'],
+                'arguments' => ['consumerName', '--pid-file-path=consumerName-myHostName.pid'],
                 'allowedConsumers' => ['consumerName'],
                 'shellBackgroundExpects' => 1,
                 'isRunExpects' => 1,

app/code/Magento/MessageQueue/Test/Unit/_files/consumers_runner_functions_mocks.php

@@ -0,0 +1,14 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\MessageQueue\Model\Cron;
+
+/**
+ * @return string
+ */
+function gethostname()
+{
+    return 'myHost@Name';
+}