Changeset 62249

Timestamp:

04/21/2026 02:03:56 PM (3 weeks ago)

Author:

dmsnell

Message:

Tests: Print invalid UTF-8 as ASCII to fix hosts test reporting failures.

When serializing test output into XML, invalid UTF-8 bytes lead to a failure to load those test results when they are read. This patch adds code to remap those invalid bytes in an ASCII-readable form, whereas the invalid bytes are separated by parentheses and encoded in their hex form.

This ensures that a proper XML file is generated from the testing results.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/11620
Discussed in: https://core.trac.wordpress.org/ticket/31992
Reported in: ​https://github.com/WordPress/phpunit-test-runner/pull/310

Follow-up to: [62225].

Props agulbra, amykamala, codexdemon, dmsnell, mywp459, rolle.
See #31992.

Location:

trunk/tests/phpunit/tests/formatting

Files:

• isEmail.php (modified) (1 diff)
• sanitizeEmail.php (modified) (2 diffs)

trunk/tests/phpunit/tests/formatting/isEmail.php

@@ -123 +123 @@
 
         foreach ( $invalid_emails as $email ) {
-            yield $email => array( $email );
+            yield self::invalid_utf8_as_ascii( $email ) => array( $email );
         }
     }
+
+    /**
+     * Transforms invalid byte sequences in UTF-8 into representations of
+     * each byte value, according to the maximal subpart rule.
+     *
+     * Example:
+     *
+     *     // For valid UTF-8 the output is the input.
+     *     'test' === invalid_utf8_as_ascii( 'test' );
+     *
+     *     // Invalid bytes are represented with their hex value.
+     *     'a(0x80)b' === invalid_utf8_as_ascii( "a\x80b" );
+     *
+     *     // Invalid byte sequences form maximal subparts.
+     *     '(0xC2)(0xEF 0xBF)' === invalid_utf8_as_ascii( "\xC2\xEF\xBF" );
+     *
+     * @param string $text
+     * @return string
+     */
+    private static function invalid_utf8_as_ascii( string $text ): string {
+        $output        = '';
+        $at            = 0;
+        $was_at        = 0;
+        $end           = strlen( $text );
+        $invalid_bytes = 0;
+
+        while ( $at < $end ) {
+            if ( 0 === _wp_scan_utf8( $text, $at, $invalid_bytes ) && 0 === $invalid_bytes ) {
+                break;
+            }
+
+            if ( $at > $was_at ) {
+                $output .= substr( $text, $was_at, $at - $was_at );
+            }
+
+            if ( $invalid_bytes > 0 ) {
+                $output .= '(';
+
+                for ( $i = 0; $i < $invalid_bytes; $i++ ) {
+                    $space   = $i > 0 ? ' ' : '';
+                    $as_hex  = bin2hex( $text[ $at + $i ] );
+                    $output .= "{$space}0x{$as_hex}";
+                }
+
+                $output .= ')';
+            }
+
+            $at    += $invalid_bytes;
+            $was_at = $at;
+        }
+
+        return $output;
+    }
 }

trunk/tests/phpunit/tests/formatting/sanitizeEmail.php

@@ -18 +18 @@
      */
     public function test_returns_stripped_email_address( $address, $expected ) {
-        $this->assertSame(
-            $expected,
-            sanitize_email( $address ),
-            'Should have produced the known sanitized form of the email.'
-        );
+        $sanitized = sanitize_email( $address );
+
+        if ( $expected === $sanitized ) {
+            $this->assertSame(
+                $expected,
+                $sanitized,
+                'Should have produced the known sanitized form of the email.'
+            );
+        } else {
+            $this->assertSame(
+                $expected,
+                self::invalid_utf8_as_ascii( $sanitized ),
+                'Should have produced the known sanitized form of the email.'
+            );
+        }
     }
 
@@ -40 +50 @@
         );
     }
+
+    /**
+     * Transforms invalid byte sequences in UTF-8 into representations of
+     * each byte value, according to the maximal subpart rule.
+     *
+     * Example:
+     *
+     *     // For valid UTF-8 the output is the input.
+     *     'test' === invalid_utf8_as_ascii( 'test' );
+     *
+     *     // Invalid bytes are represented with their hex value.
+     *     'a(0x80)b' === invalid_utf8_as_ascii( "a\x80b" );
+     *
+     *     // Invalid byte sequences form maximal subparts.
+     *     '(0xC2)(0xEF 0xBF)' === invalid_utf8_as_ascii( "\xC2\xEF\xBF" );
+     *
+     * @param string $text
+     * @return string
+     */
+    private static function invalid_utf8_as_ascii( string $text ): string {
+        $output        = '';
+        $at            = 0;
+        $was_at        = 0;
+        $end           = strlen( $text );
+        $invalid_bytes = 0;
+
+        while ( $at < $end ) {
+            if ( 0 === _wp_scan_utf8( $text, $at, $invalid_bytes ) && 0 === $invalid_bytes ) {
+                break;
+            }
+
+            if ( $at > $was_at ) {
+                $output .= substr( $text, $was_at, $at - $was_at );
+            }
+
+            if ( $invalid_bytes > 0 ) {
+                $output .= '(';
+
+                for ( $i = 0; $i < $invalid_bytes; $i++ ) {
+                    $space   = $i > 0 ? ' ' : '';
+                    $as_hex  = bin2hex( $text[ $at + $i ] );
+                    $output .= "{$space}0x{$as_hex}";
+                }
+
+                $output .= ')';
+            }
+
+            $at    += $invalid_bytes;
+            $was_at = $at;
+        }
+
+        return $output;
+    }
 }