Skip to content

Tests: Improve unit test coverage for WP_Sitemaps_Renderer. #13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huzaifaalmesbah wants to merge 2 commits into
base: trunk
Choose a base branch
from
+218 −0
Open

Tests: Improve unit test coverage for WP_Sitemaps_Renderer. #13537

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
402979b
Tests: Improve unit test coverage for WP_Sitemaps_Renderer.
huzaifaalmesbah Sep 15, 2026
9ee3ee9
Tests: Address review feedback for WP_Sitemaps_Renderer tests.
huzaifaalmesbah Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
218 changes: 218 additions & 0 deletions tests/phpunit/tests/sitemaps/wpSitemapsRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,4 +281,222 @@ public function test_get_sitemap_xml_extra_elements() {
'Invalid child of "sitemap:url" in rendered XML.'
);
}

/**
* Test that the sitemap stylesheet URL can be filtered.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_stylesheet_url
*/
public function test_get_sitemap_stylesheet_url_filter() {
$custom_url = 'https://example.com/custom-sitemap.xsl';

add_filter(
'wp_sitemaps_stylesheet_url',
static function () use ( $custom_url ) {
return $custom_url;
}
);

$sitemap_renderer = new WP_Sitemaps_Renderer();
$entries = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/2019/10/post-1',
),
);

$actual = $sitemap_renderer->get_sitemap_xml( $entries );
$this->assertStringContainsString( '<?xml-stylesheet type="text/xsl" href="' . $custom_url . '" ?>', $actual );
}

/**
* Test that the sitemap index stylesheet URL can be filtered.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_index_stylesheet_url
*/
public function test_get_sitemap_index_stylesheet_url_filter() {
$custom_url = 'https://example.com/custom-sitemap-index.xsl';

add_filter(
'wp_sitemaps_stylesheet_index_url',
static function () use ( $custom_url ) {
return $custom_url;
}
);

$sitemap_renderer = new WP_Sitemaps_Renderer();
$entries = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/wp-sitemap-posts-post-1.xml',
),
);

$actual = $sitemap_renderer->get_sitemap_index_xml( $entries );
$this->assertStringContainsString( '<?xml-stylesheet type="text/xsl" href="' . $custom_url . '" ?>', $actual );
}

/**
* Test XML output for empty sitemap page renderer.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_xml
*/
public function test_get_sitemap_xml_empty() {
$renderer = new WP_Sitemaps_Renderer();
$actual = $renderer->get_sitemap_xml( array() );
$expected = '<?xml version="1.0" encoding="UTF-8"?>' .
'<?xml-stylesheet type="text/xsl" href="http://' . WP_TESTS_DOMAIN . '/?sitemap-stylesheet=sitemap" ?>' .
'<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"/>';

$this->assertXMLEquals( $expected, $actual, 'Empty sitemap markup incorrect.' );
}

/**
* Test XML output for empty sitemap index renderer.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_index_xml
*/
public function test_get_sitemap_index_xml_empty() {
$renderer = new WP_Sitemaps_Renderer();
$actual = $renderer->get_sitemap_index_xml( array() );
$expected = '<?xml version="1.0" encoding="UTF-8"?>' .
'<?xml-stylesheet type="text/xsl" href="http://' . WP_TESTS_DOMAIN . '/?sitemap-stylesheet=index" ?>' .
'<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"/>';

$this->assertXMLEquals( $expected, $actual, 'Empty sitemap index markup incorrect.' );
}

/**
* Test XML output for the sitemap page renderer with all supported fields.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_xml
*/
public function test_get_sitemap_xml_with_all_supported_fields() {
$url_list = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/2019/10/post-1',
'lastmod' => '2020-01-01',
'changefreq' => 'monthly',
'priority' => '0.8',
),
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/2019/10/post-2',
'lastmod' => '2020-02-02',
'changefreq' => 'daily',
'priority' => '1.0',
),
);

$renderer = new WP_Sitemaps_Renderer();

