Was added description to exceptions, annotations to properties and cl…

…asses. Implemented validation of exception message in unit test
vpodorozh · Oct 12, 2018 · 2f2cafe · 2f2cafe
1 parent a20968d
commit 2f2cafe
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 7 deletions.
diff --git a/lib/internal/Magento/Framework/Communication/Config/Validator.php b/lib/internal/Magento/Framework/Communication/Config/Validator.php
@@ -121,7 +121,7 @@ public function validateResponseHandlersType($serviceName, $methodName, $handler
      * @param string $typeName
      * @return $this
      * @throws \Exception In case when type is invalid
-     * @throws \InvalidArgumentException
+`     * @throws \InvalidArgumentException if methods don't have annotation
      */
     protected function validateType($typeName)
     {

diff --git a/lib/internal/Magento/Framework/Reflection/MethodsMap.php b/lib/internal/Magento/Framework/Reflection/MethodsMap.php
@@ -94,8 +94,8 @@ public function getMethodReturnType($typeName, $methodName)
      *  'validatePassword' => 'boolean'
      * ]
      * </pre>
-     * @throws \InvalidArgumentException
-     * @throws \ReflectionException
+     * @throws \InvalidArgumentException if methods don't have annotation
+     * @throws \ReflectionException for missing DocBock or invalid reflection class
      */
     public function getMethodsMap($interfaceName)
     {
@@ -150,8 +150,8 @@ public function getMethodParams($serviceClassName, $serviceMethodName)
      *
      * @param string $interfaceName
      * @return array
-     * @throws \ReflectionException
-     * @throws \InvalidArgumentException
+     * @throws \ReflectionException for missing DocBock or invalid reflection class
+     * @throws \InvalidArgumentException if methods don't have annotation
      */
     private function getMethodMapViaReflection($interfaceName)
     {

diff --git a/lib/internal/Magento/Framework/Test/Unit/Communication/Config/ValidatorTest.php b/lib/internal/Magento/Framework/Test/Unit/Communication/Config/ValidatorTest.php
@@ -1,14 +1,27 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 namespace Magento\Framework\Test\Unit\Communication\Config;
 
-
 use Magento\Framework\Communication\Config\Validator;
 use Magento\Framework\Reflection\MethodsMap;
 use Magento\Framework\Reflection\TypeProcessor;
 
+/**
+ * Unit test for \Magento\Framework\Communication\Config\Validator class
+ */
 class ValidatorTest extends \PHPUnit\Framework\TestCase
 {
+    /**
+     * @var TypeProcessor|\PHPUnit_Framework_MockObject_MockObject
+     */
     protected $typeProcessor;
+
+    /**
+     * @var MethodsMap|\PHPUnit_Framework_MockObject_MockObject
+     */
     protected $methodsMap;
 
     public function setUp()
@@ -19,7 +32,6 @@ public function setUp()
             ->method('getMethodsMap')
             ->will($this->throwException(new \InvalidArgumentException('message', 333)));
 
-
         $this->typeProcessor = $this->createMock(TypeProcessor::class);
         $this->typeProcessor->expects(static::any())
             ->method('isTypeSimple')
@@ -33,6 +45,7 @@ public function setUp()
     /**
      * @expectedException  \LogicException
      * @expectedExceptionCode 333
+     * @expectedExceptionMessage Response schema definition has service class with wrong annotated methods
      */
     public function testValidateResponseSchemaType()
     {
@@ -44,6 +57,7 @@ public function testValidateResponseSchemaType()
     /**
      * @expectedException  \LogicException
      * @expectedExceptionCode 333
+     * @expectedExceptionMessage Request schema definition has service class with wrong annotated methods
      */
     public function testValidateRequestSchemaType()
     {