Skip to content

[Notifier] [DX] Abstract test cases #39495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 22, 2020
Merged

[Notifier] [DX] Abstract test cases #39495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/composer-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"preferred-install": {
"symfony/form": "source",
"symfony/http-kernel": "source",
"symfony/notifier": "source",
"symfony/validator": "source",
"*": "dist"
}
Expand Down
47 changes: 18 additions & 29 deletions src/Symfony/Component/Notifier/Bridge/Firebase/Tests/FirebaseTransportFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,50 +11,39 @@

namespace Symfony\Component\Notifier\Bridge\Firebase\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Notifier\Bridge\Firebase\FirebaseTransportFactory;
use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
use Symfony\Component\Notifier\Transport\Dsn;
use Symfony\Component\Notifier\Tests\TransportFactoryTestCase;
use Symfony\Component\Notifier\Transport\TransportFactoryInterface;

/**
* @author Oskar Stark <oskarstark@googlemail.com>
*/
final class FirebaseTransportFactoryTest extends TestCase
final class FirebaseTransportFactoryTest extends TransportFactoryTestCase
{
public function testCreateWithDsn()
/**
* @return FirebaseTransportFactory
*/
public function createFactory(): TransportFactoryInterface
{
$factory = $this->createFactory();

$transport = $factory->create(Dsn::fromString('firebase://username:password@host.test'));

$this->assertSame('firebase://host.test', (string) $transport);
}

public function testSupportsReturnsTrueWithSupportedScheme()
{
$factory = $this->createFactory();

$this->assertTrue($factory->supports(Dsn::fromString('firebase://username:password@default')));
return new FirebaseTransportFactory();
}

public function testSupportsReturnsFalseWithUnsupportedScheme()
public function createProvider(): iterable
{
$factory = $this->createFactory();

$this->assertFalse($factory->supports(Dsn::fromString('somethingElse://username:password@default')));
yield [
'firebase://host.test',
'firebase://username:password@host.test',
];
}

public function testUnsupportedSchemeThrowsUnsupportedSchemeException()
public function supportsProvider(): iterable
{
$factory = $this->createFactory();

$this->expectException(UnsupportedSchemeException::class);

$factory->create(Dsn::fromString('somethingElse://username:password@default'));
yield [true, 'firebase://username:password@default'];
yield [false, 'somethingElse://username:password@default'];
}

private function createFactory(): FirebaseTransportFactory
public function unsupportedSchemeProvider(): iterable
{
return new FirebaseTransportFactory();
yield ['somethingElse://username:password@default'];
}
}
36 changes: 16 additions & 20 deletions src/Symfony/Component/Notifier/Bridge/Firebase/Tests/FirebaseTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,44 +11,40 @@

namespace Symfony\Component\Notifier\Bridge\Firebase\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Notifier\Bridge\Firebase\FirebaseTransport;
use Symfony\Component\Notifier\Exception\LogicException;
use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\Message\MessageInterface;
use Symfony\Component\Notifier\Message\SmsMessage;
use Symfony\Component\Notifier\Tests\TransportTestCase;
use Symfony\Component\Notifier\Transport\TransportInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;

