danog/telegram-entities
1
0
Fork 0
mirror of https://github.com/danog/telegram-entities.git synced 2024-11-26 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity
5202723d6d
telegram-entities/tests/EntitiesTest.php

900 lines
28 KiB
PHP
Raw Normal View History

First commit
2024-04-15 15:52:07 +02:00
<?php
declare(strict_types=1);
namespace danog\TestTelegramEntities;
use Amp\Http\Client\HttpClient;
use Amp\Http\Client\HttpClientBuilder;
use Amp\Http\Client\Request;
use AssertionError;
use danog\TelegramEntities\Entities;
use danog\TelegramEntities\EntityTools;
Fix toHTML
2024-04-22 17:29:36 +02:00
use PHPUnit\Framework\Attributes\DataProvider;
First commit
2024-04-15 15:52:07 +02:00
use PHPUnit\Framework\TestCase;
/** @internal */
class EntitiesTest extends TestCase
{
private static HttpClient $client;
public static function setUpBeforeClass(): void
{
self::$client = HttpClientBuilder::buildDefault();
}
public function testMb(): void
{
$this->assertEquals(1, EntityTools::mbStrlen('t'));
$this->assertEquals(1, EntityTools::mbStrlen('я'));
$this->assertEquals(2, EntityTools::mbStrlen('👍'));
$this->assertEquals(4, EntityTools::mbStrlen('🇺🇦'));
$this->assertEquals('st', EntityTools::mbSubstr('test', 2));
$this->assertEquals('aя', EntityTools::mbSubstr('aяaя', 2));
$this->assertEquals('a👍', EntityTools::mbSubstr('a👍a👍', 3));
$this->assertEquals('🇺🇦', EntityTools::mbSubstr('🇺🇦🇺🇦', 4));
$this->assertEquals(['te', 'st'], EntityTools::mbStrSplit('test', 2));
$this->assertEquals(['aя', 'aя'], EntityTools::mbStrSplit('aяaя', 2));
$this->assertEquals(['a👍', 'a👍'], EntityTools::mbStrSplit('a👍a👍', 3));
$this->assertEquals(['🇺🇦', '🇺🇦'], EntityTools::mbStrSplit('🇺🇦🇺🇦', 4));
}
private static function render(string $message, string $parse_mode): Entities
{
return match ($parse_mode) {
'html' => Entities::fromHtml($message),
'markdown' => Entities::fromMarkdown($message),
};
}
public function testEntities(): void
{
foreach ($this->provideEntities() as $params) {
$this->testEntitiesInner(...$params);
}
}
public function testUnclosed(): void
{
$this->expectExceptionMessage("Found unclosed markdown elements ](");
Entities::fromMarkdown('[');
}
public function testUnclosedLink(): void
{
$this->expectExceptionMessage("Unclosed ) opened @ pos 7!");
Entities::fromMarkdown('[test](https://google.com');
}
public function testUnclosedCode(): void
{
$this->expectExceptionMessage('Unclosed ``` opened @ pos 3!');
Entities::fromMarkdown('```');
}
public function testStandalone(): void
{
$test = Entities::fromMarkdown(']');
$this->assertEmpty($test->entities);
$this->assertSame(']', $test->message);
$test = Entities::fromMarkdown('!!');
$this->assertEmpty($test->entities);
$this->assertSame('!!', $test->message);
$test = Entities::fromMarkdown('|');
$this->assertEmpty($test->entities);
$this->assertSame('|', $test->message);
}
Fix toHTML
2024-04-22 17:29:36 +02:00
#[DataProvider('provideHtmlEntities')]
public function testToHtml(string $message, string $htmlTg, string $htmlNoTg, array $entities): void
{
$e = new Entities($message, $entities);
$this->assertEquals($htmlTg, $e->toHTML(true));
$this->assertEquals($htmlNoTg, $e->toHTML(false));
$this->assertEquals($htmlNoTg, $e->toHTML());
}
public static function provideHtmlEntities(): iterable
{
yield [
'test',
'test',
'test',
[[
'type' => 'bank_card',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<blockquote>test</blockquote>',
'<blockquote>test</blockquote>',
[[
'type' => 'block_quote',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<b>test</b>',
'<b>test</b>',
[[
'type' => 'bold',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<b>t<i>es</i>t</b>',
'<b>t<i>es</i>t</b>',
[[
'type' => 'bold',
'offset' => 0,
'length' => 4,
], [
'type' => 'italic',
'offset' => 1,
'length' => 2,
]]
];
yield [
'test',
'test',
'test',
[[
'type' => 'bot_command',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'test',
'test',
[[
'type' => 'cashtag',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<code>test</code>',
'<code>test</code>',
[[
'type' => 'code',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<tg-emoji emoji-id="12345">test</tg-emoji>',
'test',
[[
'type' => 'custom_emoji',
'offset' => 0,
'length' => 4,
'custom_emoji_id' => 12345,
]]
];
yield [
'test',
'<a href="mailto:test">test</a>',
'<a href="mailto:test">test</a>',
[[
'type' => 'email',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'test',
'test',
[[
'type' => 'hashtag',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<i>test</i>',
'<i>test</i>',
[[
'type' => 'italic',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<a href="tg://user?id=12345">test</a>',
'test',
[[
'type' => 'text_mention',
'offset' => 0,
'length' => 4,
'user' => ['id' => 12345]
]]
];
yield [
'@test',
'<a href="https://t.me/test">@test</a>',
'<a href="https://t.me/test">@test</a>',
[[
'type' => 'mention',
'offset' => 0,
'length' => 5,
]]
];
yield [
'test',
'test',
'test',
[[
'type' => 'phone_number',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<pre language="language">test</pre>',
'<pre language="language">test</pre>',
[[
'type' => 'pre',
'offset' => 0,
'length' => 4,
'language' => 'language',
]]
];
yield [
'test',
'<tg-spoiler>test</tg-spoiler>',
Add support for <span class="tg-spoiler">
2024-05-09 20:33:35 +02:00
'<span class="tg-spoiler">test</span>',
Fix toHTML
2024-04-22 17:29:36 +02:00
[[
'type' => 'spoiler',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<s>test</s>',
'<s>test</s>',
[[
'type' => 'strikethrough',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<a href="https://google.com">test</a>',
'<a href="https://google.com">test</a>',
[[
'type' => 'text_link',
'offset' => 0,
'length' => 4,
'url' => 'https://google.com',
]]
];
Add entity escaping to URLs
2024-05-07 15:11:17 +02:00
yield [
'test',
'<a href="https://google.com/?arg=a&amp;arg2=b">test</a>',
'<a href="https://google.com/?arg=a&amp;arg2=b">test</a>',
[[
'type' => 'text_link',
'offset' => 0,
'length' => 4,
'url' => 'https://google.com/?arg=a&arg2=b',
]]
];
Fix toHTML
2024-04-22 17:29:36 +02:00
yield [
'test',
'<u>test</u>',
'<u>test</u>',
[[
'type' => 'underline',
'offset' => 0,
'length' => 4,
]]
];
yield [
'test',
'<a href="test">test</a>',
'<a href="test">test</a>',
[[
'type' => 'url',
'offset' => 0,
'length' => 4,
]]
];
}
First commit
2024-04-15 15:52:07 +02:00
private function testEntitiesInner(string $mode, string $html, string $bare, array $entities, ?string $htmlReverse = null): void
{
$result = self::render(message: $html, parse_mode: $mode);
$this->assertEquals($bare, $result->message);
$this->assertEquals($entities, $result->entities);
if (
!\str_contains($html, 'tg://emoji')
&& !\str_contains($html, '<br')
&& !\str_contains($html, 'mention:')
&& $html !== '[not a link]'
&& $bare !== "a_b\n\\ ```"
) {
$token = \getenv("TOKEN");
$dest = \getenv("DEST");
if (!$token) {
throw new AssertionError("A TOKEN environment variable must be defined to run the tests!");
}
if (!$dest) {
throw new AssertionError("A DEST environment variable must be defined to run the tests!");
}
$resultApi = \json_decode(self::$client->request(new Request(
"https://api.telegram.org/bot{$token}/sendMessage?".\http_build_query([
'chat_id'=> $dest,
'parse_mode'=> match ($mode) {
'markdown' => 'MarkdownV2',
'html' => 'html'
},
'text' => $html
])
))->getBody()->buffer(), true);
if (!isset($resultApi['result'])) {
throw new AssertionError(\json_encode($resultApi));
}
$entities = $resultApi['result']['entities'] ?? [];
$entities = \array_map(function (array $e): array {
if (isset($e['user'])) {
$e['user'] = ['id' => $e['user']['id']];
}
return $e;
}, $entities);
$this->assertEquals($bare, $resultApi['result']['text']);
$this->assertEquals($entities, $entities);
}
if (\strtolower($mode) === 'html') {
$this->assertEquals(
\trim(\str_replace(['<br/>', ' </b>', 'mention:'], ['<br>', '</b> ', 'tg://user?id='], $htmlReverse ?? $html)),
$result->toHTML(true)
);
$result = self::render(message: EntityTools::htmlEscape($html), parse_mode: $mode);
$this->assertEquals($html, $result->message);
$this->assertNoRelevantEntities($result->entities);
} else {
$result = self::render(message: EntityTools::markdownEscape($html), parse_mode: $mode);
$this->assertEquals($html, $result->message);
$this->assertNoRelevantEntities($result->entities);
$result = self::render(message: "```\n".EntityTools::markdownCodeblockEscape($html)."\n```", parse_mode: $mode);
$this->assertEquals($html, \rtrim($result->message));
$this->assertEquals([['offset' => 0, 'length' => EntityTools::mbStrlen($html), 'language' => '', 'type' => 'pre']], $result->entities);
}
}
private function assertNoRelevantEntities(array $entities): void
{
$entities = \array_filter($entities, static fn (array $e) => !\in_array(
$e['type'],
['url', 'email', 'phone_number', 'mention', 'bot_command'],
true
));
$this->assertEmpty($entities);
}
private function provideEntities(): array
{
return [
[
'html',
'<b>test</b>',
'test',
[
[
'offset' => 0,
'length' => 4,
'type' => 'bold',
],
],
],
[
'html',
'<b>test</b><br>test',
"test\ntest",
[
[
'offset' => 0,
'length' => 4,
'type' => 'bold',
],
],
],
[
'html',
'<b>test</b><br/>test',
"test\ntest",
[
[
'offset' => 0,
'length' => 4,
'type' => 'bold',
],
],
],
[
'html',
'🇺🇦<b>🇺🇦</b>',
'🇺🇦🇺🇦',
[
[
'offset' => 4,
'length' => 4,
'type' => 'bold',
],
],
],
[
'html',
'test<b>test </b>',
'testtest',
[
[
'offset' => 4,
'length' => 4,
'type' => 'bold',
],
],
],
[
'html',
'è»test<b>test </b>test',
'è»testtest test',
[
[
'offset' => 6,
'length' => 4,
'type' => 'bold',
],
],
],
[
'html',
'test<b> test</b>',
'test test',
[
[
'offset' => 4,
'length' => 5,
'type' => 'bold',
],
],
],
[
'markdown',
'test* test*',
'test test',
[
[
'offset' => 4,
'length' => 5,
'type' => 'bold',
],
],
],
[
'html',
'<b>test</b><br><i>test</i> <code>test</code> <pre language="html">test</pre> <a href="https://example.com/">test</a> <s>strikethrough</s> <u>underline</u> <blockquote>blockquote</blockquote> https://google.com daniil@daniil.it +39398172758722 @daniilgentili <tg-spoiler>spoiler</tg-spoiler> &lt;b&gt;not_bold&lt;/b&gt;',
"test\ntest test test test strikethrough underline blockquote https://google.com daniil@daniil.it +39398172758722 @daniilgentili spoiler <b>not_bold</b>",
[
[
'offset' => 0,
'length' => 4,
'type' => 'bold',
],
[
'offset' => 5,
'length' => 4,
'type' => 'italic',
],
[
'offset' => 10,
'length' => 4,
'type' => 'code',
],
[
'offset' => 15,
'length' => 4,
'language' => 'html',
'type' => 'pre',
],
[
'offset' => 20,
'length' => 4,
'url' => 'https://example.com/',
'type' => 'text_link',
],
[
'offset' => 25,
'length' => 13,
'type' => 'strikethrough',
],
[
'offset' => 39,
'length' => 9,
'type' => 'underline',
],
[
'offset' => 49,
'length' => 10,
'type' => 'block_quote',
],
[
'offset' => 127,
'length' => 7,
'type' => 'spoiler',
],
],
'<b>test</b><br><i>test</i> <code>test</code> <pre language="html">test</pre> <a href="https://example.com/">test</a> <s>strikethrough</s> <u>underline</u> <blockquote>blockquote</blockquote> https://google.com daniil@daniil.it +39398172758722 @daniilgentili <tg-spoiler>spoiler</tg-spoiler> &lt;b&gt;not_bold&lt;/b&gt;',
],
[
'markdown',
'test *bold _bold and italic_ bold*',
'test bold bold and italic bold',
[
[
'offset' => 10,
'length' => 15,
'type' => 'italic',
],
[
'offset' => 5,
'length' => 25,
'type' => 'bold',
],
],
],
[
'markdown',
"a\nb\nc",
"a\nb\nc",
[],
],
[
'markdown',
"a\n\nb\n\nc",
"a\n\nb\n\nc",
[],
],
[
'markdown',
"a\n\n\nb\n\n\nc",
"a\n\n\nb\n\n\nc",
[],
],
[
'markdown',
"a\n```php\n<?php\necho 'yay';\n```",
"a\n<?php\necho 'yay';",
[
[
'offset' => 2,
'length' => 17,
'type' => 'pre',
'language' => 'php',
],
],
],
[
'html',
'<b>\'"</b>',
'\'"',
[
[
'offset' => 0,
'length' => 2,
'type' => 'bold',
],
],
'<b>&apos;&quot;</b>',
],
Add support for <span class="tg-spoiler">
2024-05-09 20:33:35 +02:00
[
'html',
'<span class="tg-spoiler">spoiler</span>',
'spoiler',
[
[
'offset' => 0,
'length' => 7,
'type' => 'spoiler',
],
],
'<tg-spoiler>spoiler</tg-spoiler>',
],
First commit
2024-04-15 15:52:07 +02:00
[
'html',
'<a href="mention:101374607">mention1</a> <a href="tg://user?id=101374607">mention2</a>',
'mention1 mention2',
[
[
'offset' => 0,
'length' => 8,
'type' => 'text_mention',
'user' => ['id' => 101374607],
],
[
'offset' => 9,
'length' => 8,
'type' => 'text_mention',
'user' => ['id' => 101374607],
],
],
],
[
'html',
'<a href="tg://user?id=101374607">mention1</a> <a href="tg://user?id=101374607">mention2</a>',
'mention1 mention2',
[
[
'offset' => 0,
'length' => 8,
'type' => 'text_mention',
'user' => ['id' => 101374607],
],
[
'offset' => 9,
'length' => 8,
'type' => 'text_mention',
'user' => ['id' => 101374607],
],
],
],
[
'markdown',
'_a b c <b\> & " \' \_ \* \~ \\__',
'a b c <b> & " \' _ * ~ _',
[
[
'offset' => 0,
'length' => 23,
'type' => 'italic',
],
],
],
[
'markdown',
EntityTools::markdownEscape('\\ test testovich _*~'),
'\\ test testovich _*~',
[],
],
[
'markdown',
"```\na_b\n".EntityTools::markdownCodeblockEscape('\\ ```').'```',
"a_b\n\\ ```",
[
[
'offset' => 0,
'length' => 9,
'type' => 'pre',
'language' => '',
],
],
],
[
'markdown',
'`c_d '.EntityTools::markdownCodeEscape('`').'`',
'c_d `',
[
[
'offset' => 0,
'length' => 5,
'type' => 'code',
],
],
],
[
'markdown',
'[link ](https://google.com/)test',
'link test',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
'url' => 'https://google.com/',
],
],
],
[
'markdown',
'[link]('.EntityTools::markdownUrlEscape('https://transfer.sh/(/test/test.PNG,/test/test.MP4).zip').')',
'link',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
'url' => 'https://transfer.sh/(/test/test.PNG,/test/test.MP4).zip',
],
],
],
[
'markdown',
'[link]('.EntityTools::markdownUrlEscape('https://google.com/').')',
'link',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
'url' => 'https://google.com/',
],
],
],
[
'markdown',
'[link]('.EntityTools::markdownUrlEscape('https://google.com/?v=\\test').')',
'link',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
'url' => 'https://google.com/?v=\\test',
],
],
],
[
'markdown',
'[link ](https://google.com/)',
'link',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
'url' => 'https://google.com/',
],
],
],
[
'markdown',
'![link ](tg://emoji?id=5368324170671202286)',
'link',
[
[
'offset' => 0,
'length' => 4,
'type' => 'custom_emoji',
'custom_emoji_id' => 5368324170671202286,
],
],
],
[
'markdown',
'[not a link]',
'[not a link]',
[],
],
[
'html',
'<a href="https://google.com/">link </a>test',
'link test',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
'url' => 'https://google.com/',
],
],
'<a href="https://google.com/">link</a> test',
],
[
'html',
Add entity escaping to URLs
2024-05-07 15:11:17 +02:00
'<a href="https://google.com/?a=a&amp;b=b">link </a>',
First commit
2024-04-15 15:52:07 +02:00
'link',
[
[
'offset' => 0,
'length' => 4,
'type' => 'text_link',
Add entity escaping to URLs
2024-05-07 15:11:17 +02:00
'url' => 'https://google.com/?a=a&b=b',
First commit
2024-04-15 15:52:07 +02:00
],
],
Add entity escaping to URLs
2024-05-07 15:11:17 +02:00
'<a href="https://google.com/?a=a&amp;b=b">link</a> ',
First commit
2024-04-15 15:52:07 +02:00
],
[
'markdown',
'test _italic_ *bold* __underlined__ ~strikethrough~ ```test pre``` `code` ||spoiler||',
'test italic bold underlined strikethrough pre code spoiler',
[
[
'offset' => 5,
'length' => 6,
'type' => 'italic',
],
[
'offset' => 12,
'length' => 4,
'type' => 'bold',
],
[
'offset' => 17,
'length' => 10,
'type' => 'underline',
],
[
'offset' => 28,
'length' => 13,
'type' => 'strikethrough',
],
[
'offset' => 42,
'length' => 4,
'type' => 'pre',
'language' => 'test',
],
[
'offset' => 47,
'length' => 4,
'type' => 'code',
],
[
'offset' => 52,
'length' => 7,
'type' => 'spoiler',
],
],
],
[
'markdown',
'[special link]('.EntityTools::markdownUrlEscape('https://google.com/)').')',
'special link',
[
[
'offset' => 0,
'length' => 12,
'type' => 'text_link',
'url' => 'https://google.com/)',
],
],
'<a href="https://google.com/)">link</a> ',
],
[
'markdown',
'`'.EntityTools::markdownCodeEscape('``').'`',
'``',
[
[
'offset' => 0,
'length' => 2,
'type' => 'code',
],
],
'`\`\``',
],
];
}
}
Reference in New Issue Copy Permalink