<!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>[43291] trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php: Tests: Add case for `wp_privacy_send_personal_data_export_email()`.</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/43291">43291</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/43291","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-05-16 23:53:38 +0000 (Wed, 16 May 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'>Tests: Add case for `wp_privacy_send_personal_data_export_email()`.
Props birgire.
See <a href="https://core.trac.wordpress.org/ticket/43546">#43546</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp"></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/wpPrivacySendPersonalDataExportEmail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php (rev 0)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2018-05-16 23:53:38 UTC (rev 43291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,173 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test cases for the `wp_privacy_send_personal_data_export_email()` function.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 4.9.6
+ */
+
+/**
+ * Tests_Privacy_WpPrivacySendPersonalDataExportEmail class.
+ *
+ * @group privacy
+ * @covers wp_privacy_send_personal_data_export_email
+ *
+ * @since 4.9.6
+ */
+class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase {
+ /**
+ * Request ID.
+ *
+ * @since 4.9.6
+ *
+ * @var int $request_id
+ */
+ protected static $request_id;
+
+ /**
+ * Requester Email.
+ *
+ * @since 4.9.6
+ *
+ * @var string $requester_email
+ */
+ protected static $requester_email;
+
+ /**
+ * Reset the mocked phpmailer instance before each test method.
+ *
+ * @since 4.9.6
+ */
+ function setUp() {
+ parent::setUp();
+ reset_phpmailer_instance();
+ }
+
+ /**
+ * Reset the mocked phpmailer instance after each test method.
+ *
+ * @since 4.9.6
+ */
+ function tearDown() {
+ reset_phpmailer_instance();
+ parent::tearDown();
+ }
+
+ /**
+ * Create user request fixtures shared by test methods.
+ *
+ * @since 4.9.6
+ *
+ * @param WP_UnitTest_Factory $factory Factory.
+ */
+ public static function wpSetUpBeforeClass( $factory ) {
+ self::$requester_email = 'requester@example.com';
+ self::$request_id = wp_create_user_request( self::$requester_email, 'export_personal_data' );
+
+ _wp_privacy_account_request_confirmed( self::$request_id );
+ }
+
+ /**
+ * The function should send an export link to the requester when the user request is confirmed.
+ */
+ public function test_function_should_send_export_link_to_requester() {
+ $archive_url = wp_privacy_exports_url() . 'wp-personal-data-file-requester-at-example-com-Wv0RfMnGIkl4CFEDEEkSeIdfLmaUrLsl.zip';
+ update_post_meta( self::$request_id, '_export_file_url', $archive_url );
+
+ $email_sent = wp_privacy_send_personal_data_export_email( self::$request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'request-confirmed', get_post_status( self::$request_id ) );
+ $this->assertSame( self::$requester_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Personal Data Export', $mailer->get_sent()->subject );
+ $this->assertContains( $archive_url, $mailer->get_sent()->body );
+ $this->assertContains( 'please download it', $mailer->get_sent()->body );
+ $this->assertTrue( $email_sent );
+ }
+
+ /**
+ * The function should error when the request ID is invalid.
+ *
+ * @since 4.9.6
+ */
+ public function test_function_should_error_when_request_id_invalid() {
+ $request_id = 0;
+ $email_sent = wp_privacy_send_personal_data_export_email( $request_id );
+ $this->assertWPError( $email_sent );
+ $this->assertSame( 'invalid', $email_sent->get_error_code() );
+
+ $request_id = PHP_INT_MAX;
+ $email_sent = wp_privacy_send_personal_data_export_email( $request_id );
+ $this->assertWPError( $email_sent );
+ $this->assertSame( 'invalid', $email_sent->get_error_code() );
+ }
+
+ /**
+ * The function should error when the email was not sent.
+ *
+ * @since 4.9.6
+ */
+ public function test_return_wp_error_when_send_fails() {
+ add_filter( 'wp_mail_from', '__return_empty_string' ); // Cause `wp_mail()` to return false.
+ $email_sent = wp_privacy_send_personal_data_export_email( self::$request_id );
+ remove_filter( 'wp_mail_from', '__return_empty_string' );
+
+ $this->assertWPError( $email_sent );
+ $this->assertSame( 'error', $email_sent->get_error_code() );
+ }
+
+ /**
+ * The export expiration should be filterable.
+ *
+ * @since 4.9.6
+ */
+ public function test_export_expiration_should_be_filterable() {
+ add_filter( 'wp_privacy_export_expiration', array( $this, 'modify_export_expiration' ) );
+ wp_privacy_send_personal_data_export_email( self::$request_id );
+ remove_filter( 'wp_privacy_export_expiration', array( $this, 'modify_export_expiration' ) );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ $this->assertContains( 'we will automatically delete the file on December 18, 2017,', $mailer->get_sent()->body );
+ }
+
+ /**
+ * Filter callback that modifies the lifetime, in seconds, of a personal data export file.
+ *
+ * @since 4.9.6
+ *
+ * @param int $expiration The expiration age of the export, in seconds.
+ * @return int $expiration The expiration age of the export, in seconds.
+ */
+ public function modify_export_expiration( $expiration ) {
+ // Set date to always be "Mon, 18 Dec 2017 21:30:00 GMT", so can assert a fixed date.
+ return 1513632600 - time();
+ }
+
+ /**
+ * The email content should be filterable.
+ *
+ * @since 4.9.6
+ */
+ public function test_email_content_should_be_filterable() {
+ add_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content' ), 10, 2 );
+ wp_privacy_send_personal_data_export_email( self::$request_id );
+ remove_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content' ) );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+ $this->assertContains( 'Custom content for request ID: ' . self::$request_id, $mailer->get_sent()->body );
+ }
+
+ /**
+ * Filter callback that modifies the text of the email sent with a personal data export file.
+ *
+ * @since 4.9.6
+ *
+ * @param string $email_text Text in the email.
+ * @param int $request_id The request ID for this personal data export.
+ * @return string $email_text Text in the email.
+ */
+ public function modify_email_content( $email_text, $request_id ) {
+ return 'Custom content for request ID: ' . $request_id;
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>