Codeception 5 compatibility (#66)

* initial change for codecept5

* refactor changes

* add Codeception 5.x to Requirements

* fix compatibility issues

Co-authored-by: Gregory Heitz <edno@users.noreply.github.com>

Earthfile

@@ -1,13 +1,15 @@
-ARG version=7.4
+ARG version=8.0
 ARG vendor=./vendor/bin
 FROM php:$version-alpine
 WORKDIR /codeception
 ENV XDEBUG_MODE=coverage
 
 deps:
+  RUN apk add git libzip-dev zip
   RUN apk add --quiet --no-progress --no-cache $PHPIZE_DEPS
   RUN pecl -q install xdebug
   RUN docker-php-ext-enable xdebug
+  RUN docker-php-ext-install zip
   RUN curl -sS https://getcomposer.org/installer | \
       php -- --install-dir=/usr/bin --filename=composer
 
@@ -17,15 +19,15 @@ setup:
   RUN composer update \
     --prefer-stable \
     --no-progress \
-    --no-interaction \
-    --quiet
+    --no-interaction
 
 test:
   FROM +setup
   RUN $vendor/codecept run \
     --no-interaction \
     --coverage \
-    --coverage-xml
+    --coverage-xml \
+    -v
   SAVE ARTIFACT tests/_output AS LOCAL ./tests/_output
 
 mutation:

README.md

@@ -20,7 +20,7 @@ scenario.
 
 ## Minimum Requirements
 
-- Codeception 3.x, 4.x
+- Codeception 3.x, 4.x, 5.x
 - PHP 7.4 - 8.1 (use release 2.0.6 for older PHP versions)
 
 ## Installation
@@ -80,20 +80,20 @@ modules:
 ## Usage
 
 Once installed you will be able to access variables stored using
-[Fixtures](https://codeception.com/docs/reference/Fixtures.html).  
+[Fixtures](https://codeception.com/docs/reference/Fixtures.html).
 
 ### Simple parameters
 
-In scenario steps, the variables can be accessed using the syntax `{{param}}`.  
+In scenario steps, the variables can be accessed using the syntax `{{param}}`.
 While executing your features the variables will be automatically replaced by their value.
 
 ### Array parameters
 
-You can refer to an element in an array using the syntax `{{param[key]}}`.  
+You can refer to an element in an array using the syntax `{{param[key]}}`.
 
 ### Test Suite Config parameters
 
-You can refer to a test suite configuration parameter using the syntax `{{config:param}}`.  
+You can refer to a test suite configuration parameter using the syntax `{{config:param}}`.
 Note that the keyword **config:** is mandatory.
 
 ## Example

codeception.dist.yml

@@ -6,6 +6,7 @@ paths:
     data: tests/_data
     support: tests/_support
     envs: tests/_envs
+    output: tests/_output
 
 settings:
     colors: true
@@ -29,4 +30,4 @@ coverage:
 
 modules:
     enabled:
-        - Codeception\Extension\GherkinParam
+        - Codeception\Extension\GherkinParam

composer.json

@@ -1,7 +1,14 @@
 {
   "name": "edno/codeception-gherkin-param",
   "description": "Codeception module for supporting parameter notation in Gherkin features",
-  "keywords": ["codeception", "extension", "gherkin", "bdd", "module", "test"],
+  "keywords": [
+    "codeception",
+    "extension",
+    "gherkin",
+    "bdd",
+    "module",
+    "test"
+  ],
   "homepage": "https://edno.github.io/codeception-gherkin-param",
   "license": "Apache-2.0",
   "authors": [
@@ -18,15 +25,15 @@
   "require-dev": {
     "brainmaestro/composer-git-hooks": "^2.8",
     "codeception/assert-throws": "^1.2",
-    "codeception/module-asserts": "^2",
-    "codeception/mockery-module": "^0.4",
+    "codeception/module-asserts": "^2.0|^3.0",
+    "codeception/mockery-module": "^0.4|^0.5",
     "infection/codeception-adapter": "^0.4",
     "infection/infection": "^0.26",
     "php-coveralls/php-coveralls": "^2",
     "phpstan/phpstan": "^0.12",
     "phpstan/phpstan-deprecation-rules": "^0.12",
     "phpstan/phpstan-phpunit": "^0.12",
-    "phpmd/phpmd" : "@stable",
+    "phpmd/phpmd": "@stable",
     "squizlabs/php_codesniffer": "^3"
   },
   "autoload": {

src/GherkinParam.php

@@ -31,6 +31,7 @@
 use \Codeception\Exception\ExtensionException;
 use \Codeception\Configuration;
 use \Codeception\Step;
+use \Codeception\Lib\ModuleContainer;
 use \Codeception\Extension\GherkinParamException;
 
 /**
@@ -39,15 +40,34 @@
  * @category Test
  * @package  GherkinParam
  * @author   Gregory Heitz <edno@edno.io>
- * @license  https://git.io/Juy0k Apache Licence
+ * @license  https://git.io/Juy0k Apache License
  * @link     https://packagist.org/packages/edno/codeception-gherkin-param
  *
  * @SuppressWarnings(PHPMD.CamelCaseMethodName)
  * @SuppressWarnings(PHPMD.CamelCaseVariableName)
  * @SuppressWarnings(PHPMD.CamelCasePropertyName)
  */
+
 class GherkinParam extends \Codeception\Module
 {
+    /**
+    * List events to listen to
+    *
+    * @var array<string,string>
+    */
+    public static array $events = [
+    //run before any suite
+    'suite.before' => 'beforeSuite',
+    //run before any steps
+    'step.before' => 'beforeStep'
+    ];
+
+    /**
+    * Current test suite config
+    *
+    * @var array<mixed>
+    */
+    private static $_suiteConfig;
 
     /**
      * Flag to enable exception (prioritized over $_nullable=true)
@@ -57,7 +77,7 @@ class GherkinParam extends \Codeception\Module
      *        instead replacement value is parameter {{name}}
      * true: exception thrown if parameter invalid
      */
-    private $_throwException = false;
+    private bool $_throwException = false;
 
     /**
      * Flag to null invalid parameter (incompatible with $_throwException=true)
@@ -66,40 +86,14 @@ class GherkinParam extends \Codeception\Module
      * true: if parameter invalid then replacement value will be null
      * false: default behaviour, ie replacement value is parameter {{name}}
      */
-    private $_nullable = false;
-
-    /**
-     * Array of configuration parameters
-     *
-     * @var array<string>
-     */
-    protected $config = ['onErrorThrowException', 'onErrorNull'];
-
-    /**
-     * List events to listen to
-     *
-     * @var array<string,string>
-     */
-    public static $events = [
-    //run before any suite
-    'suite.before' => 'beforeSuite',
-    //run before any steps
-    'step.before' => 'beforeStep'
-    ];
-
-    /**
-     * Current test suite config
-     *
-     * @var array<mixed>
-     */
-    private static $_suiteConfig;
+    private bool $_nullable = false;
 
     /**
      * RegExp for parsing steps
      *
      * @var array<string,string>
      */
-    private static $_regEx = [
+    private static array $_regEx = [
     'match'  => '/{{\s?[A-z0-9_:-<>]+\s?}}/',
     'filter' => '/[{}]/',
     'config' => '/(?:^config)?:([A-z0-9_-]+)+(?=:|$)/',

tests/_support/AcceptanceTester.php

@@ -116,9 +116,9 @@ public function iSeeTableNull(TableNode $table): void
      */
     public function theConfigurationParameterIsSetTo(
         string $param,
-        bool $value
+        ?string $value
     ): void {
-        $this->setConfigParam($param, $value);
+        $this->setConfigParam($param, (bool)$value);
     }
 
 }

tests/acceptance.suite.dist.yml

@@ -2,7 +2,7 @@
 #
 # Suite for acceptance tests.
 
-class_name: AcceptanceTester
+actor: AcceptanceTester
 
 modules:
   enabled:

tests/unit.suite.dist.yml

@@ -2,7 +2,7 @@
 #
 # Suite for unit tests.
 
-class_name: UnitTester
+actor: UnitTester
 
 modules:
   enabled: