AbstractTransportFactoryTestCase.php

<?php


/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Mailer\Test;

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Mailer\Exception\UnsupportedSchemeException;
use Symfony\Component\Mailer\Transport\Dsn;
use Symfony\Component\Mailer\Transport\TransportFactoryInterface;
use Symfony\Component\Mailer\Transport\TransportInterface;
abstract class AbstractTransportFactoryTestCase extends TestCase {
    protected const USER = 'u$er';
    protected const PASSWORD = 'pa$s';
    public abstract function getFactory() : TransportFactoryInterface;
    
    /**
     * @psalm-return iterable<array{0: Dsn, 1: bool}>
     */
    public static abstract function supportsProvider() : iterable;
    
    /**
     * @psalm-return iterable<array{0: Dsn, 1: TransportInterface}>
     */
    public static abstract function createProvider() : iterable;
    
    /**
     * @psalm-return iterable<array{0: Dsn, 1?: string|null}>
     */
    public static abstract function unsupportedSchemeProvider() : iterable;
    
    /**
     * @dataProvider supportsProvider
     */
    public function testSupports(Dsn $dsn, bool $supports) {
        $factory = $this->getFactory();
        $this->assertSame($supports, $factory->supports($dsn));
    }
    
    /**
     * @dataProvider createProvider
     */
    public function testCreate(Dsn $dsn, TransportInterface $transport) {
        $factory = $this->getFactory();
        $this->assertEquals($transport, $factory->create($dsn));
        if (str_contains('smtp', $dsn->getScheme())) {
            $this->assertStringMatchesFormat($dsn->getScheme() . '://%S' . $dsn->getHost() . '%S', (string) $transport);
        }
    }
    
    /**
     * @dataProvider unsupportedSchemeProvider
     */
    public function testUnsupportedSchemeException(Dsn $dsn, ?string $message = null) {
        $factory = $this->getFactory();
        $this->expectException(UnsupportedSchemeException::class);
        if (null !== $message) {
            $this->expectExceptionMessage($message);
        }
        $factory->create($dsn);
    }

}