Skip to content

Commit 225623f

Browse files
marcozhengmarcozheng
committed
Merge remote-tracking branch 'origin/MAGETWO-30277-Improve-Web-API-Related-Code-Quality' into MAGETWO-30299-Reduce-Code-Complexity
2 parents 49c699e + dddbab8 commit 225623f

File tree

18 files changed

+84
-76
lines changed

18 files changed

+84
-76
lines changed

‎app/code/Magento/Bundle/composer.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
"magento/module-eav": "0.42.0-beta7",
1717
"magento/module-gift-message": "0.42.0-beta7",
1818
"magento/framework": "0.42.0-beta7",
19-
"magento/module-webapi": "0.42.0-beta7",
2019
"magento/module-quote": "0.42.0-beta7",
2120
"magento/magento-composer-installer": "*"
2221
},

‎app/code/Magento/ConfigurableProduct/Model/OptionRepository.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ public function save($productSku, \Magento\ConfigurableProduct\Api\Data\OptionIn
240240
*
241241
* @param string $productSku
242242
* @return \Magento\Catalog\Model\Product
243-
* @throws \Magento\Exception\InputException
243+
* @throws InputException
244244
*/
245245
private function getProduct($productSku)
246246
{

‎app/code/Magento/ConfigurableProduct/composer.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
"magento/module-catalog-rule": "0.42.0-beta7",
1616
"magento/module-directory": "0.42.0-beta7",
1717
"magento/framework": "0.42.0-beta7",
18-
"magento/module-webapi": "0.42.0-beta7",
1918
"magento/module-quote": "0.42.0-beta7",
2019
"magento/magento-composer-installer": "*"
2120
},

‎app/code/Magento/Webapi/Block/Adminhtml/Integration/Activate/Permissions/Tab/Webapi.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,38 +31,38 @@ class Webapi extends \Magento\Backend\Block\Widget\Form\Generic implements
3131
/** @var \Magento\Webapi\Model\Soap\Config */
3232
protected $_config;
3333

34-
/** @var \Magento\Core\Helper\Data */
35-
protected $_coreHelper;
34+
/** @var \Magento\Framework\Json\Encoder */
35+
protected $encoder;
3636

3737
/**
3838
* Initialize dependencies.
3939
*
4040
* @param \Magento\Backend\Block\Template\Context $context
4141
* @param \Magento\Framework\Registry $registry
4242
* @param \Magento\Framework\Data\FormFactory $formFactory
43-
* @param \Magento\Core\Helper\Data $coreHelper
4443
* @param \Magento\Framework\Acl\RootResource $rootResource
4544
* @param \Magento\Framework\Acl\Resource\ProviderInterface $resourceProvider
4645
* @param \Magento\Integration\Helper\Data $integrationData
4746
* @param \Magento\Webapi\Model\Soap\Config $config
47+
* @param \Magento\Framework\Json\Encoder $encoder
4848
* @param array $data
4949
*/
5050
public function __construct(
5151
\Magento\Backend\Block\Template\Context $context,
5252
\Magento\Framework\Registry $registry,
5353
\Magento\Framework\Data\FormFactory $formFactory,
54-
\Magento\Core\Helper\Data $coreHelper,
5554
\Magento\Framework\Acl\RootResource $rootResource,
5655
\Magento\Framework\Acl\Resource\ProviderInterface $resourceProvider,
5756
\Magento\Integration\Helper\Data $integrationData,
5857
\Magento\Webapi\Model\Soap\Config $config,
58+
\Magento\Framework\Json\Encoder $encoder,
5959
array $data = []
6060
) {
6161
$this->_rootResource = $rootResource;
6262
$this->_resourceProvider = $resourceProvider;
6363
$this->_integrationData = $integrationData;
6464
$this->_config = $config;
65-
$this->_coreHelper = $coreHelper;
65+
$this->encoder = $encoder;
6666
parent::__construct($context, $registry, $formFactory, $data);
6767
}
6868

@@ -133,7 +133,7 @@ public function getResourcesTreeJson()
133133
$resources = $this->_resourceProvider->getAclResources();
134134
$aclResourcesTree = $this->_integrationData->mapResources($resources[1]['children']);
135135

136-
return $this->_coreHelper->jsonEncode($aclResourcesTree);
136+
return $this->encoder->jsonEncode($aclResourcesTree);
137137
}
138138

139139
/**
@@ -150,7 +150,7 @@ public function getSelectedResourcesJson()
150150
$resources = $this->_resourceProvider->getAclResources();
151151
$selectedResources = $this->_getAllResourceIds($resources[1]['children']);
152152
}
153-
return $this->_coreHelper->jsonEncode($selectedResources);
153+
return $this->encoder->jsonEncode($selectedResources);
154154
}
155155

156156
/**

‎app/code/Magento/Webapi/Block/Adminhtml/Integration/Edit/Tab/Webapi.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ class Webapi extends \Magento\Backend\Block\Widget\Form\Generic implements
3232
/** @var \Magento\Integration\Helper\Data */
3333
protected $_integrationData;
3434

