allow vendord

vendor/fedapay/fedapay-php/tests/HttpClient/CurlClientTest.php

@@ -0,0 +1,223 @@
+<?php
+
+namespace Tests;
+
+use FedaPay\HttpClient\CurlClient;
+use FedaPay\FedaPay;
+
+class CurlClientTest extends BaseTestCase
+{
+    /**
+     * @before
+     */
+    public function saveOriginalNetworkValues()
+    {
+        $this->origMaxNetworkRetries = FedaPay::getMaxNetworkRetries();
+        $this->origMaxNetworkRetryDelay = FedaPay::getMaxNetworkRetryDelay();
+        $this->origInitialNetworkRetryDelay = FedaPay::getInitialNetworkRetryDelay();
+    }
+
+    /**
+     * @before
+     */
+    public function setUpReflectors()
+    {
+        $fedaPayReflector = new \ReflectionClass('\FedaPay\FedaPay');
+
+        $this->maxNetworkRetryDelayProperty = $fedaPayReflector->getProperty('maxNetworkRetryDelay');
+        $this->maxNetworkRetryDelayProperty->setAccessible(true);
+
+        $this->initialNetworkRetryDelayProperty = $fedaPayReflector->getProperty('initialNetworkRetryDelay');
+        $this->initialNetworkRetryDelayProperty->setAccessible(true);
+
+        $curlClientReflector = new \ReflectionClass('FedaPay\HttpClient\CurlClient');
+
+        $this->shouldRetryMethod = $curlClientReflector->getMethod('shouldRetry');
+        $this->shouldRetryMethod->setAccessible(true);
+
+        $this->sleepTimeMethod = $curlClientReflector->getMethod('sleepTime');
+        $this->sleepTimeMethod->setAccessible(true);
+    }
+
+    /**
+     * @after
+     */
+    public function restoreOriginalNetworkValues()
+    {
+        FedaPay::setMaxNetworkRetries($this->origMaxNetworkRetries);
+        $this->setMaxNetworkRetryDelay($this->origMaxNetworkRetryDelay);
+        $this->setInitialNetworkRetryDelay($this->origInitialNetworkRetryDelay);
+    }
+
+    private function setMaxNetworkRetryDelay($maxNetworkRetryDelay)
+    {
+        $this->maxNetworkRetryDelayProperty->setValue(null, $maxNetworkRetryDelay);
+    }
+
+    private function setInitialNetworkRetryDelay($initialNetworkRetryDelay)
+    {
+        $this->initialNetworkRetryDelayProperty->setValue(null, $initialNetworkRetryDelay);
+    }
+
+    private function createFakeRandomGenerator($returnValue = 1.0)
+    {
+        $fakeRandomGenerator = $this->createMock('\FedaPay\Util\RandomGenerator');
+        $fakeRandomGenerator->method('randFloat')->willReturn($returnValue);
+        return $fakeRandomGenerator;
+    }
+
+    public function testTimeout()
+    {
+        $curl = new CurlClient();
+        $this->assertSame(CurlClient::DEFAULT_TIMEOUT, $curl->getTimeout());
+        $this->assertSame(CurlClient::DEFAULT_CONNECT_TIMEOUT, $curl->getConnectTimeout());
+
+        // implicitly tests whether we're returning the CurlClient instance
+        $curl = $curl->setConnectTimeout(1)->setTimeout(10);
+        $this->assertSame(1, $curl->getConnectTimeout());
+        $this->assertSame(10, $curl->getTimeout());
+
+        $curl->setTimeout(-1);
+        $curl->setConnectTimeout(-999);
+        $this->assertSame(0, $curl->getTimeout());
+        $this->assertSame(0, $curl->getConnectTimeout());
+    }
+
+    public function testUserAgentInfo()
+    {
+        $curl = new CurlClient();
+        $uaInfo = $curl->getUserAgentInfo();
+        $this->assertNotNull($uaInfo);
+        $this->assertNotNull($uaInfo['httplib']);
+        $this->assertNotNull($uaInfo['ssllib']);
+    }
+
+    public function testDefaultOptions()
+    {
+        $withClosure = new CurlClient(function ($method, $absUrl, $headers, $params, $hasFile) use (&$ref) {
+            $ref = func_get_args();
+            return [];
+        });
+
+        $withClosure->request('get', 'https://httpbin.org/status/200', [], [], false);
+        $this->assertSame($ref, ['get', 'https://httpbin.org/status/200', [], [], false]);
+
+        // this is the last test case that will run, since it'll throw an exception at the end
+        $withBadClosure = new CurlClient(function () {
+            return 'thisShouldNotWork';
+        });
+        $this->expectException('FedaPay\Error\ApiConnection');
+        $this->expectExceptionMessage('Non-array value returned by defaultOptions CurlClient callback');
+        $withBadClosure->request('get', 'https://httpbin.org/status/200', [], [], false);
+    }
+
+    public function testSslOption()
+    {
+        // make sure options array loads/saves properly
+        $optionsArray = [CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1];
+        $withOptionsArray = new CurlClient($optionsArray);
+        $this->assertSame($withOptionsArray->getDefaultOptions(), $optionsArray);
+    }
+
+    public function testShouldRetryOnTimeout()
+    {
+        FedaPay::setMaxNetworkRetries(2);
+
+        $curlClient = new CurlClient();
+
+        $this->assertTrue($this->shouldRetryMethod->invoke($curlClient, CURLE_OPERATION_TIMEOUTED, 0, 0));
+    }
+
+    public function testShouldRetryOnConnectionFailure()
+    {
+        FedaPay::setMaxNetworkRetries(2);
+
+        $curlClient = new CurlClient();
+
+        $this->assertTrue($this->shouldRetryMethod->invoke($curlClient, CURLE_COULDNT_CONNECT, 0, 0));
+    }
+
+    public function testShouldRetryOnConflict()
+    {
+        FedaPay::setMaxNetworkRetries(2);
+
+        $curlClient = new CurlClient();
+
+        $this->assertTrue($this->shouldRetryMethod->invoke($curlClient, 0, 409, 0));
+    }
+
+    public function testShouldNotRetryAtMaximumCount()
+    {
+        FedaPay::setMaxNetworkRetries(2);
+
+        $curlClient = new CurlClient();
+
+        $this->assertFalse($this->shouldRetryMethod->invoke($curlClient, 0, 0, FedaPay::getMaxNetworkRetries()));
+    }
+
+    public function testShouldNotRetryOnCertValidationError()
+    {
+        FedaPay::setMaxNetworkRetries(2);
+
+        $curlClient = new CurlClient();
+
+        $this->assertFalse($this->shouldRetryMethod->invoke($curlClient, CURLE_SSL_PEER_CERTIFICATE, -1, 0));
+    }
+
+    public function testSleepTimeShouldGrowExponentially()
+    {
+        $this->setMaxNetworkRetryDelay(999);
+
+        $curlClient = new CurlClient(null, $this->createFakeRandomGenerator());
+
+        $this->assertEquals(
+            FedaPay::getInitialNetworkRetryDelay() * 1,
+            $this->sleepTimeMethod->invoke($curlClient, 1)
+        );
+        $this->assertEquals(
+            FedaPay::getInitialNetworkRetryDelay() * 2,
+            $this->sleepTimeMethod->invoke($curlClient, 2)
+        );
+        $this->assertEquals(
+            FedaPay::getInitialNetworkRetryDelay() * 4,
+            $this->sleepTimeMethod->invoke($curlClient, 3)
+        );
+        $this->assertEquals(
+            FedaPay::getInitialNetworkRetryDelay() * 8,
+            $this->sleepTimeMethod->invoke($curlClient, 4)
+        );
+    }
+
+    public function testSleepTimeShouldEnforceMaxNetworkRetryDelay()
+    {
+        $this->setInitialNetworkRetryDelay(1);
+        $this->setMaxNetworkRetryDelay(2);
+
+        $curlClient = new CurlClient(null, $this->createFakeRandomGenerator());
+
+        $this->assertEquals(1, $this->sleepTimeMethod->invoke($curlClient, 1));
+        $this->assertEquals(2, $this->sleepTimeMethod->invoke($curlClient, 2));
+        $this->assertEquals(2, $this->sleepTimeMethod->invoke($curlClient, 3));
+        $this->assertEquals(2, $this->sleepTimeMethod->invoke($curlClient, 4));
+    }
+
+    public function testSleepTimeShouldAddSomeRandomness()
+    {
+        $randomValue = 0.8;
+        $this->setInitialNetworkRetryDelay(1);
+        $this->setMaxNetworkRetryDelay(8);
+
+        $curlClient = new CurlClient(null, $this->createFakeRandomGenerator($randomValue));
+
+        $baseValue = FedaPay::getInitialNetworkRetryDelay() * (0.5 * (1 + $randomValue));
+
+        // the initial value cannot be smaller than the base,
+        // so the randomness is ignored
+        $this->assertEquals(FedaPay::getInitialNetworkRetryDelay(), $this->sleepTimeMethod->invoke($curlClient, 1));
+
+        // after the first one, the randomness is applied
+        $this->assertEquals($baseValue * 2, $this->sleepTimeMethod->invoke($curlClient, 2));
+        $this->assertEquals($baseValue * 4, $this->sleepTimeMethod->invoke($curlClient, 3));
+        $this->assertEquals($baseValue * 8, $this->sleepTimeMethod->invoke($curlClient, 4));
+    }
+}