Allow use of @precondition and @postcondition PHPUnit annotations

New in PHPUnit 9.1 sebastianbergmann/phpunit#4148 Change-Id: Ie147e7446e8edf1febf56cab7f69e0c33584395d
wikimedia · Dec 13, 2024 · 82f8c83 · 82f8c83
1 parent 6939f62
commit 82f8c83
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/MediaWiki/Sniffs/Commenting/FunctionAnnotationsSniff.php b/MediaWiki/Sniffs/Commenting/FunctionAnnotationsSniff.php
@@ -113,6 +113,8 @@ class FunctionAnnotationsSniff implements Sniff {
 		// are listed above
 		'@afterclass' => '@afterClass',
 		'@beforeclass' => '@beforeClass',
+		'@precondition' => '@preCondition',
+		'@postcondition' => '@postCondition',
 		'@codecoverageignore' => '@codeCoverageIgnore',
 		'@covernothing' => '@coverNothing',
 		'@coversnothing' => '@coversNothing',

diff --git a/MediaWiki/Sniffs/Commenting/PhpunitAnnotationsSniff.php b/MediaWiki/Sniffs/Commenting/PhpunitAnnotationsSniff.php
@@ -46,6 +46,9 @@ class PhpunitAnnotationsSniff implements Sniff {
 		'@before' => true,
 		'@beforeClass' => true,
 
+		'@preCondition' => true,
+		'@postCondition' => true,
+
 		'@covers' => true,
 		'@cover' => [ '@covers', 'SingularCover' ],
 
@@ -107,6 +110,8 @@ class PhpunitAnnotationsSniff implements Sniff {
 		'@afterClass',
 		'@before',
 		'@beforeClass',
+		'@preCondition',
+		'@postCondition',
 	];
 
 	/**
@@ -134,6 +139,16 @@ class PhpunitAnnotationsSniff implements Sniff {
 			'message' => 'setUp functions (*SetUpBeforeClass)',
 			'code' => 'NotSetUpBeforeClassFunction',
 		],
+		'@preCondition' => [
+			'regex' => '/PreConditions$/',
+			'message' => 'assertPreConditions functions (*PreConditions)',
+			'code' => 'NotAssertPreConditionsFunction',
+		],
+		'@postCondition' => [
+			'regex' => '/PostConditions$/',
+			'message' => 'assertPostConditions functions (*PostConditions)',
+			'code' => 'NotAssertPostConditionsFunction',
+		],
 		'*' => [
 			'regex' => '/^(?:test|provide)|Provider$/',
 			'message' => 'test functions',