35-
/** @var \Magento\Webapi\Helper\Data */
36-
protected $_webapiData;
35+
/** @var \Magento\Webapi\Model\Soap\Config */
36+
protected $_webapiConfig;
3737

3838
/**
3939
* Initialize dependencies.
@@ -43,7 +43,7 @@ class Webapi extends \Magento\Backend\Block\Widget\Form\Generic implements
4343
* @param \Magento\Framework\Data\FormFactory $formFactory
4444
* @param \Magento\Framework\Acl\RootResource $rootResource
4545
* @param \Magento\Framework\Acl\Resource\ProviderInterface $aclResourceProvider
46-
* @param \Magento\Webapi\Helper\Data $webapiData
46+
* @param \Magento\Webapi\Model\Soap\Config $webapiConfig
4747
* @param \Magento\Integration\Helper\Data $integrationData
4848
* @param array $data
4949
*
@@ -55,13 +55,13 @@ public function __construct(
5555
\Magento\Framework\Data\FormFactory $formFactory,
5656
\Magento\Framework\Acl\RootResource $rootResource,
5757
\Magento\Framework\Acl\Resource\ProviderInterface $aclResourceProvider,
58-
\Magento\Webapi\Helper\Data $webapiData,
58+
\Magento\Webapi\Model\Soap\Config $webapiConfig,
5959
\Magento\Integration\Helper\Data $integrationData,
6060
array $data = []
6161
) {
6262
$this->_rootResource = $rootResource;
6363
$this->_aclResourceProvider = $aclResourceProvider;
64-
$this->_webapiData = $webapiData;
64+
$this->_webapiConfig = $webapiConfig;
6565
$this->_integrationData = $integrationData;
6666
parent::__construct($context, $registry, $formFactory, $data);
6767
}
@@ -117,7 +117,7 @@ public function isHidden()
117117
protected function _construct()
118118
{
119119
parent::_construct();
120-
$this->setSelectedResources($this->_webapiData->getSelectedResources());
120+
$this->setSelectedResources($this->_webapiConfig->getSelectedResources());
121121
}
122122

123123
/**

‎app/code/Magento/Webapi/Model/Soap/Config.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ public function getServiceName($interfaceName, $preserveVersion = true)
294294
* @throws \InvalidArgumentException When class is not valid API service.
295295
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
296296
*/
297-
private function getServiceNameParts($className, $preserveVersion = false)
297+
protected function getServiceNameParts($className, $preserveVersion = false)
298298
{
299299
if (!preg_match(\Magento\Webapi\Model\Config::SERVICE_CLASS_PATTERN, $className, $matches)) {
300300
$apiClassPattern = "#^(.+?)\\\\(.+?)\\\\Api\\\\(.+?)(Interface)?$#";

‎dev/tests/integration/testsuite/Magento/User/_files/user_with_role.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
$model = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create('Magento\User\Model\User');
1313
$model->setFirstname("John")
1414
->setLastname("Doe")
15-
->setUsername('adminUser2')
15+
->setUsername('adminUser')
1616
->setPassword(\Magento\TestFramework\Bootstrap::ADMIN_PASSWORD)
17-
->setEmail('adminUser2@example.com')
17+
->setEmail('adminUser@example.com')
1818
->setRoleType('G')
1919
->setResourceId('Magento_Backend::all')
2020
->setPrivileges("")

‎dev/tests/unit/testsuite/Magento/Framework/Webapi/ErrorProcessorTest.php

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ class ErrorProcessorTest extends \PHPUnit_Framework_TestCase
1616
/** @var ErrorProcessor */
1717
protected $_errorProcessor;
1818

19-
/** @var \Magento\Core\Helper\Data */
20-
protected $_helperMock;
19+
/** @var \Magento\Framework\Json\Encoder */
20+
protected $encoderMock;
2121

2222
/** @var \PHPUnit_Framework_MockObject_MockObject */
2323
protected $_appStateMock;
@@ -28,9 +28,10 @@ class ErrorProcessorTest extends \PHPUnit_Framework_TestCase
2828
protected function setUp()
2929
{
3030
/** Set up mocks for SUT. */
31-
$this->_helperMock = $this->getMockBuilder(
32-
'Magento\Core\Helper\Data'
33-
)->disableOriginalConstructor()->getMock();
31+
$this->encoderMock = $this->getMockBuilder('Magento\Framework\Json\Encoder')
32+
->disableOriginalConstructor()
33+
->setMethods(['jsonEncode'])
34+
->getMock();
3435

3536
$this->_appStateMock = $this->getMockBuilder('Magento\Framework\App\State')
3637
->disableOriginalConstructor()
@@ -44,7 +45,7 @@ protected function setUp()
4445

4546
/** Initialize SUT. */
4647
$this->_errorProcessor = new ErrorProcessor(
47-
$this->_helperMock,
48+
$this->encoderMock,
4849
$this->_appStateMock,
4950
$this->_loggerMock,
5051
$filesystemMock
@@ -56,7 +57,7 @@ protected function setUp()
5657
protected function tearDown()
5758
{
5859
unset($this->_errorProcessor);
59-
unset($this->_helperMock);
60+
unset($this->encoderMock);
6061
unset($this->_appStateMock);
6162
parent::tearDown();
6263
}
@@ -68,7 +69,7 @@ public function testRenderJson()
6869
{
6970
$_SERVER['HTTP_ACCEPT'] = 'json';
7071
/** Assert that jsonEncode method will be executed once. */
71-
$this->_helperMock->expects(
72+
$this->encoderMock->expects(
7273
$this->once()
7374
)->method(
7475
'jsonEncode'
@@ -107,7 +108,7 @@ public function testRenderJsonInDeveloperMode()
107108
/** Mock app to return enabled developer mode flag. */
108109
$this->_appStateMock->expects($this->any())->method('getMode')->will($this->returnValue('developer'));
109110
/** Assert that jsonEncode method will be executed once. */
110-
$this->_helperMock->expects(
111+
$this->encoderMock->expects(
111112
$this->once()
112113
)->method(
113114
'jsonEncode'
@@ -167,7 +168,7 @@ public function testRenderDefaultFormat()
167168
/** Set undefined rendering format. */
168169
$_SERVER['HTTP_ACCEPT'] = 'undefined';
169170
/** Assert that jsonEncode method will be executed at least once. */
170-
$this->_helperMock->expects($this->atLeastOnce())->method('jsonEncode');
171+
$this->encoderMock->expects($this->atLeastOnce())->method('jsonEncode');
171172
$this->_errorProcessor->renderErrorMessage('Message');
172173
}
173174

‎dev/tests/unit/testsuite/Magento/Framework/Webapi/Rest/Request/Deserializer/JsonTest.php

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,23 @@ class JsonTest extends \PHPUnit_Framework_TestCase
1515
/** @var \Magento\Framework\Webapi\Rest\Request\Deserializer\Json */
1616
protected $_jsonDeserializer;
1717

18-
/** @var \Magento\Core\Helper\Data */
19-
protected $_helperMock;
18+
/** @var \Magento\Framework\Json\Decoder */
19+
protected $decoderMock;
2020

2121
/** @var \PHPUnit_Framework_MockObject_MockObject */
2222
protected $_appStateMock;
2323

2424
protected function setUp()
2525
{
2626
/** Prepare mocks for SUT constructor. */
27-
$this->_helperMock = $this->getMockBuilder('Magento\Core\Helper\Data')->disableOriginalConstructor()->getMock();
27+
$this->decoderMock = $this->getMockBuilder('Magento\Framework\Json\Decoder')
28+
->disableOriginalConstructor()
29+
->setMethods(['jsonDecode'])
30+
->getMock();
2831
$this->_appStateMock = $this->getMock('Magento\Framework\App\State', [], [], '', false);
2932
/** Initialize SUT. */
3033
$this->_jsonDeserializer = new \Magento\Framework\Webapi\Rest\Request\Deserializer\Json(
31-
$this->_helperMock,
34+
$this->decoderMock,
3235
$this->_appStateMock
3336
);
3437
parent::setUp();
@@ -37,7 +40,7 @@ protected function setUp()
3740
protected function tearDown()
3841
{
3942
unset($this->_jsonDeserializer);
40-
unset($this->_helperMock);
43+
unset($this->decoderMock);
4144
unset($this->_appStateMock);
4245
parent::tearDown();
4346
}
@@ -57,7 +60,7 @@ public function testDeserialize()
5760
'key2' => 'test2',
5861
'array' => ['test01' => 'some1', 'test02' => 'some2'],
5962
];
60-
$this->_helperMock->expects(
63+
$this->decoderMock->expects(
6164
$this->once()
6265
)->method(
6366
'jsonDecode'
@@ -75,7 +78,7 @@ public function testDeserialize()
7578
public function testDeserializeInvalidEncodedBodyExceptionDeveloperModeOff()
7679
{
7780
/** Prepare mocks for SUT constructor. */
78-
$this->_helperMock->expects($this->once())
81+
$this->decoderMock->expects($this->once())
7982
->method('jsonDecode')
8083
->will($this->throwException(new \Zend_Json_Exception));
8184
$this->_appStateMock->expects($this->once())
@@ -100,7 +103,7 @@ public function testDeserializeInvalidEncodedBodyExceptionDeveloperModeOff()
100103
public function testDeserializeInvalidEncodedBodyExceptionDeveloperModeOn()
101104
{
102105
/** Prepare mocks for SUT constructor. */
103-
$this->_helperMock->expects(
106+
$this->decoderMock->expects(
104107
$this->once()
105108
)->method(
106109
'jsonDecode'

‎dev/tests/unit/testsuite/Magento/Framework/Webapi/Rest/RequestTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ public function testGetContentType($contentTypeHeader, $contentType, $exceptionM
151151

152152
try {
153153
$this->assertEquals($contentType, $this->_request->getContentType());
154-
} catch (\Magento\Framework\Webapi\Exception $e) {
154+
} catch (\Magento\Framework\Exception\InputException $e) {
155155
if ($exceptionMessage) {
156156
$this->assertEquals(
157157
$exceptionMessage,

0 commit comments

Comments
 (0)