MAGETWO-38070: Incorrect WSDL generation

- fixed CR comments
- added tests

Author: Eugene Tulika

app/code/Magento/Webapi/Test/Unit/Model/Soap/Config/ClassReflectorTest.php

@@ -49,10 +49,10 @@ public function testReflectClassMethods()
 
     public function testExtractMethodData()
     {
-        $classReflection = new \Zend\Server\Reflection\ReflectionClass(
-            new \ReflectionClass('\\Magento\\Webapi\\Test\\Unit\\Model\\Config\\TestServiceForClassReflector')
+        $classReflection = new \Zend\Code\Reflection\ClassReflection(
+            '\\Magento\\Webapi\\Test\\Unit\\Model\\Config\\TestServiceForClassReflector'
         );
-        /** @var $methodReflection ReflectionMethod */
+        /** @var $methodReflection \Zend\Code\Reflection\MethodReflection */
         $methodReflection = $classReflection->getMethods()[0];
         $methodData = $this->_classReflector->extractMethodData($methodReflection);
         $expectedResponse = $this->_getSampleReflectionData();

lib/internal/Magento/Framework/Reflection/Test/Unit/DataObject.php

@@ -20,6 +20,11 @@ class DataObject
      */
     protected $isActive;
 
+    /**
+     * @var string
+     */
+    private $name;
+
     /**
      * @return string
      */
@@ -55,4 +60,14 @@ public function setIsActive($isActive)
         $this->isActive = $isActive;
         return $this;
     }
+
+    /**
+     * @param null|string $name Name of the attribute
+     * @return $this
+     */
+    public function setName($name = null)
+    {
+        $this->name = $name;
+        return $this;
+    }
 }

lib/internal/Magento/Framework/Reflection/Test/Unit/TypeProcessorTest.php

@@ -213,4 +213,24 @@ public function testFindSetterMethodNameWrongCamelCasedAttribute()
         $class = new ClassReflection("\\Magento\\Framework\\Reflection\\Test\\Unit\\DataObject");
         $this->_typeProcessor->findSetterMethodName($class, 'ActivE');
     }
+
+    /**
+     * @expectedException \LogicException
+     * @expectedExceptionMessageRegExp /@param annotation is incorrect for the parameter "name" \w+/
+     */
+    public function testGetParamType()
+    {
+        $class = new ClassReflection("\\Magento\\Framework\\Reflection\\Test\\Unit\\DataObject");
+        $methodReflection = $class->getMethod('setName');
+        $paramsReflection = $methodReflection->getParameters();
+        $this->_typeProcessor->getParamType($paramsReflection[0]);
+    }
+
+    public function testGetParameterDescription()
+    {
+        $class = new ClassReflection("\\Magento\\Framework\\Reflection\\Test\\Unit\\DataObject");
+        $methodReflection = $class->getMethod('setName');
+        $paramsReflection = $methodReflection->getParameters();
+        $this->assertEquals('Name of the attribute', $this->_typeProcessor->getParamDescription($paramsReflection[0]));
+    }
 }

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

@@ -473,17 +473,18 @@ public function processSimpleAndAnyType($value, $type)
      *
      * @param ParameterReflection $param
      * @return string
-     * @throws \Exception
+     * @throws \LogicException
      */
     public function getParamType(ParameterReflection $param)
     {
         $type = $param->getType();
         if ($param->getType() == 'null') {
-            throw new \Exception(sprintf(
-                    'Type declaration is incorrect for the parameter "%s" in annotation for a method in the class "%s".'
+            throw new \LogicException(sprintf(
+                    '@param annotation is incorrect for the parameter "%s" in the method "%s:%s".'
                      . ' First declared type should not be null. E.g. string|null',
                     $param->getName(),
-                    $param->getDeclaringClass()->getName()
+                    $param->getDeclaringClass()->getName(),
+                    $param->getDeclaringFunction()->name
                 ));
         }
         if ($type == 'array') {
@@ -503,15 +504,19 @@ public function getParamType(ParameterReflection $param)
      * Get parameter description
      *
      * @param ParameterReflection $param
-     * @return mixed
+     * @return string|null
      */
     public function getParamDescription(ParameterReflection $param)
     {
         $docBlock = $param->getDeclaringFunction()->getDocBlock();
-        $pattern = "/\@param\s+([\w\\\_\[\]]+)\s+(\\\${$param->getName()})(.*)\n/";
+        $docBlockLines = explode("\n", $docBlock->getContents());
+        $pattern = "/\@param\s+([\w\\\_\[\]\|]+)\s+(\\\${$param->getName()})\s(.*)/";
         $matches = [];
-        if (preg_match($pattern, $docBlock->getContents(), $matches)) {
-            return $matches[3];
+
+        foreach ($docBlockLines as $line) {
+            if (preg_match($pattern, $line, $matches)) {
+                return $matches[3];
+            }
         }
     }