Merge pull request #79 from systopia/chore-update-from-extension-template

chore: Apply changes from extension template

Author: dontub

.github/workflows/phpcs.yml

@@ -13,7 +13,7 @@ jobs:
     name: PHP_CodeSniffer
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -29,7 +29,7 @@ jobs:
       run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
     - name: Cache dependencies
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.composer-cache.outputs.dir }}
         key: ${{ runner.os }}-composer-${{ hashFiles('tools/phpcs/composer.json') }}

.github/workflows/phpstan.yml

@@ -20,7 +20,7 @@ jobs:
     name: PHPStan with PHP ${{ matrix.php-versions }} ${{ matrix.prefer }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -35,18 +35,18 @@ jobs:
       run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
     - name: Cache dependencies
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.composer-cache.outputs.dir }}
         key: ${{ runner.os }}-composer-${{ matrix.prefer }}-${{ hashFiles('**/composer.json') }}
         restore-keys: ${{ runner.os }}-composer-${{ matrix.prefer }}-
 
     - name: Install dependencies
       run: |
-        composer update --no-progress --prefer-dist --${{ matrix.prefer }} &&
+        composer update --no-progress --prefer-dist --${{ matrix.prefer }} --optimize-autoloader &&
         composer composer-phpunit -- update --no-progress --prefer-dist &&
         composer composer-phpstan -- update --no-progress --prefer-dist --optimize-autoloader &&
-        composer --working-dir=ci update --no-progress --prefer-dist --${{ matrix.prefer }} --optimize-autoloader --ignore-platform-req=ext-gd
+        composer --working-dir=ci update --no-progress --prefer-dist --${{ matrix.prefer }} --ignore-platform-req=ext-gd
 
     - name: Run PHPStan
       run: composer phpstan -- analyse -c phpstan.ci.neon

.github/workflows/phpunit.yml

@@ -7,6 +7,7 @@ on:
       - composer.json
       - tools/phpunit/composer.json
       - phpunit.xml.dist
+      - tests/docker-prepare.sh
 
 env:
   # On github CI machine creating the "/vendor" volume fails otherwise with: read-only file system: unknown
