Ticket #44233: 43546.wpPrivacyGeneratePersonalDataExportFile.diff

tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php

@@ +1 @@
+<?php
+/**
+ * Define a class to test `wp_privacy_generate_personal_data_export_file()`.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 4.9.6
+ */
+
+/**
+ * Test cases for `wp_privacy_generate_personal_data_export_file()`.
+ *
+ * @group privacy
+ * @covers wp_privacy_generate_personal_data_export_file
+ *
+ * @since 4.9.6
+ */
+class Tests_Privacy_wpPrivacyGeneratePersonalDataExportFile extends WP_UnitTestCase {
+        /**
+         * An Export Request ID
+         *
+         * @since 4.9.6
+         *
+         * @var int $export_request_id
+         */
+        protected static $export_request_id;
+
+        /**
+         * Create fixtures that are shared by multiple test cases.
+         *
+         * @param WP_UnitTest_Factory $factory The base factory object.
+         */
+        public static function wpSetUpBeforeClass( $factory ) {
+                self::$export_request_id = wp_create_user_request( 'export-requester@example.com', 'export_personal_data' );
+                update_post_meta( self::$export_request_id, '_export_data_grouped', array() );
+        }
+
+        /**
+         * Set up the test fixture.
+         * Override wp_die(), pretend to be ajax, and suppress E_WARNINGs
+         */
+        public function setUp() {
+                parent::setUp();
+
+                // We need to override the die handler because otherwise our unit test will die too
+                add_filter( 'wp_die_ajax_handler', array( $this, 'getDieHandler' ), 1, 1 );
+                add_filter( 'wp_doing_ajax', '__return_true' );
+
+                // Suppress warnings from "Cannot modify header information - headers already sent by"
+                $this->_error_level = error_reporting();
+        error_reporting( $this->_error_level & ~E_WARNING );
+        
+        // Delete the wp-personal-data-exports folder before each test
+        $wp_privacy_exports_dir = wp_privacy_exports_dir();
+        if ( empty( $wp_privacy_exports_dir ) ) {
+            $this->markTestSkipped( 'Exports directory unclear. Skipping test to avoid loss of data.' );
+        } else {
+            @chmod( $wp_privacy_exports_dir, 0755 );
+
+            if ( ! is_dir( $wp_privacy_exports_dir ) ) {
+                @unlink( untrailingslashit( $wp_privacy_exports_dir ) );
+            } else {
+                if ( 'Windows' === PHP_OS ) {
+                    exec( sprintf( "rd /s /q %s", escapeshellarg( $wp_privacy_exports_dir ) ) );
+                } else {
+                    exec( sprintf( "rm -rf %s", escapeshellarg( $wp_privacy_exports_dir ) ) );
+                }
+            }
+        }
+        }
+
+        /**
+         * Tear down the test fixture.
+         * Remove the wp_die() override, restore error reporting
+         */
+        public function tearDown() {
+                remove_filter( 'wp_die_ajax_handler', array( $this, 'getDieHandler' ), 1, 1 );
+                error_reporting( $this->_error_level );
+                parent::tearDown();
+        }
+
+        /**
+         * Return our callback handler
+         *
+         * @return callback
+         */
+        public function getDieHandler() {
+                return array( $this, 'dieHandler' );
+        }
+
+        /**
+         * Handler for wp_die()
+         * Don't die, throw.
+         *
+         * @param string $message (Unfortunately, always empty)
+         */
+        public function dieHandler( $message ) {
+                throw new Exception();
+        }
+
+    public function test_wp_privacy_generate_personal_data_export_file_can_succeed() {
+                $exception_was_thrown = false;
+
+                try {
+                        wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertFalse( $exception_was_thrown );
+    }
+
+        public function test_wp_privacy_generate_personal_data_export_file_rejects_remove_requests() {
+                $exception_was_thrown = false;
+                $request_id = wp_create_user_request( 'removal-requester@example.com', 'remove_personal_data' );
+
+                try {
+                        $this->expectOutputString( '{"success":false,"data":"Invalid request ID when generating export file."}' );
+                        wp_privacy_generate_personal_data_export_file( $request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertTrue( $exception_was_thrown );
+        }
+
+        public function test_wp_privacy_generate_personal_data_export_file_rejects_requests_with_bad_email_addresses() {
+                $exception_was_thrown = false;
+                $request_id = wp_create_user_request( 'bad-email-requester@example.com', 'export_personal_data' );
+
+                wp_update_post(
+                        array(
+                                'ID' => $request_id,
+                                'post_title' => 'not-a-valid-email-address'
+                        )
+                );
+
+                try {
+                        $this->expectOutputString( '{"success":false,"data":"Invalid email address when generating export file."}' );
+                        wp_privacy_generate_personal_data_export_file( $request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertTrue( $exception_was_thrown );
+        }
+
+    public function test_wp_privacy_generate_personal_data_export_file_detects_cannot_create_folder() {
+                $exception_was_thrown = false;
+                $index_html_path = wp_privacy_exports_dir();
+        touch( untrailingslashit( $index_html_path ) ); // creates a file with our folder name, thereby blocking the folder creation
+
+                try {
+                        $this->expectOutputString( '{"success":false,"data":"Unable to create export folder."}' );
+                        wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertTrue( $exception_was_thrown );
+        }
+    
+    public function test_wp_privacy_generate_personal_data_export_file_creates_index_in_export_folder() {
+                $exception_was_thrown = false;
+
+                try {
+                        $this->expectOutputString( '' );
+                        wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertFalse( $exception_was_thrown );
+
+                $index_html_path = wp_privacy_exports_dir() . 'index.html';
+        $this->assertTrue( file_exists( $index_html_path ) );
+    }
+
+    public function test_wp_privacy_generate_personal_data_export_file_detects_cannot_create_index() {
+                $exception_was_thrown = false;
+
+                $exports_dir = wp_privacy_exports_dir();
+                mkdir( $exports_dir );
+                chmod( $exports_dir, 0444 ); // make it read only so protection will fail
+
+                try {
+                        $this->expectOutputString( '{"success":false,"data":"Unable to protect export folder from browsing."}' );
+                        wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertTrue( $exception_was_thrown );
+        }
+
+    public function test_wp_privacy_generate_personal_data_export_file_detects_cannot_write_html() {
+                $exception_was_thrown = false;
+
+                $exports_dir = wp_privacy_exports_dir();
+                mkdir( $exports_dir );
+                $index_html_path = wp_privacy_exports_dir() . 'index.html';
+                touch( $index_html_path );
+                chmod( $exports_dir, 0555 ); // make the folder read only so html writing will fail
+
+                try {
+                        $this->expectOutputString( '{"success":false,"data":"Unable to open export file (HTML report) for writing."}' );
+                        wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                $this->assertTrue( $exception_was_thrown );
+        }
+
+    public function test_wp_privacy_generate_personal_data_export_file_contents() {
+                $exception_was_thrown = false;
+
+                try {
+                        $this->expectOutputString( '' );
+                        wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+                } catch( Exception $e ) {
+                        $exception_was_thrown = true;
+                }
+
+                if ( ! $exception_was_thrown ) {
+                        $archive_pathname = get_post_meta( self::$export_request_id, '_export_file_path', true );
+                        $temp_dir = trailingslashit( wp_privacy_exports_dir() . 'tempdir' );
+                        mkdir( $temp_dir );
+                        $zip = new ZipArchive;
+                        $res = $zip->open( $archive_pathname );
+
+                        $this->assertTrue( $res );
+
+                        $zip->extractTo( $temp_dir );
+                        $zip->close();
+                                
+                        $this->assertTrue( file_exists( $temp_dir . 'index.html' ) );
+
+                        $report_contents = file_get_contents( $temp_dir . 'index.html' );
+
+                        $this->assertContains( '<h1>Personal Data Export</h1>', $report_contents );
+                        $this->assertContains( '<h2>About</h2>', $report_contents );
+
+                        $request = wp_get_user_request_data( self::$export_request_id );
+                        $this->assertContains( $request->email, $report_contents );
+                }
+
+                $this->assertFalse( $exception_was_thrown );
+        }
+
+        // TODO - Come up with tests for the following, if even possible (might require changes to function)
+        // 1. ziparchive not available
+        // 2. cannot create zip file (and intermediate HTML report file should also be removed)
+    // 3. unable to add data to zip file (and intermediate HTML report file should also be removed)
+}