ClientTest::generateSoapFault() - Code Metrics - Inspection of "Merge pull request #8 from Werkspot/LauLaman-patch..." - Werkspot/BingAdsApiBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3624f7...34c464 )

by Winfred

created 2016-04-19 08:51 UTC

ClientTest::generateSoapFault() B

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	24
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes	5
Bugs	0	Features	1

Metric	Value
c	5
b	0
f	1
dl	0
loc	24
rs	8.9713
cc	3
eloc	20
nc	3
nop	2

<?php
namespace Test\Werkspot\BingAdsApiBundle\Api;

use BingAds\Bulk\ReportTimePeriod;
use BingAds\Proxy\ClientProxy;
use GuzzleHttp\Client as GuzzleClient;
use Mockery;
use Mockery\MockInterface;
use PHPUnit_Framework_TestCase;
use SoapFault;
use stdClass;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Werkspot\BingAdsApiBundle\Api\Client;
use Werkspot\BingAdsApiBundle\Api\Exceptions;
use Werkspot\BingAdsApiBundle\Api\Helper;
use Werkspot\BingAdsApiBundle\Guzzle\OauthTokenService;
use Werkspot\BingAdsApiBundle\Model\AccessToken;
use Werkspot\BingAdsApiBundle\Model\ApiDetails;

class ClientTest extends PHPUnit_Framework_TestCase
{
    const ACCESS_TOKEN = '2ec09aeccaf634d982eec793037e37fe';
    const REFRESH_TOKEN = '0c59f7e609b0cc467067e39d523116ce';

    public function testSetApiDetails()
    {
        $newApiDetails = new ApiDetails('1', '2', '3', '4', '5');

        $expected = $this->getApiClient(
            new OauthTokenService(new \GuzzleHttp\Client()),
            $newApiDetails,
            new ClientProxy('example.com'),
            $this->getFileHelper(),
            new Helper\Csv(),
            $this->getTimeHelperMock()
        );

        $api = $this->getApiClient(
            new OauthTokenService(new \GuzzleHttp\Client()),
            new ApiDetails(null, null, null, null, null),
            new ClientProxy('example.com'),
            $this->getFileHelper(),
            new Helper\Csv(),
            $this->getTimeHelperMock()
        );

        $this->assertNotEquals($expected, $api);
        $api->setApiDetails($newApiDetails);
        $this->assertEquals($expected, $api);
    }

    /**
     * @dataProvider getTestSoapExceptionData
     *
     * @param int $code
     * @param string $exceptionClassName
     */
    public function testSoapExceptions($code, $exceptionClassName)
    {
        $this->expectException($exceptionClassName);
        $this->runClientSoapException($code);
    }

    /**
     * @dataProvider getTestSoapExceptionData
     *
     * @param int $code
     * @param string $exceptionClassName
     */
    public function testSoapOperationErrorExceptions($code, $exceptionClassName)
    {
        $this->expectException($exceptionClassName);
        $this->runClientSoapException($code, 'OperationError');
    }

    /**
     * @dataProvider getTestSoapExceptionData
     *
     * @param int $code
     * @param string $exceptionClassName
     */
    public function testSoapBatchErrorExceptions($code, $exceptionClassName)
    {
        $this->expectException($exceptionClassName);
        $this->runClientSoapException($code, 'BatchErrors');
    }

    public function getTestSoapExceptionData()
    {
        return [
            0 => [
                'errorCode' => 0,
                'exceptionClassName' => Exceptions\SoapInternalErrorException::class
            ],
            105 => [
                'errorCode' => 105,
                'exceptionClassName' => Exceptions\SoapInvalidCredentialsException::class,
            ],
            106 => [
                'errorCode' => 106,
                'exceptionClassName' => Exceptions\SoapUserIsNotAuthorizedException::class,
            ],
            2004 => [
                'errorCode' => 2004,
                'exceptionClassName' => Exceptions\SoapNoCompleteDataAvailableException::class,
            ],
            2100 => [
                'errorCode' => 2100,
                'exceptionClassName' => Exceptions\SoapReportingServiceInvalidReportIdException::class,
            ],
            9999 => [
                'errorCode' => 9999,
                'exceptionClassName' => Exceptions\SoapUnknownErrorException::class,
            ],
        ];
    }

