feat: introduce ignore_php_platform_requirements object for .laminas-ci.json

The `ignore_php_platform_requirements` can be an object containing the PHP version to ignore along with the instruction to either ignore the requirements or not.

This also deprecates the old `ignore_platform_reqs_8` configuration.

Signed-off-by: Maximilian Bösing <[email protected]>

Author: boesing

README.md

@@ -151,7 +151,12 @@ In each case, it MUST have the structure as noted above:
     "e.g. 'memory_limit=-1'"
   ],
   "dependencies": "dependencies to test against; one of lowest, locked, latest",
-  "ignore_platform_reqs_on_8": "(boolean; OPTIONAL) Whether or not to ignore platform requirements on PHP 8; defaults to true",
+  "ignore_platform_reqs_8": "(boolean; OPTIONAL; DEPRECATED) Whether or not to ignore platform requirements on PHP 8; defaults to true",
+  "ignore_platform_reqs": {
+      "8.0": true,
+      "8.1": true,
+      "(object; OPTIONAL) Whether or not to ignore platform requirements for specific PHP versions; defaults to true for PHP 8 & PHP 8.1": false
+  },
   "command": "command to run to perform the check"
 }
 ```
@@ -180,7 +185,12 @@ The syntax for the `additional_checks` key is as follows:
                 "ini": [
                     "(array of strings; OPTIONAL) specific php.ini settings to use for this check only"
                 ],
-                "ignore_platform_reqs_on_8": "(boolean; OPTIONAL) Whether or not to ignore platform reqs when installing dependencies on PHP 8.0; defaults to true"
+                "ignore_platform_reqs_8": "(boolean; OPTIONAL; DEPRECATED) Whether or not to ignore platform reqs when installing dependencies on PHP 8.0; defaults to true",
+                "ignore_platform_reqs": {
+                    "8.0": true,
+                    "8.1": true,
+                    "(object; OPTIONAL) Whether or not to ignore platform requirements for specific PHP versions; defaults to true for PHP 8 & PHP 8.1": false
+                }
             }
         }
     ]

index.js

@@ -45,7 +45,9 @@ core.info(`Using php extensions: ${JSON.stringify(config.extensions)}`);
 core.info(`Providing php.ini settings: ${JSON.stringify(config.php_ini)}`);
 core.info(`Dependency sets found: ${JSON.stringify(config.dependencies)}`);
 core.info(`Additional checks found: ${JSON.stringify(config.additional_checks)}`);
-core.info(`Ignore platform reqs on version 8: ${config.ignore_platform_reqs_8 ? "Yes" : "No"}`);
+for (const [IGNORE_PLATFORM_REQS_PHP_VERSION, IGNORE_PLATFORM_REQS] of Object.entries(config.ignore_php_platform_requirements)) {
+    core.info(`Ignoring platform requirements for PHP ${IGNORE_PLATFORM_REQS_PHP_VERSION}: ${IGNORE_PLATFORM_REQS ? "Yes" : "No"}`);
+}
 
 let matrix = {include: createJobs(config)};
 

src/additional-checks.js

@@ -105,16 +105,59 @@ const discoverDependencySetsForCheck = function (job, config) {
     return false;
 };
 
+/**
+ * @param {Object} job
+ * @param {Object} ignore_php_platform_requirements
+ * @return {Object}
+ */
+const discoverIgnorePhpPlatformDetailsForCheck = function (job, ignore_php_platform_requirements) {
+    let ignore_php_platform_requirements_for_job = ignore_php_platform_requirements;
+
+    if (typeof job.php !== 'string') {
+        return ignore_php_platform_requirements_for_job;
+    }
+
+    if (job.php === '*') {
+        ignore_php_platform_requirements_for_job = Object.assign(
+            ignore_php_platform_requirements_for_job,
+            job.ignore_php_platform_requirements ?? {}
+        );
+
+        return ignore_php_platform_requirements_for_job;
+    }
+
+    if (job.ignore_php_platform_requirement !== undefined && typeof job.ignore_php_platform_requirement === 'boolean') {
+        ignore_php_platform_requirements_for_job[job.php] = job.ignore_php_platform_requirement;
+    } else if (job.ignore_platform_reqs_8 !== undefined && typeof job.ignore_platform_reqs_8 === 'boolean') {
+        core.warning('WARNING: You are using `ignore_platform_reqs_8` in your projects configuration.');
+        core.warning('This is deprecated as of v1.9.0 of the matrix action and will be removed in future versions.');
+        core.warning('Please use `ignore_php_platform_requirement` or `ignore_php_platform_requirements` in your additional check configuration instead.');
+
+        ignore_php_platform_requirements_for_job['8.0'] = job.ignore_platform_reqs_8;
+    }
+
+    return Object.assign(ignore_php_platform_requirements, ignore_php_platform_requirements_for_job);
+};
+
 /**
  * @param {String} name
  * @param {String} command
  * @param {Array} versions
  * @param {Array} dependencies
  * @param {Array} extensions
  * @param {Array} ini
+ * @param {Object} ignore_php_platform_requirements
  * @return {Array} Array of jobs
  */
-const createAdditionalJobList = function (name, command, versions, dependencies, extensions, ini) {
+const createAdditionalJobList = function (
+    name,
+    command,
+    versions,
+    dependencies,
+    extensions,
+    ini,
+    ignore_php_platform_requirements
+) {
     return versions.reduce(function (jobs, version) {
         return jobs.concat(dependencies.reduce(function (jobs, deps) {
             return jobs.concat(new Job(
@@ -124,7 +167,8 @@ const createAdditionalJobList = function (name, command, versions, dependencies,
                     version,
                     extensions,
                     ini,
-                    deps
+                    deps,
+                    ignore_php_platform_requirements[version] ?? false
                 ))
             ));
         }, []));
@@ -157,7 +201,8 @@ export default function (config) {
             versions,
             dependencies,
             discoverExtensionsForCheck(checkConfig.job, config),
-            discoverIniSettingsForCheck(checkConfig.job, config)
+            discoverIniSettingsForCheck(checkConfig.job, config),
+            discoverIgnorePhpPlatformDetailsForCheck(checkConfig.job, config.ignore_php_platform_requirements)
         ));
     }, []);
 };

src/command.js

@@ -1,28 +1,28 @@
 import { CURRENT_STABLE } from './config.js';
 
 export class Command {
-    command                = '';
-    php                    = CURRENT_STABLE;
-    extensions             = [];
-    ini                    = [];
-    dependencies           = 'locked';
-    ignore_platform_reqs_8 = true;
+    command                         = '';
+    php                             = CURRENT_STABLE;
+    extensions                      = [];
+    ini                             = [];
+    dependencies                    = 'locked';
+    ignore_php_platform_requirement = false;
 
     /**
      * @param {String} command
      * @param {String} php
      * @param {Array<String>} extensions
      * @param {Array<String>} ini
      * @param {String} dependencies
-     * @param {Boolean} ignore_platform_reqs_8
+     * @param {Boolean} ignore_php_platform_requirement
      */
-    constructor(command, php, extensions, ini, dependencies, ignore_platform_reqs_8) {
-        this.command                = command;
-        this.php                    = php;
-        this.extensions             = extensions;
-        this.ini                    = ini;
-        this.dependencies           = dependencies;
-        this.ignore_platform_reqs_8 = ignore_platform_reqs_8;
+    constructor(command, php, extensions, ini, dependencies, ignore_php_platform_requirement) {
+        this.command                          = command;
+        this.php                              = php;
+        this.extensions                       = extensions;
+        this.ini                              = ini;
+        this.dependencies                     = dependencies;
+        this.ignore_php_platform_requirement = ignore_php_platform_requirement;
     }
 
     toJSON() {
@@ -32,7 +32,8 @@ export class Command {
             extensions: this.extensions,
             ini: this.ini,
             dependencies: this.dependencies,
-            ignore_platform_reqs_8: this.ignore_platform_reqs_8,
+            ignore_platform_reqs_8: this.ignore_php_platform_requirement,
+            ignore_php_platform_requirement: this.ignore_php_platform_requirement,
         };
     }
 };

src/config.js

@@ -1,3 +1,4 @@
+import core from '@actions/core';
 import fs from 'fs';
 import semver from 'semver';
 import { Requirements } from './check-requirements.js';
@@ -58,19 +59,21 @@ function gatherVersions (composerJson) {
 }
 
 class Config {
-    code_checks            = true;
-    doc_linting            = true;
-    versions               = [];
-    stable_version         = CURRENT_STABLE;
-    minimum_version        = CURRENT_STABLE;
-    locked_dependencies    = false;
-    extensions             = [];
-    php_ini                = ['memory_limit        = -1'];
-    dependencies           = ['lowest', 'latest'];
-    checks                 = [];
-    exclude                = [];
-    additional_checks      = [];
-    ignore_platform_reqs_8 = true;
+    code_checks                        = true;
+    doc_linting                        = true;
+    versions                           = [];
+    stable_version                     = CURRENT_STABLE;
+    minimum_version                    = CURRENT_STABLE;
+    locked_dependencies                = false;
+    extensions                         = [];
+    php_ini                            = ['memory_limit        = -1'];
+    dependencies                       = ['lowest', 'latest'];
+    checks                             = [];
+    exclude                            = [];
+    additional_checks                  = [];
+    ignore_php_platform_requirements   = {
+        '8.0': true
+    };
 
     /**
      * @param {Requirements} requirements
@@ -116,8 +119,18 @@ class Config {
             this.additional_checks = configuration.additional_checks;
         }
 
+        if (configuration.ignore_php_platform_requirements !== undefined && typeof configuration.ignore_php_platform_requirements === 'object') {
+            this.ignore_php_platform_requirements = Object.assign(
+                this.ignore_php_platform_requirements,
+                configuration.ignore_php_platform_requirements
+            );
+        }
+
         if (configuration.ignore_platform_reqs_8 !== undefined && typeof configuration.ignore_platform_reqs_8 === 'boolean') {
-            this.ignore_platform_reqs_8 = configuration.ignore_platform_reqs_8;
+            core.warning('WARNING: You are using `ignore_platform_reqs_8` in your projects configuration.');
+            core.warning('This is deprecated as of v1.9.0 of the matrix action and will be removed in future versions.');
+            core.warning('Please use `ignore_php_platform_requirements` instead.');
+            this.ignore_php_platform_requirements['8.0'] = configuration.ignore_platform_reqs_8;
         }
     }
 }

src/create-jobs.js

@@ -34,7 +34,7 @@ const createQaJobs = function (command, config) {
             config.extensions,
             config.php_ini,
             'locked',
-            config.ignore_platform_reqs_8,
+            config.ignore_php_platform_requirements[config.minimum_version] ?? false,
         ))
     )];
 };
@@ -84,7 +84,7 @@ const createPHPUnitJob = function (version, deps, config) {
             config.extensions,
             config.php_ini,
             deps,
-            config.ignore_platform_reqs_8,
+            config.ignore_php_platform_requirements[version] ?? false,
         )),
     );
 };
@@ -102,7 +102,7 @@ const createNoOpJob = function (config) {
             [],
             [],
             'locked',
-            config.ignore_platform_reqs_8,
+            config.ignore_php_platform_requirements[config.stable_version] ?? false,
         )),
     )];
 };