Changeset 43080 for branches/4.9/tests/phpunit/tests/comment.php

Timestamp:

05/02/2018 12:20:31 AM (8 years ago)

Author:

SergeyBiryukov

Message:

Privacy: add functionality to anonymize commenters.

Props xkon, fclaussen, allendav, birgire, azaozz.
Merges [42994] to the 4.9 branch.
See #43442.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• tests/phpunit/tests/comment.php (modified) (1 diff)

branches/4.9/tests/phpunit/tests/comment.php

@@ -701 +701 @@
     }
 
+    /**
+     * The `wp_comments_personal_data_eraser()` function should erase user's comments.
+     *
+     * @ticket 43442
+     */
+    public function test_wp_comments_personal_data_eraser() {
+
+        $post_id = self::factory()->post->create();
+        $user_id = self::factory()->user->create();
+
+        $args       = array(
+            'user_id'              => $user_id,
+            'comment_post_ID'      => $post_id,
+            'comment_author'       => 'Comment Author',
+            'comment_author_email' => 'personal@local.host',
+            'comment_author_url'   => 'https://local.host/',
+            'comment_author_IP'    => '192.168.0.1',
+            'comment_date'         => '2018-04-14 17:20:00',
+            'comment_agent'        => 'COMMENT_AGENT',
+            'comment_content'      => 'Comment Content',
+        );
+        $comment_id = self::factory()->comment->create( $args );
+
+        wp_comments_personal_data_eraser( $args['comment_author_email'] );
+
+        $comment = get_comment( $comment_id );
+
+        $actual = array(
+            'comment_ID'           => $comment->comment_ID,
+            'user_id'              => $comment->user_id,
+            'comment_author'       => $comment->comment_author,
+            'comment_author_email' => $comment->comment_author_email,
+            'comment_author_url'   => $comment->comment_author_url,
+            'comment_author_IP'    => $comment->comment_author_IP,
+            'comment_date'         => $comment->comment_date,
+            'comment_date_gmt'     => $comment->comment_date_gmt,
+            'comment_agent'        => $comment->comment_agent,
+            'comment_content'      => $comment->comment_content,
+        );
+
+        $expected = array(
+            'comment_ID'           => (string) $comment_id,
+            'user_id'              => '0', // Anonymized.
+            'comment_author'       => 'Anonymous', // Anonymized.
+            'comment_author_email' => 'deleted@site.invalid', // Anonymized.
+            'comment_author_url'   => 'https://site.invalid', // Anonymized.
+            'comment_author_IP'    => '192.168.0.0', // Anonymized.
+            'comment_date'         => '2018-04-14 17:20:00',
+            'comment_date_gmt'     => '2018-04-14 17:20:00',
+            'comment_agent'        => '', // Anonymized.
+            'comment_content'      => 'Comment Content',
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Testing the `wp_comments_personal_data_eraser()` function's output on an empty first page.
+     *
+     * @ticket 43442
+     */
+    public function test_wp_comments_personal_data_eraser_empty_first_page_output() {
+
+        $actual   = wp_comments_personal_data_eraser( 'nocommentsfound@local.host' );
+        $expected = array(
+            'num_items_removed'  => 0,
+            'num_items_retained' => 0,
+            'messages'           => array(),
+            'done'               => true,
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Testing the `wp_comments_personal_data_eraser()` function's output, for the non-empty first page.
+     *
+     * @ticket 43442
+     */
+    public function test_wp_comments_personal_data_eraser_non_empty_first_page_output() {
+
+        $post_id = self::factory()->post->create();
+        $args    = array(
+            'comment_post_ID'      => $post_id,
+            'comment_author'       => 'Comment Author',
+            'comment_author_email' => 'personal@local.host',
+            'comment_author_url'   => 'https://local.host/',
+            'comment_author_IP'    => '192.168.0.1',
+            'comment_date'         => '2018-04-14 17:20:00',
+            'comment_agent'        => 'COMMENT_AGENT',
+            'comment_content'      => 'Comment Content',
+        );
+        self::factory()->comment->create( $args );
+
+        $actual   = wp_comments_personal_data_eraser( $args['comment_author_email'] );
+        $expected = array(
+            'num_items_removed'  => 1,
+            'num_items_retained' => 0,
+            'messages'           => array(),
+            'done'               => true,
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Testing the `wp_comments_personal_data_eraser()` function's output, for an empty second page.
+     *
+     * @ticket 43442
+     */
+    public function test_wp_comments_personal_data_eraser_empty_second_page_output() {
+
+        $post_id = self::factory()->post->create();
+        $args    = array(
+            'comment_post_ID'      => $post_id,
+            'comment_author'       => 'Comment Author',
+            'comment_author_email' => 'personal@local.host',
+            'comment_author_url'   => 'https://local.host/',
+            'comment_author_IP'    => '192.168.0.1',
+            'comment_date'         => '2018-04-14 17:20:00',
+            'comment_agent'        => 'COMMENT_AGENT',
+            'comment_content'      => 'Comment Content',
+        );
+        self::factory()->comment->create( $args );
+
+        $actual   = wp_comments_personal_data_eraser( $args['comment_author_email'], 2 );
+        $expected = array(
+            'num_items_removed'  => 0,
+            'num_items_retained' => 0,
+            'messages'           => array(),
+            'done'               => true,
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Testing the `wp_anonymize_comment` filter, to prevent comment anonymization.
+     *
+     * @ticket 43442
+     */
+    public function test_wp_anonymize_comment_filter_to_prevent_comment_anonymization() {
+
+        $post_id    = self::factory()->post->create();
+        $args       = array(
+            'comment_post_ID'      => $post_id,
+            'comment_author'       => 'Comment Author',
+            'comment_author_email' => 'personal@local.host',
+            'comment_author_url'   => 'https://local.host/',
+            'comment_author_IP'    => '192.168.0.1',
+            'comment_date'         => '2018-04-14 17:20:00',
+            'comment_agent'        => 'COMMENT_AGENT',
+            'comment_content'      => 'Comment Content',
+        );
+        $comment_id = self::factory()->comment->create( $args );
+
+        add_filter( 'wp_anonymize_comment', '__return_false' );
+        $actual = wp_comments_personal_data_eraser( $args['comment_author_email'] );
+        remove_filter( 'wp_anonymize_comment', '__return_false' );
+
+        $message = sprintf( 'Comment %d contains personal data but could not be anonymized.', $comment_id );
+
+        $expected = array(
+            'num_items_removed'  => 0,
+            'num_items_retained' => 1,
+            'messages'           => array( $message ),
+            'done'               => true,
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Testing the `wp_anonymize_comment` filter, to prevent comment anonymization, with a custom message.
+     *
+     * @ticket 43442
+     */
+    public function test_wp_anonymize_comment_filter_to_prevent_comment_anonymization_with_custom_message() {
+
+        $post_id    = self::factory()->post->create();
+        $args       = array(
+            'comment_post_ID'      => $post_id,
+            'comment_author'       => 'Comment Author',
+            'comment_author_email' => 'personal@local.host',
+            'comment_author_url'   => 'https://local.host/',
+            'comment_author_IP'    => '192.168.0.1',
+            'comment_date'         => '2018-04-14 17:20:00',
+            'comment_agent'        => 'COMMENT_AGENT',
+            'comment_content'      => 'Comment Content',
+        );
+        $comment_id = self::factory()->comment->create( $args );
+
+        add_filter( 'wp_anonymize_comment', array( $this, 'wp_anonymize_comment_custom_message' ), 10, 3 );
+        $actual = wp_comments_personal_data_eraser( $args['comment_author_email'] );
+        remove_filter( 'wp_anonymize_comment', array( $this, 'wp_anonymize_comment_custom_message' ) );
+
+        $message = sprintf( 'Some custom message for comment %d.', $comment_id );
+
+        $expected = array(
+            'num_items_removed'  => 0,
+            'num_items_retained' => 1,
+            'messages'           => array( $message ),
+            'done'               => true,
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Callback for the `wp_anonymize_comment` filter.
+     *
+     * @param  bool|string $anonymize          Whether to apply the comment anonymization (bool).
+     *                                         Custom prevention message (string). Default true.
+     * @param  WP_Comment  $comment            WP_Comment object.
+     * @param  array       $anonymized_comment Anonymized comment data.
+     * @return string
+     */
+    public function wp_anonymize_comment_custom_message( $anonymize, $comment, $anonymized_comment ) {
+        return sprintf( 'Some custom message for comment %d.', $comment->comment_ID );
+    }
+
     public function test_update_should_invalidate_comment_cache() {
         global $wpdb;