WordPress.org

Make WordPress Core

Ticket #35160: 35160.rss2.patch

File 35160.rss2.patch, 10.5 KB (added by stevenkword, 6 years ago)

Clean-up for the RSS2 tests

  • tests/phpunit/tests/feed/rss2.php

     
    11<?php
    22
    33/**
    4  * test the RSS 2.0 feed by generating a feed, parsing it, and checking that the
     4 * Test the RSS 2.0 feed by generating a feed, parsing it, and checking that the
    55 * parsed contents match the contents of the posts stored in the database.  Since
    66 * we're using a real XML parser, this confirms that the feed is valid, well formed,
    77 * and contains the right stuff.
     
    88 *
    99 * @group feed
    1010 */
    11 class Tests_Feed_RSS2 extends WP_UnitTestCase {
     11class Tests_Feeds_RSS2 extends WP_UnitTestCase {
    1212        static $user_id;
    1313        static $posts;
     14        static $category;
    1415
     16        /**
     17         * Setup a new user and attribute some posts.
     18         */
    1519        public static function wpSetUpBeforeClass( $factory ) {
     20                // Create a user
    1621                self::$user_id = $factory->user->create();
    17                 self::$posts = $factory->post->create_many( 5, array(
    18                         'post_author' => self::$user_id,
     22                self::$user_id = $factory->user->create( array(
     23                        'role'         => 'author',
     24                        'user_login'   => 'test_author',
     25                        'display_name' => 'Test A. Uthor',
    1926                ) );
     27
     28                // Create a taxonomy
     29                self::$category = self::factory()->category->create_and_get( array(
     30                        'name' => 'Test Category',
     31                        'slug' => 'test-cat',
     32                ) );
     33
     34                // Create a few posts
     35                self::$posts = $factory->post->create_many( 42, array(
     36                        'post_author'  => self::$user_id,
     37                        'post_content' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec velit massa, ultrices eu est suscipit, mattis posuere est. Donec vitae purus lacus. Cras vitae odio odio.',
     38                        'post_excerpt' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
     39                ) );
     40
     41                // Assign a category to those posts
     42                foreach ( self::$posts as $post ) {
     43                        wp_set_object_terms( $post, self::$category->slug, 'category' );
     44                }
    2045        }
    2146
     47        /**
     48         * Destroy the user we created and related posts.
     49         */
    2250        public static function wpTearDownAfterClass() {
     51                // Delete our user
    2352                self::delete_user( self::$user_id );
    2453
     54                // Delete all of our posts
    2555                foreach ( self::$posts as $post ) {
    2656                        wp_delete_post( $post, true );
    2757                }
     58
     59                // Delete our taxonomy
     60                wp_delete_category( self::$category->term_id );
    2861        }
    2962
     63        /**
     64         * Setup.
     65         */
    3066        public function setUp() {
    3167                parent::setUp();
    3268
    33                 $this->post_count = get_option('posts_per_rss');
    34                 $this->excerpt_only = get_option('rss_use_excerpt');
     69                $this->post_count = (int) get_option( 'posts_per_rss' );
     70                $this->excerpt_only = get_option( 'rss_use_excerpt' );
    3571                // this seems to break something
    36                 update_option('use_smilies', false);
     72                update_option( 'use_smilies', false );
    3773        }
    3874
     75        /**
     76         * This is a bit of a hack used to buffer feed content.
     77         */
    3978        function do_rss2() {
    4079                ob_start();
    41                 // nasty hack
     80                // Nasty hack! In the future it would better to leverage do_feed( 'rss2' ).
    4281                global $post;
    4382                try {
    4483                        @require(ABSPATH . 'wp-includes/feed-rss2.php');
     
    5089                return $out;
    5190        }
    5291
    53         function test_rss() {
     92        /**
     93         * Test the <rss> element to make sure its present and populated
     94         * with the expected child elements and attributes.
     95         */
     96        function test_rss_element() {
    5497                $this->go_to( '/?feed=rss2' );
    5598                $feed = $this->do_rss2();
    56                 $xml = xml_to_array($feed);
     99                $xml = xml_to_array( $feed );
    57100
    58                 // get the rss element
    59                 $rss = xml_find($xml, 'rss');
     101                // Get the <rss> child element of <xml>.
     102                $rss = xml_find( $xml, 'rss' );
    60103
    61                 // there should only be one rss element
    62                 $this->assertEquals(1, count($rss));
     104                // There should only be one <rss> child element.
     105                $this->assertEquals( 1, count( $rss ) );
    63106
    64                 $this->assertEquals('2.0', $rss[0]['attributes']['version']);
    65                 $this->assertEquals('http://purl.org/rss/1.0/modules/content/', $rss[0]['attributes']['xmlns:content']);
    66                 $this->assertEquals('http://wellformedweb.org/CommentAPI/', $rss[0]['attributes']['xmlns:wfw']);
    67                 $this->assertEquals('http://purl.org/dc/elements/1.1/', $rss[0]['attributes']['xmlns:dc']);
     107                $this->assertEquals( '2.0', $rss[0]['attributes']['version'] );
     108                $this->assertEquals( 'http://purl.org/rss/1.0/modules/content/', $rss[0]['attributes']['xmlns:content'] );
     109                $this->assertEquals( 'http://wellformedweb.org/CommentAPI/', $rss[0]['attributes']['xmlns:wfw'] );
     110                $this->assertEquals( 'http://purl.org/dc/elements/1.1/', $rss[0]['attributes']['xmlns:dc'] );
    68111
    69112                // rss should have exactly one child element (channel)
    70                 $this->assertEquals(1, count($rss[0]['child']));
     113                $this->assertEquals( 1, count( $rss[0]['child'] ) );
    71114        }
    72115
    73         function test_channel() {
     116        /**
     117         * [test_channel_element description]
     118         * @return [type] [description]
     119         */
     120        function test_channel_element() {
    74121                $this->go_to( '/?feed=rss2' );
    75122                $feed = $this->do_rss2();
    76                 $xml = xml_to_array($feed);
     123                $xml = xml_to_array( $feed );
    77124
    78125                // get the rss -> channel element
    79                 $channel = xml_find($xml, 'rss', 'channel');
     126                $channel = xml_find( $xml, 'rss', 'channel' );
    80127
    81                 $this->assertTrue(empty($channel[0]['attributes']));
     128                // The channel should be free of attributes
     129                $this->assertTrue( empty( $channel[0]['attributes'] ) );
    82130
    83                 $title = xml_find($xml, 'rss', 'channel', 'title');
    84                 $this->assertEquals(get_option('blogname'), $title[0]['content']);
     131                // Verify the channel is present and contains a title child element
     132                $title = xml_find( $xml, 'rss', 'channel', 'title' );
     133                $this->assertEquals( get_option( 'blogname' ), $title[0]['content'] );
    85134
    86                 $desc = xml_find($xml, 'rss', 'channel', 'description');
    87                 $this->assertEquals(get_option('blogdescription'), $desc[0]['content']);
     135                $desc = xml_find( $xml, 'rss', 'channel', 'description' );
     136                $this->assertEquals( get_option( 'blogdescription' ), $desc[0]['content'] );
    88137
    89                 $link = xml_find($xml, 'rss', 'channel', 'link');
    90                 $this->assertEquals(get_option('siteurl'), $link[0]['content']);
     138                $link = xml_find( $xml, 'rss', 'channel', 'link' );
     139                $this->assertEquals( get_option( 'siteurl' ), $link[0]['content'] );
    91140
    92                 $pubdate = xml_find($xml, 'rss', 'channel', 'lastBuildDate');
    93                 $this->assertEquals(strtotime(get_lastpostmodified()), strtotime($pubdate[0]['content']));
     141                $pubdate = xml_find( $xml, 'rss', 'channel', 'lastBuildDate' );
     142                $this->assertEquals( strtotime( get_lastpostmodified() ), strtotime( $pubdate[0]['content'] ) );
    94143        }
    95144
    96145        /**
    97146         * @ticket UT32
    98147         */
    99         function test_items() {
     148        function test_item_elements() {
    100149                $this->go_to( '/?feed=rss2' );
    101150                $feed = $this->do_rss2();
    102                 $xml = xml_to_array($feed);
     151                $xml = xml_to_array( $feed );
    103152
    104                 // get all the rss -> channel -> item elements
     153                // Get all the <item> child elements of the <channel> element
    105154                $items = xml_find( $xml, 'rss', 'channel', 'item' );
    106155
    107                 // check each of the items against the known post data
     156                // Verify we are displaying the correct number of posts.
     157                $this->assertCount( $this->post_count, $items );
     158
     159                // We Really only need to test X number of items unless the content is different
     160                $items = array_slice( $items, 1 );
     161
     162                // Check each of the desired entries against the known post data
    108163                foreach ( $items as $key => $item ) {
    109164
    110165                        // Get post for comparison
     
    112167                        preg_match( '/\?p=(\d+)/', $guid[0]['content'], $matches );
    113168                        $post = get_post( $matches[1] );
    114169
    115                         // title
     170                        // Title
    116171                        $title = xml_find( $items[$key]['child'], 'title' );
    117172                        $this->assertEquals( $post->post_title, $title[0]['content'] );
    118173
    119                         // link
     174                        // Link
    120175                        $link = xml_find( $items[$key]['child'], 'link' );
    121176                        $this->assertEquals( get_permalink( $post ), $link[0]['content'] );
    122177
    123                         // comment link
     178                        // Comment link
    124179                        $comments_link = xml_find( $items[$key]['child'], 'comments' );
    125                         $this->assertEquals( get_permalink( $post) . '#respond', $comments_link[0]['content'] );
     180                        $this->assertEquals( get_permalink( $post ) . '#respond', $comments_link[0]['content'] );
    126181
    127                         // pub date
     182                        // Pub date
    128183                        $pubdate = xml_find( $items[$key]['child'], 'pubDate' );
    129184                        $this->assertEquals( strtotime( $post->post_date_gmt ), strtotime( $pubdate[0]['content'] ) );
    130185
    131                         // author
     186                        // Author
    132187                        $creator = xml_find( $items[$key]['child'], 'dc:creator' );
    133188                        $user = new WP_User( $post->post_author );
    134                         $this->assertEquals( $user->user_login, $creator[0]['content'] );
     189                        $this->assertEquals( $user->display_name, $creator[0]['content'] );
    135190
    136                         // categories (perhaps multiple)
     191                        // Categories (perhaps multiple)
    137192                        $categories = xml_find( $items[$key]['child'], 'category' );
    138193                        $cats = array();
    139194                        foreach ( get_the_category( $post->ID ) as $term ) {
     
    147202                                }
    148203                        }
    149204                        $cats = array_filter( $cats );
    150                         // should be the same number of categories
     205                        // Should be the same number of categories
    151206                        $this->assertEquals( count( $cats ), count( $categories ) );
    152207
    153208                        // ..with the same names
    154209                        foreach ( $cats as $id => $cat ) {
    155                                 $this->assertEquals( $cat, $categories[$id]['content']);
     210                                $this->assertEquals( $cat, $categories[$id]['content'] );
    156211                        }
    157212
    158213                        // GUID
    159214                        $guid = xml_find( $items[$key]['child'], 'guid' );
    160                         $this->assertEquals('false', $guid[0]['attributes']['isPermaLink'] );
     215                        $this->assertEquals( 'false', $guid[0]['attributes']['isPermaLink'] );
    161216                        $this->assertEquals( $post->guid, $guid[0]['content'] );
    162217
    163                         // description/excerpt
    164                         if ( !empty( $post->post_excerpt ) ) {
     218                        // Description / Excerpt
     219                        if ( ! empty( $post->post_excerpt ) ) {
    165220                                $description = xml_find( $items[$key]['child'], 'description' );
    166221                                $this->assertEquals( trim( $post->post_excerpt ), trim( $description[0]['content'] ) );
    167222                        }
    168223
    169                         // post content
    170                         if ( !$this->excerpt_only ) {
     224                        // Post content
     225                        if ( ! $this->excerpt_only ) {
    171226                                $content = xml_find( $items[$key]['child'], 'content:encoded' );
    172227                                $this->assertEquals( trim( apply_filters( 'the_content', $post->post_content ) ), trim( $content[0]['content'] ) );
    173228                        }
    174229
    175                         // comment rss
     230                        // Comment rss
    176231                        $comment_rss = xml_find( $items[$key]['child'], 'wfw:commentRss' );
    177                         $this->assertEquals( html_entity_decode( get_post_comments_feed_link( $post->ID) ), $comment_rss[0]['content'] );
     232                        $this->assertEquals( html_entity_decode( get_post_comments_feed_link( $post->ID ) ), $comment_rss[0]['content'] );
    178233                }
    179234        }
    180235
     
    186241
    187242                $this->go_to( '/?feed=rss2' );
    188243                $feed = $this->do_rss2();
    189                 $xml = xml_to_array($feed);
     244                $xml = xml_to_array( $feed );
    190245
    191246                // get all the rss -> channel -> item elements
    192247                $items = xml_find( $xml, 'rss', 'channel', 'item' );
     
    209264
    210265                remove_filter( 'comments_open', '__return_false' );
    211266        }
     267
    212268}