ilMailAddressParserTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\Attributes\DataProvider;

class ilMailAddressParserTest extends ilMailBaseTestCase
{
    private const string DEFAULT_HOST = 'ilias';

    public static function emailAddressesProvider(): array
    {
        return [
            'Username Addresses' => [
                'phpunit@' . self::DEFAULT_HOST . ',phpunit',
                [
                    new ilMailAddress('phpunit', self::DEFAULT_HOST),
                    new ilMailAddress('phpunit', self::DEFAULT_HOST),
                ],
            ],
            'Email Address' => [
                'phpunit@ilias.de',
                [
                    new ilMailAddress('phpunit', 'ilias.de'),
                ],
            ],
            'Email Addresses with Umlauts' => [
                'phpünit@ilias.de,phpnitü@ilias.de,üphpnit@iliäs.de',
                [
                    new ilMailAddress('phpünit', 'ilias.de'),
                    new ilMailAddress('phpnitü', 'ilias.de'),
                    new ilMailAddress('üphpnit', 'iliäs.de'),
                ],
            ],
            'Trailing Dot in Local Part of Email Address' => [
                'phpunit.@ilias.de',
                [
                    new ilMailAddress('phpunit.', 'ilias.de'),
                ],
            ],
            'Mailing List Address' => [
                '#il_ml_4711',
                [
                    new ilMailAddress('#il_ml_4711', self::DEFAULT_HOST),
                ],
            ],
            'Role Address' => [
                '#il_role_1000',
                [
                    new ilMailAddress('#il_role_1000', self::DEFAULT_HOST),
                ],
            ],
            'Local Role Address' => [
                '#il_crs_member_998',
                [
                    new ilMailAddress('#il_crs_member_998', self::DEFAULT_HOST),
                ],
            ],
            'Course Role Address With Role Names for Course and Role' => [
                '#member@[French Course]',
                [
                    new ilMailAddress('#member', '[French Course]'),
                ],
            ],
            'Course Role Recipient with Course Role Address (Role Names for Course and Role)' => [
                'Course Administrator <#admin@[Math Course]>',
                [
                    new ilMailAddress('#admin', '[Math Course]'),
                ],
            ],
            'Course Role Recipient with Course Role Address (Numeric Id for Course Role)' => [
                'Course Administrator <#il_crs_admin_2581>',
                [
                    new ilMailAddress('#il_crs_admin_2581', self::DEFAULT_HOST),
                ],
            ],
            'sepp@some.where;done@web.de' => [
                // https://mantis.ilias.de/view.php?id=30306
                'sepp@some.where;done@web.de',
                [
                    new ilMailAddress('sepp', 'some.where'),
                    new ilMailAddress('done', 'web.de'),
                ],
            ],
        ];
    }

    public static function emailInvalidAddressesProvider(): array
    {
        return [
            'Trailing Quote in Local Part' => [
                'phpunit"@',
            ],
            'Trailing Quote in Local Part of Email Address' => [
                'phpunit"@ilias.de',
            ],
        ];
    }

    #[DataProvider('emailAddressesProvider')]
    public function testBuiltInAddressParser(string $addresses, array $expected): void
    {
        if (!function_exists('imap_rfc822_parse_adrlist')) {
            $this->markTestSkipped('Skipped test, imap extension required');
        }

        $parser = new ilMailImapRfc822AddressParser($addresses);
        $parsed_addresses = $parser->parse();

        $this->assertCount(count($expected), $parsed_addresses);
        $this->assertEquals($expected, $parsed_addresses);
    }

    #[DataProvider('emailAddressesProvider')]
    public function testPearAddressParser(string $addresses, array $expected): void
    {
        $parser = new ilMailPearRfc822WrapperAddressParser($addresses);
        $parsed_addresses = $parser->parse();

        $this->assertEquals($expected, $parsed_addresses);
        $this->assertCount(count($expected), $parsed_addresses);
    }

    public function testAddressParserReturnsEmptyListIfAnEmptyAddressStringIsGiven(): void
    {
        $parser = new ilMailPearRfc822WrapperAddressParser('');
        $parsed_addresses = $parser->parse();

        $this->assertCount(0, $parsed_addresses);
    }

    #[DataProvider('emailInvalidAddressesProvider')]
    public function testExceptionShouldBeRaisedIfEmailCannotBeParsedWithPearAddressParser(string $addresses): void
    {
        $this->expectException(ilMailException::class);

        $parser = new ilMailPearRfc822WrapperAddressParser($addresses);
        $parser->parse();
    }

    public function testWrappingParserDelegatesParsingToAggregatedParser(): void
    {
        $wrapped_parser = $this->getMockBuilder(ilBaseMailRfc822AddressParser::class)
            ->setConstructorArgs(['phpunit', 'ilias'])
            ->getMock();
        $wrapped_parser->expects($this->once())->method('parse');

        $parser = new ilMailRfc822AddressParser($wrapped_parser);
        $parser->parse();
    }
}