Merge pull request #14 from Art4/phpunit-10

Phpunit 10 and Code Coverage

.github/workflows/tests.yml

@@ -35,7 +35,7 @@ jobs:
         with:
           php-version: ${{ matrix.php }}
           ini-values: error_reporting=-1, display_errors=On, log_errors_max_len=0
-          coverage: none
+          coverage: xdebug
           tools: none
 
       # Install dependencies and handle caching in one go.
@@ -57,9 +57,17 @@ jobs:
           composer-options: --ignore-platform-reqs
 
       - name: Run phpunit tests
-        run: composer run phpunit -- --coverage-text
+        run: composer run phpunit -- --coverage-clover ./.code-coverage/clover.xml
 
       - name: Run static code analysis
         # Do not run phpstan on lowest php version
         if: ${{ matrix.prefer-versions == 'latest' }}
         run: composer run phpstan -- --error-format=github
+
+      - name: Send coverage report to Codecov
+        if: ${{ success() && matrix.php == '8.2' }}
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./.code-coverage/clover.xml
+          fail_ci_if_error: true
+          verbose: true

.gitignore

@@ -1,4 +1,6 @@
+/.code-coverage
 /.php-cs-fixer.cache
+/.phpunit.cache/
 /.phpunit.result.cache
 /composer.lock
 /vendor/

CHANGELOG.md

@@ -10,9 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add support for PHP 8.2
+- Add tests with PHPStan level 8
 
 ### Changed
 
+- 100% code coverage
 - Drop support for PHP 7.1
 
 ## [1.0.1 - 2023-05-31](https://github.com/Art4/WP-Requests-PSR18-Adapter/compare/1.0.0...1.0.1)
@@ -43,8 +45,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Change Code Style to PSR-12
 - Drop support for PHP 7.0
 
-## [1.0.0-beta - 2022-10-06](https://github.com/Art4/WP-Requests-PSR18-Adapter/compare/09aae5d7deac8058c5a25c1d951cd350d066ad6e...1.0.0-beta)
+## [1.0.0-beta - 2022-10-06](https://github.com/Art4/WP-Requests-PSR18-Adapter/compare/f2ab377f89c42ed364f0324a99ff164ae929d22a...1.0.0-beta)
 
 ### Added
 
-- Library created from pull request
+- Library created from pull request: https://github.com/WordPress/Requests/pull/768

README.md

@@ -1,14 +1,21 @@
 # WordPress/Requests PSR-18 Adapter
 
