GithubExceptionThrowerTest.php

<?php

namespace Github\Tests\HttpClient\Plugin;

use Github\Exception\ExceptionInterface;
use Github\HttpClient\Plugin\GithubExceptionThrower;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Http\Client\Promise\HttpFulfilledPromise;
use Http\Client\Promise\HttpRejectedPromise;
use PHPUnit\Framework\TestCase;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * @author Sergii Ivashchenko <serg.ivashchenko@gmail.com>
 */
class GithubExceptionThrowerTest extends TestCase
{
    /**
     * @dataProvider responseProvider
     */
    public function testHandleRequest(ResponseInterface $response, ExceptionInterface $exception = null): void
    {
        $request = new Request('GET', 'https://api.github.com/issues');

        $promise = new HttpFulfilledPromise($response);

        $plugin = new GithubExceptionThrower();

        $result = $plugin->handleRequest(
            $request,
            function (RequestInterface $request) use ($promise) {
                return $promise;
            },
            function (RequestInterface $request) use ($promise) {
                return $promise;
            }
        );

        if ($exception) {
            $this->assertInstanceOf(HttpRejectedPromise::class, $result);
        } else {
            $this->assertInstanceOf(HttpFulfilledPromise::class, $result);
        }

        if ($exception) {
            $this->expectException(get_class($exception));
            $this->expectExceptionCode($exception->getCode());
            $this->expectExceptionMessageMatches('/'.preg_quote($exception->getMessage(), '/').'$/');
        }

        $result->wait();
    }

    /**
     * @return array
     */
    public static function responseProvider()
    {
        return [
            '200 Response' => [
                'response' => new Response(),
                'exception' => null,
            ],
            'Rate Limit Exceeded' => [
                'response' => new Response(
                    429,
                    [
                        'Content-Type' => 'application/json',
                        'X-RateLimit-Remaining' => 0,
                        'X-RateLimit-Limit' => 5000,
                    ],
                    ''
                ),
                'exception' => new \Github\Exception\ApiLimitExceedException(5000),
            ],
            'Rate Limit Exceeded via 403 status' => [
                'response' => new Response(
                    403,
                    [
                        'Content-Type' => 'application/json',
                        'X-RateLimit-Remaining' => 0,
                        'X-RateLimit-Limit' => 5000,
                        'X-RateLimit-Reset' => 1609245810,
                    ],
                    json_encode(
                        [
                            'message' => 'API rate limit exceeded for installation ID xxxxxxx.',
                        ]
                    )
                ),
                'exception' => new \Github\Exception\ApiLimitExceedException(5000),
            ],
            'Secondary Rate Limit Exceeded via 403 status' => [
                'response' => new Response(
                    403,
                    [
                        'Content-Type' => 'application/json',
                        'X-RateLimit-Remaining' => 100,
                        'X-RateLimit-Limit' => 5000,
                        'X-RateLimit-Reset' => 1609245810,
                    ],
                    json_encode(
                        [
                            'message' => 'You have exceeded a secondary rate limit. Please wait a few minutes before you try again.',
                        ]
                    )
                ),
                'exception' => new \Github\Exception\ApiLimitExceedException(5000),
            ],
            'Two Factor Authentication Required' => [
                'response' => new Response(
                    401,
                    [
                        'Content-Type' => 'application/json',
                        'X-GitHub-OTP' => 'required; :2fa-type',
                    ],
                    ''
                ),
                'exception' => new \Github\Exception\TwoFactorAuthenticationRequiredException('2fa-type'),
            ],
            '400 Bad Request' => [
                'response' => new Response(
                    400,
                    [
                        'Content-Type' => 'application/json',
                    ],
                    json_encode(
                        [
                            'message' => 'Problems parsing JSON',
                        ]
                    )
                ),
                'exception' => new \Github\Exception\ErrorException('Problems parsing JSON (Bad Request)', 400),
            ],
            '422 Unprocessable Entity' => [
                'response' => new Response(
                    422,
                    [
                        'Content-Type' => 'application/json',
                    ],
                    json_encode(
                        [
                            'message' => 'Bad Request',
                            'errors' => [
                                [
                                    'code' => 'missing',
                                    'field' => 'field',
                                    'value' => 'value',
                                    'resource' => 'resource',
                                ],
                            ],
                        ]
                    )
                ),
                'exception' => new \Github\Exception\ErrorException('Validation Failed: The field value does not exist, for resource "resource"', 422),
            ],
            '502 Response' => [
                'response' => new Response(
                    502,
                    [
                        'Content-Type' => 'application/json',
                    ],
                    json_encode(
                        [
                            'errors' => [
                                ['message' => 'Something went wrong with executing your query'],
                            ],
                        ]
                    )
                ),
                'exception' => new \Github\Exception\RuntimeException('Something went wrong with executing your query', 502),
            ],
            'Sso required Response' => [
                'response' => new Response(
                    403,
                    [
                        'Content-Type' => 'application/json',
                        'X-GitHub-SSO' => 'required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4',
                    ]
                ),
                'exception' => new \Github\Exception\SsoRequiredException('https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4'),
            ],
            'Default handling' => [
                'response' => new Response(
                    555,
                    [],
                    'Error message'
                ),
                'exception' => new \Github\Exception\RuntimeException('Error message', 555),
            ],
            'Graphql error response (200)' => [
                'response' => new Response(
                    200,
                    [
                        'content-type' => 'application/json',
                    ],
                    json_encode(
                        [
                            'errors' => [
                                [
                                    ['path' => ['query', 'repository']],
                                    'message' => 'Field "xxxx" doesn\'t exist on type "Issue"',
                                ],
                                [
                                    ['path' => ['query', 'repository']],
                                    'message' => 'Field "dummy" doesn\'t exist on type "PullRequest"',
                                ],
                            ],
                        ]
                    )
                ),
                'exception' => new \Github\Exception\RuntimeException('Field "xxxx" doesn\'t exist on type "Issue", Field "dummy" doesn\'t exist on type "PullRequest"'),
            ],
            'Grapql requires authentication' => [
                'response' => new Response(
                    401,
                    [
                        'content-type' => 'application/json',
                        'X-RateLimit-Limit' => 0,
                        'X-RateLimit-Remaining' => 0,
                        'X-RateLimit-Reset' => 1609245810,
                        'X-RateLimit-Used' => 0,
                    ],
                    json_encode(
                        [
                            'message' => 'This endpoint requires you to be authenticated.',
                            'documentation_url' => 'https://docs.github.com/v3/#authentication',
                        ]
                    )
                ),
                'exception' => new \Github\Exception\RuntimeException('This endpoint requires you to be authenticated.', 401),
            ],
            'Cannot delete active deployment' => [
                'response' => new Response(
                    422,
                    [
                        'content-type' => 'application/json',
                    ],
                    json_encode(
                        [
                            'message' => 'Validation Failed',
                            'errors' => ['We cannot delete an active deployment unless it is the only deployment in a given environment.'],
                            'documentation_url' => 'https://docs.github.com/rest/reference/repos#delete-a-deployment',
                        ]
                    )
                ),
                'exception' => new \Github\Exception\ValidationFailedException('Validation Failed: We cannot delete an active deployment unless it is the only deployment in a given environment.', 422),
            ],
        ];
    }
}