Merge remote-tracking branch 'api/MAGETWO-31785-Bug-ExceptionCustomerGroupsSearch' into combined

Olexii Korshenko · Olexii Korshenko · commit ff389b8faac6 · 2014-12-16T16:45:39.000+02:00
diff --git a/app/code/Magento/Webapi/Controller/Rest/Request/Deserializer/Json.php b/app/code/Magento/Webapi/Controller/Rest/Request/Deserializer/Json.php
@@ -36,7 +36,7 @@ public function __construct(\Magento\Core\Helper\Data $helper, State $appState)
      * @param string $encodedBody Posted content from request.
      * @return array|null Return NULL if content is invalid.
      * @throws \InvalidArgumentException
-     * @throws \Magento\Webapi\Exception If decoding error occurs or in case of empty argument type
+     * @throws \Magento\Webapi\Exception If decoding error was encountered.
      */
     public function deserialize($encodedBody)
     {
@@ -45,9 +45,6 @@ public function deserialize($encodedBody)
                 sprintf('"%s" data type is invalid. String is expected.', gettype($encodedBody))
             );
         }
-        if (empty($encodedBody)) {
-            throw new \Magento\Webapi\Exception(__('Request body should not be empty.'));
-        }
         try {
             $decodedBody = $this->_helper->jsonDecode($encodedBody);
         } catch (\Zend_Json_Exception $e) {
diff --git a/app/code/Magento/Webapi/Controller/Rest/Request/Deserializer/Xml.php b/app/code/Magento/Webapi/Controller/Rest/Request/Deserializer/Xml.php
@@ -41,7 +41,7 @@ public function __construct(\Magento\Framework\Xml\Parser $xmlParser, State $app
      * @param string $xmlRequestBody XML document
      * @return array Data converted from XML document to array. Root node is excluded from response.
      * @throws \InvalidArgumentException In case of invalid argument type.
-     * @throws \Magento\Webapi\Exception If decoding error occurs or in case of empty argument type
+     * @throws \Magento\Webapi\Exception If decoding error occurs.
      */
     public function deserialize($xmlRequestBody)
     {
@@ -50,9 +50,6 @@ public function deserialize($xmlRequestBody)
                 sprintf('"%s" data type is invalid. String is expected.', gettype($xmlRequestBody))
             );
         }
-        if (empty($xmlRequestBody)) {
-            throw new \Magento\Webapi\Exception(__('Request body is expected.'));
-        }
         /** Disable external entity loading to prevent possible vulnerability */
         $previousLoaderState = libxml_disable_entity_loader(true);
         set_error_handler([$this, 'handleErrors']);
diff --git a/app/code/Magento/Webapi/Controller/ServiceArgsSerializer.php b/app/code/Magento/Webapi/Controller/ServiceArgsSerializer.php
@@ -10,6 +10,7 @@
 use Magento\Framework\Api\AttributeValue;
 use Magento\Framework\Api\Config\Reader as ServiceConfigReader;
 use Magento\Framework\Api\SimpleDataObjectConverter;
+use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\SerializationException;
 use Magento\Framework\Reflection\TypeProcessor;
 use Magento\Framework\Serialization\DataBuilderFactory;
@@ -71,6 +72,7 @@ public function __construct(
      * @param string $serviceMethodName name of the method that we are trying to call
      * @param array $inputArray data to send to method in key-value format
      * @return array list of parameters that can be used to call the service method
+     * @throws InputException if no value is provided for required parameters
      */
     public function getInputData($serviceClassName, $serviceMethodName, array $inputArray)
     {
@@ -82,6 +84,7 @@ public function getInputData($serviceClassName, $serviceMethodName, array $input
         $params = $serviceMethod->getParameters();
 
         $inputData = [];
+        $inputError = [];
         foreach ($params as $param) {
             $paramName = $param->getName();
             $snakeCaseParamName = strtolower(preg_replace("/(?<=\\w)(?=[A-Z])/", "_$1", $paramName));
@@ -93,7 +96,21 @@ public function getInputData($serviceClassName, $serviceMethodName, array $input
                 $paramType = $this->getParamType($param);
                 $inputData[] = $this->_convertValue($paramValue, $paramType);
             } else {
-                $inputData[] = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
+                if ($param->isDefaultValueAvailable()) {
+                    $inputData[] = $param->getDefaultValue();
+                } else {
+                    $inputError[] = $paramName;
+                }
+            }
+        }
+
+        if (!empty($inputError)) {
+            $exception = new InputException();
+            foreach ($inputError as $errorParamField) {
+                $exception->addError(InputException::REQUIRED_FIELD, ['fieldName' => $errorParamField]);
+            }
+            if ($exception->wasErrorAdded()) {
+                throw $exception;
             }
         }
 
diff --git a/dev/tests/api-functional/_files/Magento/TestModule5/Service/V1/AllSoapAndRestInterface.php b/dev/tests/api-functional/_files/Magento/TestModule5/Service/V1/AllSoapAndRestInterface.php
@@ -41,14 +41,14 @@ public function update(\Magento\TestModule5\Service\V1\Entity\AllSoapAndRest $en
     /**
      * Update existing item.
      *
-     * @param string $firstId
-     * @param string $secondId
+     * @param string $parentId
+     * @param string $entityId
      * @param \Magento\TestModule5\Service\V1\Entity\AllSoapAndRest $entityItem
      * @return \Magento\TestModule5\Service\V1\Entity\AllSoapAndRest
      */
     public function nestedUpdate(
-        $firstId,
-        $secondId,
+        $parentId,
+        $entityId,
         \Magento\TestModule5\Service\V1\Entity\AllSoapAndRest $entityItem
     );
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/AccountManagementTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/AccountManagementTest.php
@@ -323,6 +323,42 @@ public function testValidateResetPasswordLinkTokenInvalidToken()
         }
     }
 
+    public function testInitiatePasswordMissingRequiredFields()
+    {
+        $this->_markTestAsRestOnly('Soap clients explicitly check for required fields based on WSDL.');
+        $serviceInfo = [
+            'rest' => [
+                'resourcePath' => self::RESOURCE_PATH . '/password',
+                'httpMethod' => RestConfig::HTTP_METHOD_PUT,
+            ]
+        ];
+
+        try {
+            $this->_webApiCall($serviceInfo);
+        } catch (\Exception $e) {
+            $this->assertEquals(\Magento\Webapi\Exception::HTTP_BAD_REQUEST, $e->getCode());
+            $exceptionData = $this->processRestExceptionResult($e);
+            $expectedExceptionData = [
+                'message' => InputException::DEFAULT_MESSAGE,
+                'errors' => [
+                    [
+                        'message' => InputException::REQUIRED_FIELD,
+                        'parameters' => [
+                            'fieldName' => 'email',
+                        ],
+                    ],
+                    [
+                        'message' => InputException::REQUIRED_FIELD,
+                        'parameters' => [
+                            'fieldName' => 'template',
+                        ]
+                    ],
+                ],
+            ];
+            $this->assertEquals($expectedExceptionData, $exceptionData);
+        }
+    }
+
     public function testInitiatePasswordReset()
     {
         $customerData = $this->_createCustomer();
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/CustomerRepositoryTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/CustomerRepositoryTest.php
@@ -6,6 +6,7 @@
 
 use Magento\Customer\Api\Data\CustomerInterface as Customer;
 use Magento\Framework\Api\SearchCriteria;
+use Magento\Framework\Exception\InputException;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\Helper\Customer as CustomerHelper;
 use Magento\TestFramework\TestCase\WebapiAbstract;
@@ -392,6 +393,33 @@ public function testSearchCustomersUsingGET()
         $this->assertEquals($customerData[Customer::ID], $searchResults['items'][0][Customer::ID]);
     }
 
+    /**
+     * Test with empty GET based filter
+     */
+    public function testSearchCustomersUsingGETEmptyFilter()
+    {
+        $this->_markTestAsRestOnly('Soap clients explicitly check for required fields based on WSDL.');
+        $serviceInfo = [
+            'rest' => [
+                'resourcePath' => self::RESOURCE_PATH . '/search',
+                'httpMethod' => RestConfig::HTTP_METHOD_GET,
+            ],
+        ];
+        try {
+            $this->_webApiCall($serviceInfo);
+        } catch (\Exception $e) {
+            $this->assertEquals(HTTPExceptionCodes::HTTP_BAD_REQUEST, $e->getCode());
+            $exceptionData = $this->processRestExceptionResult($e);
+            $expectedExceptionData = [
+                'message' => InputException::REQUIRED_FIELD,
+                'parameters' => [
+                    'fieldName' => 'searchCriteria'
+                ],
+            ];
+            $this->assertEquals($expectedExceptionData, $exceptionData);
+        }
+    }
+
     /**
      * Test using multiple filters
      */
diff --git a/dev/tests/api-functional/testsuite/Magento/Webapi/DeserializationTest.php b/dev/tests/api-functional/testsuite/Magento/Webapi/DeserializationTest.php
@@ -38,10 +38,11 @@ public function testPostRequestWithEmptyBody()
                 'httpMethod' => RestConfig::HTTP_METHOD_POST,
             ],
         ];
-        $expectedMessage = 'Request body should not be empty.';
+        $expectedMessage = '{"message":"%fieldName is a required field.","parameters":{"fieldName":"item"}}';
         try {
             $this->_webApiCall($serviceInfo, CurlClient::EMPTY_REQUEST_BODY);
         } catch (\Exception $e) {
+            $this->assertEquals(\Magento\Webapi\Exception::HTTP_BAD_REQUEST, $e->getCode());
             $this->assertContains(
                 $expectedMessage,
                 $e->getMessage(),
@@ -63,10 +64,11 @@ public function testPutRequestWithEmptyBody()
                 'httpMethod' => RestConfig::HTTP_METHOD_PUT,
             ],
         ];
-        $expectedMessage = 'Request body should not be empty.';
+        $expectedMessage = '{"message":"%fieldName is a required field.","parameters":{"fieldName":"entityItem"}}';
         try {
             $this->_webApiCall($serviceInfo, CurlClient::EMPTY_REQUEST_BODY);
         } catch (\Exception $e) {
+            $this->assertEquals(\Magento\Webapi\Exception::HTTP_BAD_REQUEST, $e->getCode());
             $this->assertContains(
                 $expectedMessage,
                 $e->getMessage(),
diff --git a/dev/tests/unit/testsuite/Magento/Webapi/Controller/Rest/Request/Deserializer/JsonTest.php b/dev/tests/unit/testsuite/Magento/Webapi/Controller/Rest/Request/Deserializer/JsonTest.php
@@ -47,12 +47,6 @@ public function testDeserializerInvalidArgumentException()
         $this->_jsonDeserializer->deserialize(false);
     }
 
-    public function testDeserializerOauthInputException()
-    {
-        $this->setExpectedException('\Magento\Webapi\Exception', 'Request body should not be empty.');
-        $this->_jsonDeserializer->deserialize('');
-    }
-
     public function testDeserialize()
     {
         /** Prepare mocks for SUT constructor. */
@@ -82,7 +76,7 @@ public function testDeserializeInvalidEncodedBodyExceptionDeveloperModeOff()
         /** Prepare mocks for SUT constructor. */
         $this->_helperMock->expects($this->once())
             ->method('jsonDecode')
-            ->will($this->throwException(new \Zend_Json_Exception()));
+            ->will($this->throwException(new \Zend_Json_Exception));
         $this->_appStateMock->expects($this->once())
             ->method('getMode')
             ->will($this->returnValue('production'));
diff --git a/dev/tests/unit/testsuite/Magento/Webapi/Controller/Rest/Request/Deserializer/XmlTest.php b/dev/tests/unit/testsuite/Magento/Webapi/Controller/Rest/Request/Deserializer/XmlTest.php
@@ -42,12 +42,6 @@ public function testDeserializeInvalidArgumentException()
         $this->_xmlDeserializer->deserialize(false);
     }
 
-    public function testDeserializerOauthInputException()
-    {
-        $this->setExpectedException('\Magento\Webapi\Exception', 'Request body is expected.');
-        $this->_xmlDeserializer->deserialize('');
-    }
-
     public function testDeserialize()
     {
         /** Prepare mocks for SUT constructor. */

Original file line number	Diff line number	Diff line change
`@@ -42,12 +42,6 @@ public function testDeserializeInvalidArgumentException()`
`42`	`42`	`$this->_xmlDeserializer->deserialize(false);`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function testDeserializerOauthInputException()`
`46`		`- {`
`47`		`- $this->setExpectedException('\Magento\Webapi\Exception', 'Request body is expected.');`
`48`		`- $this->_xmlDeserializer->deserialize('');`
`49`		`- }`
`50`		`-`
`51`	`45`	`public function testDeserialize()`
`52`	`46`	`{`
`53`	`47`	`/** Prepare mocks for SUT constructor. */`