Merge pull request #206 from magento-okapis/MAGETWO-54560-Split-Queue-Configs

[Okapis] Multiple Topics per Queue

Author: Oleksii Korshenko

dev/tests/api-functional/framework/bootstrap.php

@@ -20,34 +20,8 @@
 $logWriter->setFormatter(new \Zend_Log_Formatter_Simple('%message%' . PHP_EOL));
 $logger = new \Zend_Log($logWriter);
 
-/** Copy test modules to app/code/Magento to make them visible for Magento instance */
-$pathToCommittedTestModules = __DIR__ . '/../_files/Magento';
-$pathToInstalledMagentoInstanceModules = __DIR__ . '/../../../../app/code/Magento';
-$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($pathToCommittedTestModules));
-/** @var SplFileInfo $file */
-foreach ($iterator as $file) {
-    if (!$file->isDir()) {
-        $source = $file->getPathname();
-        $relativePath = substr($source, strlen($pathToCommittedTestModules));
-        $destination = $pathToInstalledMagentoInstanceModules . $relativePath;
-        $targetDir = dirname($destination);
-        if (!is_dir($targetDir)) {
-            mkdir($targetDir, 0755, true);
-        }
-        copy($source, $destination);
-    }
-}
-unset($iterator, $file);
-
-// Register the modules under '_files/'
-$pathPattern = $pathToInstalledMagentoInstanceModules . '/TestModule*/registration.php';
-$files = glob($pathPattern, GLOB_NOSORT);
-if ($files === false) {
-    throw new \RuntimeException('glob() returned error while searching in \'' . $pathPattern . '\'');
-}
-foreach ($files as $file) {
-    include $file;
-}
+$testFrameworkDir = __DIR__;
+require_once  __DIR__ . '/../../integration/framework/deployTestModules.php';
 
 /* Bootstrap the application */
 $settings = new \Magento\TestFramework\Bootstrap\Settings($testsBaseDir, get_defined_constants());

dev/tests/integration/_files/Magento/TestModuleSample/composer.json

@@ -0,0 +1,19 @@
+{
+  "name": "magento/module-sample-test",
+  "description": "test sample module",
+  "require": {
+    "php": "~5.6.0|7.0.2|7.0.4|~7.0.6",
+    "magento/framework": "100.1.*",
+    "magento/module-integration": "100.1.*"
+  },
+  "type": "magento2-module",
+  "version": "1.0",
+  "extra": {
+    "map": [
+      [
+        "*",
+        "Magento/TestModuleSample"
+      ]
+    ]
+  }
+}

dev/tests/integration/_files/Magento/TestModuleSample/etc/module.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+    <module name="Magento_TestModuleSample" setup_version="0.0.1" active="true">
+    </module>
+</config>

dev/tests/integration/_files/Magento/TestModuleSample/registration.php

@@ -0,0 +1,12 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\Framework\Component\ComponentRegistrar;
+
+$registrar = new ComponentRegistrar();
+if ($registrar->getPath(ComponentRegistrar::MODULE, 'Magento_TestModuleSample') === null) {
+    ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magento_TestModuleSample', __DIR__);
+}

dev/tests/integration/framework/bootstrap.php

@@ -15,6 +15,9 @@
     define('TESTS_TEMP_DIR', $testsBaseDir . '/tmp');
 }
 
+$testFrameworkDir = __DIR__;
+require_once 'deployTestModules.php';
+
 try {
     setCustomErrorHandler();
 

dev/tests/integration/framework/deployTestModules.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+/**
+ * @var $testFrameworkDir string - Must be defined in parent script.
+ */
+
+/** Copy test modules to app/code/Magento to make them visible for Magento instance */
+$pathToCommittedTestModules = $testFrameworkDir . '/../_files/Magento';
+$pathToInstalledMagentoInstanceModules = $testFrameworkDir . '/../../../../app/code/Magento';
+$iterator = new RecursiveIteratorIterator(
+    new RecursiveDirectoryIterator($pathToCommittedTestModules, RecursiveDirectoryIterator::FOLLOW_SYMLINKS)
+);
+/** @var SplFileInfo $file */
+foreach ($iterator as $file) {
+    if (!$file->isDir()) {
+        $source = $file->getPathname();
+        $relativePath = substr($source, strlen($pathToCommittedTestModules));
+        $destination = $pathToInstalledMagentoInstanceModules . $relativePath;
+        $targetDir = dirname($destination);
+        if (!is_dir($targetDir)) {
+            mkdir($targetDir, 0755, true);
+        }
+        copy($source, $destination);
+    }
+}
+unset($iterator, $file);
+
+// Register the modules under '_files/'
+$pathPattern = $pathToInstalledMagentoInstanceModules . '/TestModule*/registration.php';
+$files = glob($pathPattern, GLOB_NOSORT);
+if ($files === false) {
+    throw new \RuntimeException('glob() returned error while searching in \'' . $pathPattern . '\'');
+}
+foreach ($files as $file) {
+    include $file;
+}

dev/tests/integration/testsuite/Magento/TestModuleSample/ModuleInstallationTest.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestModuleSample;
+
+class ModuleInstallationTest extends \PHPUnit_Framework_TestCase
+{
+    public function testSampleModuleInstallation()
+    {
+        /** @var \Magento\Framework\Module\ModuleListInterface $moduleList */
+        $moduleList = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
+            \Magento\Framework\Module\ModuleListInterface::class
+        );
+        $this->assertTrue(
+            $moduleList->has('Magento_TestModuleSample'),
+            'Test module [Magento_TestModuleSample] is not installed'
+        );
+    }
+}