+[![Latest Version](https://img.shields.io/github/release/Art4/WP-Requests-PSR18-Adapter.svg)](https://github.com/Art4/WP-Requests-PSR18-Adapter/releases)
+[![Software License](https://img.shields.io/badge/license-GPL3-brightgreen.svg)](LICENSE.md)
+[![Build Status](https://github.com/Art4/WP-Requests-PSR18-Adapter/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/Art4/WP-Requests-PSR18-Adapter/actions)
+[![codecov](https://codecov.io/gh/Art4/WP-Requests-PSR18-Adapter/branch/main/graph/badge.svg?token=NWWJXG6MIL)](https://codecov.io/gh/Art4/WP-Requests-PSR18-Adapter)
+[![Total Downloads](https://img.shields.io/packagist/dt/art4/requests-psr18-adapter.svg)](https://packagist.org/packages/art4/requests-psr18-adapter)
+
 Use [WordPress/Requests](https://github.com/WordPress/Requests) as a [PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP client adapter.
 
-Requires PHP 7.2+
+- Requires PHP 7.2+
+- Supports Requests v1.8+ and v2
 
 ## Why?
 
 Requests is a HTTP library written in PHP, that [lacks of support for PSR-7](https://github.com/WordPress/Requests/issues/320) and also for PSR-18 because of the compatability with PHP 5.6+.
 
-[I've created a PR in Requests to add PSR-7 support](https://github.com/WordPress/Requests/pull/768) but I would be able to use it today. So I created this library. If one day Requests nativly supports PSR-7 and PSR-18, this library will become obsolete.
+[I've created a PR in Requests to add PSR-7 support](https://github.com/WordPress/Requests/pull/768) but this would add new direct dependencies to Requests. So I created this library as an optional wrapper for Requests. If one day Requests nativly supports PSR-7 and PSR-18, this library might become obsolete.
 
 ## How to use
 
@@ -54,5 +61,5 @@ try {
 }
 
 // Use the PSR-7 Response
-var_dump($response);
+var_dump($response->getBody()->__toString());
 ```

composer.json

@@ -22,8 +22,8 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",
         "phpstan/phpstan": "^1.10",
-        "phpunit/phpunit": "^8 || ^9",
-        "yoast/phpunit-polyfills": "^1.0.3"
+        "phpunit/phpunit": "^8 || ^9 || ^10",
+        "yoast/phpunit-polyfills": "^2"
     },
     "autoload": {
         "files": ["v1-compat/autoload.php"],
@@ -37,6 +37,7 @@
         }
     },
     "scripts": {
+        "coverage": "phpunit --coverage-html=.code-coverage",
         "phpstan": "phpstan analyze --memory-limit 512M --configuration .phpstan.neon",
         "phpunit": "phpunit"
     },

phpunit.xml

@@ -1,19 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
          bootstrap="vendor/autoload.php"
-         forceCoversAnnotation="true"
-         beStrictAboutCoversAnnotation="true"
+         beStrictAboutCoverageMetadata="false"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
-         verbose="true">
-    <testsuite name="default">
-        <directory suffix="Test.php">tests</directory>
-    </testsuite>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+         cacheDirectory=".phpunit.cache"
+         requireCoverageMetadata="false">
+  <coverage/>
+  <testsuite name="default">
+    <directory suffix="Test.php">tests</directory>
+  </testsuite>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>

src/Psr/Response.php

@@ -50,11 +50,11 @@ public static function fromResponse(RequestsResponse $response)
 
         $headers = [];
 
+        /**
+         * @var string $name
+         * @var string[] $value
+         */
         foreach ($response->headers->getAll() as $name => $value) {
-            if (!is_array($value)) {
-                $value = [$value];
-            }
-
             $headers[$name] = $value;
         }
 

src/Psr/StringBasedStream.php

@@ -235,10 +235,6 @@ public function getContents(): string
      */
     public function getMetadata(?string $key = null)
     {
-        if (func_num_args() > 0 && !is_string($key)) {
-            throw InvalidArgument::create(1, '$key', 'string', gettype($key));
-        }
-
         if (is_string($key)) {
             return null;
         }

src/Psr/Uri.php

@@ -162,21 +162,20 @@ public function getPort(): ?int
         $port = $this->iri->port;
         $scheme = $this->getScheme();
 
+        try {
+            $portFromScheme = Port::get($scheme);
+        } catch (RequestsException $th) {
+            $portFromScheme = null;
+        }
+
         if ($port === null) {
-            try {
-                return Port::get($scheme);
-            } catch (RequestsException $th) {
-                return null;
-            }
+            return $portFromScheme;
         }
 
         $port = intval($port);
 
-        try {
-            if ($port === Port::get($scheme)) {
-                return null;
-            }
-        } catch (RequestsException $th) {
+        if ($port === $portFromScheme) {
+            return null;
         }
 
         return $port;

tests/Exception/Psr/NetworkException/GetRequestTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Art4\Requests\Tests\Exception\Psr\NetworkException;
+
+use Art4\Requests\Exception\Psr\NetworkException;
+use Psr\Http\Message\RequestInterface;
+use WpOrg\Requests\Exception\Transport;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
+
+final class GetRequestTest extends TestCase
+{
+    /**
+     * Tests receiving the request when using getRequest().
+     *
+     * @covers \Art4\Requests\Exception\Psr\NetworkException::__construct
+     * @covers \Art4\Requests\Exception\Psr\NetworkException::getRequest
+     *
+     * @return void
+     */
+    public function testGetRequestReturnsRequest()
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $previous = $this->createMock(Transport::class);
+
+        $exception = new NetworkException($request, $previous);
+
+        $this->assertSame($request, $exception->getRequest());
+    }
+}

tests/Exception/Psr/RequestException/GetRequestTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Art4\Requests\Tests\Exception\Psr\RequestException;
+
+use Art4\Requests\Exception\Psr\RequestException;
+use Psr\Http\Message\RequestInterface;
+use WpOrg\Requests\Exception\Transport;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
+
+final class GetRequestTest extends TestCase
+{
+    /**
+     * Tests receiving the request when using getRequest().
+     *
+     * @covers \Art4\Requests\Exception\Psr\RequestException::__construct
+     * @covers \Art4\Requests\Exception\Psr\RequestException::getRequest
+     *
+     * @return void
+     */
+    public function testGetRequestReturnsRequest()
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $previous = $this->createMock(Transport::class);
+
+        $exception = new RequestException($request, $previous);
+
+        $this->assertSame($request, $exception->getRequest());
+    }
+}

tests/Psr/HttpClient/CreateRequestTest.php

@@ -81,7 +81,7 @@ public function testCreateRequestWithoutUriStringThrowsException($input)
      *
      * @return array<string, mixed>
      */
-    public function dataInvalidTypeNotString()
+    public static function dataInvalidTypeNotString()
     {
         return TypeProviderHelper::getAllExcept(TypeProviderHelper::GROUP_STRING);
     }

tests/Psr/HttpClient/HttpClientTest.php → tests/Psr/HttpClient/SendRequestTest.php

@@ -12,11 +12,12 @@
 use WpOrg\Requests\Transport;
 use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
-final class HttpClientTest extends TestCase
+final class SendRequestTest extends TestCase
 {
     /**
      * Tests receiving a response when using sendRequest().
      *
+     * @covers \Art4\Requests\Psr\HttpClient::__construct
      * @covers \Art4\Requests\Psr\HttpClient::sendRequest
      *
      * @return void

tests/Psr/Request/GetHeaderLineTest.php

@@ -4,11 +4,9 @@
 
 namespace Art4\Requests\Tests\Psr\Request;
 
-use InvalidArgumentException;
-use Psr\Http\Message\UriInterface;
 use Art4\Requests\Psr\Request;
+use Psr\Http\Message\UriInterface;
 use Yoast\PHPUnitPolyfills\TestCases\TestCase;
-use Art4\Requests\Tests\TypeProviderHelper;
 
 final class GetHeaderLineTest extends TestCase
 {
@@ -55,14 +53,4 @@ public function testGetHeaderLineWithCaseInsensitiveNameReturnsString()
 
         $this->assertSame('value', $request->getHeaderLine('NAME'));
     }
-
-    /**
-     * Data Provider.
-     *
-     * @return array<string, mixed>
-     */
-    public function dataInvalidTypeNotString()
-    {
-        return TypeProviderHelper::getAllExcept(TypeProviderHelper::GROUP_STRING);
-    }
 }

tests/Psr/Request/GetHeaderTest.php

@@ -4,11 +4,9 @@
 
 namespace Art4\Requests\Tests\Psr\Request;
 
-use InvalidArgumentException;
-use Psr\Http\Message\UriInterface;
 use Art4\Requests\Psr\Request;
+use Psr\Http\Message\UriInterface;
 use Yoast\PHPUnitPolyfills\TestCases\TestCase;
-use Art4\Requests\Tests\TypeProviderHelper;
 
 final class GetHeaderTest extends TestCase
 {
@@ -55,14 +53,4 @@ public function testGetHeaderWithCaseInsensitiveNameReturnsArray()
 
         $this->assertSame(['value'], $request->getHeader('NAME'));
     }
-
-    /**
-     * Data Provider.
-     *
-     * @return array<string, mixed>
-     */
-    public function dataInvalidTypeNotString()
-    {
-        return TypeProviderHelper::getAllExcept(TypeProviderHelper::GROUP_STRING);
-    }
 }

tests/Psr/Request/GetRequestTargetTest.php

@@ -35,7 +35,7 @@ public function testGetRequestTargetReturnsString(string $path, string $query, s
      *
      * @return array<string,string[]>
      */
-    public function dataGetRequestTarget(): array
+    public static function dataGetRequestTarget(): array
     {
         return [
             'Retrieves the message request target' => ['path', '', 'path'],

tests/Psr/Request/HasHeaderTest.php

@@ -4,11 +4,9 @@
 
 namespace Art4\Requests\Tests\Psr\Request;
 
-use InvalidArgumentException;
-use Psr\Http\Message\UriInterface;
 use Art4\Requests\Psr\Request;
+use Psr\Http\Message\UriInterface;
 use Yoast\PHPUnitPolyfills\TestCases\TestCase;
-use Art4\Requests\Tests\TypeProviderHelper;
 
 final class HasHeaderTest extends TestCase
 {
@@ -55,14 +53,4 @@ public function testHasHeaderWithCaseInsensitiveNameReturnsTrue()
 
         $this->assertTrue($request->hasHeader('name'));
     }
-
-    /**
-     * Data Provider.
-     *
-     * @return array<string, mixed>
-     */
-    public function dataInvalidTypeNotString()
-    {
-        return TypeProviderHelper::getAllExcept(TypeProviderHelper::GROUP_STRING);
-    }
 }