@@ -23,7 +24,7 @@ jobs:
       CIVICRM_IMAGE_TAG: ${{ matrix.civicrm-image-tags }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Pull images
       run: docker compose -f tests/docker-compose.yml pull --quiet
     - name: Start containers

ci/composer.json

@@ -6,7 +6,8 @@
             "civicrm/composer-compile-plugin": false,
             "civicrm/composer-downloads-plugin": true,
             "cweagans/composer-patches": true
-        }
+        },
+        "sort-packages": true
     },
     "require": {
         "civicrm/civicrm-core": "^5.54"

composer.json

@@ -1,13 +1,21 @@
 {
     "name": "systopia/de.systopia.civioffice",
+    "type": "civicrm-ext",
+    "license": "AGPL-3.0-or-later",
     "description": "CiviCRM integration for various exchangeable office suites",
-    "license": "AGPL-3.0",
     "authors": [
         {
-            "name": "SYSTOPIA",
-            "email": "[email protected]"
+            "name": "SYSTOPIA GmbH",
+            "email": "[email protected]",
+            "homepage": "https://www.systopia.de"
         }
     ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "config": {
+        "prepend-autoloader": false,
+        "sort-packages": true
+    },
     "require": {
         "beberlei/assert": "^3"
     },
@@ -33,7 +41,7 @@
             "@php tools/phpcs/vendor/bin/phpcbf"
         ],
         "phpstan": [
-            "@php tools/phpstan/vendor/bin/phpstan"
+            "@php tools/phpstan/vendor/bin/phpstan -v"
         ],
         "phpunit": [
             "@php tools/phpunit/vendor/bin/simple-phpunit --coverage-text"

phpstan.neon.dist

@@ -4,9 +4,10 @@ parameters:
 		- Civi
 		#- CRM
 		- tests
+		#- civioffice.php
 	excludePaths:
 		analyse:
-			- CRM/*/DAO/*
+			- CRM/Civioffice/DAO/*
 			- tests/phpunit/bootstrap.php
 	scanFiles:
 		- civioffice.civix.php
@@ -16,11 +17,12 @@ parameters:
 		- tools/phpunit/vendor/bin/.phpunit/phpunit/src/Framework
 	bootstrapFiles:
 		- tools/phpunit/vendor/bin/.phpunit/phpunit/vendor/autoload.php
-		- vendor/autoload.php
 		- phpstanBootstrap.php
 	level: 9
 	universalObjectCratesClasses:
 		- Civi\Core\Event\GenericHookEvent
+		- CRM_Core_Config
+		- CRM_Core_DAO
 	checkTooWideReturnTypesInProtectedAndPublicMethods: true
 	checkUninitializedProperties: true
 	checkMissingCallableSignature: true

phpstanBootstrap.php

@@ -41,3 +41,7 @@
     }
   }
 }
+
+if (file_exists(__DIR__ . '/vendor/autoload.php')) {
+  require_once __DIR__ . '/vendor/autoload.php';
+}

tests/docker-compose.yml

@@ -1,7 +1,6 @@
-version: "3"
 services:
   civicrm:
-    image: michaelmcandrew/civicrm:${CIVICRM_IMAGE_TAG:-5-drupal-php8.1}
+    image: michaelmcandrew/civicrm:${CIVICRM_IMAGE_TAG:-5-drupal}
     environment:
       - PROJECT_NAME=test
       - BASE_URL=http://localhost
@@ -10,6 +9,7 @@ services:
       - CIVICRM_DB_PASS=secret
       - CIVICRM_DB_HOST=mysql
       - CIVICRM_DB_PORT=3306
+      - CIVICRM_SITE_KEY=TEST_KEY
       - DRUPAL_DB_NAME=test
       - DRUPAL_DB_USER=root
       - DRUPAL_DB_PASS=secret

tests/docker-phpunit.sh

@@ -9,6 +9,16 @@ if [ ! -e tools/phpunit/vendor/bin ]; then
   "$SCRIPT_DIR/docker-prepare.sh"
 fi
 
+# CIVICRM_SMARTY_AUTOLOAD_PATH is not set in the container's civicrm.settings.php so we have to do it here.
+# Otherwise this results in this error:
+# Fatal error: Cannot declare class Smarty, because the name is already in use in /var/www/html/sites/all/modules/civicrm/packages/smarty5/Smarty.php on line 4
+smarty=$(printf '%s\n' /var/www/html/sites/all/modules/civicrm/packages/smarty* | sort -r | head -n1)
+if [ -e "$smarty/Smarty.php" ]; then
+  export CIVICRM_SMARTY_AUTOLOAD_PATH="$smarty/Smarty.php"
+elif [ -e "$smarty/vendor/autoload.php" ]; then
+  export CIVICRM_SMARTY_AUTOLOAD_PATH="$smarty/vendor/autoload.php"
+fi
+
 export XDEBUG_MODE=coverage
 # TODO: Remove when not needed, anymore.
 # In Docker container with CiviCRM 5.5? all deprecations are reported as direct

tests/docker-prepare.sh

@@ -27,13 +27,25 @@ else
     -i /var/www/html/sites/default/civicrm.settings.php
   civicrm-docker-install
 
-  cv ext:enable "$EXT_NAME"
+  # Avoid this error:
+  # The autoloader expected class "Civi\ActionSchedule\Mapping" to be defined in
+  # file "[...]/Civi/ActionSchedule/Mapping.php". The file was found but the
+  # class was not in it, the class name or namespace probably has a typo.
+  #
+  # Necessary for CiviCRM 5.66.0 - 5.74.x.
+  # https://github.com/civicrm/civicrm-core/blob/5.66.0/Civi/ActionSchedule/Mapping.php
+  if [ -e /var/www/html/sites/all/modules/civicrm/Civi/ActionSchedule/Mapping.php ] \
+      && grep -q '// Empty file' /var/www/html/sites/all/modules/civicrm/Civi/ActionSchedule/Mapping.php; then
+    rm /var/www/html/sites/all/modules/civicrm/Civi/ActionSchedule/Mapping.php
+  fi
 
   # For headless tests these files need to exist.
   touch /var/www/html/sites/all/modules/civicrm/sql/test_data.mysql
   touch /var/www/html/sites/all/modules/civicrm/sql/test_data_second_domain.mysql
+
+  cv ext:enable "$EXT_NAME"
 fi
 
 cd "$EXT_DIR"
-composer update --no-progress --prefer-dist --optimize-autoloader --no-dev
+composer update --no-progress --prefer-dist --optimize-autoloader
 composer composer-phpunit -- update --no-progress --prefer-dist