ClientTest::testSoapOperationErrorExceptions() - Code Metrics - Inspection of "Merge pull request #6 from Werkspot/tests" - Werkspot/BingAdsApiBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (3fd795)

by Laurens

created 2016-03-10 09:10 UTC

ClientTest::testSoapOperationErrorExceptions() A

↳ Parent: ClientTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

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

use BingAds\Bulk\ReportTimePeriod;
use BingAds\Proxy\ClientProxy;
use Mockery;
use Mockery\MockInterface;
use PHPUnit_Framework_TestCase;
use SoapFault;
use stdClass;
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()
    {
        $expected = new Client(
            new OauthTokenService(new \GuzzleHttp\Client()),
            new ApiDetails('1', '2', '3', '4', '5'),
            new ClientProxy('example.com'),
            new Helper\File(),
            new Helper\Csv(),
            $this->getTimeHelperMock()
        );

        $api = new Client(
            new OauthTokenService(new \GuzzleHttp\Client()),
            new ApiDetails(null, null, null, null, null),
            new ClientProxy('example.com'),
            new Helper\File(),
            new Helper\Csv(),
            $this->getTimeHelperMock()
        );
        $api->setApiDetails(new ApiDetails('1', '2', '3', '4', '5'));
        $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,
            new Helper\File(),
            new Helper\Csv(),
            $this->getTimeHelperMock()
        );
        $apiClient->get([], 'GeoLocationPerformanceReport', ReportTimePeriod::LastWeek);
    }

    /**
     * @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 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}";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        $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;
    }
}


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

Werkspot / BingAdsApiBundle

Branch — master (3fd795)

ClientTest::testSoapOperationErrorExceptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like