makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-08 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/17010] Add tests for push notification type

Browse source 
PHPBB3-17010
This commit is contained in:
Marc Alexander 2022-09-18 21:30:01 +02:00
parent ec3dc28b51
commit be21479b2a
No known key found for this signature in database
GPG key ID: 50E0D2423696F995
5 changed files with 720 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
tests/notification/base.php
View file

@ -125,6 +125,7 @@ abstract class phpbb_tests_notification_base extends phpbb_database_test_case
$phpbb_container->setParameter('tables.notification_types', 'phpbb_notification_types');
$phpbb_container->setParameter('tables.notification_emails', 'phpbb_notification_emails');
$phpbb_container->setParameter('tables.notification_push', 'phpbb_notification_push');
$phpbb_container->setParameter('tables.push_subscriptions', 'phpbb_push_subscriptions');
$this->notifications = new phpbb_notification_manager_helper(
array(),

284
tests/notification/fixtures/webpush_notification.type.post.xml Normal file
View file

@ -0,0 +1,284 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dataset>
<table name="phpbb_forums_watch">
<column>forum_id</column>
<column>user_id</column>
<column>notify_status</column>
<row>
<value>1</value>
<value>6</value>
<value>0</value>
</row>
<row>
<value>1</value>
<value>7</value>
<value>0</value>
</row>
<row>
<value>1</value>
<value>8</value>
<value>0</value>
</row>
</table>
<table name="phpbb_notifications">
<column>notification_id</column>
<column>notification_type_id</column>
<column>user_id</column>
<column>item_id</column>
<column>item_parent_id</column>
<column>notification_read</column>
<column>notification_data</column>
<row>
<value>1</value>
<value>1</value>
<value>5</value>
<value>1</value>
<value>1</value>
<value>0</value>
<value></value>
</row>
<row>
<value>2</value>
<value>1</value>
<value>8</value>
<value>1</value>
<value>1</value>
<value>0</value>
<value></value>
</row>
</table>
<table name="phpbb_notification_push">
</table>
<table name="phpbb_notification_types">
<column>notification_type_id</column>
<column>notification_type_name</column>
<column>notification_type_enabled</column>
<row>
<value>1</value>
<value>notification.type.post</value>
<value>1</value>
</row>
<row>
<value>2</value>
<value>notification.type.forum</value>
<value>1</value>
</row>
</table>
<table name="phpbb_posts">
<column>post_id</column>
<column>topic_id</column>
<column>forum_id</column>
<column>post_text</column>
<row>
<value>1</value>
<value>1</value>
<value>1</value>
<value></value>
</row>
</table>
<table name="phpbb_push_subscriptions">
<column>subscription_id</column>
<column>user_id</column>
<column>endpoint</column>
</table>
<table name="phpbb_topics">
<column>topic_id</column>
<column>forum_id</column>
<row>
<value>1</value>
<value>1</value>
</row>
<row>
<value>2</value>
<value>1</value>
</row>
</table>
<table name="phpbb_topics_watch">
<column>topic_id</column>
<column>user_id</column>
<column>notify_status</column>
<row>
<value>1</value>
<value>2</value>
<value>0</value>
</row>
<row>
<value>2</value>
<value>2</value>
<value>0</value>
</row>
<row>
<value>1</value>
<value>3</value>
<value>0</value>
</row>
<row>
<value>1</value>
<value>4</value>
<value>0</value>
</row>
<row>
<value>1</value>
<value>5</value>
<value>0</value>
</row>
<row>
<value>1</value>
<value>6</value>
<value>0</value>
</row>
</table>
<table name="phpbb_users">
<column>user_id</column>
<column>username_clean</column>
<column>user_permissions</column>
<column>user_sig</column>
<row>
<value>2</value>
<value>poster</value>
<value></value>
<value></value>
</row>
<row>
<value>3</value>
<value>test</value>
<value></value>
<value></value>
</row>
<row>
<value>4</value>
<value>unauthorized</value>
<value></value>
<value></value>
</row>
<row>
<value>5</value>
<value>notified</value>
<value></value>
<value></value>
</row>
<row>
<value>6</value>
<value>disabled</value>
<value></value>
<value></value>
</row>
<row>
<value>7</value>
<value>default</value>
<value></value>
<value></value>
</row>
<row>
<value>8</value>
<value>latest</value>
<value></value>
<value></value>
</row>
</table>
<table name="phpbb_user_notifications">
<column>item_type</column>
<column>item_id</column>
<column>user_id</column>
<column>method</column>
<column>notify</column>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>2</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>3</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>4</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>5</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>6</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>7</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.post</value>
<value>0</value>
<value>8</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>2</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>3</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>4</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>5</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>6</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>7</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
<row>
<value>notification.type.forum</value>
<value>0</value>
<value>8</value>
<value>notification.method.webpush</value>
<value>1</value>
</row>
</table>
</dataset>

1
tests/notification/notification_method_email_test.php
View file

@ -92,6 +92,7 @@ class notification_method_email_test extends phpbb_tests_notification_base
$phpbb_container->setParameter('tables.notification_types', 'phpbb_notification_types');
$phpbb_container->setParameter('tables.notification_emails', 'phpbb_notification_emails');
$phpbb_container->setParameter('tables.notification_push', 'phpbb_notification_push');
$phpbb_container->setParameter('tables.push_subscriptions', 'phpbb_push_subscriptions');
$phpbb_container->set(
'text_formatter.s9e.mention_helper',
new \phpbb\textformatter\s9e\mention_helper(

433
tests/notification/notification_method_webpush_test.php Normal file
View file

@ -0,0 +1,433 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
use phpbb\notification\method\webpush;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
require_once __DIR__ . '/base.php';
/**
* @group
*/
class notification_method_webpush_test extends phpbb_tests_notification_base
{
/** @var string[] VAPID keys for testing purposes */
public const VAPID_KEYS = [
'publicKey' => 'BIcGkq1Ncj3a2-J0UW-1A0NETLjvxZzNLiYBiPVMKNjgwmwPi5jyK87VfS4FZn9n7S9pLMQzjV3LmFuOnRSOvmI',
'privateKey' => 'SrlbBEVgibWmKHYbDPu4Y2XvDWPjeGcc9fC16jq01xU',
];
/** @var webpush */
protected $notification_method_webpush;
public function getDataSet()
{
return $this->createXMLDataSet(__DIR__ . '/fixtures/webpush_notification.type.post.xml');
}
protected function get_notification_methods()
{
return [
'notification.method.webpush',
];
}
public static function setUpBeforeClass(): void
{
self::start_webpush_testing();
}
public static function tearDownAfterClass(): void
{
self::stop_webpush_testing();
}
protected static function start_webpush_testing(): void
{
// Stop first to ensure port is available
self::stop_webpush_testing();
$process = new \Symfony\Component\Process\Process(['node_modules/.bin/web-push-testing', '--port', '9012', 'start']);
$process->run();
}
protected static function stop_webpush_testing(): void
{
$process = new \Symfony\Component\Process\Process(['node_modules/.bin/web-push-testing', '--port', '9012', 'stop']);
$process->run();
}
protected function setUp(): void
{
phpbb_database_test_case::setUp();
global $phpbb_root_path, $phpEx;
include_once(__DIR__ . '/ext/test/notification/type/test.' . $phpEx);
global $db, $config, $user, $auth, $cache, $phpbb_container, $phpbb_dispatcher;
$avatar_helper = $this->getMockBuilder('\phpbb\avatar\helper')
->disableOriginalConstructor()
->getMock();
$db = $this->db = $this->new_dbal();
$config = $this->config = new \phpbb\config\config([
'allow_privmsg' => true,
'allow_bookmarks' => true,
'allow_topic_notify' => true,
'allow_forum_notify' => true,
'allow_board_notifications' => true,
'webpush_vapid_public' => self::VAPID_KEYS['publicKey'],
'webpush_vapid_private' => self::VAPID_KEYS['privateKey'],
]);
$lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx);
$lang = new \phpbb\language\language($lang_loader);
$user = new \phpbb\user($lang, '\phpbb\datetime');
$this->user = $user;
$this->user_loader = new \phpbb\user_loader($avatar_helper, $this->db, $phpbb_root_path, $phpEx, 'phpbb_users');
$auth = $this->auth = new phpbb_mock_notifications_auth();
$this->phpbb_dispatcher = new phpbb_mock_event_dispatcher();
$phpbb_dispatcher = $this->phpbb_dispatcher;
$cache_driver = new \phpbb\cache\driver\dummy();
$cache = $this->cache = new \phpbb\cache\service(
$cache_driver,
$this->config,
$this->db,
$this->phpbb_dispatcher,
$phpbb_root_path,
$phpEx
);
$phpbb_container = $this->container = new ContainerBuilder();
$loader = new YamlFileLoader($phpbb_container, new FileLocator(__DIR__ . '/fixtures'));
$loader->load('services_notification.yml');
$phpbb_container->set('user_loader', $this->user_loader);
$phpbb_container->set('user', $user);
$phpbb_container->set('language', $lang);
$phpbb_container->set('config', $this->config);
$phpbb_container->set('dbal.conn', $this->db);
$phpbb_container->set('auth', $auth);
$phpbb_container->set('cache.driver', $cache_driver);
$phpbb_container->set('cache', $cache);
$phpbb_container->set('text_formatter.utils', new \phpbb\textformatter\s9e\utils());
$phpbb_container->set('dispatcher', $this->phpbb_dispatcher);
$phpbb_container->setParameter('core.root_path', $phpbb_root_path);
$phpbb_container->setParameter('core.php_ext', $phpEx);
$phpbb_container->setParameter('tables.notifications', 'phpbb_notifications');
$phpbb_container->setParameter('tables.user_notifications', 'phpbb_user_notifications');
$phpbb_container->setParameter('tables.notification_types', 'phpbb_notification_types');
$phpbb_container->setParameter('tables.notification_emails', 'phpbb_notification_emails');
$phpbb_container->setParameter('tables.notification_push', 'phpbb_notification_push');
$phpbb_container->setParameter('tables.push_subscriptions', 'phpbb_push_subscriptions');
$phpbb_container->set(
'text_formatter.s9e.mention_helper',
new \phpbb\textformatter\s9e\mention_helper(
$this->db,
$auth,
$this->user,
$phpbb_root_path,
$phpEx
)
);
$this->notification_method_webpush = new \phpbb\notification\method\webpush(
$phpbb_container->get('user_loader'),
$phpbb_container->get('user'),
$phpbb_container->get('config'),
$phpbb_container->get('dbal.conn'),
$phpbb_root_path,
$phpEx,
$phpbb_container->getParameter('tables.notification_push'),
$phpbb_container->getParameter('tables.push_subscriptions')
);
$phpbb_container->set('notification.method.webpush', $this->notification_method_webpush);
$this->notifications = new phpbb_notification_manager_helper(
array(),
array(),
$this->container,
$this->user_loader,
$this->phpbb_dispatcher,
$this->db,
$this->cache,
$lang,
$this->user,
'phpbb_notification_types',
'phpbb_user_notifications'
);
$phpbb_container->set('notification_manager', $this->notifications);
$phpbb_container->addCompilerPass(new phpbb\di\pass\markpublic_pass());
$phpbb_container->compile();
$this->notifications->setDependencies($this->auth, $this->config);
$types = array();
foreach ($this->get_notification_types() as $type)
{
$class = $this->build_type($type);
$types[$type] = $class;
}
$this->notifications->set_var('notification_types', $types);
$methods = array();
foreach ($this->get_notification_methods() as $method)
{
$class = $this->container->get($method);
$methods[$method] = $class;
}
$this->notifications->set_var('notification_methods', $methods);
}
public function data_notification_webpush()
{
return [
/**
* Normal post
*
* User => State description
* 2 => Topic id=1 and id=2 subscribed, should receive a new topics post notification
* 3 => Topic id=1 subscribed, should receive a new topic post notification
* 4 => Topic id=1 subscribed, should receive a new topic post notification
* 5 => Topic id=1 subscribed, post id=1 already notified, should receive a new topic post notification
* 6 => Topic id=1 and forum id=1 subscribed, should receive a new topic/forum post notification
* 7 => Forum id=1 subscribed, should NOT receive a new topic post but a forum post notification
* 8 => Forum id=1 subscribed, post id=1 already notified, should NOT receive a new topic post but a forum post notification
*/
[
'notification.type.post',
[
'forum_id' => '1',
'post_id' => '2',
'topic_id' => '1',
],
[
2 => ['user_id' => '2'],
3 => ['user_id' => '3'],
4 => ['user_id' => '4'],
5 => ['user_id' => '5'],
6 => ['user_id' => '6'],
],
],
[
'notification.type.forum',
[
'forum_id' => '1',
'post_id' => '3',
'topic_id' => '1',
],
[
6 => ['user_id' => '6'],
7 => ['user_id' => '7'],
8 => ['user_id' => '8']
],
],
[
'notification.type.post',
[
'forum_id' => '1',
'post_id' => '4',
'topic_id' => '2',
],
[
2 => ['user_id' => '2'],
],
],
[
'notification.type.forum',
[
'forum_id' => '1',
'post_id' => '5',
'topic_id' => '2',
],
[
6 => ['user_id' => '6'],
7 => ['user_id' => '7'],
8 => ['user_id' => '8'],
],
],
[
'notification.type.post',
[
'forum_id' => '2',
'post_id' => '6',
'topic_id' => '3',
],
[
],
],
[
'notification.type.forum',
[
'forum_id' => '2',
'post_id' => '6',
'topic_id' => '3',
],
[
],
],
];
}
/**
* @dataProvider data_notification_webpush
*/
public function test_notification_webpush($notification_type, $post_data, $expected_users)
{
$post_data = array_merge([
'post_time' => 1349413322,
'poster_id' => 1,
'topic_title' => '',
'post_subject' => '',
'post_username' => '',
'forum_name' => '',
],
$post_data);
$notification_options = [
'item_id' => $post_data['post_id'],
'item_parent_id' => $post_data['topic_id'],
];
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet');
$this->notifications->add_notifications($notification_type, $post_data);
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals($expected_users, $notified_users, 'Assert that expected users have been notified');
$post_data['post_id']++;
$notification_options['item_id'] = $post_data['post_id'];
$post_data['post_time'] = 1349413323;
$this->notifications->add_notifications($notification_type, $post_data);
$notified_users2 = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals($expected_users, $notified_users2, 'Assert that expected users stay the same after replying to same topic');
}
/**
* @dataProvider data_notification_webpush
*/
public function test_get_subscription($notification_type, $post_data, $expected_users): void
{
$subscription_info = [];
foreach ($expected_users as $user_id => $user_data)
{
$subscription_info[$user_id] = $this->create_subscription_for_user($user_id);
}
$post_data = array_merge([
'post_time' => 1349413322,
'poster_id' => 1,
'topic_title' => '',
'post_subject' => '',
'post_username' => '',
'forum_name' => '',
],
$post_data);
$notification_options = [
'item_id' => $post_data['post_id'],
'item_parent_id' => $post_data['topic_id'],
];
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet');
foreach ($expected_users as $user_id => $data)
{
$messages = $this->get_messages_for_subscription($subscription_info[$user_id]['clientHash']);
$this->assertEmpty($messages);
}
$this->notifications->add_notifications($notification_type, $post_data);
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals($expected_users, $notified_users, 'Assert that expected users have been notified');
foreach ($expected_users as $user_id => $data)
{
$messages = $this->get_messages_for_subscription($subscription_info[$user_id]['clientHash']);
$this->assertNotEmpty($messages);
}
}
protected function create_subscription_for_user($user_id): array
{
$client = new \GuzzleHttp\Client();
try
{
$response = $client->request('POST', 'http://localhost:9012/subscribe', ['form_params' => [
'applicationServerKey' => self::VAPID_KEYS['publicKey'],
]]);
}
catch (\GuzzleHttp\Exception\GuzzleException $exception)
{
$this->fail('Failed getting subscription from web-push-testing client');
}
$subscription_return = \phpbb\json\sanitizer::decode((string) $response->getBody());
$subscription_data = $subscription_return['data'];
$this->assertNotEmpty($subscription_data['endpoint']);
$this->assertStringStartsWith('http://localhost:9012/notify/', $subscription_data['endpoint']);
$this->assertIsArray($subscription_data['keys']);
// Add subscription data to admin user (user id 2)
$push_subscriptions_table = $this->container->getParameter('tables.push_subscriptions');
$sql = 'INSERT INTO ' . $push_subscriptions_table . ' ' . $this->db->sql_build_array('INSERT', [
'user_id' => $user_id,
'endpoint' => $subscription_data['endpoint'],
'p256dh' => $subscription_data['keys']['p256dh'],
'auth' => $subscription_data['keys']['auth'],
]);
$this->db->sql_query($sql);
return $subscription_data;
}
protected function get_messages_for_subscription($client_hash): array
{
$client = new \GuzzleHttp\Client();
try
{
$response = $client->request('POST', 'http://localhost:9012/get-notifications', ['form_params' => [
'clientHash' => $client_hash,
]]);
}
catch (\GuzzleHttp\Exception\GuzzleException $exception)
{
$this->fail('Failed getting messages from web-push-testing client');
}
$response_data = json_decode($response->getBody()->getContents(), true);
$this->assertNotEmpty($response_data);
$this->assertArrayHasKey('data', $response_data);
$this->assertArrayHasKey('messages', $response_data['data']);
return $response_data['data']['messages'];
}
}

1
tests/notification/submit_post_base.php
View file

@ -155,6 +155,7 @@ abstract class phpbb_notification_submit_post_base extends phpbb_database_test_c
$phpbb_container->setParameter('tables.notification_types', 'phpbb_notification_types');
$phpbb_container->setParameter('tables.notification_emails', 'phpbb_notification_emails');
$phpbb_container->setParameter('tables.notification_push', 'phpbb_notification_push');
$phpbb_container->setParameter('tables.push_subscriptions', 'phpbb_push_subscriptions');
$phpbb_container->set('content.visibility', new \phpbb\content_visibility($auth, $config, $phpbb_dispatcher, $db, $user, $phpbb_root_path, $phpEx, FORUMS_TABLE, POSTS_TABLE, TOPICS_TABLE, USERS_TABLE));
$phpbb_container->addCompilerPass(new phpbb\di\pass\markpublic_pass());
$phpbb_container->compile();