ConstantLooseComparisonRuleTest.php

<?php declare(strict_types = 1);

namespace PHPStan\Rules\Comparison;

use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\RequiresPhp;
use function array_merge;
use const PHP_VERSION_ID;

/**
 * @extends RuleTestCase<ConstantLooseComparisonRule>
 */
class ConstantLooseComparisonRuleTest extends RuleTestCase
{

	private bool $treatPhpDocTypesAsCertain = true;

	private bool $reportAlwaysTrueInLastCondition = false;

	protected function getRule(): Rule
	{
		return new ConstantLooseComparisonRule(
			new PossiblyImpureTipHelper(true),
			$this->treatPhpDocTypesAsCertain,
			$this->reportAlwaysTrueInLastCondition,
			true,
		);
	}

	public function testRule(): void
	{
		$this->analyse([__DIR__ . '/data/loose-comparison.php'], [
			[
				"Loose comparison using == between 0 and '0' will always evaluate to true.",
				16,
			],
			[
				"Loose comparison using == between 0 and '1' will always evaluate to false.",
				20,
			],
			[
				"Loose comparison using == between 0 and '1' will always evaluate to false.",
				27,
			],
			[
				"Loose comparison using == between 0 and '1' will always evaluate to false.",
				33,
			],
			[
				"Loose comparison using == between 0 and '0' will always evaluate to true.",
				35,
				'Remove remaining cases below this one and this error will disappear too.',
			],
			[
				'Loose comparison using != between 3 and 3 will always evaluate to false.',
				48,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
		]);
	}

	#[RequiresPhp('>= 8.1')]
	public function testBug8485(): void
	{
		$this->analyse([__DIR__ . '/data/bug-8485.php'], [
			[
				'Loose comparison using == between Bug8485\E::c and Bug8485\E::c will always evaluate to true.',
				21,
			],
			[
				'Loose comparison using == between Bug8485\F::c and Bug8485\E::c will always evaluate to false.',
				26,
			],
			[
				'Loose comparison using == between Bug8485\F::c and Bug8485\E::c will always evaluate to false.',
				31,
			],
			[
				'Loose comparison using == between Bug8485\F and Bug8485\E will always evaluate to false.',
				38,
			],
			[
				'Loose comparison using == between Bug8485\F and Bug8485\E::c will always evaluate to false.',
				43,
			],
		]);
	}

	public static function dataReportAlwaysTrueInLastCondition(): iterable
	{
		yield [false, [
			[
				'Loose comparison using == between 1 and 1 will always evaluate to true.',
				21,
				'Remove remaining cases below this one and this error will disappear too.',
			],
		]];
		yield [true, [
			[
				'Loose comparison using == between 1 and 1 will always evaluate to true.',
				12,
			],
			[
				'Loose comparison using == between 1 and 1 will always evaluate to true.',
				21,
			],
		]];
	}

	/**
	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
	 */
	#[DataProvider('dataReportAlwaysTrueInLastCondition')]
	public function testReportAlwaysTrueInLastCondition(bool $reportAlwaysTrueInLastCondition, array $expectedErrors): void
	{
		$this->reportAlwaysTrueInLastCondition = $reportAlwaysTrueInLastCondition;
		$this->analyse([__DIR__ . '/data/loose-comparison-report-always-true-last-condition.php'], $expectedErrors);
	}

	public static function dataTreatPhpDocTypesAsCertain(): iterable
	{
		yield [false, []];
		yield [true, [
			[
				'Loose comparison using == between 3 and 3 will always evaluate to true.',
				14,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
		]];
	}

	/**
	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
	 */
	#[DataProvider('dataTreatPhpDocTypesAsCertain')]
	public function testTreatPhpDocTypesAsCertain(bool $treatPhpDocTypesAsCertain, array $expectedErrors): void
	{
		$this->treatPhpDocTypesAsCertain = $treatPhpDocTypesAsCertain;
		$this->analyse([__DIR__ . '/data/loose-comparison-treat-phpdoc-types.php'], $expectedErrors);
	}

	public function testBug11694(): void
	{
		$expectedErrors = [
			[
				'Loose comparison using == between 3 and int<10, 20> will always evaluate to false.',
				17,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between int<10, 20> and 3 will always evaluate to false.',
				18,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between 23 and int<10, 20> will always evaluate to false.',
				23,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between int<10, 20> and 23 will always evaluate to false.',
				24,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between null and int<10, 20> will always evaluate to false.',
				26,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between int<10, 20> and null will always evaluate to false.',
				27,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
		];

		if (PHP_VERSION_ID >= 80000) {
			$expectedErrors = array_merge($expectedErrors, [
				[
					"Loose comparison using == between '13foo' and int<10, 20> will always evaluate to false.",
					29,
				],
				[
					"Loose comparison using == between int<10, 20> and '13foo' will always evaluate to false.",
					30,
				],
			]);
		}

		$expectedErrors = array_merge($expectedErrors, [
			[
				'Loose comparison using == between \' 3\' and int<10, 20> will always evaluate to false.',
				32,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between int<10, 20> and \' 3\' will always evaluate to false.',
				33,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between \' 23\' and int<10, 20> will always evaluate to false.',
				38,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between int<10, 20> and \' 23\' will always evaluate to false.',
				39,
				'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
			],
			[
				'Loose comparison using == between true and int<10, 20> will always evaluate to true.',
				41,
			],
			[
				'Loose comparison using == between int<10, 20> and true will always evaluate to true.',
				42,
			],
			[
				'Loose comparison using == between false and int<10, 20> will always evaluate to false.',
				44,
			],
			[
				'Loose comparison using == between int<10, 20> and false will always evaluate to false.',
				45,
			],
		]);

		$this->analyse([__DIR__ . '/data/bug-11694.php'], $expectedErrors);
	}

	public function testBug8800(): void
	{
		$this->treatPhpDocTypesAsCertain = true;
		$this->analyse([__DIR__ . '/data/bug-8800.php'], [
			[
				'Loose comparison using == between 0|1|false and 2 will always evaluate to false.',
				9,
			],
		]);
	}

	public function testBug13098(): void
	{
		$this->treatPhpDocTypesAsCertain = true;
		$this->analyse([__DIR__ . '/data/bug-13098.php'], []);
	}

	public function testBug14394(): void
	{
		$this->treatPhpDocTypesAsCertain = true;
		$this->analyse([__DIR__ . '/data/bug-14394.php'], [
			[
				'Loose comparison using == between float and NAN will always evaluate to false.',
				8,
			],
			[
				'Loose comparison using == between list<mixed> and array{NAN} will always evaluate to false.',
				10,
			],
			[
				'Loose comparison using == between NAN and NAN will always evaluate to false.',
				16,
			],
			[
				'Loose comparison using == between array{NAN} and array{NAN} will always evaluate to false.',
				18,
			],
		]);
	}

}