Cavemanon/piratepoet
8
Fork 0
Code Pull Requests Actions Releases 16 Activity

Fix and refactor ViewInBrowserControllerTest

Browse Source 
[MAILPOET-2430]
This commit is contained in:
Jan Jakeš
2020-02-06 14:11:16 +01:00
committed by Jack Kitterhing
parent 216341d5f6
commit e3cc5a0ec0
2 changed files with 164 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/DI/ContainerConfigurator.php
View File

@@ -205,7 +205,7 @@ class ContainerConfigurator implements IContainerConfigurator {
$container->autowire(\MailPoet\Subscribers\RequiredCustomFieldValidator::class)->setPublic(true); $container->autowire(\MailPoet\Subscribers\RequiredCustomFieldValidator::class)->setPublic(true);
$container->autowire(\MailPoet\Subscribers\SubscriberActions::class)->setPublic(true); $container->autowire(\MailPoet\Subscribers\SubscriberActions::class)->setPublic(true);
$container->autowire(\MailPoet\Subscribers\InactiveSubscribersController::class); $container->autowire(\MailPoet\Subscribers\InactiveSubscribersController::class);
$container->autowire(\MailPoet\Subscribers\LinkTokens::class); $container->autowire(\MailPoet\Subscribers\LinkTokens::class)->setPublic(true);
$container->autowire(\MailPoet\Subscribers\SubscribersRepository::class); $container->autowire(\MailPoet\Subscribers\SubscribersRepository::class);
// Segments // Segments
$container->autowire(\MailPoet\Segments\SubscribersListings::class)->setPublic(true); $container->autowire(\MailPoet\Segments\SubscribersListings::class)->setPublic(true);
@@ -251,7 +251,7 @@ class ContainerConfigurator implements IContainerConfigurator {
$container->autowire(\MailPoet\WooCommerce\Helper::class)->setPublic(true); $container->autowire(\MailPoet\WooCommerce\Helper::class)->setPublic(true);
$container->autowire(\MailPoet\WooCommerce\Settings::class)->setPublic(true); $container->autowire(\MailPoet\WooCommerce\Settings::class)->setPublic(true);
$container->autowire(\MailPoet\WooCommerce\Subscription::class)->setPublic(true); $container->autowire(\MailPoet\WooCommerce\Subscription::class)->setPublic(true);
$container->autowire(\MailPoet\WooCommerce\TransactionalEmails::class); $container->autowire(\MailPoet\WooCommerce\TransactionalEmails::class)->setPublic(true);
$container->autowire(\MailPoet\WooCommerce\TransactionalEmails\Template::class); $container->autowire(\MailPoet\WooCommerce\TransactionalEmails\Template::class);
$container->autowire(\MailPoet\WooCommerce\TransactionalEmails\Renderer::class); $container->autowire(\MailPoet\WooCommerce\TransactionalEmails\Renderer::class);
// WordPress // WordPress

323
tests/integration/Newsletter/ViewInBrowser/ViewInBrowserControllerTest.php
View File

@@ -2,245 +2,237 @@
namespace MailPoet\Newsletter\ViewInBrowser; namespace MailPoet\Newsletter\ViewInBrowser;
use Codeception\Stub;
use Codeception\Stub\Expected; use Codeception\Stub\Expected;
use MailPoet\Config\AccessControl; use MailPoet\Config\AccessControl;
use MailPoet\Models\Newsletter; use MailPoet\Models\Newsletter;
use MailPoet\Models\ScheduledTask; use MailPoet\Models\ScheduledTask;
use MailPoet\Models\SendingQueue; use MailPoet\Models\SendingQueue;
use MailPoet\Models\Subscriber; use MailPoet\Models\Subscriber;
use MailPoet\Newsletter\ViewInBrowser\ViewInBrowserRenderer as NewsletterViewInBrowser;
use MailPoet\Router\Endpoints\ViewInBrowser;
use MailPoet\Settings\SettingsController;
use MailPoet\Subscribers\LinkTokens; use MailPoet\Subscribers\LinkTokens;
use MailPoet\Tasks\Sending as SendingTask; use MailPoet\Tasks\Sending as SendingTask;
use MailPoet\WP\Emoji;
use MailPoet\WP\Functions;
use MailPoetVendor\Idiorm\ORM; use MailPoetVendor\Idiorm\ORM;
class ViewInBrowserControllerTest extends \MailPoetTest { class ViewInBrowserControllerTest extends \MailPoetTest {
public $viewInBrowser; /** @var ViewInBrowserController */
public $browserPreviewData; private $viewInBrowserController;
public $queue;
public $subscriber; /** @var Newsletter */
public $newsletter; private $newsletter;
/** @var Subscriber */
private $subscriber;
/** @var SendingTask */
private $sendingTask;
/** @var mixed[] */
private $browserPreviewData;
public function _before() { public function _before() {
parent::_before();
// create newsletter // create newsletter
$newsletter = Newsletter::create(); $newsletter = Newsletter::create();
$newsletter->type = 'type'; $newsletter->type = 'type';
$this->newsletter = $newsletter->save(); $this->newsletter = $newsletter->save();
// create subscriber // create subscriber
$subscriber = Subscriber::create(); $subscriber = Subscriber::create();
$subscriber->email = 'test@example.com'; $subscriber->email = 'test@example.com';
$subscriber->firstName = 'First'; $subscriber->firstName = 'First';
$subscriber->lastName = 'Last'; $subscriber->lastName = 'Last';
$this->subscriber = $subscriber->save(); $this->subscriber = $subscriber->save();
// create queue
$queue = SendingTask::create(); // create task & queue
$queue->newsletterId = $newsletter->id; $sendingTask = SendingTask::create();
$queue->setSubscribers([$subscriber->id]); $sendingTask->newsletterId = $newsletter->id;
$queue->updateProcessedSubscribers([$subscriber->id]); $sendingTask->setSubscribers([$subscriber->id]);
$this->queue = $queue->save(); $sendingTask->updateProcessedSubscribers([$subscriber->id]);
$this->sendingTask = $sendingTask->save();
$linkTokens = new LinkTokens; $linkTokens = new LinkTokens;
// build browser preview data // build browser preview data
$this->browserPreviewData = [ $this->browserPreviewData = [
'queue_id' => $queue->id, 'queue_id' => $sendingTask->queue()->id,
'subscriber_id' => $subscriber->id, 'subscriber_id' => $subscriber->id,
'newsletter_id' => $newsletter->id, 'newsletter_id' => $newsletter->id,
'newsletter_hash' => $newsletter->hash, 'newsletter_hash' => $newsletter->hash,
'subscriber_token' => $linkTokens->getToken($subscriber), 'subscriber_token' => $linkTokens->getToken($subscriber),
'preview' => false, 'preview' => false,
]; ];
// instantiate class // instantiate class
$this->viewInBrowser = new ViewInBrowser(new AccessControl(), new LinkTokens(), $this->diContainer->get(NewsletterViewInBrowser::class)); $this->viewInBrowserController = $this->diContainer->get(ViewInBrowserController::class);
} }
public function testItAbortsWhenBrowserPreviewDataIsMissing() { public function testItThrowsWhenDataIsMissing() {
$viewInBrowser = $this->make($this->viewInBrowser, [
'linkTokens' => $this->make(LinkTokens::class, [
'verifyToken' => true,
]),
'_abort' => Expected::exactly(2),
]);
// newsletter ID is required // newsletter ID is required
$data = $this->browserPreviewData; $data = $this->browserPreviewData;
unset($data['newsletter_id']); unset($data['newsletter_id']);
$viewInBrowser->view($data); $this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Missing 'newsletter_id'");
// TODO: newsletter hash is required // newsletter hash is required
$data = $this->browserPreviewData;
unset($data['newsletter_hash']);
$this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Missing 'newsletter_hash'");
// subscriber token is required if subscriber is provided // subscriber token is required if subscriber is provided
$data = $this->browserPreviewData; $data = $this->browserPreviewData;
unset($data['subscriber_token']); unset($data['subscriber_token']);
$viewInBrowser->view($data); $this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Missing 'subscriber_token'");
} }
public function testItAbortsWhenBrowserPreviewDataIsInvalid() { public function testItThrowsWhenDataIsInvalid() {
$viewInBrowser = $this->make($this->viewInBrowser, [
'linkTokens' => new LinkTokens,
'_abort' => Expected::exactly(3),
]);
// newsletter ID is invalid // newsletter ID is invalid
$data = $this->browserPreviewData; $data = $this->browserPreviewData;
$data['newsletter_id'] = 99; $data['newsletter_id'] = 99;
$viewInBrowser->view($data); $this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Invalid 'newsletter_id'");
// subscriber token is invalid // newsletter hash is invalid
$data = $this->browserPreviewData;
$data['subscriber_token'] = false;
$viewInBrowser->view($data);
// subscriber token is invalid
$data = $this->browserPreviewData;
$data['subscriber_token'] = 'invalid';
$viewInBrowser->view($data);
// subscriber has not received the newsletter
}
public function testItAbortsWhenSubscriberTokenDoesNotMatch() {
$viewInBrowser = $this->make($this->viewInBrowser, [
'linkTokens' => new LinkTokens,
'_abort' => Expected::once(),
]);
$subscriber = $this->subscriber;
$subscriber->email = 'random@email.com';
$subscriber->save();
$data = array_merge(
$this->browserPreviewData,
[
'queue' => $this->queue,
'subscriber' => $subscriber,
'newsletter' => $this->newsletter,
'subscriber_token' => 'somewrongtoken',
]
);
$viewInBrowser->view($data);
}
public function testItAbortsWhenNewsletterHashIsInvalid() {
$viewInBrowser = $this->make($this->viewInBrowser, [
'_abort' => Expected::once(),
]);
$data = $this->browserPreviewData; $data = $this->browserPreviewData;
$data['newsletter_hash'] = 'invalid-hash'; $data['newsletter_hash'] = 'invalid-hash';
$viewInBrowser->view($data); $this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Invalid 'newsletter_hash'");
// subscriber token is invalid
$data = $this->browserPreviewData;
$data['subscriber_token'] = 'invalid-token';
$this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Invalid 'subscriber_token'");
} }
public function testItAbortsWhenSubscriberIsNotOnProcessedList() { public function testItThrowsWhenSubscriberIsNotOnProcessedList() {
$viewInBrowser = $this->make($this->viewInBrowser, [
'linkTokens' => $this->make(LinkTokens::class, [
'verifyToken' => true,
]),
'newsletterViewInBrowser' => $this->make(NewsletterViewInBrowser::class, [
'view' => Expected::once(),
]),
'_abort' => Expected::once(),
'_displayNewsletter' => Expected::once(),
]);
$data = $this->browserPreviewData; $data = $this->browserPreviewData;
$viewInBrowser->view($data); $sendingTask = $this->sendingTask;
$sendingTask->setSubscribers([]);
$queue = $this->queue; $sendingTask->updateProcessedSubscribers([]);
$queue->setSubscribers([]); $sendingTask->save();
$queue->updateProcessedSubscribers([]); $this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, 'Subscriber did not receive the newsletter yet');
$queue->save();
$viewInBrowser->view($data);
} }
public function testItDoesNotRequireWpAdministratorToBeOnProcessedListWhenPreviewIsEnabled() { public function testItDoesNotRequireWpAdministratorToBeOnProcessedListWhenPreviewIsEnabled() {
$viewInBrowser = $this->make($this->viewInBrowser, [ $data = $this->browserPreviewData;
'accessControl' => new AccessControl(),
'linkTokens' => $this->make(LinkTokens::class, [
'verifyToken' => true,
]),
'newsletterViewInBrowser' => $this->make(NewsletterViewInBrowser::class, [
'view' => Expected::exactly(3),
]),
'_abort' => Expected::once(),
'_displayNewsletter' => Expected::exactly(3),
]);
$data = array_merge(
$this->browserPreviewData,
[
'queue' => $this->queue,
'subscriber' => $this->subscriber,
'newsletter' => $this->newsletter,
]
);
$data['preview'] = true; $data['preview'] = true;
// when WP user is not logged, abort should be called $sendingTask = $this->sendingTask;
$viewInBrowser->view($data); $sendingTask->setSubscribers([]);
$sendingTask->updateProcessedSubscribers([]);
$sendingTask->save();
// when WP user is not logged, it should throw
$this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Subscriber did not receive the newsletter yet");
// when WP user does not have 'manage options' permission, it should throw
$wpUser = wp_set_current_user(0); $wpUser = wp_set_current_user(0);
// when WP user does not have 'manage options' permission, false should be returned
$wpUser->remove_role('administrator'); $wpUser->remove_role('administrator');
//$viewInBrowser = new ViewInBrowser(new AccessControl(), SettingsController::getInstance(), new LinkTokens(), new Emoji()); $this->expectViewThrowsExceptionWithMessage($this->viewInBrowserController, $data, "Subscriber did not receive the newsletter yet");
$viewInBrowser->view($data);
// when WP has 'manage options' permission, data should be returned // when WP has 'manage options' permission, it should not throw
$wpUser->add_role('administrator'); $wpUser->add_role('administrator');
//$viewInBrowser = new ViewInBrowser(new AccessControl(), SettingsController::getInstance(), new LinkTokens(), new Emoji()); $this->viewInBrowserController->view($data);
$viewInBrowser->view($data);
} }
public function testItSetsSubscriberToLoggedInWPUserWhenPreviewIsEnabled() { public function testItSetsSubscriberToLoggedInWPUserWhenPreviewIsEnabled() {
$viewInBrowser = $this->viewInBrowser; $viewInBrowserRenderer = $this->make(ViewInBrowserRenderer::class, [
$data = array_merge( 'render' => Expected::once(function (bool $isPreview, Newsletter $newsletter, Subscriber $subscriber = null, SendingQueue $queue = null) {
$this->browserPreviewData, assert($subscriber !== null); // PHPStan
[ expect($subscriber)->notNull();
'queue' => $this->queue, expect($subscriber->id)->equals(1);
'subscriber' => null, }),
'newsletter' => $this->newsletter, ]);
]
$viewInBrowserController = new ViewInBrowserController(
$this->diContainer->get(AccessControl::class),
$this->diContainer->get(LinkTokens::class),
$viewInBrowserRenderer
); );
$data->preview = true;
$data = $this->browserPreviewData;
unset($data['subscriber_id']);
$data['preview'] = true;
$this->subscriber->wpUserId = 1;
$this->subscriber->save();
wp_set_current_user(1); wp_set_current_user(1);
$viewInBrowser = new ViewInBrowser(new AccessControl(), SettingsController::getInstance(), new LinkTokens(), new Emoji()); $viewInBrowserController->view($data);
$result = $viewInBrowser->_validateBrowserPreviewData($data);
expect($result->subscriber->id)->equals(1);
} }
public function testItGetsOrFindsQueueWhenItIsNotAWelcomeEmail() { public function testItGetsQueueByQueueId() {
$viewInBrowserRenderer = $this->make(ViewInBrowserRenderer::class, [
'render' => Expected::once(function (bool $isPreview, Newsletter $newsletter, Subscriber $subscriber = null, SendingQueue $queue = null) {
assert($queue !== null); // PHPStan
expect($queue)->notNull();
expect($queue->id)->same($this->sendingTask->id);
}),
]);
$viewInBrowserController = new ViewInBrowserController(
$this->diContainer->get(AccessControl::class),
$this->diContainer->get(LinkTokens::class),
$viewInBrowserRenderer
);
$data = $this->browserPreviewData; $data = $this->browserPreviewData;
// queue will be found when not defined $data['queueId'] = $this->sendingTask->queue()->id;
$data->queueId = null; $viewInBrowserController->view($data);
$result = $this->viewInBrowser->_validateBrowserPreviewData($data); }
expect($result->queue->id)->equals($this->queue->id);
// queue will be found when defined public function testItGetsQueueByNewsletter() {
$data->queueId = $this->queue->id; $viewInBrowserRenderer = $this->make(ViewInBrowserRenderer::class, [
$result = $this->viewInBrowser->_validateBrowserPreviewData($data); 'render' => Expected::once(function (bool $isPreview, Newsletter $newsletter, Subscriber $subscriber = null, SendingQueue $queue = null) {
expect($result->queue->id)->equals($this->queue->id); assert($queue !== null); // PHPStan
// queue will not be found when it is a welcome email expect($queue)->notNull();
expect($queue->id)->same($this->sendingTask->queue()->id);
}),
]);
$viewInBrowserController = new ViewInBrowserController(
$this->diContainer->get(AccessControl::class),
$this->diContainer->get(LinkTokens::class),
$viewInBrowserRenderer
);
$data = $this->browserPreviewData;
$data['queueId'] = null;
$viewInBrowserController->view($data);
}
public function testItResetsQueueForWelcomeEmails() {
$viewInBrowserRenderer = $this->make(ViewInBrowserRenderer::class, [
'render' => Expected::once(function (bool $isPreview, Newsletter $newsletter, Subscriber $subscriber = null, SendingQueue $queue = null) {
expect($queue)->null();
}),
]);
$viewInBrowserController = new ViewInBrowserController(
$this->diContainer->get(AccessControl::class),
$this->diContainer->get(LinkTokens::class),
$viewInBrowserRenderer
);
// queue will be set to null for welcome email
$newsletter = $this->newsletter; $newsletter = $this->newsletter;
$newsletter->type = Newsletter::TYPE_WELCOME; $newsletter->type = Newsletter::TYPE_WELCOME;
$newsletter->save(); $newsletter->save();
$data->queueId = null; $viewInBrowserController->view($this->browserPreviewData);
$result = $this->viewInBrowser->_validateBrowserPreviewData($data);
expect($result->queue)->false();
} }
public function testItProcessesBrowserPreviewData() { public function testItResetsQueueForAutomaticEmailsInPreview() {
$processedData = $this->viewInBrowser->_processBrowserPreviewData($this->browserPreviewData); $viewInBrowserRenderer = $this->make(ViewInBrowserRenderer::class, [
expect($processedData->queue->id)->equals($this->queue->id); 'render' => Expected::once(function (bool $isPreview, Newsletter $newsletter, Subscriber $subscriber = null, SendingQueue $queue = null) {
expect($processedData->subscriber->id)->equals($this->subscriber->id); expect($queue)->null();
expect($processedData->newsletter->id)->equals($this->newsletter->id); }),
} ]);
public function testItReturnsViewActionResult() { $viewInBrowserController = new ViewInBrowserController(
$viewInBrowser = Stub::make($this->viewInBrowser, [ $this->diContainer->get(AccessControl::class),
'linkTokens' => new LinkTokens, $this->diContainer->get(LinkTokens::class),
'_displayNewsletter' => Expected::exactly(1), $viewInBrowserRenderer
'settings' => SettingsController::getInstance(), );
'emoji' => new Emoji(),
], $this); // queue will be set to null for automatic email
$viewInBrowser->view($this->browserPreviewData); $data = $this->browserPreviewData;
$data['preview'] = true;
$newsletter = $this->newsletter;
$newsletter->type = Newsletter::TYPE_AUTOMATIC;
$newsletter->save();
$viewInBrowserController->view($data);
} }
public function _after() { public function _after() {
@@ -252,4 +244,13 @@ class ViewInBrowserControllerTest extends \MailPoetTest {
$wpUser = wp_get_current_user(); $wpUser = wp_get_current_user();
$wpUser->add_role('administrator'); $wpUser->add_role('administrator');
} }
private function expectViewThrowsExceptionWithMessage(ViewInBrowserController $viewInBrowserController, array $data, string $message) {
try {
$viewInBrowserController->view($data);
$this->fail("Expected 'InvalidArgumentException' with message '$message' was not thrown");
} catch (\InvalidArgumentException $e) {
expect($e->getMessage())->same($message);
}
}
} }