ENGCOM-3753: Integration Test Framework AMQP Helper Flexibility #18978

Author: sidolov

dev/tests/integration/framework/Magento/TestFramework/Helper/Amqp.php

@@ -13,26 +13,63 @@
  */
 class Amqp
 {
+    const CONFIG_PATH_HOST = 'queue/amqp/host';
+    const CONFIG_PATH_USER = 'queue/amqp/user';
+    const CONFIG_PATH_PASSWORD = 'queue/amqp/password';
+    const DEFAULT_MANAGEMENT_PORT = '15672';
+
     /**
      * @var Curl
      */
     private $curl;
 
+    /**
+     * @var \Magento\Framework\App\DeploymentConfig
+     */
+    private $deploymentConfig;
+
     /**
      * RabbitMQ API host
      *
      * @var string
      */
-    private $host = 'http://localhost:15672/api/';
+    private $host;
 
     /**
      * Initialize dependencies.
+     * @param \Magento\Framework\App\DeploymentConfig $deploymentConfig
      */
-    public function __construct()
-    {
+    public function __construct(
+        \Magento\Framework\App\DeploymentConfig $deploymentConfig = null
+    ) {
+        $this->deploymentConfig = $deploymentConfig ?? \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
+            ->get(\Magento\Framework\App\DeploymentConfig::class);
         $this->curl = new Curl();
-        $this->curl->setCredentials('guest', 'guest');
+        $this->curl->setCredentials(
+            $this->deploymentConfig->get(self::CONFIG_PATH_USER),
+            $this->deploymentConfig->get(self::CONFIG_PATH_PASSWORD)
+        );
         $this->curl->addHeader('content-type', 'application/json');
+        $this->host = sprintf(
+            'http://%s:%s/api/',
+            $this->deploymentConfig->get(self::CONFIG_PATH_HOST),
+            defined('RABBITMQ_MANAGEMENT_PORT') ? RABBITMQ_MANAGEMENT_PORT : self::DEFAULT_MANAGEMENT_PORT
+        );
+    }
+
+    /**
+     * Check that the RabbitMQ instance has the management plugin installed and the api
+     * is available.
+     *
+     * @return bool
+     */
+    public function isAvailable(): bool
+    {
+        $this->curl->get($this->host . 'overview');
+        $data = $this->curl->getBody();
+        $data = json_decode($data, true);
+
+        return isset($data['management_version']);
     }
 
     /**

dev/tests/integration/framework/Magento/TestFramework/MessageQueue/PublisherConsumerController.php

@@ -80,6 +80,13 @@ public function initialize()
                 "This test relies on *nix shell and should be skipped in Windows environment."
             );
         }
+
+        if (!$this->amqpHelper->isAvailable()) {
+            throw new PreconditionFailedException(
+                'This test relies on RabbitMQ Management Plugin.'
+            );
+        }
+
         $connections = $this->amqpHelper->getConnections();
         foreach (array_keys($connections) as $connectionName) {
             $this->amqpHelper->deleteConnection($connectionName);

dev/tests/integration/phpunit.xml.dist

@@ -72,6 +72,8 @@
         <!-- Connection parameters for MongoDB library tests -->
         <!--<const name="MONGODB_CONNECTION_STRING" value="mongodb://localhost:27017"/>-->
         <!--<const name="MONGODB_DATABASE_NAME" value="magento_integration_tests"/>-->
+        <!-- Connection parameters for RabbitMQ tests -->
+        <!--<const name="RABBITMQ_MANAGEMENT_PORT" value="15672"/>-->
     </php>
     <!-- Test listeners -->
     <listeners>

dev/tests/integration/testsuite/Magento/Framework/MessageQueue/TopologyTest.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\MessageQueue;
 
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\MessageQueue\PreconditionFailedException;
+
 /**
  * @see dev/tests/integration/_files/Magento/TestModuleMessageQueueConfiguration
  * @see dev/tests/integration/_files/Magento/TestModuleMessageQueueConfigOverride
@@ -25,7 +28,12 @@ class TopologyTest extends \PHPUnit\Framework\TestCase
 
     protected function setUp()
     {
-        $this->helper = new \Magento\TestFramework\Helper\Amqp();
+        $this->helper = Bootstrap::getObjectManager()->create(\Magento\TestFramework\Helper\Amqp::class);
+
+        if (!$this->helper->isAvailable()) {
+            $this->fail('This test relies on RabbitMQ Management Plugin.');
+        }
+
         $this->declaredExchanges = $this->helper->getExchanges();
     }
 
@@ -39,6 +47,7 @@ public function testTopologyInstallation(array $expectedConfig, array $bindingCo
         $name = $expectedConfig['name'];
         $this->assertArrayHasKey($name, $this->declaredExchanges);
         unset($this->declaredExchanges[$name]['message_stats']);
+        unset($this->declaredExchanges[$name]['user_who_performed_action']);
         $this->assertEquals(
             $expectedConfig,
             $this->declaredExchanges[$name],