    /**
     * @param int $code
     * @param null|string $type
     *
     * @return MockInterface
     */
    private function runClientSoapException($code, $type = null)
    {
        $clientProxyMock = $this->getClientProxyMock();
        $clientProxyMock
            ->shouldReceive('GetService')
            ->andThrow($this->generateSoapFault($code, $type));

        $apiClient = $this->getApiClient(
            $this->getOauthTokenServiceMock(),
            new ApiDetails('refreshToken', 'clientId', 'clientSecret', 'redirectUri', 'devToken'),
            $clientProxyMock,
            $this->getFileHelper(),
            new Helper\Csv(),
            $this->getTimeHelperMock()
        );

        $apiClient->getReport('GeoLocationPerformanceReport', [], ReportTimePeriod::LastWeek, 'test.csv');
    }

    /**
     * @return Mockery\MockInterface
     */
    private function getOauthTokenServiceMock()
    {
        $oauthTokenServiceMock = Mockery::mock(OauthTokenService::class);
        $oauthTokenServiceMock
            ->shouldReceive('refreshToken')
            ->with('clientId', 'clientSecret', 'redirectUri', AccessToken::class)
            ->once()
            ->andReturn(new AccessToken(self::ACCESS_TOKEN, self::REFRESH_TOKEN));

        return $oauthTokenServiceMock;
    }

    private function getTimeHelperMock()
    {
        $timeHelperMock = Mockery::mock(Helper\Time::class);
        $timeHelperMock->shouldReceive('sleep')->andReturnNull();

        return $timeHelperMock;
    }

    /**
     * @param OauthTokenService $oauthTokenService
     * @param ApiDetails $apiDetails
     * @param ClientProxy $clientProxy
     * @param Helper\File $fileHelper
     * @param Helper\Csv $csvHelper
     * @param Helper\Time $timeHelper
     *
     * @return Client
     */
    private function getApiClient(OauthTokenService $oauthTokenService, ApiDetails $apiDetails, ClientProxy $clientProxy, Helper\File $fileHelper, Helper\Csv $csvHelper, Helper\Time $timeHelper)
    {
        $apiClient = new Client($oauthTokenService, $apiDetails, $clientProxy, $fileHelper, $csvHelper, $timeHelper);
        $apiClient->setConfig(['cache_dir' => '/tmp']);

        return $apiClient;
    }

    /**
     * @param int $code
     * @param null|string $type
     *
     * @return \SoapFault
     */
    private function generateSoapFault($code, $type = null)
    {
        $message = "an error message {$code}";
        $error = new stdClass();
        $error->Code = $code;
        $error->Message = $message;
        $exception = new SoapFault('Server', '');
        $exception->detail = new stdClass();
        if ($type === 'BatchErrors') {
            $exception->detail->ApiFaultDetail = new stdClass();
            $exception->detail->ApiFaultDetail->BatchErrors = new stdClass();
            $exception->detail->ApiFaultDetail->BatchErrors->BatchError = [$error];
        } elseif ($type === 'OperationError') {
            $exception->detail->ApiFaultDetail = new stdClass();
            $exception->detail->ApiFaultDetail->OperationErrors = new stdClass();
            $exception->detail->ApiFaultDetail->OperationErrors->OperationError = [$error];
        } else {
            $exception->detail->AdApiFaultDetail = new stdClass();
            $exception->detail->AdApiFaultDetail->Errors = new stdClass();
            $exception->detail->AdApiFaultDetail->Errors->AdApiError = [$error];
        }

        return $exception;
    }

    private function getClientProxyMock()
    {
        $clientProxyMock = Mockery::mock(ClientProxy::class);
        $clientProxyMock
            ->shouldReceive('ConstructWithCredentials')
            ->andReturnSelf()
            ->once()
            ->shouldReceive('GetNamespace')
            ->andReturn('Namespace');

        return $clientProxyMock;
    }

    /**
     * @return Helper\File
     */
    private function getFileHelper()
    {
        return  new Helper\File(new GuzzleClient(), new Filesystem(), new Finder());
    }
}


