<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[44535] trunk/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php: Privacy: Add unit tests for privacy erasure fulfillment notifications.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/44535">44535</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/44535","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-01-10 02:06:44 +0000 (Thu, 10 Jan 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Privacy: Add unit tests for privacy erasure fulfillment notifications.
Adds appropriate unit tests for `_wp_privacy_send_erasure_fulfillment_notification()`.
Props birgire, desrosj.
Fixes <a href="https://core.trac.wordpress.org/ticket/44234">#44234</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendErasureFulfillmentNotificationphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsprivacywpPrivacySendErasureFulfillmentNotificationphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php (rev 0)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php 2019-01-10 02:06:44 UTC (rev 44535)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,279 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test cases for the `_wp_privacy_send_erasure_fulfillment_notification()` function.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 5.1.0
+ */
+
+/**
+ * Tests_Privacy_WpPrivacySendErasureFulfillmentNotification class.
+ *
+ * @group privacy
+ * @covers ::_wp_privacy_send_erasure_fulfillment_notification
+ *
+ * @since 5.1.0
+ */
+class Tests_Privacy_WpPrivacySendErasureFulfillmentNotification extends WP_UnitTestCase {
+ /**
+ * Request ID.
+ *
+ * @since 5.1.0
+ *
+ * @var int $request_id
+ */
+ protected static $request_id;
+
+ /**
+ * Requester Email.
+ *
+ * @since 5.1.0
+ *
+ * @var string $requester_email
+ */
+ protected static $requester_email;
+
+ /**
+ * Create user request fixtures shared by test methods.
+ *
+ * @since 5.1.0
+ *
+ * @param WP_UnitTest_Factory $factory Factory.
+ */
+ public static function wpSetUpBeforeClass( $factory ) {
+ self::$requester_email = 'erase-my-data@local.test';
+ self::$request_id = wp_create_user_request( self::$requester_email, 'erase_personal_data' );
+ wp_update_post(
+ array(
+ 'ID' => self::$request_id,
+ 'post_status' => 'request-completed',
+ )
+ );
+ }
+
+ /**
+ * Reset the mocked PHPMailer instance before each test method.
+ *
+ * @since 5.1.0
+ */
+ public function setUp() {
+ parent::setUp();
+ reset_phpmailer_instance();
+ }
+
+ /**
+ * Reset the mocked PHPMailer instance after each test method.
+ *
+ * @since 5.1.0
+ */
+ public function tearDown() {
+ reset_phpmailer_instance();
+ parent::tearDown();
+ }
+
+ /**
+ * The function should send an email when a valid request ID is passed.
+ *
+ * @ticket 44234
+ */
+ public function test_should_send_email_no_privacy_policy() {
+
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ $this->assertContains( self::$requester_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Erasure Request Fulfilled', $mailer->get_sent()->subject );
+ $this->assertContains( 'Your request to erase your personal data', $mailer->get_sent()->body );
+ $this->assertContains( 'has been completed.', $mailer->get_sent()->body );
+ $this->assertContains( wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), $mailer->get_sent()->body );
+ $this->assertContains( home_url(), $mailer->get_sent()->body );
+
+ $this->assertNotContains( 'you can also read our privacy policy', $mailer->get_sent()->body );
+ $this->assertTrue( (bool) get_post_meta( self::$request_id, '_wp_user_notified', true ) );
+ }
+
+ /**
+ * The email should include a link to the site's privacy policy when set.
+ *
+ * @ticket 44234
+ */
+ public function test_should_send_email_with_privacy_policy() {
+ $privacy_policy = $this->factory->post->create(
+ array(
+ 'post_type' => 'page',
+ 'title' => 'Site Privacy Policy',
+ 'post_status' => 'publish',
+ )
+ );
+ update_option( 'wp_page_for_privacy_policy', $privacy_policy );
+
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( self::$requester_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'you can also read our privacy policy', $mailer->get_sent()->body );
+ $this->assertContains( get_privacy_policy_url(), $mailer->get_sent()->body );
+ $this->assertTrue( (bool) get_post_meta( self::$request_id, '_wp_user_notified', true ) );
+ }
+
+ /**
+ * The function should send a fulfillment email only once.
+ *
+ * @ticket 44234
+ */
+ public function test_should_send_email_only_once() {
+ // First function call.
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ // Should send an email.
+ $this->assertContains( self::$requester_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Erasure Request Fulfilled', $mailer->get_sent()->subject );
+ $this->assertTrue( (bool) get_post_meta( self::$request_id, '_wp_user_notified', true ) );
+
+ reset_phpmailer_instance();
+
+ // Second function call.
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ // Should not send an email.
+ $this->assertEmpty( $mailer->mock_sent );
+ $this->assertTrue( metadata_exists( 'post', self::$request_id, '_wp_user_notified' ) );
+ }
+
+ /**
+ * The email address of the recipient of the fulfillment notification should be filterable.
+ *
+ * @ticket 44234
+ */
+ public function test_email_address_of_recipient_should_be_filterable() {
+ add_filter( 'user_erasure_fulfillment_email_to', array( $this, 'filter_email_address' ) );
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'modified-' . self::$requester_email, $mailer->get_recipient( 'to' )->address );
+ }
+
+ /**
+ * Filter callback that modifies the email address of the recipient of the fulfillment notification.
+ *
+ * @since 5.1.0
+ *
+ * @param string $user_email The email address of the notification recipient.
+ * @return string $user_email The email address of the notification recipient.
+ */
+ public function filter_email_address( $user_email ) {
+ return 'modified-' . $user_email;
+ }
+
+ /**
+ * The email subject of the fulfillment notification should be filterable.
+ *
+ * @ticket 44234
+ */
+ public function test_email_subject_should_be_filterable() {
+ add_filter( 'user_erasure_complete_email_subject', array( $this, 'filter_email_subject' ) );
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'Modified subject', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * Filter callback that modifies the email subject of the data erasure fulfillment notification.
+ *
+ * @since 5.1.0
+ *
+ * @param string $subject The email subject.
+ * @return string $subject The email subject.
+ */
+ public function filter_email_subject( $subject ) {
+ return 'Modified subject';
+ }
+
+ /**
+ * The email body text of the fulfillment notification should be filterable.
+ *
+ * @ticket 44234
+ */
+ public function test_email_body_text_should_be_filterable() {
+ add_filter( 'user_confirmed_action_email_content', array( $this, 'filter_email_body_text' ) );
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'Modified text', trim( $mailer->get_sent()->body ) );
+ }
+
+ /**
+ * Filter callback that modifies the email body text of the data erasure fulfillment notification.
+ *
+ * @since 5.1.0
+ *
+ * @param string $email_text Text in the email.
+ * @return string $email_text Text in the email.
+ */
+ public function filter_email_body_text( $email_text ) {
+ return 'Modified text';
+ }
+
+ /**
+ * The function should not send an email when the request ID does not exist.
+ *
+ * @ticket 44234
+ */
+ public function test_should_not_send_email_when_passed_invalid_request_id() {
+ _wp_privacy_send_erasure_fulfillment_notification( 1234567890 );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertEmpty( $mailer->mock_sent );
+ }
+
+ /**
+ * The function should not send an email when the ID passed does not correspond to a user request.
+ *
+ * @ticket 44234
+ */
+ public function test_should_not_send_email_when_not_user_request() {
+ $post_id = $this->factory->post->create(
+ array(
+ 'post_type' => 'post', // Should be 'user_request'.
+ )
+ );
+
+ _wp_privacy_send_erasure_fulfillment_notification( $post_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertEmpty( $mailer->mock_sent );
+ }
+
+ /**
+ * The function should not send an email when the request is not completed.
+ *
+ * @ticket 44234
+ */
+ public function test_should_not_send_email_when_request_not_completed() {
+ wp_update_post(
+ array(
+ 'ID' => self::$request_id,
+ 'post_status' => 'request-confirmed', // Should be 'request-completed'.
+ )
+ );
+
+ _wp_privacy_send_erasure_fulfillment_notification( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertEmpty( $mailer->mock_sent );
+ $this->assertFalse( metadata_exists( 'post', self::$request_id, '_wp_user_notified' ) );
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>