Refactor deprecation warning tests

getkirby · Dec 27, 2023 · 2e83a0e · 2e83a0e
1 parent 9ddc04d
commit 2e83a0e
Show file tree

Hide file tree

Showing 4 changed files with 151 additions and 117 deletions.
diff --git a/tests/Cms/Helpers/HelperFunctionsTest.php b/tests/Cms/Helpers/HelperFunctionsTest.php
@@ -8,10 +8,8 @@
 use Kirby\Image\QrCode;
 use Kirby\Toolkit\Collection;
 use Kirby\Toolkit\Obj;
-use PHPUnit\Framework\Assert;
-use PHPUnit\Framework\Error\Deprecated;
 
-class HelperFunctionsTest extends TestCase
+class HelperFunctionsTest extends HelpersTestCase
 {
 	protected $fixtures;
 	protected $kirby;
@@ -189,17 +187,11 @@ public function testCssWithArray()
 
 	public function testDeprecated()
 	{
-		// the deprecation warnings are always triggered in testing mode,
-		// so we cannot test it with disabled debug mode
-
-		try {
-			deprecated('The xyz method is deprecated.');
-		} catch (Deprecated $e) {
-			$this->assertSame('The xyz method is deprecated.', $e->getMessage());
-			return;
-		}
-
-		Assert::fail('Expected deprecation warning was not generated');
+		$this->assertError(
+			E_USER_DEPRECATED,
+			'The xyz method is deprecated.',
+			fn () => deprecated('The xyz method is deprecated.')
+		);
 	}
 
 	public function testDumpOnCli()

diff --git a/tests/Cms/Helpers/HelpersTest.php b/tests/Cms/Helpers/HelpersTest.php
@@ -4,17 +4,13 @@
 
 use Kirby\Exception\InvalidArgumentException;
 use Kirby\Toolkit\Obj;
-use PHPUnit\Framework\Assert;
-use PHPUnit\Framework\Error\Deprecated;
-use PHPUnit\Framework\Error\Warning;
 
 /**
  * @coversDefaultClass Kirby\Cms\Helpers
  */
-class HelpersTest extends TestCase
+class HelpersTest extends HelpersTestCase
 {
 	protected $deprecations = [];
-	protected $hasErrorHandler = false;
 
 	public function setUp(): void
 	{
@@ -28,69 +24,62 @@ public function tearDown(): void
 		parent::tearDown();
 
 		Helpers::$deprecations = $this->deprecations;
-
-		if ($this->hasErrorHandler === true) {
-			restore_error_handler();
-			$this->hasErrorHandler = false;
-		}
 	}
 
 	/**
 	 * @covers ::deprecated
 	 */
 	public function testDeprecated()
 	{
-		// the deprecation warnings are always triggered in testing mode,
-		// so we cannot test it with disabled debug mode
-
-		try {
-			Helpers::deprecated('The xyz method is deprecated.');
-		} catch (Deprecated $e) {
-			$this->assertSame('The xyz method is deprecated.', $e->getMessage());
-			return;
-		}
-
-		Assert::fail('Expected deprecation warning was not generated');
+		$this->assertError(
+			E_USER_DEPRECATED,
+			'The xyz method is deprecated.',
+			fn () => Helpers::deprecated('The xyz method is deprecated.')
+		);
 	}
 
 	/**
 	 * @covers ::deprecated
 	 */
 	public function testDeprecatedKeyUndefined()
 	{
-		try {
-			Helpers::deprecated('The xyz method is deprecated.', 'my-key');
-		} catch (Deprecated $e) {
-			$this->assertSame('The xyz method is deprecated.', $e->getMessage());
-			return;
-		}
-
-		Assert::fail('Expected deprecation warning was not generated');
+		$this->assertError(
+			E_USER_DEPRECATED,
+			'The xyz method is deprecated.',
+			fn () => Helpers::deprecated('The xyz method is deprecated.', 'my-key')
+		);
 	}
 
 	/**
 	 * @covers ::deprecated
 	 */
 	public function testDeprecatedActivated()
 	{
-		try {
-			Helpers::$deprecations = ['my-key' => true];
-			Helpers::deprecated('The xyz method is deprecated.', 'my-key');
-		} catch (Deprecated $e) {
-			$this->assertSame('The xyz method is deprecated.', $e->getMessage());
-			return;
-		}
-
-		Assert::fail('Expected deprecation warning was not generated');
+		$this->assertError(
+			E_USER_DEPRECATED,
+			'The xyz method is deprecated.',
+			function () {
+				Helpers::$deprecations = ['my-key' => true];
+				Helpers::deprecated('The xyz method is deprecated.', 'my-key');
+			}
+		);
 	}
 
 	/**
 	 * @covers ::deprecated
 	 */
 	public function testDeprecatedKeyDeactivated()
 	{
-		Helpers::$deprecations = ['my-key' => false];
-		$this->assertFalse(Helpers::deprecated('The xyz method is deprecated.', 'my-key'));
+		$result = $this->assertError(
+			E_USER_DEPRECATED,
+			'The xyz method is deprecated.',
+			function () {
+				Helpers::$deprecations = ['my-key' => false];
+				return Helpers::deprecated('The xyz method is deprecated.', 'my-key');
+			},
+			false
+		);
+		$this->assertFalse($result);
 	}
 
 	/**
@@ -211,24 +200,23 @@ public function testHandleErrorsWarningCaughtCallbackValue()
 	 */
 	public function testHandleErrorsWarningNotCaught()
 	{
-		try {
-			Helpers::handleErrors(
-				fn () => trigger_error('Some warning', E_USER_WARNING),
-				function (int $errno, string $errstr) {
-					$this->assertSame(E_USER_WARNING, $errno);
-					$this->assertSame('Some warning', $errstr);
-
-					// continue the handler chain
-					return false;
-				},
-				'handled'
-			);
-		} catch (Warning $e) {
-			$this->assertSame('Some warning', $e->getMessage());
-			return;
-		}
-
-		Assert::fail('Expected warning was not generated');
+		$this->assertError(
+			E_USER_WARNING,
+			'Some warning',
+			function () {
+				Helpers::handleErrors(
+					fn () => trigger_error('Some warning', E_USER_WARNING),
+					function (int $errno, string $errstr) {
+						$this->assertSame(E_USER_WARNING, $errno);
+						$this->assertSame('Some warning', $errstr);
+
+						// continue the handler chain
+						return false;
+					},
+					'handled'
+				);
+			}
+		);
 	}
 
 	/**

diff --git a/tests/Cms/HelpersTestCase.php b/tests/Cms/HelpersTestCase.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace Kirby\Cms;
+
+use Closure;
+
+class HelpersTestCase extends TestCase
+{
+	protected $hasErrorHandler = false;
+
+	public function tearDown(): void
+	{
+		parent::tearDown();
+
+		if ($this->hasErrorHandler === true) {
+			restore_error_handler();
+			$this->hasErrorHandler = false;
+		}
+	}
+
+	public function assertError(
+		int $expectedErrorType,
+		string $exptectedErrorMessage,
+		Closure $callback,
+		bool $expectedFailure = true
+	) {
+		$this->hasErrorHandler = true;
+
+		$called = false;
+
+		set_error_handler(
+			function (int $errno, string $errstr) use ($expectedErrorType, $exptectedErrorMessage, &$called) {
+				$called = true;
+				$this->assertSame($expectedErrorType, $errno);
+				$this->assertSame($exptectedErrorMessage, $errstr);
+			}
+		);
+
+		$result = $callback();
+
+		if ($expectedFailure === false) {
+			$this->assertFalse($called);
+			return $result;
+		}
+
+		$this->assertTrue($called);
+	}
+}