Added phpstan to workflow (#1442)

* Pass phpstan level 1

* Updated composer.lock

* Reverted change & updated baseline

* Reverted change & updated baseline

* Updated workflow

* Updated workflow - added openmage version

* added help

.ddev/commands/web/phpstan

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+## Description: run PHPStan
+## Usage: phpstan
+## Example: ddev phpstan <path-to-files>
+
+XDEBUG_MODE=off php vendor/bin/phpstan analyze "$@"

.github/workflows/phpstan.yml

@@ -0,0 +1,76 @@
+name: PHPStan
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+jobs:
+  phpstan:
+    name: Analyze
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        openmage_version: ["20.10.2"]
+        operating-system: [ubuntu-latest]
+        php-versions: ['7.4']
+        mysql_version: ['8.0']
+
+    services:
+      mysql:
+        image: mysql:${{ matrix.mysql_version }}
+        env:
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: magento_test_db
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+
+      - uses: actions/checkout@v4
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Validate mysql service
+        run: |
+          echo "Checking mysql service"
+          sudo apt-get install -y mysql-client
+          mysql --host 127.0.0.1 --port ${{ job.services.mysql.ports['3306'] }} -uroot -proot -e "SHOW DATABASES"
+
+      - name: Install OpenMage
+        run: |
+          php bin/n98-magerun --no-interaction install \
+            --magentoVersionByName="openmage-${{ matrix.openmage_version }}" \
+            --installationFolder="./magento" \
+            --dbHost="127.0.0.1" \
+            --dbPort="${{ job.services.mysql.ports['3306'] }}" \
+            --dbUser="root" \
+            --dbPass="root" \
+            --dbName="magento_test_db" \
+            --installSampleData=no \
+            --useDefaultConfigParams=yes \
+            --baseUrl="http://magento.local/"
+        env:
+          COMPOSER_VENDOR_PATH : ${{ github.workspace }}/magento/vendor
+
+      - name: PHPStan Static Analysis
+        run: XDEBUG_MODE=off php vendor/bin/phpstan.phar analyze

.gitignore

@@ -29,4 +29,7 @@ act.secrets
 /docs/
 
 # php-cs-fixer cache
-/.php-cs-fixer.cache
+/.php-cs-fixer.cache
+
+# phpunit cache
+/.phpunit.result.cache

.phpstan.dist.baseline.neon

@@ -0,0 +1,16 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Unsafe usage of new static\\(\\)\\.$#"
+			count: 1
+			path: src/N98/Magento/Application/ConfigFile.php
+
+		-
+			message: "#^Call to an undefined static method N98\\\\Util\\\\OperatingSystem\\:\\:getCurrentPhpBinary\\(\\)\\.$#"
+			count: 1
+			path: src/N98/Magento/Command/Installer/SubCommand/InstallComposer.php
+
+		-
+			message: "#^Call to an undefined static method N98\\\\Util\\\\OperatingSystem\\:\\:locateProgram\\(\\)\\.$#"
+			count: 1
+			path: src/N98/Magento/Command/Installer/SubCommand/InstallComposer.php

.phpstan.dist.neon

@@ -0,0 +1,10 @@
+includes:
+    - .phpstan.dist.baseline.neon
+    - phar://phpstan.phar/conf/bleedingEdge.neon
+parameters:
+    paths:
+      - src
+    scanDirectories:
+      - magento
+    level: 1
+    treatPhpDocTypesAsCertain: false

composer.json

@@ -34,6 +34,7 @@
     "require-dev": {
         "ext-simplexml": "*",
         "bamarni/symfony-console-autocomplete": "^1.2.0",
+        "composer/composer": "^2.7",
         "friendsofphp/php-cs-fixer": "^3.4",
         "mikey179/vfsstream": "^1.6",
         "phing/phing": "~2.17.0",