Merge pull request #46 from youwe-petervanderwal/feat/pimcore-phpstan

Feat/pimcore phpstan

Author: youwe-petervanderwal

CHANGELOG.md

@@ -15,9 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Upstream projects not having phpunit installed will install phpunit with an @stable version.
 - Added support for Drupal configuration and templates.
 - Migration docs for migration from v2 to v3 of the testing suite.
-- Option to use PHP CS Fixer instead of PHPCS
-- Pimcore coding standards with [PER coding standards](https://www.php-fig.org/per/coding-style/)
-- Added support for an Allow List within the Security Checker. 
+- Option to use PHP CS Fixer instead of PHPCS.
+- Pimcore coding standards with [PER coding standards](https://www.php-fig.org/per/coding-style/).
+- Added support for an Allow List within the Security Checker.
+- Pimcore PHPStan default config.
 
 ### Changed
 - [BREAKING] The composer.json configurations `config.youwe-testing-suite.type` and `config.mediact-testing-suite.type`

config/pimcore/grumphp.yml

@@ -9,6 +9,4 @@ parameters:
   phpcs.enabled: false
   phpcsfixer.enabled: true
 
-#  securitychecker.allow_list:
-#    - CVE-2002-0121 # Add a jira ticket indicating when this vulnerability will be fixed (update/upgrade will be
-                     #    performed). Within that ticket explain this (new) vulnerability.
+  phpstan.level: 6

config/pimcore/phpstan-bootstrap.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+// Using same bootstrap as Pimcore (Bundles) uses themselves for PHPStan
+// phpcs:disable PSR1.Files.SideEffects.FoundWithSymbols
+
+if (file_exists(__DIR__ . '/../../../../../vendor/autoload.php')) {
+    define('PIMCORE_PROJECT_ROOT', __DIR__ . '/../../../../..');
+} elseif (getenv('PIMCORE_PROJECT_ROOT')) {
+    if (file_exists(getenv('PIMCORE_PROJECT_ROOT') . '/vendor/autoload.php')) {
+        define('PIMCORE_PROJECT_ROOT', getenv('PIMCORE_PROJECT_ROOT'));
+    } else {
+        throw new \Exception('Invalid Pimcore project root "' . getenv('PIMCORE_PROJECT_ROOT') . '"');
+    }
+} else {
+    throw new \Exception(
+        'Unknown configuration! Pimcore project root not found, please set env variable PIMCORE_PROJECT_ROOT.'
+    );
+}
+
+include PIMCORE_PROJECT_ROOT . '/vendor/autoload.php';
+\Pimcore\Bootstrap::setProjectRoot();
+\Pimcore\Bootstrap::bootstrap();
+
+if (!defined('PIMCORE_TEST')) {
+    define('PIMCORE_TEST', true);
+}

phpstan.neon

@@ -1,5 +1,6 @@
 parameters:
   excludePaths:
+    - config/pimcore/phpstan-bootstrap.php
     - src/installers.php
     - tests/*
   ignoreErrors:

src/Installer/PackagesInstaller.php

@@ -55,6 +55,12 @@ class PackagesInstaller implements InstallerInterface
                 'updateDependencies' => true,
             ]
         ],
+        'pimcore' => [
+            'phpstan/phpstan-symfony' => [
+                'version' => '@stable',
+                'updateDependencies' => true,
+            ],
+        ],
     ];
 
     /**

templates/files/pimcore/grumphp.yml

@@ -1,2 +1,13 @@
 imports:
-  - resource: 'vendor/youwe/testing-suite/config/pimcore/grumphp.yml'
+  - resource: 'vendor/youwe/testing-suite/config/pimcore/grumphp.yml'
+
+parameters:
+#  phpstan.level: 6 # The default PHPStan level for Pimcore is 6, but you might want to lower it for your project
+                    # when you're working towards stricter rules (and then increment it with every refactoring).
+                    # See https://phpstan.org/user-guide/rule-levels for more explanation about the different levels.
+                    # - For Pimcore 10.4 till 10.x: suggest to use level 5 maximum
+                    # - For Pimcore 10.0 till 10.3.x: suggest to use level 4 maximum
+
+#  securitychecker.allow_list:
+#    - CVE-2002-0121 # Add a jira ticket indicating when this vulnerability will be fixed (update/upgrade will be
+                     #    performed). Within that ticket explain this (new) vulnerability.

templates/files/pimcore/phpstan.neon

@@ -1,3 +1,23 @@
+includes:
+    - vendor/phpstan/phpstan-symfony/extension.neon
+
 parameters:
-  excludes_analyse:
-#    - %rootDir%/../../../path/to/exclude/*
+  excludePaths:
+    # Symfony files
+    - %rootDir%/../../../bin/console
+    - %rootDir%/../../../public/index.php
+    # Full var folder, contains all kind of auto-generated files (e.g. cache, generated Pimcore DataObject classes)
+    - %rootDir%/../../../var/*
+    # Configuration written by Pimcore (which is written either to var/ or to config/pimcore/ depending on settings)
+    - %rootDir%/../../../config/pimcore/*
+    # Unit tests
+    - %rootDir%/../../../tests/fixtures/*
+    # Deployer (which would be nice if it is correct too, but does need its own composer install, therefore excluding)
+    - %rootDir%/../../../build/deployer/*
+
+    # Custom excludes
+    # - %rootDir%/../../../path/to/exclude/*
+
+  # Point PHPStan to internal constants that are bootstrapped
+  bootstrapFiles:
+    - ./vendor/youwe/testing-suite/config/pimcore/phpstan-bootstrap.php