Adding psalm, have a validation on code coverage, php 8.0

batenburg · Jan 10, 2021 · 7fa7ed1 · 7fa7ed1
1 parent af2c083
commit 7fa7ed1
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 7 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -10,6 +10,7 @@ php:
   - 7.2
   - 7.3
   - 7.4
+  - 8.0
 
 env:
   global:
@@ -62,6 +63,7 @@ jobs:
       php: 7.4
       script:
         - ./vendor/bin/phpcs
+        - ./vendor/bin/psalm
 
     - stage: Coverage
       php: 7.4
@@ -73,4 +75,4 @@ jobs:
       script:
         - ./vendor/bin/phpunit -v --coverage-clover ./build/logs/clover.xml
       after_script:
-        - php ./vendor/bin/php-coveralls -v
+        -  php coverage-checker.php clover.xml 100
diff --git a/composer.json b/composer.json
@@ -16,8 +16,8 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^8.5 || ^9.0",
-    "php-coveralls/php-coveralls": "^2.4",
-    "squizlabs/php_codesniffer": "^3.5"
+    "squizlabs/php_codesniffer": "^3.5",
+    "vimeo/psalm": "^4.3"
   },
   "autoload": {
     "psr-4": {

diff --git a/coverage-checker.php b/coverage-checker.php
@@ -0,0 +1,30 @@
+<?php
+$inputFile  = $argv[1];
+$percentage = min(100, max(0, (int) $argv[2]));
+
+if (!file_exists($inputFile)) {
+    throw new InvalidArgumentException('Invalid input file provided');
+}
+
+if (!$percentage) {
+    throw new InvalidArgumentException('An integer checked percentage must be given as second parameter');
+}
+
+$xml             = new SimpleXMLElement(file_get_contents($inputFile));
+$metrics         = $xml->xpath('//metrics');
+$totalElements   = 0;
+$checkedElements = 0;
+
+foreach ($metrics as $metric) {
+    $totalElements   += (int) $metric['elements'];
+    $checkedElements += (int) $metric['coveredelements'];
+}
+
+$coverage = ($checkedElements / $totalElements) * 100;
+
+if ($coverage < $percentage) {
+    echo 'Code coverage is ' . $coverage . '%, which is below the accepted ' . $percentage . '%' . PHP_EOL;
+    exit(1);
+}
+
+echo 'Code coverage is ' . $coverage . '% - OK!' . PHP_EOL;
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -0,0 +1,55 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="3"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <directory name="tests" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <PropertyNotSetInConstructor>
+            <errorLevel type="suppress">
+                <directory name="tests"/>
+            </errorLevel>
+        </PropertyNotSetInConstructor>
+
+        <PossiblyUndefinedMethod>
+            <errorLevel type="suppress">
+                <directory name="tests"/>
+            </errorLevel>
+        </PossiblyUndefinedMethod>
+
+        <PossiblyInvalidArgument>
+            <errorLevel type="suppress">
+                <directory name="tests"/>
+            </errorLevel>
+        </PossiblyInvalidArgument>
+
+        <MismatchingDocblockPropertyType>
+            <errorLevel type="suppress">
+                <directory name="tests"/>
+            </errorLevel>
+        </MismatchingDocblockPropertyType>
+
+        <MixedMethodCall>
+            <errorLevel type="suppress">
+                <directory name="tests"/>
+            </errorLevel>
+        </MixedMethodCall>
+
+        <InvalidThrow>
+            <errorLevel type="suppress">
+                <file name="src/Repository/CacheRepository.php"/>
+                <file name="tests/Unit/Repository/CacheRepositoryTest.php"/>
+            </errorLevel>
+        </InvalidThrow>
+    </issueHandlers>
+</psalm>
diff --git a/src/DependencyInjection/CacheExtension.php b/src/DependencyInjection/CacheExtension.php
@@ -16,7 +16,7 @@ class CacheExtension extends Extension
      * @param ContainerBuilder $container
      * @throws Exception
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');

diff --git a/tests/Unit/Repository/CacheRepositoryTest.php b/tests/Unit/Repository/CacheRepositoryTest.php
@@ -162,7 +162,7 @@ public function testWhenTheItemIsRetrievedFromTheCacheItWillNotSaveToTheCache():
     {
         // Setup
         $key     = 'test.key';
-        $closure = function () {
+        $closure = function (): string {
             return 'item';
         };
         $this->mockGetItem(1, [$key]);
@@ -187,7 +187,7 @@ public function testWhenAnItemIsNotInCacheTheRememberItemWillSaveAndReturnIt():
         // Setup
         $key      = 'test.key';
         $expected = 'expected result';
-        $closure  = function () use ($expected) {
+        $closure  = function () use ($expected): string {
             return $expected;
         };
         $this->mockGetItem(2, [$key], [$key]);
@@ -209,7 +209,7 @@ public function testARememberItemCanBeStoredWithACustomExpiresAfter(): void
         // Setup
         $key      = 'test.key';
         $expected = 'expected result';
-        $closure  = function () use ($expected) {
+        $closure  = function () use ($expected): string {
             return $expected;
         };
         $expiresAfterInSeconds = 600;
@@ -360,6 +360,10 @@ public function fakeFindByIdWithArgument(int $id, string $argument): string
         return $id . $argument;
     }
 
+    /**
+     * @param int $count
+     * @param mixed ...$keys
+     */
     private function mockGetItem(int $count, ...$keys): void
     {
         $this->cacheAdapter->expects($this->exactly($count))