Tests: Ignore EOL differences in some tests using multiline string assertions.

Unix vs. Windows EOL style mismatches can cause misleading failures in tests using the heredoc syntax (`<<<`) or multiline strings as the expected result.

Follow-up to [48466], [50995], [51079].

See #52625.

git-svn-id: https://develop.svn.wordpress.org/trunk@51135 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2021-06-09 19:41:47 +00:00
parent b0eadda6e6
commit 81e84e12e8
3 changed files with 41 additions and 26 deletions

View File

@@ -660,12 +660,27 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase {
* Asserts that two values have the same type and value, with EOL differences discarded.
*
* @since 5.6.0
* @since 5.8.0 Added support for nested arrays.
*
* @param string $expected The expected value.
* @param string $actual The actual value.
* @param string|array $expected The expected value.
* @param string|array $actual The actual value.
*/
public function assertSameIgnoreEOL( $expected, $actual ) {
$this->assertSame( str_replace( "\r\n", "\n", $expected ), str_replace( "\r\n", "\n", $actual ) );
$expected = map_deep(
$expected,
function ( $value ) {
return str_replace( "\r\n", "\n", $value );
}
);
$actual = map_deep(
$actual,
function ( $value ) {
return str_replace( "\r\n", "\n", $value );
}
);
$this->assertSame( $expected, $actual );
}
/**

View File

@@ -307,7 +307,7 @@ class WP_Test_REST_Widget_Types_Controller extends WP_Test_REST_Controller_Testc
$request = new WP_REST_Request( 'POST', '/wp/v2/widget-types/search/encode' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame(
$this->assertSameIgnoreEOL(
"<p>\n" .
"\t\t\t<label for=\"widget-search--1-title\">Title:</label>\n" .
"\t\t\t<input class=\"widefat\" id=\"widget-search--1-title\" name=\"widget-search[-1][title]\" type=\"text\" value=\"\" />\n" .
@@ -343,7 +343,7 @@ class WP_Test_REST_Widget_Types_Controller extends WP_Test_REST_Controller_Testc
$request->set_param( 'number', 8 );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame(
$this->assertSameIgnoreEOL(
"<p>\n" .
"\t\t\t<label for=\"widget-search-8-title\">Title:</label>\n" .
"\t\t\t<input class=\"widefat\" id=\"widget-search-8-title\" name=\"widget-search[8][title]\" type=\"text\" value=\"\" />\n" .
@@ -385,7 +385,7 @@ class WP_Test_REST_Widget_Types_Controller extends WP_Test_REST_Controller_Testc
);
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame(
$this->assertSameIgnoreEOL(
"<p>\n" .
"\t\t\t<label for=\"widget-search--1-title\">Title:</label>\n" .
"\t\t\t<input class=\"widefat\" id=\"widget-search--1-title\" name=\"widget-search[-1][title]\" type=\"text\" value=\"Test title\" />\n" .
@@ -421,7 +421,7 @@ class WP_Test_REST_Widget_Types_Controller extends WP_Test_REST_Controller_Testc
$request->set_param( 'form_data', 'widget-search[-1][title]=Updated+title' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame(
$this->assertSameIgnoreEOL(
"<p>\n" .
"\t\t\t<label for=\"widget-search--1-title\">Title:</label>\n" .
"\t\t\t<input class=\"widefat\" id=\"widget-search--1-title\" name=\"widget-search[-1][title]\" type=\"text\" value=\"Updated title\" />\n" .
@@ -465,7 +465,7 @@ class WP_Test_REST_Widget_Types_Controller extends WP_Test_REST_Controller_Testc
);
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame(
$this->assertSameIgnoreEOL(
"<p>\n" .
"\t\t\t<label for=\"widget-search--1-title\">Title:</label>\n" .
"\t\t\t<input class=\"widefat\" id=\"widget-search--1-title\" name=\"widget-search[-1][title]\" type=\"text\" value=\"Test title\" />\n" .

View File

@@ -381,12 +381,17 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$data = $this->remove_links( $data );
$this->assertEqualSets(
$this->assertSameIgnoreEOL(
array(
array(
'id' => 'text-1',
'id_base' => 'text',
'sidebar' => 'sidebar-1',
'rendered' => '<div class="textwidget">Custom text test</div>',
'rendered_form' => '<input id="widget-text-1-title" name="widget-text[1][title]" class="title sync-input" type="hidden" value="">' . "\n" .
' <textarea id="widget-text-1-text" name="widget-text[1][text]" class="text sync-input" hidden>Custom text test</textarea>' . "\n" .
' <input id="widget-text-1-filter" name="widget-text[1][filter]" class="filter sync-input" type="hidden" value="on">' . "\n" .
' <input id="widget-text-1-visual" name="widget-text[1][visual]" class="visual sync-input" type="hidden" value="on">',
'instance' => array(
'encoded' => base64_encode(
serialize(
@@ -406,11 +411,6 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
'text' => 'Custom text test',
),
),
'rendered' => '<div class="textwidget">Custom text test</div>',
'rendered_form' => '<input id="widget-text-1-title" name="widget-text[1][title]" class="title sync-input" type="hidden" value="">' . "\n" .
' <textarea id="widget-text-1-text" name="widget-text[1][text]" class="text sync-input" hidden>Custom text test</textarea>' . "\n" .
' <input id="widget-text-1-filter" name="widget-text[1][filter]" class="filter sync-input" type="hidden" value="on">' . "\n" .
' <input id="widget-text-1-visual" name="widget-text[1][visual]" class="visual sync-input" type="hidden" value="on">',
),
array(
'id' => 'testwidget',
@@ -1207,11 +1207,16 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
$request = new WP_REST_Request( 'DELETE', '/wp/v2/widgets/text-1' );
$response = rest_do_request( $request );
$this->assertEqualSets(
$this->assertSameIgnoreEOL(
array(
'id' => 'text-1',
'id_base' => 'text',
'sidebar' => 'wp_inactive_widgets',
'rendered' => '',
'rendered_form' => '<input id="widget-text-1-title" name="widget-text[1][title]" class="title sync-input" type="hidden" value="">' . "\n" .
' <textarea id="widget-text-1-text" name="widget-text[1][text]" class="text sync-input" hidden>Custom text test</textarea>' . "\n" .
' <input id="widget-text-1-filter" name="widget-text[1][filter]" class="filter sync-input" type="hidden" value="on">' . "\n" .
' <input id="widget-text-1-visual" name="widget-text[1][visual]" class="visual sync-input" type="hidden" value="on">',
'instance' => array(
'encoded' => base64_encode(
serialize(
@@ -1231,11 +1236,6 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
'text' => 'Custom text test',
),
),
'rendered' => '',
'rendered_form' => '<input id="widget-text-1-title" name="widget-text[1][title]" class="title sync-input" type="hidden" value="">' . "\n" .
' <textarea id="widget-text-1-text" name="widget-text[1][text]" class="text sync-input" hidden>Custom text test</textarea>' . "\n" .
' <input id="widget-text-1-filter" name="widget-text[1][filter]" class="filter sync-input" type="hidden" value="on">' . "\n" .
' <input id="widget-text-1-visual" name="widget-text[1][visual]" class="visual sync-input" type="hidden" value="on">',
),
$response->get_data()
);
@@ -1264,7 +1264,7 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
$request->set_query_params( array( 'force' => true ) );
$response = rest_do_request( $request );
$this->assertEqualSets(
$this->assertSameIgnoreEOL(
array(
'deleted' => true,
'previous' => array(
@@ -1272,6 +1272,11 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
'id' => 'text-1',
'id_base' => 'text',
'sidebar' => 'sidebar-1',
'rendered' => '<div class="textwidget">Custom text test</div>',
'rendered_form' => '<input id="widget-text-1-title" name="widget-text[1][title]" class="title sync-input" type="hidden" value="">' . "\n" .
' <textarea id="widget-text-1-text" name="widget-text[1][text]" class="text sync-input" hidden>Custom text test</textarea>' . "\n" .
' <input id="widget-text-1-filter" name="widget-text[1][filter]" class="filter sync-input" type="hidden" value="on">' . "\n" .
' <input id="widget-text-1-visual" name="widget-text[1][visual]" class="visual sync-input" type="hidden" value="on">',
'instance' => array(
'encoded' => base64_encode(
serialize(
@@ -1291,11 +1296,6 @@ class WP_Test_REST_Widgets_Controller extends WP_Test_REST_Controller_Testcase {
'text' => 'Custom text test',
),
),
'rendered' => '<div class="textwidget">Custom text test</div>',
'rendered_form' => '<input id="widget-text-1-title" name="widget-text[1][title]" class="title sync-input" type="hidden" value="">' . "\n" .
' <textarea id="widget-text-1-text" name="widget-text[1][text]" class="text sync-input" hidden>Custom text test</textarea>' . "\n" .
' <input id="widget-text-1-filter" name="widget-text[1][filter]" class="filter sync-input" type="hidden" value="on">' . "\n" .
' <input id="widget-text-1-visual" name="widget-text[1][visual]" class="visual sync-input" type="hidden" value="on">',
),
),