Merge pull request #6614 from Codeception/try-to-methods-always-retur…

…n-bool tryTo methods must always return Boolean result
Codeception · Dec 17, 2022 · 7bee938 · 7bee938
2 parents 7139bca + 63aaaa4
commit 7bee938
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/src/Codeception/Step/TryTo.php b/src/Codeception/Step/TryTo.php
@@ -46,6 +46,8 @@ public static function getTemplate(Template $template): ?Template
         return $template
             ->place('doc', $conditionalDoc)
             ->place('action', 'tryTo' . ucfirst($action))
+            ->place('return', 'return ')
+            ->place('return_type', ': bool')
             ->place('step', 'TryTo');
     }
 }
diff --git a/tests/data/retries/tests/_support/Helper/Retry.php b/tests/data/retries/tests/_support/Helper/Retry.php
@@ -16,7 +16,7 @@ public function _before(\Codeception\TestInterface $test)
         $this->time = microtime(true);
     }
 
-    public function failAt($amount = 3)
+    public function failAt($amount = 3): void
     {
         if ($this->fails < $amount) {
             ++$this->fails;

diff --git a/tests/data/retries/tests/retry.suite.yml b/tests/data/retries/tests/retry.suite.yml
@@ -2,6 +2,7 @@ actor: RetryTester
 modules:
     enabled:
         - \Helper\Retry
+        - Asserts
 step_decorators:
     - Codeception\Step\Retry
     - Codeception\Step\TryTo
diff --git a/tests/data/retries/tests/retry/TryToCest.php b/tests/data/retries/tests/retry/TryToCest.php
@@ -7,6 +7,7 @@ class TryToCest
     #[Group('ignore')]
     public function ignoreFailure(RetryTester $I)
     {
-        $I->tryToFailAt(1);
+        $result = $I->tryToFailAt(1);
+        $I->assertFalse($result, 'tryTo must return false on failure');
     }
 }