lib/internal/Magento/Framework/Communication/Config/ConfigParser.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Communication\Config;
+
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Phrase;
+
+/**
+ * Parser helper for communication-related configs.
+ */
+class ConfigParser
+{
+    const TYPE_NAME = 'typeName';
+    const METHOD_NAME = 'methodName';
+
+    /**
+     * Parse service method name.
+     *
+     * @param string $serviceMethod
+     * @return array Contains class name and method name
+     * @throws LocalizedException
+     */
+    public function parseServiceMethod($serviceMethod)
+    {
+        $pattern = '/^([a-zA-Z\\\\]+)::([a-zA-Z]+)$/';
+        preg_match($pattern, $serviceMethod, $matches);
+        if (!isset($matches[1]) || !isset($matches[2])) {
+            throw new LocalizedException(
+                new Phrase(
+                    'Service method "%serviceMethod" must match the following pattern: "%pattern"',
+                    ['serviceMethod' => $serviceMethod, 'pattern' => $pattern]
+                )
+            );
+        }
+        $className = $matches[1];
+        $methodName = $matches[2];
+        return [self::TYPE_NAME => $className, self::METHOD_NAME => $methodName];
+    }
+}

lib/internal/Magento/Framework/Communication/Config/Reader/XmlReader/Converter.php

@@ -9,13 +9,18 @@
 use Magento\Framework\Phrase;
 use Magento\Framework\Communication\Config\ReflectionGenerator;
 use Magento\Framework\Stdlib\BooleanUtils;
+use Magento\Framework\Communication\Config\ConfigParser;
 use Magento\Framework\Communication\Config\Reader\XmlReader\Validator;
 
 /**
  * Converts Communication config from \DOMDocument to array
  */
 class Converter implements \Magento\Framework\Config\ConverterInterface
 {
+    /**
+     * @deprecated
+     * @see ConfigParser::SERVICE_METHOD_NAME_PATTERN
+     */
     const SERVICE_METHOD_NAME_PATTERN = '/^([a-zA-Z\\\\]+)::([a-zA-Z]+)$/';
 
     /**
@@ -33,6 +38,11 @@ class Converter implements \Magento\Framework\Config\ConverterInterface
      */
     private $xmlValidator;
 
+    /**
+     * @var ConfigParser
+     */
+    private $configParser;
+
     /**
      * Initialize dependencies
      *
@@ -50,6 +60,21 @@ public function __construct(
         $this->xmlValidator = $xmlValidator;
     }
 
+    /**
+     * The getter function to get the new ConfigParser dependency.
+     *
+     * @return \Magento\Framework\Communication\Config\ConfigParser
+     * @deprecated
+     */
+    private function getConfigParser()
+    {
+        if ($this->configParser === null) {
+            $this->configParser = \Magento\Framework\App\ObjectManager::getInstance()
+                ->get(\Magento\Framework\Communication\Config\ConfigParser::class);
+        }
+        return $this->configParser;
+    }
+
     /**
      * Convert dom node tree to array
      *
@@ -81,8 +106,8 @@ protected function extractTopics($config)
             $serviceMethod = $this->getServiceMethodBySchema($topicNode);
             $requestResponseSchema = $serviceMethod
                 ? $this->reflectionGenerator->extractMethodMetadata(
-                    $serviceMethod['typeName'],
-                    $serviceMethod['methodName']
+                    $serviceMethod[ConfigParser::TYPE_NAME],
+                    $serviceMethod[ConfigParser::METHOD_NAME]
                 )
                 : null;
             $requestSchema = $this->extractTopicRequestSchema($topicNode);
@@ -104,8 +129,8 @@ protected function extractTopics($config)
             if ($serviceMethod) {
                 $output[$topicName] = $this->reflectionGenerator->generateTopicConfigForServiceMethod(
                     $topicName,
-                    $serviceMethod['typeName'],
-                    $serviceMethod['methodName'],
+                    $serviceMethod[ConfigParser::TYPE_NAME],
+                    $serviceMethod[ConfigParser::METHOD_NAME],
                     $handlers
                 );
             } else if ($requestSchema && $responseSchema) {
@@ -213,7 +238,8 @@ protected function getServiceMethodBySchema($topicNode)
             return null;
         }
         $topicName = $topicAttributes->getNamedItem('name')->nodeValue;
-        return $this->parseServiceMethod($topicAttributes->getNamedItem('schema')->nodeValue, $topicName);
+        $serviceMethod = $topicAttributes->getNamedItem('schema')->nodeValue;
+        return $this->parseServiceMethod($serviceMethod, $topicName);
     }
 
     /**
@@ -225,10 +251,13 @@ protected function getServiceMethodBySchema($topicNode)
      */
     protected function parseServiceMethod($serviceMethod, $topicName)
     {
-        preg_match(self::SERVICE_METHOD_NAME_PATTERN, $serviceMethod, $matches);
-        $className = $matches[1];
-        $methodName = $matches[2];
-        $this->xmlValidator->validateServiceMethod($serviceMethod, $topicName, $className, $methodName);
-        return ['typeName' => $className, 'methodName' => $methodName];
+        $parsedServiceMethod = $this->getConfigParser()->parseServiceMethod($serviceMethod);
+        $this->xmlValidator->validateServiceMethod(
+            $serviceMethod,
+            $topicName,
+            $parsedServiceMethod[ConfigParser::TYPE_NAME],
+            $parsedServiceMethod[ConfigParser::METHOD_NAME]
+        );
+        return $parsedServiceMethod;
     }
 }

lib/internal/Magento/Framework/Communication/ConfigInterface.php

@@ -41,7 +41,7 @@ interface ConfigInterface
      * Get configuration of the specified topic.
      *
      * @param string $topicName
-     * @return string[]
+     * @return array
      * @throws LocalizedException
      */
     public function getTopic($topicName);