Merge pull request #939 from ergebnis/feature/invoke-parent-method

Enhancement: Implement `InvokeParentHookMethodRule`

Author: localheinz

CHANGELOG.md

@@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 For a full diff see [`2.9.0...main`][2.9.0...main].
 
+### Added
+
+- Added `Methods\InvokeParentHookMethodRule`, which reports an error when a hook method that overrides a hook method in a parent class does not invoke the overridden hook method in the expected order ([#939]), by [@localheinz]
+
 ## [`2.9.0`][2.9.0]
 
 For a full diff see [`2.8.0...2.9.0`][2.8.0...2.9.0].
@@ -640,6 +644,7 @@ For a full diff see [`362c7ea...0.1.0`][362c7ea...0.1.0].
 [#913]: https://github.com/ergebnis/phpstan-rules/pull/913
 [#914]: https://github.com/ergebnis/phpstan-rules/pull/914
 [#938]: https://github.com/ergebnis/phpstan-rules/pull/938
+[#939]: https://github.com/ergebnis/phpstan-rules/pull/939
 
 [@cosmastech]: https://github.com/cosmastech
 [@enumag]: https://github.com/enumag

README.md

@@ -64,6 +64,7 @@ This package provides the following rules for use with [`phpstan/phpstan`](https
 - [`Ergebnis\PHPStan\Rules\Functions\NoParameterWithNullDefaultValueRule`](https://github.com/ergebnis/phpstan-rules#functionsnoparameterwithnulldefaultvaluerule)
 - [`Ergebnis\PHPStan\Rules\Functions\NoReturnByReferenceRule`](https://github.com/ergebnis/phpstan-rules#functionsnoreturnbyreferencerule)
 - [`Ergebnis\PHPStan\Rules\Methods\FinalInAbstractClassRule`](https://github.com/ergebnis/phpstan-rules#methodsfinalinabstractclassrule)
+- [`Ergebnis\PHPStan\Rules\Methods\InvokeParentHookMethodRule`](https://github.com/ergebnis/phpstan-rules#methodsinvokeparenthookmethodrule)
 - [`Ergebnis\PHPStan\Rules\Methods\NoConstructorParameterWithDefaultValueRule`](https://github.com/ergebnis/phpstan-rules#methodsnoconstructorparameterwithdefaultvaluerule)
 - [`Ergebnis\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRule`](https://github.com/ergebnis/phpstan-rules#methodsnonullablereturntypedeclarationrule)
 - [`Ergebnis\PHPStan\Rules\Methods\NoParameterPassedByReferenceRule`](https://github.com/ergebnis/phpstan-rules#methodsnoparameterpassedbyreferencerule)
@@ -446,6 +447,63 @@ parameters:
 			enabled: false
 ```
 
+#### `Methods\InvokeParentHookMethodRule`
+
+This rule reports an error when a hook method that overrides a hook method in a parent class does not invoke the overridden hook method in the expected order.
+
+##### Defaults
+
+By default, this rule requires the following hook methods to be invoked before doing something in the overriding method:
+
+- [`Codeception\PHPUnit\TestCase::_setUp()`](https://github.com/Codeception/phpunit-wrapper/blob/9.0.0/src/TestCase.php#L11-L13)
+- [`Codeception\PHPUnit\TestCase::_setUpBeforeClass()`](https://github.com/Codeception/phpunit-wrapper/blob/9.0.0/src/TestCase.php#L25-L27)
+- [`Codeception\Test\Unit::_before()`](https://github.com/Codeception/Codeception/blob/4.2.2/src/Codeception/Test/Unit.php#L63-L65)
+- [`Codeception\Test\Unit::_setUp()`](https://github.com/Codeception/Codeception/blob/4.2.2/src/Codeception/Test/Unit.php#L34-L58)
+- [`PHPUnit\Framework\TestCase::assertPreConditions()`](https://github.com/sebastianbergmann/phpunit/blob/6.0.0/src/Framework/TestCase.php#L2073-L2075)
+- [`PHPUnit\Framework\TestCase::setUp()`](https://github.com/sebastianbergmann/phpunit/blob/6.0.0/src/Framework/TestCase.php#L2063-L2065)
+- [`PHPUnit\Framework\TestCase::setUpBeforeClass()`](https://github.com/sebastianbergmann/phpunit/blob/6.0.0/src/Framework/TestCase.php#L2055-L2057)
+
+By default, this rule requires the following hook methods to be invoked after doing something in the overriding method:
+
+- [`Codeception\PHPUnit\TestCase::_tearDown()`](https://github.com/Codeception/phpunit-wrapper/blob/9.0.0/src/TestCase.php#L18-L20)
+- [`Codeception\PHPUnit\TestCase::_tearDownAfterClass()`](https://github.com/Codeception/phpunit-wrapper/blob/9.0.0/src/TestCase.php#L32-L34)
+- [`Codeception\Test\Unit::_after()`](https://github.com/Codeception/Codeception/blob/4.2.2/src/Codeception/Test/Unit.php#L75-L77)
+- [`Codeception\Test\Unit::_tearDown()`](https://github.com/Codeception/Codeception/blob/4.2.2/src/Codeception/Test/Unit.php#L67-L70)
+- [`PHPUnit\Framework\TestCase::assertPostConditions()`](https://github.com/sebastianbergmann/phpunit/blob/6.0.0/src/Framework/TestCase.php#L2083-L2085)
+- [`PHPUnit\Framework\TestCase::tearDown()`](https://github.com/sebastianbergmann/phpunit/blob/6.0.0/src/Framework/TestCase.php#L2091-L2093)
+- [`PHPUnit\Framework\TestCase::tearDownAfterClass()`](https://github.com/sebastianbergmann/phpunit/blob/6.0.0/src/Framework/TestCase.php#L2098-L2100)
+
+##### Disabling the rule
+
+You can set the `enabled` parameter to `false` to disable this rule.
+
+```neon
+parameters:
+	ergebnis:
+		invokeParentHookMethod:
+			enabled: false
+```
+
+##### Configuring methods to invoke the parent method in the right order:
+
+You can set the `hookMethods` parameter to a list of hook methods:
+
+```neon
+parameters:
+	ergebnis:
+		invokeParentHookMethod:
+			hookMethods:
+				- className: "Example\Test\Functional\AbstractCest"
+					methodName: "_before"
+					hasContent: "yes"
+					invocation: "first"
+```
+
+- `className`: name of the class that declares the hook method
+- `methodName`: name of the hook method
+- `hasContent`: one of `"yes"`, `"no"`, `"maybe"`
+- `invocation`: one of `"any"` (needs to be invoked), `"first"` (needs to be invoked before all other statements in the overriding hook method, `"last"` (needs to be invoked after all other statements in the overriding hook method)
+
 #### `Methods\NoConstructorParameterWithDefaultValueRule`
 
 This rule reports an error when a constructor declared in

composer-require-checker.json

@@ -2,6 +2,8 @@
   "symbol-whitelist": [
     "array",
     "bool",
+    "Codeception\\PHPUnit\\TestCase",
+    "Codeception\\Test\\Unit",
     "Doctrine\\ORM\\Mapping\\Embeddable",
     "Doctrine\\ORM\\Mapping\\Entity",
     "false",
@@ -30,6 +32,7 @@
     "PhpParser\\Node\\Stmt\\Class_",
     "PhpParser\\Node\\Stmt\\ClassMethod",
     "PhpParser\\Node\\Stmt\\Declare_",
+    "PhpParser\\Node\\Stmt\\Expression",
     "PhpParser\\Node\\Stmt\\Function_",
     "PhpParser\\Node\\Stmt\\InlineHTML",
     "PhpParser\\Node\\Stmt\\Switch_",

composer.json

@@ -26,11 +26,13 @@
     "phpstan/phpstan": "^2.1.8"
   },
   "require-dev": {
+    "codeception/codeception": "^4.0.0 || ^5.0.0",
     "doctrine/orm": "^2.20.0 || ^3.3.0",
     "ergebnis/composer-normalize": "^2.47.0",
     "ergebnis/license": "^2.6.0",
     "ergebnis/php-cs-fixer-config": "^6.46.0",
     "ergebnis/phpunit-slow-test-detector": "^2.19.1",
+    "fakerphp/faker": "^1.24.1",
     "nette/di": "^3.1.10",
     "phpstan/extension-installer": "^1.4.3",
     "phpstan/phpstan-deprecation-rules": "^2.0.3",