$actual = $renderer->get_sitemap_xml( $url_list );
$expected = '<?xml version="1.0" encoding="UTF-8"?>' .
'<?xml-stylesheet type="text/xsl" href="http://' . WP_TESTS_DOMAIN . '/?sitemap-stylesheet=sitemap" ?>' .
'<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' .
'<url>' .
'<loc>http://' . WP_TESTS_DOMAIN . '/2019/10/post-1</loc>' .
'<lastmod>2020-01-01</lastmod>' .
'<changefreq>monthly</changefreq>' .
'<priority>0.8</priority>' .
'</url>' .
'<url>' .
'<loc>http://' . WP_TESTS_DOMAIN . '/2019/10/post-2</loc>' .
'<lastmod>2020-02-02</lastmod>' .
'<changefreq>daily</changefreq>' .
'<priority>1.0</priority>' .
'</url>' .
'</urlset>';

$this->assertXMLEquals( $expected, $actual, 'Sitemap page markup with all supported fields incorrect.' );
}

/**
* Test XML escaping for sitemap entries.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_xml
*/
public function test_get_sitemap_xml_escaping() {
$url_list = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/?foo=1&bar=2',
'lastmod' => '2020-01-01 & "quotes"',
'changefreq' => 'weekly < monthly',
'priority' => '0.5 > 0.3',
),
);

$renderer = new WP_Sitemaps_Renderer();
$xml_dom = $this->loadXML( $renderer->get_sitemap_xml( $url_list ) );
$xpath = new DOMXPath( $xml_dom );
$xpath->registerNamespace( 'sitemap', 'http://www.sitemaps.org/schemas/sitemap/0.9' );

$this->assertSame( 'http://' . WP_TESTS_DOMAIN . '/?foo=1&bar=2', $xpath->evaluate( 'string(/sitemap:urlset/sitemap:url/sitemap:loc)' ) );
$this->assertSame( '2020-01-01 & "quotes"', $xpath->evaluate( 'string(/sitemap:urlset/sitemap:url/sitemap:lastmod)' ) );
$this->assertSame( 'weekly < monthly', $xpath->evaluate( 'string(/sitemap:urlset/sitemap:url/sitemap:changefreq)' ) );
$this->assertSame( '0.5 > 0.3', $xpath->evaluate( 'string(/sitemap:urlset/sitemap:url/sitemap:priority)' ) );
}

/**
* Test XML escaping for sitemap index entries.
*
* @covers WP_Sitemaps_Renderer::get_sitemap_index_xml
*/
public function test_get_sitemap_index_xml_escaping() {
$entries = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/wp-sitemap.php?foo=1&bar=2',
'lastmod' => '2020-01-01 & "special"',
),
);

$renderer = new WP_Sitemaps_Renderer();
$xml_dom = $this->loadXML( $renderer->get_sitemap_index_xml( $entries ) );
$xpath = new DOMXPath( $xml_dom );
$xpath->registerNamespace( 'sitemap', 'http://www.sitemaps.org/schemas/sitemap/0.9' );

$this->assertSame( 'http://' . WP_TESTS_DOMAIN . '/wp-sitemap.php?foo=1&bar=2', $xpath->evaluate( 'string(/sitemap:sitemapindex/sitemap:sitemap/sitemap:loc)' ) );
$this->assertSame( '2020-01-01 & "special"', $xpath->evaluate( 'string(/sitemap:sitemapindex/sitemap:sitemap/sitemap:lastmod)' ) );
}

/**
* Test render_index() outputs index XML.
*
* @covers WP_Sitemaps_Renderer::render_index
*
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function test_render_index() {
$entries = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/wp-sitemap-posts-post-1.xml',
),
);

$renderer = new WP_Sitemaps_Renderer();
$expected_xml = $renderer->get_sitemap_index_xml( $entries );

$this->expectOutputString( $expected_xml );
$renderer->render_index( $entries );
}

/**
* Test render_sitemap() outputs sitemap XML.
*
* @covers WP_Sitemaps_Renderer::render_sitemap
*
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function test_render_sitemap() {
$url_list = array(
array(
'loc' => 'http://' . WP_TESTS_DOMAIN . '/2019/10/post-1',
),
);

$renderer = new WP_Sitemaps_Renderer();
$expected_xml = $renderer->get_sitemap_xml( $url_list );

$this->expectOutputString( $expected_xml );
$renderer->render_sitemap( $url_list );
}
}
Loading