-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #67 from packagist/z/httplug-upgrade
Upgrade HTTPlug from Legacy to PSR 17/18 Discovery Factories
- Loading branch information
Showing
4 changed files
with
134 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * (c) Packagist Conductors GmbH <contact@packagist.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace PrivatePackagist\ApiClient\HttpClient\Plugin; | ||
|
|
||
| use GuzzleHttp\Psr7\HttpFactory; | ||
| use GuzzleHttp\Psr7\Response; | ||
| use Http\Client\Common\HttpMethodsClientInterface; | ||
| use Http\Message\MessageFactory\GuzzleMessageFactory; | ||
| use Http\Message\RequestMatcher as RequestMatcherInterface; | ||
| use Http\Mock\Client as MockClient; | ||
| use PHPUnit\Framework\TestCase; | ||
| use PrivatePackagist\ApiClient\HttpClient\HttpPluginClientBuilder; | ||
| use Psr\Http\Message\RequestInterface; | ||
| use Psr\Http\Message\ResponseInterface; | ||
|
|
||
| class HttpPluginClientBuilderTest extends TestCase | ||
| { | ||
| public function testInvalidRequestFactory(): void | ||
| { | ||
| $this->expectException(\TypeError::class); | ||
| $definitelyNotARequestFactory = new \stdClass; | ||
| /** @phpstan-ignore-next-line We are passing in an invalid type on purpose. */ | ||
| new HttpPluginClientBuilder(new MockClient, $definitelyNotARequestFactory); | ||
| } | ||
|
|
||
| /** @dataProvider provideRequestFactories */ | ||
| public function testRequestFactory(?object $factory): void | ||
| { | ||
| $mockHttp = new MockClient; | ||
| $mockHttp->setDefaultException(new \Exception('Mock HTTP client did not match request.')); | ||
| $mockHttp->on($this->matchRequestIncludingHeaders(), new Response(307, ['Location' => '/kittens.jpg'])); | ||
|
|
||
| $builder = new HttpPluginClientBuilder($mockHttp, $factory); | ||
| // Make sure that the RequestFactory passed is acceptable for the client. | ||
| $client = $builder->getHttpClient(); | ||
| $this->assertInstanceOf(HttpMethodsClientInterface::class, $client); | ||
|
|
||
| // Ensure that the Request Factory correctly generates a request object (including headers | ||
| // as RequestFactory and RequestFactoryInterface set headers differently). | ||
| $response = $client->get('https://example.com/puppies.jpg', ['Accept' => 'image/vnd.cute+jpeg']); | ||
| $this->assertInstanceOf(ResponseInterface::class, $response); | ||
| $this->assertSame(307, $response->getStatusCode()); | ||
| $locationHeaders = $response->getHeader('Location'); | ||
| $this->assertCount(1, $locationHeaders); | ||
| $this->assertSame('/kittens.jpg', reset($locationHeaders)); | ||
| } | ||
|
|
||
| /** | ||
| * The concrete implementation of the RequestMatcher interface does not allow matching on | ||
| * headers, which we need to test to ensure both legacy and PSR17 implementations work. | ||
| */ | ||
| private function matchRequestIncludingHeaders(): RequestMatcherInterface | ||
| { | ||
| return new class implements RequestMatcherInterface { | ||
| public function matches(RequestInterface $request): bool | ||
| { | ||
| $acceptHeaders = $request->getHeader('Accept'); | ||
| return $request->getUri()->getPath() === '/puppies.jpg' | ||
| && count($acceptHeaders) === 1 | ||
| && reset($acceptHeaders) === 'image/vnd.cute+jpeg'; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| /** @return iterable{object|null} */ | ||
| public static function provideRequestFactories(): iterable | ||
| { | ||
| yield [null]; | ||
| // Http\Message\RequestFactory | ||
| yield [new GuzzleMessageFactory]; | ||
| // Psr\Http\Message\RequestFactoryInterface | ||
| yield [new HttpFactory]; | ||
| } | ||
| } |