/**
* @author Oskar Stark <oskarstark@googlemail.com>
*/
final class FirebaseTransportTest extends TestCase
final class FirebaseTransportTest extends TransportTestCase
{
public function testToStringContainsProperties()
/**
* @return FirebaseTransport
*/
public function createTransport(?HttpClientInterface $client = null): TransportInterface
{
$transport = $this->createTransport();

$this->assertSame('firebase://host.test', (string) $transport);
return new FirebaseTransport('username:password', $client ?: $this->createMock(HttpClientInterface::class));
}

public function testSupportsMessageInterface()
public function toStringProvider(): iterable
{
$transport = $this->createTransport();

$this->assertTrue($transport->supports(new ChatMessage('testChatMessage')));
$this->assertFalse($transport->supports($this->createMock(MessageInterface::class)));
yield ['firebase://fcm.googleapis.com/fcm/send', $this->createTransport()];
}

public function testSendNonSmsMessageThrowsException()
public function supportedMessagesProvider(): iterable
{
$transport = $this->createTransport();

$this->expectException(LogicException::class);

$transport->send($this->createMock(MessageInterface::class));
yield [new ChatMessage('Hello!')];
}

private function createTransport(): FirebaseTransport
public function unsupportedMessagesProvider(): iterable
{
return (new FirebaseTransport('username:password', $this->createMock(HttpClientInterface::class)))->setHost('host.test');
yield [new SmsMessage('0611223344', 'Hello!')];
yield [$this->createMock(MessageInterface::class)];
}
}
2 changes: 1 addition & 1 deletion src/Symfony/Component/Notifier/Bridge/Firebase/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"require": {
"php": ">=7.2.5",
"symfony/http-client": "^4.3|^5.0",
"symfony/notifier": "~5.1.0"
"symfony/notifier": "~5.1.11"
},
"autoload": {
"psr-4": { "Symfony\\Component\\Notifier\\Bridge\\Firebase\\": "" },
Expand Down
67 changes: 21 additions & 46 deletions src/Symfony/Component/Notifier/Bridge/FreeMobile/Tests/FreeMobileTransportFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,67 +11,42 @@

namespace Symfony\Component\Notifier\Bridge\FreeMobile\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransportFactory;
use Symfony\Component\Notifier\Exception\IncompleteDsnException;
use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
use Symfony\Component\Notifier\Transport\Dsn;
use Symfony\Component\Notifier\Tests\TransportFactoryTestCase;
use Symfony\Component\Notifier\Transport\TransportFactoryInterface;

final class FreeMobileTransportFactoryTest extends TestCase
final class FreeMobileTransportFactoryTest extends TransportFactoryTestCase
{
public function testCreateWithDsn()
/**
* @return FreeMobileTransportFactory
*/
public function createFactory(): TransportFactoryInterface
{
$factory = $this->createFactory();

$transport = $factory->create(Dsn::fromString('freemobile://login:pass@host.test?phone=0611223344'));

$this->assertSame('freemobile://host.test?phone=0611223344', (string) $transport);
}

public function testCreateWithNoPhoneThrowsIncompleteDsnException()
{
$factory = $this->createFactory();

$this->expectException(IncompleteDsnException::class);

$factory->create(Dsn::fromString('freemobile://login:pass@default'));
}

public function testSupportsReturnsTrueWithSupportedScheme()
{
$factory = $this->createFactory();

$this->assertTrue($factory->supports(Dsn::fromString('freemobile://login:pass@default?phone=0611223344')));
return new FreeMobileTransportFactory();
}

public function testSupportsReturnsFalseWithUnsupportedScheme()
public function createProvider(): iterable
{
$factory = $this->createFactory();

$this->assertFalse($factory->supports(Dsn::fromString('somethingElse://login:pass@default?phone=0611223344')));
yield [
'freemobile://host.test?phone=0611223344',
'freemobile://login:pass@host.test?phone=0611223344',
];
}

public function testUnsupportedSchemeThrowsUnsupportedSchemeException()
public function supportsProvider(): iterable
{
$factory = $this->createFactory();

$this->expectException(UnsupportedSchemeException::class);

$factory->create(Dsn::fromString('somethingElse://login:pass@default?phone=0611223344'));
yield [true, 'freemobile://login:pass@default?phone=0611223344'];
yield [false, 'somethingElse://login:pass@default?phone=0611223344'];
}

public function testUnsupportedSchemeThrowsUnsupportedSchemeExceptionEvenIfRequiredOptionIsMissing()
public function incompleteDsnProvider(): iterable
{
$factory = $this->createFactory();

$this->expectException(UnsupportedSchemeException::class);

// unsupported scheme and missing "phone" option
$factory->create(Dsn::fromString('somethingElse://login:pass@default'));
yield 'missing option: phone' => ['freemobile://login:pass@default'];
}

private function createFactory(): FreeMobileTransportFactory
public function unsupportedSchemeProvider(): iterable
{
return new FreeMobileTransportFactory();
yield ['somethingElse://login:pass@default?phone=0611223344'];
yield ['somethingElse://login:pass@default']; // missing "phone" option
}
}
48 changes: 17 additions & 31 deletions src/Symfony/Component/Notifier/Bridge/FreeMobile/Tests/FreeMobileTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,52 +11,38 @@

namespace Symfony\Component\Notifier\Bridge\FreeMobile\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransport;
use Symfony\Component\Notifier\Exception\LogicException;
use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\Message\MessageInterface;
use Symfony\Component\Notifier\Message\SmsMessage;
use Symfony\Component\Notifier\Tests\TransportTestCase;
use Symfony\Component\Notifier\Transport\TransportInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;

final class FreeMobileTransportTest extends TestCase
final class FreeMobileTransportTest extends TransportTestCase
{
public function testToStringContainsProperties()
/**
* @return FreeMobileTransport
*/
public function createTransport(?HttpClientInterface $client = null): TransportInterface
{
$transport = $this->createTransport();

$this->assertSame('freemobile://host.test?phone=0611223344', (string) $transport);
}

public function testSupportsMessageInterface()
{
$transport = $this->createTransport();

$this->assertTrue($transport->supports(new SmsMessage('0611223344', 'Hello!')));

$this->assertFalse($transport->supports(new SmsMessage('0699887766', 'Hello!'))); // because this phone number is not configured on the transport!
$this->assertFalse($transport->supports($this->createMock(MessageInterface::class)));
return new FreeMobileTransport('login', 'pass', '0611223344', $client ?: $this->createMock(HttpClientInterface::class));
}

public function testSendNonSmsMessageThrowsException()
public function toStringProvider(): iterable
{
$transport = $this->createTransport();

$this->expectException(LogicException::class);

$transport->send($this->createMock(MessageInterface::class));
yield ['freemobile://smsapi.free-mobile.fr/sendmsg?phone=0611223344', $this->createTransport()];
}

public function testSendSmsMessageButInvalidPhoneThrowsException()
public function supportedMessagesProvider(): iterable
{
$transport = $this->createTransport();

$this->expectException(LogicException::class);

$transport->send(new SmsMessage('0699887766', 'Hello!'));
yield [new SmsMessage('0611223344', 'Hello!')];
}

private function createTransport(): FreeMobileTransport
public function unsupportedMessagesProvider(): iterable
{
return (new FreeMobileTransport('login', 'pass', '0611223344', $this->createMock(HttpClientInterface::class)))->setHost('host.test');
yield [new SmsMessage('0699887766', 'Hello!')]; // because this phone number is not configured on the transport!
yield [new ChatMessage('Hello!')];
yield [$this->createMock(MessageInterface::class)];
}
}
2 changes: 1 addition & 1 deletion src/Symfony/Component/Notifier/Bridge/FreeMobile/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"require": {
"php": ">=7.2.5",
"symfony/http-client": "^4.3|^5.1",
"symfony/notifier": "~5.1.0"
"symfony/notifier": "~5.1.11"
},
"autoload": {
"psr-4": { "Symfony\\Component\\Notifier\\Bridge\\FreeMobile\\": "" },
Expand Down
Loading