MAGETWO-31901: Implement Attributes Mapping to Data Interfaces

- Refactored Soap WSDL generation to add custom attribute complex types in WSDL schema Types based on available interfaces
- Added new Test to verify against test service

Author: anupdugar

app/code/Magento/Webapi/Model/Config/ClassReflector.php

@@ -94,7 +94,7 @@ public function extractMethodData(ReflectionMethod $method)
         /** @var \Zend\Server\Reflection\ReflectionParameter $parameter */
         foreach ($prototype->getParameters() as $parameter) {
             $parameterData = [
-                'type' => $this->_typeProcessor->process($parameter->getType()),
+                'type' => $this->_typeProcessor->register($parameter->getType()),
                 'required' => !$parameter->isOptional(),
                 'documentation' => $parameter->getDescription(),
             ];
@@ -105,7 +105,7 @@ public function extractMethodData(ReflectionMethod $method)
         }
         if ($prototype->getReturnType() != 'void' && $prototype->getReturnType() != 'null') {
             $methodData['interface']['out']['parameters']['result'] = [
-                'type' => $this->_typeProcessor->process($prototype->getReturnType()),
+                'type' => $this->_typeProcessor->register($prototype->getReturnType()),
                 'documentation' => $prototype->getReturnValue()->getDescription(),
                 'required' => true,
             ];

app/code/Magento/Webapi/Model/Soap/Wsdl/Generator.php

@@ -48,6 +48,11 @@ class Generator
      */
     protected $storeManager;
 
+    /**
+     * @var array
+     */
+    protected $customAttributeMapArray = null;
+
     /**
      * Initialize dependencies.
      *
@@ -62,13 +67,15 @@ public function __construct(
         Factory $wsdlFactory,
         \Magento\Webapi\Model\Cache\Type $cache,
         \Magento\Framework\Reflection\TypeProcessor $typeProcessor,
-        \Magento\Store\Model\StoreManagerInterface $storeManager
+        \Magento\Store\Model\StoreManagerInterface $storeManager,
+        \Magento\Framework\Api\CustomAttributeMap $customAttributeMap
     ) {
         $this->_apiConfig = $apiConfig;
         $this->_wsdlFactory = $wsdlFactory;
         $this->_cache = $cache;
         $this->_typeProcessor = $typeProcessor;
         $this->storeManager = $storeManager;
+        $this->customAttributeMapArray = array_values($customAttributeMap->getData());
     }
 
     /**
@@ -114,6 +121,8 @@ protected function _generate($requestedServices, $endPointUrl)
         $wsdl = $this->_wsdlFactory->create(self::WSDL_NAME, $endPointUrl);
         $wsdl->addSchemaTypeSection();
         $faultMessageName = $this->_addGenericFaultComplexTypeNodes($wsdl);
+        $wsdl = $this->addCustomAttributeTypes($wsdl);
+
         foreach ($requestedServices as $serviceClass => $serviceData) {
             $portTypeName = $this->getPortTypeName($serviceClass);
             $bindingName = $this->getBindingName($serviceClass);
@@ -159,6 +168,21 @@ protected function _generate($requestedServices, $endPointUrl)
         return $wsdl->toXML();
     }
 
+    /**
+     * Create and add WSDL Types for complex custom attribute classes
+     *
+     * @param \Magento\Webapi\Model\Soap\Wsdl $wsdl
+     * @return \Magento\Webapi\Model\Soap\Wsdl
+     */
+    protected function addCustomAttributeTypes($wsdl)
+    {
+        foreach ($this->customAttributeMapArray as $customAttributeClass) {
+            $typeName = $this->_typeProcessor->register($customAttributeClass);
+            $wsdl->addComplexType($typeName);
+        }
+        return $wsdl;
+    }
+
     /**
      * Create input message and corresponding element and complex types in WSDL.
      *

app/code/Magento/Webapi/etc/di.xml

@@ -52,4 +52,9 @@
             <argument name="cache" xsi:type="object">Magento\Webapi\Model\Cache\Type</argument>
         </arguments>
     </type>
+    <type name="Magento\Webapi\Model\Soap\Config">
+        <arguments>
+            <argument name="customAttributeMap" xsi:type="object">Magento\Framework\Api\CustomAttributeMap</argument>
+        </arguments>
+    </type>
 </config>

dev/tests/api-functional/testsuite/Magento/Webapi/CustomAttributeTypeWsdlGenerationTest.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Webapi;
+
+use Magento\TestFramework\Helper\Bootstrap;
+
+/**
+ * Test WSDL generation mechanisms.
+ */
+class CustomAttributeTypeWsdlGenerationTest extends \Magento\TestFramework\TestCase\WebapiAbstract
+{
+    /** @var string */
+    protected $_baseUrl = TESTS_BASE_URL;
+
+    /** @var string */
+    protected $_storeCode;
+
+    /** @var string */
+    protected $_soapUrl;
+
+    protected function setUp()
+    {
+        $this->_markTestAsSoapOnly("WSDL generation tests are intended to be executed for SOAP adapter only.");
+        $this->_storeCode = Bootstrap::getObjectManager()->get('Magento\Store\Model\StoreManagerInterface')
+            ->getStore()->getCode();
+        $this->_soapUrl = "{$this->_baseUrl}/soap/{$this->_storeCode}?services=testModuleMSCAllSoapAndRestV1";
+        parent::setUp();
+    }
+
+    public function testCustomAttributeTypesInWsdl()
+    {
+        /** @var $soapAdapter \Magento\TestFramework\TestCase\Webapi\Adapter\Soap */
+        $soapAdapter = $this->_getWebApiAdapter(self::ADAPTER_SOAP);
+        $soapClient = $soapAdapter->instantiateSoapClient($this->_soapUrl);
+        $types = $soapClient->getTypes();
+
+        $testCustomTypeCount = 0;
+        foreach ($types as $type) {
+            if (strpos($type, 'TestModuleMSCDataCustomAttributeDataObjectInterface') !== false ||
+                strpos($type, 'TestModuleMSCDataCustomAttributeNestedDataObjectInterface') !== false
+            ) {
+                $testCustomTypeCount++;
+            }
+        }
+
+        $this->assertEquals(
+            2,
+            $testCustomTypeCount,
+            'Incorrect count for Custom attribute types. Found "' . $testCustomTypeCount . ' type(s)" expected 2.'
+        );
+    }
+}

lib/internal/Magento/Framework/Api/CustomAttributeMap.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\Api;
+
+use Magento\Framework\Object;
+
+/**
+ * Marker Class of type Magento/Framework/Object for storing all Custom Attribute Interfaces
+ */
+class CustomAttributeMap extends Object
+{
+}

lib/internal/Magento/Framework/Reflection/TypeProcessor.php

@@ -112,10 +112,10 @@ public function setTypeData($typeName, $data)
      * Process type name. In case parameter type is a complex type (class) - process its properties.
      *
      * @param string $type
-     * @return string
+     * @return string Complex type name
      * @throws \LogicException
      */
-    public function process($type)
+    public function register($type)
     {
         $typeName = $this->normalizeType($type);
         if (!$this->isTypeSimple($typeName) && !$this->isTypeAny($typeName)) {
@@ -150,7 +150,7 @@ protected function _processComplexType($class)
         $typeName = $this->translateTypeName($class);
         $this->_types[$typeName] = [];
         if ($this->isArrayType($class)) {
-            $this->process($this->getArrayItemType($class));
+            $this->register($this->getArrayItemType($class));
         } else {
             if (!(class_exists($class) || interface_exists($class))) {
                 throw new \InvalidArgumentException(
@@ -189,7 +189,7 @@ protected function _processMethod(\Zend\Code\Reflection\MethodReflection $method
             $returnMetadata = $this->getGetterReturnType($methodReflection);
             $fieldName = $this->dataObjectGetterNameToFieldName($methodReflection->getName());
             $this->_types[$typeName]['parameters'][$fieldName] = [
-                'type' => $this->process($returnMetadata['type']),
+                'type' => $this->register($returnMetadata['type']),
                 'required' => $returnMetadata['isRequired'],
                 'documentation' => $returnMetadata['description'],
             ];