1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
/**
* Test Rest response controller.
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Webapi\Test\Unit\Rest;
use Magento\Framework\Phrase;
class ResponseTest extends \PHPUnit\Framework\TestCase
{
/** @var \Magento\Framework\Webapi\Rest\Response */
protected $responseRest;
/** @var \Magento\Framework\App\State */
protected $appStateMock;
/** @var \Magento\Framework\Webapi\Rest\Response\Renderer\Xml */
protected $rendererMock;
/** @var \Magento\Framework\Webapi\ErrorProcessor */
protected $errorProcessorMock;
protected function setUp()
{
/** Mock all objects required for SUT. */
$this->rendererMock = $this->getMockBuilder(
\Magento\Framework\Webapi\Rest\Response\Renderer\Json::class
)->disableOriginalConstructor()->getMock();
$rendererFactoryMock = $this->getMockBuilder(
\Magento\Framework\Webapi\Rest\Response\RendererFactory::class
)->disableOriginalConstructor()->getMock();
$rendererFactoryMock->expects($this->any())->method('get')->will($this->returnValue($this->rendererMock));
$this->errorProcessorMock = $this->getMockBuilder(\Magento\Framework\Webapi\ErrorProcessor::class)
->disableOriginalConstructor()->getMock();
$this->appStateMock = $this->createMock(\Magento\Framework\App\State::class);
/** Init SUP. */
$this->responseRest = new \Magento\Framework\Webapi\Rest\Response(
$rendererFactoryMock,
$this->errorProcessorMock,
$this->appStateMock
);
}
protected function tearDown()
{
unset(
$this->responseRest,
$this->appStateMock,
$this->appStateMock,
$this->rendererMock,
$this->errorProcessorMock
);
}
/**
* Test setException method with \Magento\Framework\Webapi\Exception.
*/
public function testSetWebapiExceptionException()
{
/** Init \Magento\Framework\Webapi\Exception */
$apiException = new \Magento\Framework\Webapi\Exception(
new Phrase('Exception message.'),
0,
\Magento\Framework\Webapi\Exception::HTTP_UNAUTHORIZED
);
$this->responseRest->setException($apiException);
/** Assert that \Magento\Framework\Webapi\Exception was set and presented in the list. */
$this->assertTrue(
$this->responseRest->hasExceptionOfType(\Magento\Framework\Webapi\Exception::class),
'Magento\Framework\Webapi\Exception was not set.'
);
}
/**
* Test sendResponse method with internal error exception during messages rendering.
*/
public function testSendResponseRenderMessagesException()
{
/** Init logic exception. */
$logicException = new \LogicException();
/** Mock error processor to throw \LogicException in maskException method. */
$this->errorProcessorMock->expects(
$this->any()
)->method(
'maskException'
)->will(
$this->throwException($logicException)
);
/** Assert that renderException method will be executed once with specified parameters. */
$this->errorProcessorMock->expects(
$this->once()
)->method(
'renderException'
)->with(
$logicException,
\Magento\Framework\Webapi\Exception::HTTP_INTERNAL_ERROR
);
/** Set exception to Rest response to get in to the _renderMessages method. */
$this->responseRest->setException(new \Magento\Framework\Webapi\Exception(new Phrase('Message.')));
$this->responseRest->sendResponse();
}
/**
* Test sendResponse method with HTTP Not Acceptable error exception during messages rendering.
*/
public function testSendResponseRenderMessagesHttpNotAcceptable()
{
$exception = new \Magento\Framework\Webapi\Exception(
new Phrase('Message'),
0,
\Magento\Framework\Webapi\Exception::HTTP_NOT_ACCEPTABLE
);
/** Mock error processor to throw \LogicException in maskException method. */
$this->errorProcessorMock->expects(
$this->any()
)->method(
'maskException'
)->will(
$this->throwException($exception)
);
/** Assert that renderException method will be executed once with specified parameters. */
$this->errorProcessorMock->expects(
$this->once()
)->method(
'renderException'
)->with(
$exception,
\Magento\Framework\Webapi\Exception::HTTP_NOT_ACCEPTABLE
);
/** Set exception to Rest response to get in to the _renderMessages method. */
$this->responseRest->setException(
new \Magento\Framework\Webapi\Exception(
new Phrase('Message.'),
0,
\Magento\Framework\Webapi\Exception::HTTP_BAD_REQUEST
)
);
$this->responseRest->sendResponse();
}
/**
* Test sendResponse method with exception rendering.
*/
public function testSendResponseWithException()
{
/** Mock all required objects. */
$this->rendererMock->expects(
$this->any()
)->method(
'getMimeType'
)->will(
$this->returnValue('application/json')
);
$this->rendererMock->expects(
$this->any()
)->method(
'render'
)->will(
$this->returnCallback([$this, 'callbackForSendResponseTest'], $this->returnArgument(0))
);
$exceptionMessage = 'Message';
$exceptionHttpCode = \Magento\Framework\Webapi\Exception::HTTP_BAD_REQUEST;
$exception = new \Magento\Framework\Webapi\Exception(new Phrase($exceptionMessage), 0, $exceptionHttpCode);
$this->errorProcessorMock->expects(
$this->any()
)->method(
'maskException'
)->will(
$this->returnValue($exception)
);
$this->responseRest->setException($exception);
/** Start output buffering. */
ob_start();
$this->responseRest->sendResponse();
/** Clear output buffering. */
ob_end_clean();
$actualResponse = $this->responseRest->getBody();
$expectedResult = '{"message":"' .
$exceptionMessage .
'"}';
$this->assertStringStartsWith($expectedResult, $actualResponse, 'Response body is invalid');
}
/**
* Callback for testSendResponseRenderMessages method.
*
* @param $data
* @return string
*/
public function callbackForSendResponseTest($data)
{
return json_encode($data);
}
/**
* Test sendResponse method without any exception
*/
public function testSendResponseSuccessHandling()
{
$this->responseRest->sendResponse();
$this->assertTrue($this->responseRest->getHttpResponseCode() == \Magento\Framework\Webapi\Response::HTTP_OK);
}
public function testHasExceptionOfType()
{
$this->responseRest->setException(new \Exception());
$hasException = $this->responseRest->hasExceptionOfType('Exception');
$this->assertTrue($hasException);
}
public function testHasExceptionOfTypeIfExceptionsIsEmpty()
{
$this->responseRest->setException(new \Exception());
$hasException = $this->responseRest->hasExceptionOfType('Test\Exception');
$this->assertFalse($hasException);
}
}