iTop/tests/php-unit-tests/unitary-tests/core/Log/DeprecatedCallsLogTest.php

<?php
/*
 * @copyright   Copyright (C) 2010-2024 Combodo SAS
 * @license     http://opensource.org/licenses/AGPL-3.0
 */

namespace Combodo\iTop\Test\UnitTest\Core\Log;


use Combodo\iTop\Test\UnitTest\ItopTestCase;
use DeprecatedCallsLog;

class DeprecatedCallsLogTest extends ItopTestCase
{
	/**
	 * We are testing for a undefined offset error. This was throwing a Notice, but starting with PHP 8.0 it was converted to a Warning ! Also the message was changed :(
	 *
	 * @link https://www.php.net/manual/en/migration80.incompatible.php check "A number of notices have been converted into warnings:"
	 */
	private function SetUndefinedOffsetExceptionToExpect(): void
	{
		/** @noinspection ConstantCanBeUsedInspection Preferring the function call as it is easier to read and won't cost that much in this PHPUnit context */
		if (version_compare(PHP_VERSION, '8.0', '>=')) {
			$this->expectWarning();
			$sUndefinedOffsetExceptionMessage = 'Undefined array key "tutu"';
		} else {
			$this->expectNotice();
			$sUndefinedOffsetExceptionMessage = 'Undefined index: tutu';
		}
		$this->expectExceptionMessage($sUndefinedOffsetExceptionMessage);
	}

	public function testPhpNoticeWithoutDeprecatedCallsLog(): void
	{
		$this->SetUndefinedOffsetExceptionToExpect();

		$aArray = [];
		if ('toto' === $aArray['tutu']) {
			//Do nothing, just raising a undefined offset warning
		}
	}

	/**
	 * @runInSeparateProcess Necessary, due to the DeprecatedCallsLog being enabled (no mean to reset)
	 *
	 * The error handler set by DeprecatedCallsLog during startup was causing PHPUnit to miss PHP notices like "undefined offset"
	 *
	 * The error handler is now disabled when running PHPUnit
	 *
	 * @since 3.0.4 N°6274
	 * @covers DeprecatedCallsLog::DeprecatedNoticesErrorHandler
	 */
	public function testPhpNoticeWithDeprecatedCallsLog(): void
	{
		$this->RequireOnceItopFile('core/log.class.inc.php');
		DeprecatedCallsLog::Enable(); // will set error handler
		$this->SetUndefinedOffsetExceptionToExpect();

		$aArray = [];
		if ('toto' === $aArray['tutu']) {
			//Do nothing, just raising a undefined offset warning
		}
	}

	/**
	 * @dataProvider GetMessageFromStackProvider
	 */
	public function testGetMessageFromStack($aDebugBacktrace, $sExpectedMessage): void
	{
		$sActualMessage = $this->InvokeNonPublicStaticMethod(DeprecatedCallsLog::class, 'GetMessageFromStack', [$aDebugBacktrace]);
		$this->assertEquals($sExpectedMessage, $sActualMessage);
	}

	public function GetMessageFromStackProvider()
	{
		return [
			'Call in a file outside of a function or class' => [
				[
					[
						'file'     => 'C:\Dev\wamp64\www\itop-32\sources\Application\WebPage\WebPage.php',
						'line'     => '866',
						'function' => 'NotifyDeprecatedPhpMethod',
						'class'    => 'DeprecatedCallsLog',
						'type'     => '::',
					],
					[
						'file'     => 'C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php',
						'line'     => '130',
						'function' => 'add_linked_script',
						'class'    => 'Combodo\iTop\Application\WebPage\WebPage',
						'type'     => '->',
					],
					[
						'file'     => 'C:\Dev\wamp64\www\itop-32\pages\exec.php',
						'line'     => '102',
						'args'     => ['C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php'],
						'function' => 'require_once',
					],
				],
				'Call to Combodo\iTop\Application\WebPage\WebPage::add_linked_script in C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php#L130 (from C:\Dev\wamp64\www\itop-32\pages\exec.php#L102)',
			],

			'Call in a file function, outside of a class' => [
				[
					[
						'file'     => 'C:\\Dev\\wamp64\\www\\itop-32\\sources\\Application\\WebPage\\WebPage.php',
						'line'     => 866,
						'function' => 'NotifyDeprecatedPhpMethod',
						'class'    => 'DeprecatedCallsLog',
						'type'     => '::',
					],
					[
						'file'     => 'C:\\Dev\\wamp64\\www\\itop-32\\extensions\\itop-object-copier\\copy.php',
						'line'     => 81,
						'function' => 'add_linked_script',
						'class'    => 'Combodo\\iTop\\Application\\WebPage\\WebPage',
						'type'     => '->',
					],
					[
						'file'     => 'C:\\Dev\\wamp64\\www\\itop-32\\extensions\\itop-object-copier\\copy.php',
						'line'     => 123,
						'function' => 'myFunction',
					],
				],
				'Call to Combodo\iTop\Application\WebPage\WebPage::add_linked_script in C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php#L81 (from C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php#L123)',
			],

			'Call from a class method' => [
				[
					[
						'file'     => 'C:\\Dev\\wamp64\\www\\itop-32\\sources\\Application\\WebPage\\WebPage.php',
						'line'     => 866,
						'function' => 'NotifyDeprecatedPhpMethod',
						'class'    => 'DeprecatedCallsLog',
						'type'     => '::',
					],
					[
						'file'     => 'C:\\Dev\\wamp64\\www\\itop-32\\extensions\\itop-object-copier\\copy.php',
						'line'     => 82,
						'function' => 'add_linked_script',
						'class'    => 'Combodo\\iTop\\Application\\WebPage\\WebPage',
						'type'     => '->',
					],
					[
						'file'     => 'C:\\Dev\\wamp64\\www\\itop-32\\extensions\\itop-object-copier\\copy.php',
						'line'     => 125,
						'function' => 'MyMethod',
						'class'    => 'MyClass',
						'type'     => '::',
					],
				],
				'Call to Combodo\iTop\Application\WebPage\WebPage::add_linked_script in C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php#L82 (from MyClass::MyMethod in C:\Dev\wamp64\www\itop-32\extensions\itop-object-copier\copy.php#L125)',
			],
		];
	}
}