From 1b6006c1689030c1c1e7a74bdcbe34b9da1cdab6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= <frederic.france@free.fr>
Date: Wed, 6 Dec 2023 18:25:19 +0100
Subject: [PATCH] QUAL phpstan github action

---
 .gitattributes                     |   3 +-
 .github/workflows/phpstan.yml      |  60 +++++++++++++++
 build/phpstan/bootstrap_action.php |  13 ++++
 phpstan_action.neon                | 118 +++++++++++++++++++++++++++++
 tmp/.gitkeep                       |   0
 5 files changed, 193 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/phpstan.yml
 create mode 100644 build/phpstan/bootstrap_action.php
 create mode 100644 phpstan_action.neon
 create mode 100644 tmp/.gitkeep

diff --git a/.gitattributes b/.gitattributes
index de9ce3303a9..37e320f933d 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -3,7 +3,7 @@
 * text=auto
 
 
-# Explicitly declare text files we want to always be normalized and converted 
+# Explicitly declare text files we want to always be normalized and converted
 # to native line endings on checkout.
 *.php text eol=lf
 *.pl text eol=lf
@@ -21,6 +21,7 @@
 *.yml text eol=lf
 *.yaml text eol=lf
 *.conf text eol=lf
+*.neon text eol=lf
 
 .bash_aliases text eol=lf
 
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
new file mode 100644
index 00000000000..ac3f6fc79f2
--- /dev/null
+++ b/.github/workflows/phpstan.yml
@@ -0,0 +1,60 @@
+# This is a basic workflow to check code with PHPSTAN tool
+
+name: PHPSTAN
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on pull request events but only for the develop branch
+  pull_request:
+    branches: [ develop ]
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version:
+          - "7.1"
+          - "8.2"
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+        with:
+         fetch-depth: 0
+      - name: Setup PHP
+        id: setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php-version }}"
+          tools: phpstan, cs2pr
+          extensions: calendar, json, imagick, gd, zip, mbstring, intl, opcache, imap, mysql, pgsql, sqlite3, ldap, xml
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 14.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: Restore phpstan cache
+        uses: actions/cache/restore@v3
+        with:
+          path: ./tmp
+          key: "phpstan-cache-PR-${{ matrix.php-version }}-${{ github.run_id }}"
+          restore-keys: |
+            phpstan-cache-PR-${{ matrix.php-version }}-
+      - name: Debug
+        run: cd ./tmp && ls -al
+      - name: Run PHPSTAN
+        run: phpstan -vvv analyse --error-format=checkstyle --memory-limit 4G -c phpstan_action.neon | cs2pr --graceful-warnings
+        continue-on-error: true
+      - name: "Save phpstan cache"
+        uses: actions/cache/save@v3
+        if: always()
+        with:
+          path: ./tmp
+          key: "phpstan-cache-PR-${{ matrix.php-version }}-${{ github.run_id }}"
diff --git a/build/phpstan/bootstrap_action.php b/build/phpstan/bootstrap_action.php
new file mode 100644
index 00000000000..f56067d66d8
--- /dev/null
+++ b/build/phpstan/bootstrap_action.php
@@ -0,0 +1,13 @@
+<?php
+// Defined some constants and load Dolibarr env to reduce PHPStan bootstrap that fails to load a lot of things.
+define('DOL_DOCUMENT_ROOT', __DIR__ . '/../../htdocs');
+define('DOL_DATA_ROOT', __DIR__ . '/../../documents');
+define('DOL_URL_ROOT', '/');
+define('DOL_MAIN_URL_ROOT', '/');
+define('MAIN_DB_PREFIX', 'llx_');
+
+// Load the main.inc.php file to have functions env defined
+define("NOLOGIN", '1');
+define("NOHTTPSREDIRECT", '1');
+global $conf, $db, $langs, $user;
+// include_once DOL_DOCUMENT_ROOT . '/../../htdocs/main.inc.php';
diff --git a/phpstan_action.neon b/phpstan_action.neon
new file mode 100644
index 00000000000..309c6951c95
--- /dev/null
+++ b/phpstan_action.neon
@@ -0,0 +1,118 @@
+parameters:
+	bootstrapFiles:
+		- build/phpstan/bootstrap_action.php
+	tmpDir: ./tmp
+	parallel:
+		jobSize: 20
+		processTimeout: 600.0
+		maximumNumberOfProcesses: 8
+		minimumNumberOfJobsPerProcess: 2
+		buffer: 134217728 # 128 MB
+	customRulesetUsed: true
+	level: 2
+	fileExtensions:
+		- php
+	paths:
+		- htdocs
+		- scripts
+	excludePaths:
+		analyseAndScan:
+		- htdocs/custom/*
+		- htdocs/documents/*
+		- htdocs/install/doctemplates/*
+		- htdocs/langs/*
+		- htdocs/modulebuilder/template/test/*
+		- htdocs/support/*
+		analyse:
+		- htdocs/includes/*
+	checkAlwaysTrueCheckTypeFunctionCall: false
+	checkAlwaysTrueInstanceof: false
+	checkAlwaysTrueStrictComparison: false
+	checkClassCaseSensitivity: false
+	checkFunctionArgumentTypes: false
+	checkFunctionNameCase: false
+	checkArgumentsPassedByReference: false
+	checkMaybeUndefinedVariables: false
+	checkNullables: false
+	checkThisOnly: true
+	checkUnionTypes: false
+	checkExplicitMixedMissingReturn: false
+	checkPhpDocMissingReturn: false
+	reportMaybes: false
+	reportMaybesInMethodSignatures: false
+	reportStaticMethodSignatures: false
+	polluteScopeWithLoopInitialAssignments: true
+	polluteScopeWithAlwaysIterableForeach: true
+	reportMagicMethods: false
+	reportMagicProperties: false
+	ignoreErrors:
+		- '#has an unused parameter \$param#'
+		- '#Result of function fieldList#'
+		- '#Caught class Stripe#'
+		- '#Function llxHeader invoked with#'
+		- '#Function llxHeaderVierge invoked with#'
+		- '#Function llxFooter invoked with#'
+		- '#Function llxFooterVierge invoked with#'
+		- '#If condition is always true#'
+		- '#always exists and is not falsy#'
+		- '#has no return type specified#'
+		- '#is always true#'
+		- '#is always fal#'
+		- '#always exists and is not nullable#'
+		- '#type has no value type specified in iterable type array#'
+		- '#with no value type specified in iterable type array#'
+		- '#Empty array passed to foreach#'
+		- '#in isset\(\) is not nullable#'
+		- '#in isset\(\) is never defined#'
+		- '#(\$force_dolibarr_lib|\$dolibarr_main_db).*in empty\(\) is never defined.#'
+		- '#Sprain\\SwissQrBill\\#'
+		- '#Constructor of class DolEditor has an unused parameter \$toolbarlocation#'
+		- '#Constructor of class DoliDB.* has an unused parameter \$type#'
+		- '#Default value of the parameter#'
+	internalErrorsCountLimit: 50
+	cache:
+		nodesByFileCountMax: 512
+		nodesByStringCountMax: 512
+	reportUnmatchedIgnoredErrors: false
+	universalObjectCratesClasses:
+		- stdClass
+		- SimpleXMLElement
+	earlyTerminatingMethodCalls: []
+	dynamicConstantNames:
+		- ICONV_IMPL
+		- PHP_VERSION
+		- PHP_MAJOR_VERSION
+		- PHP_MINOR_VERSION
+		- PHP_RELEASE_VERSION
+		- PHP_VERSION_ID
+		- PHP_EXTRA_VERSION
+		- PHP_ZTS
+		- PHP_DEBUG
+		- PHP_MAXPATHLEN
+		- PHP_OS
+		- PHP_OS_FAMILY
+		- PHP_SAPI
+		- PHP_EOL
+		- PHP_INT_MAX
+		- PHP_INT_MIN
+		- PHP_INT_SIZE
+		- PHP_FLOAT_DIG
+		- PHP_FLOAT_EPSILON
+		- PHP_FLOAT_MIN
+		- PHP_FLOAT_MAX
+		- DEFAULT_INCLUDE_PATH
+		- PEAR_INSTALL_DIR
+		- PEAR_EXTENSION_DIR
+		- PHP_EXTENSION_DIR
+		- PHP_PREFIX
+		- PHP_BINDIR
+		- PHP_BINARY
+		- PHP_MANDIR
+		- PHP_LIBDIR
+		- PHP_DATADIR
+		- PHP_SYSCONFDIR
+		- PHP_LOCALSTATEDIR
+		- PHP_CONFIG_FILE_PATH
+		- PHP_CONFIG_FILE_SCAN_DIR
+		- PHP_SHLIB_SUFFIX
+		- PHP_FD_SETSIZE
diff --git a/tmp/.gitkeep b/tmp/.gitkeep
new file mode 100644
index 00000000000..e69de29bb2d