AssertTest.php

<?php

declare(strict_types=1);

namespace SimpleSAML\Test\Assert;

use BadMethodCallException;
use DateTimeImmutable;
use LogicException;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
use PHPUnit\Framework\TestCase;
use ReflectionMethod;
use SimpleSAML\Assert\Assert;
use SimpleSAML\Assert\AssertionFailedException;
use SimpleSAML\Test\Utils\TestClass;
use SimpleSAML\Test\Utils\TestEnum;
use stdClass;

use function opendir;
use function sys_get_temp_dir;

/**
 * Class \SimpleSAML\Assert\AssertTest
 *
 * @package simplesamlphp/assert
 */
#[CoversClass(Assert::class)]
final class AssertTest extends TestCase
{
    #[DoesNotPerformAssertions]
    public function testAssertionPassing(): void
    {
        Assert::integer(1);
    }


    /**
     */
    public function testAssertionFailingThrowsException(): void
    {
        $this->expectException(AssertionFailedException::class);
        Assert::nullOrSame('a', 'b');
    }


    /**
     */
    public function testAssertionFailingWithCustomExceptionThrowsCustomException(): void
    {
        $this->expectException(LogicException::class);
        Assert::allSame(['a', 'b', 'c'], 'b', LogicException::class);
    }


    /**
     */
    public function testUnknownAssertionRaisesBadMethodCallException(): void
    {
        $this->expectException(BadMethodCallException::class);
        // @phpstan-ignore staticMethod.notFound
        Assert::thisAssertionDoesNotExist('a', 'b', LogicException::class); // @phpstan-ignore-line
    }


    /**
     */
    public function testUnknownNullOrAssertionRaisesBadMethodCallException(): void
    {
        $this->expectException(BadMethodCallException::class);
        // @phpstan-ignore staticMethod.notFound
        Assert::nullOrThisAssertionDoesNotExist('a', 'b', LogicException::class); // @phpstan-ignore-line
    }


    /**
     */
    public function testUnknownAllAssertionRaisesBadMethodCallException(): void
    {
        $this->expectException(BadMethodCallException::class);
        // @phpstan-ignore staticMethod.notFound
        Assert::allThisAssertionDoesNotExist('a', 'b', LogicException::class); // @phpstan-ignore-line
    }


    /**
     */
    public function testNullOrCustomAssertionWorks(): void
    {
        Assert::nullOrValidBase64('U2ltcGxlU0FNTHBocA==');
        Assert::nullOrValidBase64(null);

        // Also make sure it keeps working for Webmozart's native assertions
        Assert::nullOrString(null);
        Assert::nullOrString('test');

        // Test a failure for coverage
        $this->expectException(AssertionFailedException::class);
        Assert::nullOrValidBase64('U2ltcGxlU0FNTHocA==');
    }


    /**
     */
    public function testAllCustomAssertionWorks(): void
    {
        Assert::allValidBase64(['U2ltcGxlU0FNTHBocA==', 'dGVzdA==']);

        // Also make sure it keeps working for Webmozart's native assertions
        Assert::allString(['test', 'phpunit']);

        // Test a failure for coverage
        $this->expectException(AssertionFailedException::class);
        Assert::allValidBase64(['U2ltcGxlU0FNTHocA==', null]);
    }


    /**
     * @param mixed $value
     * @param string $expected
     */
    #[DataProvider('provideValue')]
    public function testValueToString(mixed $value, string $expected): void
    {
        $assert = new Assert();
        $method = new ReflectionMethod(Assert::class, 'valueToString');

        $this->assertEquals($expected, $method->invoke($assert, $value));
    }


    /**
     * @return array<string, array{0: mixed, 1: string}>
     */
    public static function provideValue(): array
    {
        $stringable = new TestClass('phpunit');

        $dateTime = new DateTimeImmutable('2000-01-01T00:00:00+00:00');

        $otherObject = new stdClass();

        $resource = opendir(sys_get_temp_dir());

        $enum = TestEnum::PHPUnit;

        return [
            'null' => [null, 'null'],
            'true' => [true, 'true'],
            'false' => [false, 'false'],
            'array' => [[], 'array'],
            'Stringable' => [$stringable, 'SimpleSAML\Test\Utils\TestClass: "phpunit"'],
            'DateTime' => [$dateTime, 'DateTimeImmutable: "2000-01-01T00:00:00+00:00"'],
            'Enum' => [$enum, 'SimpleSAML\Test\Utils\TestEnum::PHPUnit'],
            'object' => [$otherObject, 'stdClass'],
            'resource' => [$resource, 'resource'],
            'string' => ['string', '"string"'],
            'other' => [1, '1'],
        ];
    }
}