diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #39609 [Notifier] Add tests for SlackOptions (OskarStark)

Browse Source 
This PR was squashed before being merged into the 5.1 branch.

Discussion
----------

[Notifier] Add tests for SlackOptions

| Q             | A
| ------------- | ---
| Branch?       | 5.1
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Commits
-------

dcaee9970b [Notifier] Add tests for SlackOptions
This commit is contained in:
Fabien Potencier 2021-01-06 10:28:14 +01:00
commit 7d904729b3
2 changed files with 189 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Symfony/Component/Notifier/Bridge/Slack/SlackOptions.php
View File

@ -24,7 +24,7 @@ use Symfony\Component\Notifier\Notification\Notification;
*/
final class SlackOptions implements MessageOptionsInterface
{
private $options = [];
private $options;
public function __construct(array $options = [])
{

188
src/Symfony/Component/Notifier/Bridge/Slack/Tests/SlackOptionsTest.php Normal file
View File

@ -0,0 +1,188 @@
<?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\Notifier\Bridge\Slack\Tests;
use PHPUnit\Framework\TestCase;
use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
use Symfony\Component\Notifier\Bridge\Slack\Block\SlackDividerBlock;
use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
use Symfony\Component\Notifier\Notification\Notification;
/**
* @author Oskar Stark <oskarstark@googlemail.com>
*/
final class SlackOptionsTest extends TestCase
{
use ExpectDeprecationTrait;
/**
* @dataProvider toArrayProvider
* @dataProvider toArraySimpleOptionsProvider
*/
public function testToArray(array $options, ?array $expected = null)
{
$this->assertSame($expected ?? $options, (new SlackOptions($options))->toArray());
}
public function toArrayProvider(): iterable
{
yield 'empty is allowed' => [
[],
[],
];
yield 'always unset recipient_id' => [
['recipient_id' => '42'],
[],
];
yield 'blocks containing 1 divider block' => [
[
'blocks' => [
$block = new SlackDividerBlock(),
],
],
[
'blocks' => [
$block,
],
],
];
}
public function toArraySimpleOptionsProvider(): iterable
{
yield [['as_user' => true]];
yield [['icon_emoji' => 'foo']];
yield [['icon_url' => 'https://symfony.com']];
yield [['link_names' => true]];
yield [['mrkdwn' => true]];
yield [['parse' => 'bar']];
yield [['unfurl_links' => true]];
yield [['unfurl_media' => true]];
yield [['username' => 'baz']];
}
/**
* @dataProvider getRecipientIdProvider
*/
public function testGetRecipientId(?string $expected, SlackOptions $options)
{
$this->assertSame($expected, $options->getRecipientId());
}
public function getRecipientIdProvider(): iterable
{
yield [null, new SlackOptions()];
yield [null, (new SlackOptions(['recipient_id' => null]))];
yield ['foo', (new SlackOptions())->recipient('foo')];
yield ['foo', (new SlackOptions(['recipient_id' => 'foo']))];
}
/**
* @dataProvider setProvider
*
* @param mixed $value
*/
public function testSet(string $method, string $optionsKey, $value)
{
$options = (new SlackOptions())->$method($value);
$this->assertSame($value, $options->toArray()[$optionsKey]);
}
public function setProvider(): iterable
{
yield ['asUser', 'as_user', true];
yield ['iconEmoji', 'icon_emoji', 'foo'];
yield ['iconUrl', 'icon_url', 'https://symfony.com'];
yield ['linkNames', 'link_names', true];
yield ['mrkdwn', 'mrkdwn', true];
yield ['parse', 'parse', 'bar'];
yield ['unfurlLinks', 'unfurl_links', true];
yield ['unfurlMedia', 'unfurl_media', true];
yield ['username', 'username', 'baz'];
}
public function testSetBlock()
{
$options = (new SlackOptions())->block(new SlackDividerBlock());
$this->assertSame([['type' => 'divider']], $options->toArray()['blocks']);
}
/**
* @group legacy
*/
public function testChannelMethodRaisesDeprecation()
{
$this->expectDeprecation('Since symfony/slack-notifier 5.1: The "Symfony\Component\Notifier\Bridge\Slack\SlackOptions::channel()" method is deprecated, use "recipient()" instead.');
(new SlackOptions())->channel('channel');
}
/**
* @dataProvider fromNotificationProvider
*/
public function testFromNotification(array $expected, Notification $notification)
{
$options = SlackOptions::fromNotification($notification);
$this->assertSame($expected, $options->toArray());
}
public function fromNotificationProvider(): iterable
{
$subject = 'Hi!';
$emoji = '🌧️';
$content = 'Content here ...';
yield 'without content + without exception' => [
[
'icon_emoji' => $emoji,
'blocks' => [
[
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => $subject,
],
],
],
],
(new Notification($subject))->emoji($emoji),
];
yield 'with content + without exception' => [
[
'icon_emoji' => $emoji,
'blocks' => [
[
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => $subject,
],
],
[
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => $content,
],
],
],
],
(new Notification($subject))->emoji($emoji)->content($content),
];
}
}