1			<?php
2			namespace Test\Werkspot\BingAdsApiBundle\Api;
3
4			use BingAds\Bulk\ReportTimePeriod;
5			use BingAds\Proxy\ClientProxy;
6			use GuzzleHttp\Client as GuzzleClient;
7			use Mockery;
8			use Mockery\MockInterface;
9			use PHPUnit_Framework_TestCase;
10			use SoapFault;
11			use stdClass;
12			use Symfony\Component\Filesystem\Filesystem;
13			use Symfony\Component\Finder\Finder;
14			use Werkspot\BingAdsApiBundle\Api\Client;
15			use Werkspot\BingAdsApiBundle\Api\Exceptions;
16			use Werkspot\BingAdsApiBundle\Api\Helper;
17			use Werkspot\BingAdsApiBundle\Guzzle\OauthTokenService;
18			use Werkspot\BingAdsApiBundle\Model\AccessToken;
19			use Werkspot\BingAdsApiBundle\Model\ApiDetails;
20
21			class ClientTest extends PHPUnit_Framework_TestCase
22			{
23			const ACCESS_TOKEN = '2ec09aeccaf634d982eec793037e37fe';
24			const REFRESH_TOKEN = '0c59f7e609b0cc467067e39d523116ce';
25
26			public function testSetApiDetails()
27			{
28			$newApiDetails = new ApiDetails('1', '2', '3', '4', '5');
29
30			$expected = $this->getApiClient(
31			new OauthTokenService(new \GuzzleHttp\Client()),
32			$newApiDetails,
33			new ClientProxy('example.com'),
34			$this->getFileHelper(),
35			new Helper\Csv(),
36			$this->getTimeHelperMock()
37			);
38
39			$api = $this->getApiClient(
40			new OauthTokenService(new \GuzzleHttp\Client()),
41			new ApiDetails(null, null, null, null, null),
42			new ClientProxy('example.com'),
43			$this->getFileHelper(),
44			new Helper\Csv(),
45			$this->getTimeHelperMock()
46			);
47
48			$this->assertNotEquals($expected, $api);
49			$api->setApiDetails($newApiDetails);
50			$this->assertEquals($expected, $api);
51			}
52
53			/**
54			* @dataProvider getTestSoapExceptionData
55			*
56			* @param int $code
57			* @param string $exceptionClassName
58			*/
59			public function testSoapExceptions($code, $exceptionClassName)
60			{
61			$this->expectException($exceptionClassName);
62			$this->runClientSoapException($code);
63			}
64
65			/**
66			* @dataProvider getTestSoapExceptionData
67			*
68			* @param int $code
69			* @param string $exceptionClassName
70			*/
71			public function testSoapOperationErrorExceptions($code, $exceptionClassName)
72			{
73			$this->expectException($exceptionClassName);
74			$this->runClientSoapException($code, 'OperationError');
75			}
76
77			/**
78			* @dataProvider getTestSoapExceptionData
79			*
80			* @param int $code
81			* @param string $exceptionClassName
82			*/
83			public function testSoapBatchErrorExceptions($code, $exceptionClassName)
84			{
85			$this->expectException($exceptionClassName);
86			$this->runClientSoapException($code, 'BatchErrors');
87			}
88
89			public function getTestSoapExceptionData()
90			{
91			return [
92			0 => [
93			'errorCode' => 0,
94			'exceptionClassName' => Exceptions\SoapInternalErrorException::class
95			],
96			105 => [
97			'errorCode' => 105,
98			'exceptionClassName' => Exceptions\SoapInvalidCredentialsException::class,
99			],
100			106 => [
101			'errorCode' => 106,
102			'exceptionClassName' => Exceptions\SoapUserIsNotAuthorizedException::class,
103			],
104			2004 => [
105			'errorCode' => 2004,
106			'exceptionClassName' => Exceptions\SoapNoCompleteDataAvailableException::class,
107			],
108			2100 => [
109			'errorCode' => 2100,
110			'exceptionClassName' => Exceptions\SoapReportingServiceInvalidReportIdException::class,
111			],
112			9999 => [
113			'errorCode' => 9999,
114			'exceptionClassName' => Exceptions\SoapUnknownErrorException::class,
115			],
116			];
117			}
118
119			/**
120			* @param int $code
121			* @param null\|string $type
122			*
123			* @return MockInterface
124			*/
125			private function runClientSoapException($code, $type = null)
126			{
127			$clientProxyMock = $this->getClientProxyMock();
128			$clientProxyMock
129			->shouldReceive('GetService')
130			->andThrow($this->generateSoapFault($code, $type));
131
132			$apiClient = $this->getApiClient(
133			$this->getOauthTokenServiceMock(),
134			new ApiDetails('refreshToken', 'clientId', 'clientSecret', 'redirectUri', 'devToken'),
135			$clientProxyMock,
136			$this->getFileHelper(),
137			new Helper\Csv(),
138			$this->getTimeHelperMock()
139			);
140
141			$apiClient->getReport('GeoLocationPerformanceReport', [], ReportTimePeriod::LastWeek, 'test.csv');
142			}
143
144			/**
145			* @return Mockery\MockInterface
146			*/
147			private function getOauthTokenServiceMock()
148			{
149			$oauthTokenServiceMock = Mockery::mock(OauthTokenService::class);
150			$oauthTokenServiceMock
151			->shouldReceive('refreshToken')
152			->with('clientId', 'clientSecret', 'redirectUri', AccessToken::class)
153			->once()
154			->andReturn(new AccessToken(self::ACCESS_TOKEN, self::REFRESH_TOKEN));
155
156			return $oauthTokenServiceMock;
157			}
158
159			private function getTimeHelperMock()
160			{
161			$timeHelperMock = Mockery::mock(Helper\Time::class);
162			$timeHelperMock->shouldReceive('sleep')->andReturnNull();
163
164			return $timeHelperMock;
165			}
166
167			/**
168			* @param OauthTokenService $oauthTokenService
169			* @param ApiDetails $apiDetails
170			* @param ClientProxy $clientProxy
171			* @param Helper\File $fileHelper
172			* @param Helper\Csv $csvHelper
173			* @param Helper\Time $timeHelper
174			*
175			* @return Client
176			*/
177			private function getApiClient(OauthTokenService $oauthTokenService, ApiDetails $apiDetails, ClientProxy $clientProxy, Helper\File $fileHelper, Helper\Csv $csvHelper, Helper\Time $timeHelper)
178			{
179			$apiClient = new Client($oauthTokenService, $apiDetails, $clientProxy, $fileHelper, $csvHelper, $timeHelper);
180			$apiClient->setConfig(['cache_dir' => '/tmp']);
181
182			return $apiClient;
183			}
184
185			/**
186			* @param int $code
187			* @param null\|string $type
188			*
189			* @return \SoapFault
190			*/
191			private function generateSoapFault($code, $type = null)
192			{
193			$message = "an error message {$code}";
194			$error = new stdClass();
195			$error->Code = $code;
196			$error->Message = $message;
197			$exception = new SoapFault('Server', '');
198			$exception->detail = new stdClass();
199			if ($type === 'BatchErrors') {
200			$exception->detail->ApiFaultDetail = new stdClass();
201			$exception->detail->ApiFaultDetail->BatchErrors = new stdClass();
202			$exception->detail->ApiFaultDetail->BatchErrors->BatchError = [$error];
203			} elseif ($type === 'OperationError') {
204			$exception->detail->ApiFaultDetail = new stdClass();
205			$exception->detail->ApiFaultDetail->OperationErrors = new stdClass();
206			$exception->detail->ApiFaultDetail->OperationErrors->OperationError = [$error];
207			} else {
208			$exception->detail->AdApiFaultDetail = new stdClass();
209			$exception->detail->AdApiFaultDetail->Errors = new stdClass();
210			$exception->detail->AdApiFaultDetail->Errors->AdApiError = [$error];
211			}
212
213			return $exception;
214			}
215
216			private function getClientProxyMock()
217			{
218			$clientProxyMock = Mockery::mock(ClientProxy::class);
219			$clientProxyMock
220			->shouldReceive('ConstructWithCredentials')
221			->andReturnSelf()
222			->once()
223			->shouldReceive('GetNamespace')
224			->andReturn('Namespace');
225
226			return $clientProxyMock;
227			}
228
229			/**
230			* @return Helper\File
231			*/
232			private function getFileHelper()
233			{
234			return new Helper\File(new GuzzleClient(), new Filesystem(), new Finder());
235			}
236			}
237

Werkspot / BingAdsApiBundle

Push — master ( 3624f7...34c464 )

ClientTest::generateSoapFault() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like