Merge pull request Codeception#6124 from Codeception/issue-6122

Action file generator improvements

Author: Naktibalda

src/Codeception/Lib/Generator/Actions.php

@@ -155,11 +155,18 @@ protected function getParamsString(\ReflectionMethod $refMethod)
     {
         $params = [];
         foreach ($refMethod->getParameters() as $param) {
+            $type = '';
+            if (PHP_VERSION_ID >= 70000) {
+                $reflectionType = $param->getType();
+                if ($reflectionType !== null) {
+                    $type = $this->stringifyType($reflectionType) . ' ';
+                }
+            }
             if ($param->isOptional()) {
-                $params[] = '$' . $param->name . ' = ' . ReflectionHelper::getDefaultValue($param);
+                $params[] = $type . '$' . $param->name . ' = ' . ReflectionHelper::getDefaultValue($param);
             } else {
-                $params[] = '$' . $param->name;
-            };
+                $params[] = $type . '$' . $param->name;
+            }
         }
         return implode(', ', $params);
     }
@@ -222,13 +229,27 @@ private function createReturnTypeHint(\ReflectionMethod $refMethod)
             return '';
         }
 
+        return ': ' . $this->stringifyType($returnType);
+    }
+
+    /**
+     * @param \ReflectionType $returnType
+     * @return string
+     */
+    private function stringifyType(\ReflectionType $returnType)
+    {
+        if ($returnType instanceof \ReflectionUnionType) {
+            $types = $returnType->getTypes();
+            return implode('|', $types);
+        }
+
         if (PHP_VERSION_ID < 70100) {
             $returnTypeString = (string)$returnType;
         } else {
             $returnTypeString = $returnType->getName();
         }
         return sprintf(
-            ': %s%s%s',
+            '%s%s%s',
             $returnType->allowsNull() ? '?' : '',
             $returnType->isBuiltin() ? '' : '\\',
             $returnTypeString

tests/cli/BuildCest.php

@@ -41,7 +41,7 @@ public function usesTypehintsWherePossible(CliGuy $I, Scenario $scenario)
         $I->wantToTest('generate typehints with generated actions');
 
         $cliHelperContents = file_get_contents(codecept_root_dir('tests/support/CliHelper.php'));
-        $cliHelperContents = str_replace('public function grabFromOutput($regex)', 'public function grabFromOutput($regex): int', $cliHelperContents);
+        $cliHelperContents = str_replace('public function grabFromOutput($regex)', 'public function grabFromOutput(string $regex): int', $cliHelperContents);
         file_put_contents(codecept_root_dir('tests/support/CliHelper.php'), $cliHelperContents);
 
         $I->runShellCommand('php codecept build');
@@ -50,15 +50,34 @@ public function usesTypehintsWherePossible(CliGuy $I, Scenario $scenario)
         $I->seeInThisFile('class CliGuy extends \Codeception\Actor');
         $I->seeInThisFile('use _generated\CliGuyActions');
         $I->seeFileFound('CliGuyActions.php', 'tests/support/_generated');
-        $I->openFile(codecept_root_dir('tests/support/CliHelper.php'));
-        $I->seeInThisFile('public function grabFromOutput($regex): int');
-        $I->seeInThisFile('return $match[1]');
+        $I->seeInThisFile('public function grabFromOutput(string $regex): int');
+    }
+
+    public function generatedUnionReturnTypeOnPhp8(CliGuy $I, Scenario $scenario)
+    {
+        if (PHP_MAJOR_VERSION < 8) {
+            $scenario->skip('Does not work in PHP < 8');
+        }
+
+        $I->wantToTest('generate action with union return type');
+
+        $cliHelperContents = file_get_contents(codecept_root_dir('tests/support/CliHelper.php'));
+        $cliHelperContents = str_replace('public function grabFromOutput($regex)', 'public function grabFromOutput(array|string $param): int|string', $cliHelperContents);
+        file_put_contents(codecept_root_dir('tests/support/CliHelper.php'), $cliHelperContents);
+
+        $I->runShellCommand('php codecept build');
+        $I->seeInShellOutput('generated successfully');
+        $I->seeInSupportDir('CliGuy.php');
+        $I->seeInThisFile('class CliGuy extends \Codeception\Actor');
+        $I->seeInThisFile('use _generated\CliGuyActions');
+        $I->seeFileFound('CliGuyActions.php', 'tests/support/_generated');
+        $I->seeInThisFile('public function grabFromOutput(array|string $param): string|int');
     }
 
     public function noReturnForVoidType(CliGuy $I, Scenario $scenario)
     {
-        if (PHP_MAJOR_VERSION < 7) {
-            $scenario->skip('Does not work in PHP < 7');
+        if (PHP_VERSION_ID < 70100) {
+            $scenario->skip('Does not work in PHP < 7.1');
         }
 
         $I->wantToTest('no return keyword generated for void typehint');
@@ -73,9 +92,6 @@ public function noReturnForVoidType(CliGuy $I, Scenario $scenario)
         $I->seeInThisFile('class CliGuy extends \Codeception\Actor');
         $I->seeInThisFile('use _generated\CliGuyActions');
         $I->seeFileFound('CliGuyActions.php', 'tests/support/_generated');
-        $I->openFile(codecept_root_dir('tests/support/CliHelper.php'));
         $I->seeInThisFile('public function seeDirFound($dir): void');
-        $I->dontSeeInThisFile('return $this->assertTrue(is_dir(');
-        $I->seeInThisFile('$this->assertTrue(is_dir(');
     }
 }