Ticket #43438: 43438.11.diff

tests/phpunit/includes/testcase-ajax.php

@@ -119 +119 @@
                 'delete-theme',
                 'install-theme',
                 'get-post-thumbnail-html',
+                'wp-privacy-export-personal-data',
         );
 
         public static function setUpBeforeClass() {

new file tests/phpunit/tests/ajax/wpAjaxWpPrivacyExportPersonalData.php

@@ +1 @@
+<?php
+/**
+ * Test cases for the `wp_ajax_wp_privacy_export_personal_data()` function.
+ *
+ * @package WordPress\UnitTests
+ *
+ * @since 4.9.6
+ */
+
+/**
+ * Tests_Ajax_WpAjaxWpPrivacyExportPersonalData class.
+ *
+ * @since 4.9.6
+ *
+ * @group ajax
+ * @group privacy
+ * @covers wp_ajax_wp_privacy_export_personal_data
+ */
+class Tests_Ajax_WpAjaxWpPrivacyExportPersonalData extends WP_Ajax_UnitTestCase {
+        /**
+         * User Request ID.
+         *
+         * @since 4.9.6
+         *
+         * @var int
+         */
+        protected static $request_id;
+
+        /**
+         * User Request Email.
+         *
+         * @since 4.9.6
+         *
+         * @var string
+         */
+        protected static $request_email;
+
+        /**
+         * Set up before class. Create fixtures.
+         *
+         * @param WP_UnitTest_Factory $factory Factory.
+         */
+        public static function wpSetUpBeforeClass( $factory ) {
+                self::$request_email = 'user.request@example.com';
+                self::$request_id    = wp_create_user_request( self::$request_email, 'export_personal_data' );
+        }
+
+        /**
+         * Tear down after class.
+         */
+        public static function tearDownAfterClass() {
+                wp_delete_post( self::$request_id, true );
+                parent::tearDownAfterClass();
+        }
+
+        /**
+         * Set up.
+         */
+        public function setUp() {
+                // Only use our custom privacy personal data exporter.
+                remove_all_filters( 'wp_privacy_personal_data_exporters' );
+                add_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_custom_personal_data_exporter' ) );
+
+                // Make sure the exporter response is not modified and avoid e.g. writing export file to disk.
+                remove_all_filters( 'wp_privacy_personal_data_export_page' );
+
+                parent::setUp();
+        }
+
+        /**
+         * Tear down.
+         */
+        public function tearDown() {
+                remove_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_custom_personal_data_exporter' ) );
+                parent::tearDown();
+        }
+
+        /**
+         * The function should successfully send exporters response data when the user is administrator.
+         *
+         * @ticket 43438
+         */
+        public function test_wp_ajax_wp_privacy_export_personal_data_should_success_when_admin_user() {
+                $this->_setRole( 'administrator' );
+                $this->assertNotWPError( self::$request_id );
+
+                // Set up a request.
+                $_POST['security'] = wp_create_nonce( 'wp-privacy-export-personal-data-' . self::$request_id );
+                $_POST['exporter'] = 1;
+                $_POST['page']     = 1;
+                $_POST['id']       = self::$request_id;
+
+                // Make the request.
+                try {
+                        $this->_handleAjax( 'wp-privacy-export-personal-data' );
+                } catch ( WPAjaxDieContinueException $e ) {
+                        unset( $e );
+                }
+
+                // Get the response.
+                $response = json_decode( $this->_last_response, true );
+
+                $this->assertTrue( $response['success'] );
+                $this->assertSame( 'custom-exporter-item-id', $response['data']['data']['item_id'] );
+                $this->assertSame( 'Email', $response['data']['data']['data'][0]['name'] );
+                $this->assertSame( self::$request_email, $response['data']['data']['data'][0]['value'] );
+        }
+
+        /**
+         * The function should send error when the request ID is missing.
+         *
+         * @ticket 43438
+         */
+        public function test_wp_ajax_wp_privacy_export_personal_data_should_error_when_missing_request_id() {
+                $this->_setRole( 'administrator' );
+                $this->assertNotWPError( self::$request_id );
+
+                // Set up a request.
+                $_POST['security'] = wp_create_nonce( 'wp-privacy-export-personal-data-' . self::$request_id );
+                $_POST['exporter'] = 1;
+                $_POST['page']     = 1;
+                // Missing request ID.
+                // $_POST['id']    = self::$request_id;
+
+                // Make the request.
+                try {
+                        $this->_handleAjax( 'wp-privacy-export-personal-data' );
+                } catch ( WPAjaxDieContinueException $e ) {
+                        unset( $e );
+                }
+
+                // Get the response.
+                $response = json_decode( $this->_last_response, true );
+
+                $this->assertFalse( $response['success'] );
+                $this->assertSame( 'Missing request ID.', $response['data'] );
+        }
+
+        /**
+         * The function should send error when the request ID is invalid.
+         *
+         * @ticket 43438
+         */
+        public function test_wp_ajax_wp_privacy_export_personal_data_should_error_when_request_ID_invalid() {
+                $this->_setRole( 'administrator' );
+                // Invalid request ID.
+                $request_id = PHP_INT_MAX;
+
+                // Set up a request.
+                $_POST['security'] = wp_create_nonce( 'wp-privacy-export-personal-data-' . $request_id );
+                $_POST['exporter'] = 1;
+                $_POST['page']     = 1;
+                $_POST['id']       = $request_id;
+
+                // Make the request.
+                try {
+                        $this->_handleAjax( 'wp-privacy-export-personal-data' );
+                } catch ( WPAjaxDieContinueException $e ) {
+                        unset( $e );
+                }
+
+                // Get the response.
+                $response = json_decode( $this->_last_response, true );
+
+                $this->assertFalse( $response['success'] );
+                $this->assertSame( 'Invalid request type.', $response['data'] );
+        }
+
+        /**
+        * Registers a custom personal data exporter.
+        *
+        * @since 4.9.6
+        *
+        * @param  array $exporters An array of personal data exporters.
+        * @return array $exporters An array of personal data exporters.
+        */
+        public function register_custom_personal_data_exporter( $exporters ) {
+                $exporters[] = array(
+                        'exporter_friendly_name' => __( 'Custom Exporter' ),
+                        'callback'               => array( $this, 'custom_personal_data_exporter' ),
+                );
+
+                return $exporters;
+        }
+
+        /**
+        * Custom Personal Data Exporter.
+        *
+        * @since 4.9.6
+        *
+        * @param  string $email_address The comment author email address.
+        * @param  int    $page          Comment page.
+        * @return array  $return        An array of personal data.
+        */
+        public function custom_personal_data_exporter( $email_address, $page = 1 ) {
+                return array(
+                        'data' => array(
+                                'group_id'    => 'custom-exporter-group-id',
+                                'group_label' => 'custom-exporter-group-label',
+                                'item_id'     => 'custom-exporter-item-id',
+                                'data'        => array(
+                                        array(
+                                                'name'  => 'Email',
+                                                'value' => $email_address,
+                                        ),
+                                ),
+                        ),
+                        'done' => true,
+                );
+        }
+
+}