Making a better build (#2)

* Making a better build

* Fixed phpstan config according to newest code quality pack

* Better tests

* Added code quality pack

* Added composer args to composer install command

* Added composer args to name of command

* Added psalm and fixed associated error

* Fixed comment to work with old version of ecs

* Upped the http message constraint since it made phpstan fail

Author: loevgaard

.github/workflows/build.yaml

@@ -3,26 +3,29 @@ on:
     push: ~
     pull_request: ~
     schedule:
-        - cron: 5 8 * * 3
+        - cron: 5 8 * * 5
 jobs:
     checks:
-        name: PHP ${{ matrix.php-versions }}
+        name: 'PHP ${{ matrix.php-versions }} with composer args: ${{ matrix.composer-args }}'
         runs-on: ${{ matrix.operating-system }}
         strategy:
             fail-fast: false
             matrix:
                 operating-system: [ubuntu-latest]
                 php-versions: ['7.2', '7.3', '7.4']
+                composer-args: ['--prefer-lowest --prefer-stable', '']
         steps:
             -   name: Checkout
                 uses: actions/checkout@v1
             -   name: Setup PHP, with composer and extensions
-                uses: shivammathur/setup-php@master
+                uses: shivammathur/setup-php@v2
                 with:
                     php-version: ${{ matrix.php-versions }}
                     extensions: mbstring
+                    coverage: none
+                    tools: composer-require-checker, composer-unused
             -   name: Install Composer dependencies
-                run: composer update --no-progress --no-suggest --prefer-dist --no-interaction
+                run: composer update --no-progress --no-suggest --prefer-dist --no-interaction ${{ matrix.composer-args }}
             -   name: Validate composer
                 run: composer validate --strict
             -   name: Check composer normalized
@@ -35,3 +38,9 @@ jobs:
                 run: composer phpspec
             -   name: Run phpunit
                 run: composer phpunit
+            -   name: Composer require checker
+                if: matrix.php-versions == '7.4' && matrix.composer-args == ''
+                run: composer-require-checker
+            -   name: Composer unused checker
+                if: matrix.php-versions == '7.4' && matrix.composer-args == ''
+                run: composer-unused

composer.json

@@ -13,20 +13,15 @@
         "php": "^7.2",
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
-        "psr/http-message": "^1.0",
+        "psr/http-message": "^1.0.1",
         "thecodingmachine/safe": "^1.0"
     },
     "require-dev": {
-        "ergebnis/composer-normalize": "^2.0",
-        "korbeil/phpstan-generic-rules": "^0.2",
         "kriswallsmith/buzz": "^1.0",
         "nyholm/psr7": "^1.1",
-        "phpspec/phpspec": "^5.1 || ^6.0",
-        "phpstan/phpstan": "^0.12",
-        "phpstan/phpstan-strict-rules": "^0.12",
-        "phpunit/phpunit": "^8.0",
-        "sylius-labs/coding-standard": "^3.1",
-        "thecodingmachine/phpstan-safe-rule": "^1.0beta"
+        "phpspec/phpspec": "^6.2",
+        "phpunit/phpunit": "^8.5",
+        "setono/code-quality-pack": "^1.2.1"
     },
     "config": {
         "sort-packages": true
@@ -48,7 +43,10 @@
     },
     "prefer-stable": true,
     "scripts": {
-        "analyse": "vendor/bin/phpstan analyse -c phpstan.neon -l max src",
+        "analyse": [
+            "vendor/bin/phpstan analyse -c phpstan.neon -l max src",
+            "vendor/bin/psalm"
+        ],
         "check-style": "vendor/bin/ecs check --ansi src/ tests/ spec/",
         "fix-style": "vendor/bin/ecs check --fix --ansi src/ tests/ spec/",
         "phpspec": "vendor/bin/phpspec run",

phpstan.neon

@@ -1,8 +1,3 @@
-includes:
-	- vendor/korbeil/phpstan-generic-rules/extension.neon
-	- vendor/phpstan/phpstan-strict-rules/rules.neon
-	- vendor/thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon
-
 parameters:
 	checkMissingIterableValueType: false
 

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src"/>
+        <ignoreFiles>
+            <directory name="vendor"/>
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Exception/RequestFailedException.php

@@ -50,8 +50,8 @@ public function getStatusCode(): int
 
     private static function resolveUri(UriInterface $uri): string
     {
-        // this will mask the API key in logs etc
-        $query = preg_replace('/apikey=[^&]+/i', 'apikey=******', $uri->getQuery());
+        /** @var string $query */
+        $query = preg_replace('/apikey=[^&]+/i', 'apikey=******', $uri->getQuery()); // this will mask the API key in logs etc
 
         return (string) $uri->withQuery($query);
     }

tests/Exception/RequestFailedExceptionTest.php

@@ -4,6 +4,7 @@
 
 namespace Setono\PostNord\Exception;
 
+use Nyholm\Psr7\Uri;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -15,13 +16,33 @@ final class RequestFailedExceptionTest extends TestCase
      */
     public function it_returns_correct_values(): void
     {
-        $request = $this->createMock(RequestInterface::class);
-        $response = $this->createMock(ResponseInterface::class);
+        $uri = new Uri('https://example.com/?apikey=secret&other_param=1');
+        $request = $this->prophesize(RequestInterface::class);
+        $request->getUri()->willReturn($uri);
+        $response = $this->prophesize(ResponseInterface::class);
 
-        $exception = new RequestFailedException($request, $response, 200);
+        $exception = new RequestFailedException($request->reveal(), $response->reveal(), 200);
 
-        $this->assertSame($request, $exception->getRequest());
-        $this->assertSame($response, $exception->getResponse());
-        $this->assertSame(200, $exception->getStatusCode());
+        self::assertSame($request->reveal(), $exception->getRequest());
+        self::assertSame($response->reveal(), $exception->getResponse());
+        self::assertSame(200, $exception->getStatusCode());
+    }
+
+    /**
+     * @test
+     */
+    public function it_masks_api_key(): void
+    {
+        $uri = new Uri('https://example.com/?apikey=secret&other_param=1');
+        $request = $this->prophesize(RequestInterface::class);
+        $request->getUri()->willReturn($uri);
+        $response = $this->prophesize(ResponseInterface::class);
+
+        $exception = new RequestFailedException($request->reveal(), $response->reveal(), 200);
+
+        self::assertSame(
+            'Request failed with status code 200. Request URI was: https://example.com/?apikey=******&other_param=1',
+            $exception->getMessage()
+        );
     }
 }