<!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>[43499] trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php: Privacy: Add unit tests for `_wp_privacy_send_request_confirmation_notification()`, introduced in [43211].</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/43499">43499</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/43499","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-07-17 22:55:51 +0000 (Tue, 17 Jul 2018)</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 `_wp_privacy_send_request_confirmation_notification()`, introduced in <a href="https://core.trac.wordpress.org/changeset/43211">[43211]</a>.
Props birgire, desrosj, garrett-eclipse.
Fixes <a href="https://core.trac.wordpress.org/ticket/43967">#43967</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendRequestConfirmationNotificationphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsprivacywpPrivacySendRequestConfirmationNotificationphp"></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/wpPrivacySendRequestConfirmationNotification.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php (rev 0)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php 2018-07-17 22:55:51 UTC (rev 43499)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,208 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test cases for the `_wp_privacy_send_request_confirmation_notification()` function.
+ *
+ * @since 4.9.8
+ */
+
+/**
+ * Tests_User_WpPrivacySendRequestConfirmationNotification class.
+ *
+ * @since 4.9.8
+ *
+ * @group privacy
+ * @group user
+ * @covers _wp_privacy_send_request_confirmation_notification()
+ */
+class Tests_User_WpPrivacySendRequestConfirmationNotification extends WP_UnitTestCase {
+ /**
+ * Reset the mocked PHPMailer instance before each test method.
+ *
+ * @since 4.9.8
+ */
+ public function setUp() {
+ parent::setUp();
+ reset_phpmailer_instance();
+ }
+
+ /**
+ * Reset the mocked PHPMailer instance after each test method.
+ *
+ * @since 4.9.8
+ */
+ public function tearDown() {
+ reset_phpmailer_instance();
+ parent::tearDown();
+ }
+
+ /**
+ * The function should not send emails when the request ID does not exist.
+ *
+ * @ticket 43967
+ */
+ public function test_function_should_not_send_email_when_not_a_valid_request_id() {
+ _wp_privacy_send_request_confirmation_notification( 1234567890 );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertEmpty( $mailer->mock_sent );
+ }
+
+ /**
+ * The function should not send emails when the ID passed is not a WP_User_Request.
+ *
+ * @ticket 43967
+ */
+ public function test_function_should_not_send_email_when_not_a_wp_user_request() {
+ $post_id = $this->factory->post->create( array(
+ 'post_type' => 'post',
+ ) );
+
+ _wp_privacy_send_request_confirmation_notification( $post_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertEmpty( $mailer->mock_sent );
+ }
+
+ /**
+ * The function should send an email to the site admin when a user request is confirmed.
+ *
+ * @ticket 43967
+ */
+ public function test_function_should_send_email_to_site_admin_when_user_request_confirmed() {
+ $email = 'export.request.from.unregistered.user@example.com';
+ $request_id = wp_create_user_request( $email, 'export_personal_data' );
+
+ _wp_privacy_account_request_confirmed( $request_id );
+
+ _wp_privacy_send_request_confirmation_notification( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'request-confirmed', get_post_status( $request_id ) );
+ $this->assertTrue( (bool) get_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', true ) );
+ $this->assertTrue( (bool) get_post_meta( $request_id, '_wp_admin_notified', true ) );
+ $this->assertSame( get_site_option( 'admin_email' ), $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Action Confirmed', $mailer->get_sent()->subject );
+ $this->assertContains( 'Request: Export Personal Data', $mailer->get_sent()->body );
+ $this->assertContains( 'A user data privacy request has been confirmed', $mailer->get_sent()->body );
+ }
+
+ /**
+ * The function should only send an email to the site admin when a user request is confirmed.
+ *
+ * @ticket 43967
+ */
+ public function test_function_should_only_send_email_to_site_admin_when_user_request_is_confirmed() {
+ $email = 'export.request.from.unregistered.user@example.com';
+ $request_id = wp_create_user_request( $email, 'export_personal_data' );
+
+ _wp_privacy_send_request_confirmation_notification( $request_id );
+
+ // Non-confirmed request.
+ $this->assertSame( 'request-pending', get_post_status( $request_id ) );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ // Email not sent.
+ $this->assertEmpty( $mailer->mock_sent );
+ $this->assertEmpty( get_post_meta( $request_id, '_wp_admin_notified', true ) );
+ }
+
+ /**
+ * The function should only send an email once to the site admin when a user request is confirmed.
+ *
+ * @ticket 43967
+ */
+ public function test_function_should_only_send_email_once_to_admin_when_user_request_is_confirmed() {
+ $email = 'export.request.from.unregistered.user@example.com';
+ $request_id = wp_create_user_request( $email, 'export_personal_data' );
+
+ _wp_privacy_account_request_confirmed( $request_id );
+
+ _wp_privacy_send_request_confirmation_notification( $request_id );
+ $first_mailer = tests_retrieve_phpmailer_instance();
+ reset_phpmailer_instance();
+ _wp_privacy_send_request_confirmation_notification( $request_id );
+ $second_mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'request-confirmed', get_post_status( $request_id ) );
+ // First email sent.
+ $this->assertNotEmpty( $first_mailer->mock_sent );
+ // Second email not sent.
+ $this->assertEmpty( $second_mailer->mock_sent );
+ }
+
+ /**
+ * The email address should be filterable.
+ *
+ * @ticket 43967
+ */
+ public function test_email_address_should_be_filterable() {
+ $email = 'export.request.from.unregistered.user@example.com';
+ $request_id = wp_create_user_request( $email, 'export_personal_data' );
+
+ _wp_privacy_account_request_confirmed( $request_id );
+
+ add_filter( 'user_request_confirmed_email_to', array( $this, 'modify_email_address' ), 10, 2 );
+ _wp_privacy_send_request_confirmation_notification( $request_id );
+ remove_all_filters( 'user_request_confirmed_email_to' );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ $this->assertSame( $email, $mailer->get_recipient( 'to' )->address );
+ }
+
+ /**
+ * Filter callback that modifies the recipient of the data request confirmation notification.
+ *
+ * @since 4.9.8
+ *
+ * @param string $admin_email The email address of the notification recipient.
+ * @param WP_User_Request $request_data The request that is initiating the notification.
+ * @return string Admin email address.
+ */
+ public function modify_email_address( $admin_email, $request_data ) {
+ $admin_email = $request_data->email;
+ return $admin_email;
+ }
+
+ /**
+ * The email content should be filterable.
+ *
+ * @ticket 43967
+ */
+ public function test_email_content_should_be_filterable() {
+ $email = 'export.request.from.unregistered.user@example.com';
+ $request_id = wp_create_user_request( $email, 'export_personal_data' );
+
+ _wp_privacy_account_request_confirmed( $request_id );
+
+ add_filter( 'user_confirmed_action_email_content', array( $this, 'modify_email_content' ), 10, 2 );
+ _wp_privacy_send_request_confirmation_notification( $request_id );
+ remove_filter( 'user_confirmed_action_email_content', array( $this, 'modify_email_content' ), 10 );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ $this->assertContains( 'Custom content containing email address:' . $email, $mailer->get_sent()->body );
+ }
+
+ /**
+ * Filter callback that modifies the body of the user request confirmation email.
+ *
+ * @since 4.9.8
+ *
+ * @param string $email_text Email text.
+ * @param array $email_data {
+ * Data relating to the account action email.
+ *
+ * @type WP_User_Request $request User request object.
+ * @type string $user_email The email address confirming a request
+ * @type string $description Description of the action being performed so the user knows what the email is for.
+ * @type string $manage_url The link to click manage privacy requests of this type.
+ * @type string $sitename The site name sending the mail.
+ * @type string $siteurl The site URL sending the mail.
+ * }
+ * @return string Email text.
+ */
+ public function modify_email_content( $email_text, $email_data ) {
+ $email_text = 'Custom content containing email address:' . $email_data['user_email'];
+ return $email_text;
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>