Allow projects to provide additional_composer_arguments

README.md

@@ -94,7 +94,10 @@ The "job" element will have the following elements, but is not restricted to the
   "dependencies": "(optional) dependencies to test against; one of lowest, locked, latest. default: locked",
   "command": "(required) command to run to perform the check", 
   "ignore_platform_reqs_8": "(optional; deprecated) boolean; whether to add `--ignore-platform-req=php` to composer for PHP 8.0. default: true",
-  "ignore_php_platform_requirement": "(optional) boolean; whether to add `--ignore-platform-req=php` to composer for this job."
+  "ignore_php_platform_requirement": "(optional) boolean; whether to add `--ignore-platform-req=php` to composer for this job.",
+  "additional_composer_arguments": [
+      "(optional) list of arguments to be passed to `composer install` and `composer update`"
+  ]
 }
 ```
 
@@ -125,7 +128,9 @@ The package can include a configuration file in its root, `.laminas-ci.json`, wh
   "ignore_php_platform_requirements": {
       "8.0": true
   },
-  "stablePHP": "7.4"
+  "stablePHP": "7.4",
+  "additional_composer_arguments": [
+  ]
 }
 ```
 

src/additional-checks.js

@@ -147,6 +147,23 @@ const discoverIgnorePhpPlatformDetailsForCheck = function (job, ignore_php_platf
     return Object.assign(ignore_php_platform_requirements, ignore_php_platform_requirements_for_job);
 };
 
+/**
+ * @param {Object} job
+ * @param {Array<String>} additional_composer_arguments
+ * @return {Array<String>}
+ */
+const discoverAdditionalComposerArgumentsForCheck = function (job, additional_composer_arguments) {
+    let unified_additional_composer_arguments = new Set(additional_composer_arguments);
+
+    if (typeof job.additional_composer_arguments !== undefined && Array.isArray(job.additional_composer_arguments)) {
+        job.additional_composer_arguments.forEach(
+            (argument) => unified_additional_composer_arguments = unified_additional_composer_arguments.add(argument)
+        );
+    }
+
+    return Array.from(unified_additional_composer_arguments);
+};
+
 /**
  * @param {String} name
  * @param {String} command
@@ -155,6 +172,7 @@ const discoverIgnorePhpPlatformDetailsForCheck = function (job, ignore_php_platf
  * @param {Array} extensions
  * @param {Array} ini
  * @param {Object} ignore_php_platform_requirements
+ * @param {Array<String>} additional_composer_arguments
  * @return {Array} Array of jobs
  */
 const createAdditionalJobList = function (
@@ -164,7 +182,8 @@ const createAdditionalJobList = function (
     dependencies,
     extensions,
     ini,
-    ignore_php_platform_requirements
+    ignore_php_platform_requirements,
+    additional_composer_arguments
 ) {
     return versions.reduce(function (jobs, version) {
         return jobs.concat(dependencies.reduce(function (jobs, deps) {
@@ -176,7 +195,8 @@ const createAdditionalJobList = function (
                     extensions,
                     ini,
                     deps,
-                    ignore_php_platform_requirements[version] ?? false
+                    ignore_php_platform_requirements[version] ?? false,
+                    additional_composer_arguments
                 ))
             ));
         }, []));
@@ -211,7 +231,8 @@ export default function (checks, config) {
             dependencies,
             discoverExtensionsForCheck(checkConfig.job, config),
             discoverIniSettingsForCheck(checkConfig.job, config),
-            discoverIgnorePhpPlatformDetailsForCheck(checkConfig.job, config.ignore_php_platform_requirements)
+            discoverIgnorePhpPlatformDetailsForCheck(checkConfig.job, config.ignore_php_platform_requirements),
+            discoverAdditionalComposerArgumentsForCheck(checkConfig.job, config.additional_composer_arguments)
         ));
     }, []);
 };

src/command.js

@@ -7,6 +7,7 @@ export class Command {
     ini                             = [];
     dependencies                    = 'locked';
     ignore_php_platform_requirement = false;
+    additional_composer_arguments   = [];
 
     /**
      * @param {String} command
@@ -15,14 +16,16 @@ export class Command {
      * @param {Array<String>} ini
      * @param {String} dependencies
      * @param {Boolean} ignore_php_platform_requirement
+     * @param {Array<String>} additional_composer_arguments
      */
-    constructor(command, php, extensions, ini, dependencies, ignore_php_platform_requirement) {
+    constructor(command, php, extensions, ini, dependencies, ignore_php_platform_requirement, additional_composer_arguments) {
         this.command                          = command;
         this.php                              = php;
         this.extensions                       = extensions;
         this.ini                              = ini;
         this.dependencies                     = dependencies;
-        this.ignore_php_platform_requirement = ignore_php_platform_requirement;
+        this.ignore_php_platform_requirement  = ignore_php_platform_requirement;
+        this.additional_composer_arguments    = additional_composer_arguments;
     }
 
     toJSON() {
@@ -34,6 +37,7 @@ export class Command {
             dependencies: this.dependencies,
             ignore_platform_reqs_8: this.ignore_php_platform_requirement,
             ignore_php_platform_requirement: this.ignore_php_platform_requirement,
+            additional_composer_arguments: this.additional_composer_arguments,
         };
     }
 };

src/config.js

@@ -82,6 +82,7 @@ class Config {
     ignore_php_platform_requirements   = {
         '8.0': true
     };
+    additional_composer_arguments      = [];
 
     /**
      * @param {Requirements} requirements
@@ -148,6 +149,11 @@ class Config {
             core.warning('Please use `ignore_php_platform_requirements` instead.');
             this.ignore_php_platform_requirements['8.0'] = configuration.ignore_platform_reqs_8;
         }
+
+        if (configuration.additional_composer_arguments !== undefined && Array.isArray(configuration.additional_composer_arguments)) {
+            const unified_additional_composer_arguments = new Set(configuration.additional_composer_arguments);
+            this.additional_composer_arguments = Array.from(unified_additional_composer_arguments);
+        }
     }
 }
 

src/create-jobs.js

@@ -35,6 +35,7 @@ const createQaJobs = function (command, config) {
             config.php_ini,
             'locked',
             config.ignore_php_platform_requirements[config.minimum_version] ?? false,
+            config.additional_composer_arguments
         ))
     )];
 };
@@ -85,6 +86,7 @@ const createPHPUnitJob = function (version, deps, config) {
             config.php_ini,
             deps,
             config.ignore_php_platform_requirements[version] ?? false,
+            config.additional_composer_arguments
         )),
     );
 };
@@ -103,6 +105,7 @@ const createNoOpJob = function (config) {
             [],
             'locked',
             config.ignore_php_platform_requirements[config.stable_version] ?? false,
+            config.additional_composer_arguments
         )),
     )];
 };