<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[60116] General: Improve unit tests for `wp_unique_id_from_values()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/60116">60116</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/60116","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-04-01 13:30:09 +0000 (Tue, 01 Apr 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>General: Improve unit tests for `wp_unique_id_from_values()`.
This is a follow-up to <a href="https://core.trac.wordpress.org/changeset/60038">[60038]</a>, which updates the PHPUnit tests to account for different systems producing potentially different hashes due to platform specific floating point precision settings.
Reviewed by audrasjb, desrosj.
Merges <a href="https://core.trac.wordpress.org/changeset/60113">[60113]</a> to the 6.8 branch.
Props debarghyabanerjee, joemcgill, peterwilsoncc, siliconforks.
Fixes <a href="https://core.trac.wordpress.org/ticket/63175">#63175</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches68testsphpunittestsfunctionswpUniqueIdFromValuesphp">branches/6.8/tests/phpunit/tests/functions/wpUniqueIdFromValues.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches68">branches/6.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.8 2025-04-01 12:42:05 UTC (rev 60115)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.8 2025-04-01 13:30:09 UTC (rev 60116)
</ins><a id="branches68"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/6.7:59437
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:60098,60104,60114
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:60098,60104,60113-60114
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches68testsphpunittestsfunctionswpUniqueIdFromValuesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.8/tests/phpunit/tests/functions/wpUniqueIdFromValues.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.8/tests/phpunit/tests/functions/wpUniqueIdFromValues.php 2025-04-01 12:42:05 UTC (rev 60115)
+++ branches/6.8/tests/phpunit/tests/functions/wpUniqueIdFromValues.php 2025-04-01 13:30:09 UTC (rev 60116)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,6 +13,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Functions_WpUniqueIdFromValues extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prefix used for testing.
+ *
+ * @var string
+ */
+ private $prefix = 'my-prefix-';
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test that the function returns consistent ids for the passed params.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 62985
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,14 +28,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_wp_unique_id_from_values( $expected, $data, $prefix ) {
- $output1 = wp_unique_id_from_values( $data );
- $output2 = wp_unique_id_from_values( $data, $prefix );
- $this->assertSame( $expected, $output1 );
- $this->assertSame( $prefix . $expected, $output2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_unique_id_from_values( $data ) {
+ // Generate IDs.
+ $unique_id_original = wp_unique_id_from_values( $data );
+ $unique_id_prefixed = wp_unique_id_from_values( $data, $this->prefix );
+
+ // Ensure that the same input produces the same ID.
+ $this->assertSame( $unique_id_original, wp_unique_id_from_values( $data ) );
+ $this->assertSame( $unique_id_prefixed, wp_unique_id_from_values( $data, $this->prefix ) );
+
+ // Ensure that the prefixed ID is the prefix + the original ID.
+ $this->assertSame( $this->prefix . $unique_id_original, $unique_id_prefixed );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test that different input data generates distinct IDs.
+ *
+ * @ticket 62985
+ *
+ * @dataProvider data_wp_unique_id_from_values
+ *
+ * @since 6.8.0
+ */
+ public function test_wp_unique_id_from_values_uniqueness( $data ) {
+ // Generate IDs.
+ $unique_id_original = wp_unique_id_from_values( $data );
+ $unique_id_prefixed = wp_unique_id_from_values( $data, $this->prefix );
+
+ // Modify the data slightly to generate a different ID.
+ $data_modified = $data;
+ $data_modified['value'] = 'modified';
+
+ // Generate new IDs with the modified data.
+ $unique_id_modified = wp_unique_id_from_values( $data_modified );
+ $unique_id_prefixed_modified = wp_unique_id_from_values( $data_modified, $this->prefix );
+
+ // Assert that the IDs for different data are distinct.
+ $this->assertNotSame( $unique_id_original, $unique_id_modified );
+ $this->assertNotSame( $unique_id_prefixed, $unique_id_prefixed_modified );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Data provider.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array[]
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,51 +75,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function data_wp_unique_id_from_values() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'string' => array(
- 'expected' => '469f5989',
- 'data' => array(
- 'value' => 'text',
- ),
- 'prefix' => 'my-prefix-',
- ),
- 'integer' => array(
- 'expected' => 'b2f0842e',
- 'data' => array(
- 'value' => 123,
- ),
- 'prefix' => 'my-prefix-',
- ),
- 'float' => array(
- 'expected' => 'a756f54d',
- 'data' => array(
- 'value' => 1.23,
- ),
- 'prefix' => 'my-prefix-',
- ),
- 'boolean' => array(
- 'expected' => 'bdae8be3',
- 'data' => array(
- 'value' => true,
- ),
- 'prefix' => 'my-prefix-',
- ),
- 'object' => array(
- 'expected' => '477bd670',
- 'data' => array(
- 'value' => new StdClass(),
- ),
- 'prefix' => 'my-prefix-',
- ),
- 'null' => array(
- 'expected' => 'a860dd95',
- 'data' => array(
- 'value' => null,
- ),
- 'prefix' => 'my-prefix-',
- ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'string' => array( array( 'value' => 'text' ) ),
+ 'integer' => array( array( 'value' => 123 ) ),
+ 'float' => array( array( 'value' => 1.23 ) ),
+ 'boolean' => array( array( 'value' => true ) ),
+ 'object' => array( array( 'value' => new StdClass() ) ),
+ 'null' => array( array( 'value' => null ) ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'multiple values' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected' => 'ef258a5d',
- 'data' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'value1' => 'text',
</span><span class="cx" style="display: block; padding: 0 10px"> 'value2' => 123,
</span><span class="cx" style="display: block; padding: 0 10px"> 'value3' => 1.23,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,11 +90,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'value5' => new StdClass(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'value6' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'prefix' => 'my-prefix-',
</del><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'nested arrays' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected' => '4345cae5',
- 'data' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'list1' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'value1' => 'text',
</span><span class="cx" style="display: block; padding: 0 10px"> 'value2' => 123,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,7 +104,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'value6' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'prefix' => 'my-prefix-',
</del><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,7 +118,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_unique_id_from_values_empty_array() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_unique_id_from_values( array(), 'my-prefix-' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_unique_id_from_values( array(), $this->prefix );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,43 +130,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_wp_unique_id_from_values_invalid_data( $data, $prefix ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_unique_id_from_values_invalid_data( $data ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->expectException( TypeError::class );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_unique_id_from_values( $data, $prefix );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_unique_id_from_values( $data, $this->prefix );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Data provider.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Data provider for invalid data tests.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array[]
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function data_wp_unique_id_from_values_invalid_data() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'string' => array(
- 'data' => 'text',
- 'prefix' => '',
- ),
- 'integer' => array(
- 'data' => 123,
- 'prefix' => '',
- ),
- 'float' => array(
- 'data' => 1.23,
- 'prefix' => '',
- ),
- 'boolean' => array(
- 'data' => true,
- 'prefix' => '',
- ),
- 'object' => array(
- 'data' => new StdClass(),
- 'prefix' => '',
- ),
- 'null' => array(
- 'data' => null,
- 'prefix' => '',
- ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'string' => array( 'text' ),
+ 'integer' => array( 123 ),
+ 'float' => array( 1.23 ),
+ 'boolean' => array( true ),
+ 'object' => array( new StdClass() ),
+ 'null' => array( null ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>